… | |
… | |
48 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
48 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
49 | |
49 | |
50 | =head1 DESCRIPTION |
50 | =head1 DESCRIPTION |
51 | |
51 | |
52 | This module provides an interface to libev |
52 | This module provides an interface to libev |
53 | (L<http://software.schmorp.de/pkg/libev.html>). |
53 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
|
|
54 | below is comprehensive, one might also consult the documentation of libev |
|
|
55 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
|
|
56 | watcher semantics or some discussion on the available backends, or how to |
|
|
57 | force a specific backend with C<LIBEV_FLAGS>. |
54 | |
58 | |
55 | =cut |
59 | =cut |
56 | |
60 | |
57 | package EV; |
61 | package EV; |
58 | |
62 | |
59 | use strict; |
63 | use strict; |
60 | |
64 | |
61 | BEGIN { |
65 | BEGIN { |
62 | our $VERSION = '1.2'; |
66 | our $VERSION = '1.3'; |
63 | use XSLoader; |
67 | use XSLoader; |
64 | XSLoader::load "EV", $VERSION; |
68 | XSLoader::load "EV", $VERSION; |
65 | } |
69 | } |
66 | |
70 | |
67 | @EV::Io::ISA = |
71 | @EV::IO::ISA = |
68 | @EV::Timer::ISA = |
72 | @EV::Timer::ISA = |
69 | @EV::Periodic::ISA = |
73 | @EV::Periodic::ISA = |
70 | @EV::Signal::ISA = |
74 | @EV::Signal::ISA = |
71 | @EV::Idle::ISA = |
75 | @EV::Idle::ISA = |
72 | @EV::Prepare::ISA = |
76 | @EV::Prepare::ISA = |
… | |
… | |
117 | innermost call to EV::loop return. |
121 | innermost call to EV::loop return. |
118 | |
122 | |
119 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
123 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
120 | fast as possible. |
124 | fast as possible. |
121 | |
125 | |
|
|
126 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
127 | |
|
|
128 | This function rolls together an I/O and a timer watcher for a single |
|
|
129 | one-shot event without the need for managing a watcher object. |
|
|
130 | |
|
|
131 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
|
|
132 | must be a bitset containing either C<EV::READ>, C<EV::WRITE> or C<EV::READ |
|
|
133 | | EV::WRITE>, indicating the type of I/O event you want to wait for. If |
|
|
134 | you do not want to wait for some I/O event, specify C<undef> for |
|
|
135 | C<$fh_or_undef> and C<0> for C<$events>). |
|
|
136 | |
|
|
137 | If timeout is C<undef> or negative, then there will be no |
|
|
138 | timeout. Otherwise a EV::timer with this value will be started. |
|
|
139 | |
|
|
140 | When an error occurs or either the timeout or I/O watcher triggers, then |
|
|
141 | the callback will be called with the received event set (in general |
|
|
142 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
|
|
143 | C<EV::WRITE> and C<EV::TIMEOUT>). |
|
|
144 | |
|
|
145 | EV::once doesn't return anything: the watchers stay active till either |
|
|
146 | of them triggers, then they will be stopped and freed, and the callback |
|
|
147 | invoked. |
|
|
148 | |
122 | =back |
149 | =back |
123 | |
150 | |
124 | =head2 WATCHER |
151 | =head2 WATCHER |
125 | |
152 | |
126 | A watcher is an object that gets created to record your interest in some |
153 | A watcher is an object that gets created to record your interest in some |
… | |
… | |
210 | watchers with higher priority will be invoked first. The valid range of |
237 | watchers with higher priority will be invoked first. The valid range of |
211 | priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default |
238 | priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default |
212 | -2). If the priority is outside this range it will automatically be |
239 | -2). If the priority is outside this range it will automatically be |
213 | normalised to the nearest valid priority. |
240 | normalised to the nearest valid priority. |
214 | |
241 | |
215 | The default priority of any newly-created weatcher is 0. |
242 | The default priority of any newly-created watcher is 0. |
|
|
243 | |
|
|
244 | Note that the priority semantics have not yet been fleshed out and are |
|
|
245 | subject to almost certain change. |
216 | |
246 | |
217 | =item $w->trigger ($revents) |
247 | =item $w->trigger ($revents) |
218 | |
248 | |
219 | Call the callback *now* with the given event mask. |
249 | Call the callback *now* with the given event mask. |
220 | |
250 | |
|
|
251 | =item $previous_state = $w->keepalive ($bool) |
|
|
252 | |
|
|
253 | Normally, C<EV::loop> will return when there are no active watchers |
|
|
254 | (which is a "deadlock" because no progress can be made anymore). This is |
|
|
255 | convinient because it allows you to start your watchers (and your jobs), |
|
|
256 | call C<EV::loop> once and when it returns you know that all your jobs are |
|
|
257 | finished (or they forgot to register some watchers for their task :). |
|
|
258 | |
|
|
259 | Sometimes, however, this gets in your way, for example when you the module |
|
|
260 | that calls C<EV::loop> (usually the main program) is not the same module |
|
|
261 | as a long-living watcher (for example a DNS client module written by |
|
|
262 | somebody else even). Then you might want any outstanding requests to be |
|
|
263 | handled, but you would not want to keep C<EV::loop> from returning just |
|
|
264 | because you happen to have this long-running UDP port watcher. |
|
|
265 | |
|
|
266 | In this case you can clear the keepalive status, which means that even |
|
|
267 | though your watcher is active, it won't keep C<EV::loop> from returning. |
|
|
268 | |
|
|
269 | The initial value for keepalive is true (enabled), and you cna change it |
|
|
270 | any time. |
|
|
271 | |
|
|
272 | Example: Register an IO watcher for some UDP socket but do not keep the |
|
|
273 | event loop from running just because of that watcher. |
|
|
274 | |
|
|
275 | my $udp_socket = ... |
|
|
276 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
|
|
277 | $udp_watcher->keepalive (0); |
221 | |
278 | |
222 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
279 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
223 | |
280 | |
224 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
281 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
225 | |
282 | |
… | |
… | |
253 | |
310 | |
254 | =item $w = EV::timer $after, $repeat, $callback |
311 | =item $w = EV::timer $after, $repeat, $callback |
255 | |
312 | |
256 | =item $w = EV::timer_ns $after, $repeat, $callback |
313 | =item $w = EV::timer_ns $after, $repeat, $callback |
257 | |
314 | |
258 | Calls the callback after C<$after> seconds. If C<$repeat> is non-zero, |
315 | Calls the callback after C<$after> seconds (which may be fractional). If |
259 | the timer will be restarted (with the $repeat value as $after) after the |
316 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
260 | callback returns. |
317 | value as $after) after the callback returns. |
261 | |
318 | |
262 | This means that the callback would be called roughly after C<$after> |
319 | This means that the callback would be called roughly after C<$after> |
263 | seconds, and then every C<$repeat> seconds. The timer does his best not |
320 | seconds, and then every C<$repeat> seconds. The timer does his best not |
264 | to drift, but it will not invoke the timer more often then once per event |
321 | to drift, but it will not invoke the timer more often then once per event |
265 | loop iteration, and might drift in other cases. If that isn't acceptable, |
322 | loop iteration, and might drift in other cases. If that isn't acceptable, |