… | |
… | |
10 | |
10 | |
11 | my $w = EV::timer 2, 0, sub { |
11 | my $w = EV::timer 2, 0, sub { |
12 | warn "is called after 2s"; |
12 | warn "is called after 2s"; |
13 | }; |
13 | }; |
14 | |
14 | |
15 | my $w = EV::timer 2, 1, sub { |
15 | my $w = EV::timer 2, 2, sub { |
16 | warn "is called roughly every 2s (repeat = 1)"; |
16 | warn "is called roughly every 2s (repeat = 2)"; |
17 | }; |
17 | }; |
18 | |
18 | |
19 | undef $w; # destroy event watcher again |
19 | undef $w; # destroy event watcher again |
20 | |
20 | |
21 | my $w = EV::periodic 0, 60, sub { |
21 | my $w = EV::periodic 0, 60, 0, sub { |
22 | warn "is called every minute, on the minute, exactly"; |
22 | warn "is called every minute, on the minute, exactly"; |
23 | }; |
23 | }; |
24 | |
24 | |
25 | # IO |
25 | # IO |
26 | |
26 | |
27 | my $w = EV::io *STDIN, EV::READ, sub { |
27 | my $w = EV::io *STDIN, EV::READ, sub { |
28 | my ($w, $revents) = @_; # all callbacks get the watcher object and event mask |
28 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
29 | warn "stdin is readable, you entered: ", <STDIN>; |
29 | warn "stdin is readable, you entered: ", <STDIN>; |
30 | }; |
30 | }; |
31 | |
31 | |
32 | # SIGNALS |
32 | # SIGNALS |
33 | |
33 | |
34 | my $w = EV::signal 'QUIT', sub { |
34 | my $w = EV::signal 'QUIT', sub { |
35 | warn "sigquit received\n"; |
35 | warn "sigquit received\n"; |
36 | }; |
36 | }; |
37 | |
37 | |
38 | my $w = EV::signal 3, sub { |
|
|
39 | warn "sigquit received (this is GNU/Linux, right?)\n"; |
|
|
40 | }; |
|
|
41 | |
|
|
42 | # CHILD/PID STATUS CHANGES |
38 | # CHILD/PID STATUS CHANGES |
43 | |
39 | |
44 | my $w = EV::child 666, sub { |
40 | my $w = EV::child 666, sub { |
45 | my ($w, $revents) = @_; |
41 | my ($w, $revents) = @_; |
46 | # my $pid = $w->rpid; |
|
|
47 | my $status = $w->rstatus; |
42 | my $status = $w->rstatus; |
48 | }; |
43 | }; |
49 | |
44 | |
50 | # MAINLOOP |
45 | # MAINLOOP |
51 | EV::loop; # loop until EV::loop_done is called |
46 | EV::loop; # loop until EV::unloop is called or all watchers stop |
52 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
47 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
53 | 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 |
54 | |
49 | |
55 | =head1 DESCRIPTION |
50 | =head1 DESCRIPTION |
56 | |
51 | |
… | |
… | |
62 | package EV; |
57 | package EV; |
63 | |
58 | |
64 | use strict; |
59 | use strict; |
65 | |
60 | |
66 | BEGIN { |
61 | BEGIN { |
67 | our $VERSION = '0.5'; |
62 | our $VERSION = '0.9'; |
68 | use XSLoader; |
63 | use XSLoader; |
69 | XSLoader::load "EV", $VERSION; |
64 | XSLoader::load "EV", $VERSION; |
70 | } |
65 | } |
71 | |
66 | |
72 | @EV::Io::ISA = |
67 | @EV::Io::ISA = |
… | |
… | |
106 | or EV::METHOD_EPOLL). |
101 | or EV::METHOD_EPOLL). |
107 | |
102 | |
108 | =item EV::loop [$flags] |
103 | =item EV::loop [$flags] |
109 | |
104 | |
110 | Begin checking for events and calling callbacks. It returns when a |
105 | Begin checking for events and calling callbacks. It returns when a |
111 | callback calls EV::loop_done. |
106 | callback calls EV::unloop. |
112 | |
107 | |
113 | The $flags argument can be one of the following: |
108 | The $flags argument can be one of the following: |
114 | |
109 | |
115 | 0 as above |
110 | 0 as above |
116 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
111 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
117 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
112 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
118 | |
113 | |
119 | =item EV::loop_done [$how] |
114 | =item EV::unloop [$how] |
120 | |
115 | |
121 | When called with no arguments or an argument of 1, makes the innermost |
116 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
122 | call to EV::loop return. |
117 | innermost call to EV::loop return. |
123 | |
118 | |
124 | When called with an agrument of 2, all calls to EV::loop will return as |
119 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
125 | fast as possible. |
120 | fast as possible. |
126 | |
121 | |
127 | =back |
122 | =back |
128 | |
123 | |
129 | =head2 WATCHER |
124 | =head2 WATCHER |
… | |
… | |
186 | |
181 | |
187 | =item $bool = $w->is_active |
182 | =item $bool = $w->is_active |
188 | |
183 | |
189 | Returns true if the watcher is active, false otherwise. |
184 | Returns true if the watcher is active, false otherwise. |
190 | |
185 | |
|
|
186 | =item $current_data = $w->data |
|
|
187 | |
|
|
188 | =item $old_data = $w->data ($new_data) |
|
|
189 | |
|
|
190 | Queries a freely usable data scalar on the watcher and optionally changes |
|
|
191 | it. This is a way to associate custom data with a watcher: |
|
|
192 | |
|
|
193 | my $w = EV::timer 60, 0, sub { |
|
|
194 | warn $_[0]->data; |
|
|
195 | }; |
|
|
196 | $w->data ("print me!"); |
|
|
197 | |
191 | =item $current_cb = $w->cb |
198 | =item $current_cb = $w->cb |
192 | |
199 | |
193 | =item $old_cb = $w->cb ($new_cb) |
200 | =item $old_cb = $w->cb ($new_cb) |
194 | |
201 | |
195 | Queries the callback on the watcher and optionally changes it. You can do |
202 | Queries the callback on the watcher and optionally changes it. You can do |
… | |
… | |
251 | Calls the callback after C<$after> seconds. If C<$repeat> is non-zero, |
258 | Calls the callback after C<$after> seconds. If C<$repeat> is non-zero, |
252 | the timer will be restarted (with the $repeat value as $after) after the |
259 | the timer will be restarted (with the $repeat value as $after) after the |
253 | callback returns. |
260 | callback returns. |
254 | |
261 | |
255 | This means that the callback would be called roughly after C<$after> |
262 | This means that the callback would be called roughly after C<$after> |
256 | seconds, and then every C<$repeat> seconds. "Roughly" because the time of |
263 | seconds, and then every C<$repeat> seconds. The timer does his best not |
257 | callback processing is not taken into account, so the timer will slowly |
264 | to drift, but it will not invoke the timer more often then once per event |
258 | drift. If that isn't acceptable, look at EV::periodic. |
265 | loop iteration, and might drift in other cases. If that isn't acceptable, |
|
|
266 | look at EV::periodic, which can provide long-term stable timers. |
259 | |
267 | |
260 | The timer is based on a monotonic clock, that is if somebody is sitting |
268 | The timer is based on a monotonic clock, that is, if somebody is sitting |
261 | in front of the machine while the timer is running and changes the system |
269 | in front of the machine while the timer is running and changes the system |
262 | clock, the timer will nevertheless run (roughly) the same time. |
270 | clock, the timer will nevertheless run (roughly) the same time. |
263 | |
271 | |
264 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
272 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
265 | |
273 | |
… | |
… | |
270 | |
278 | |
271 | =item $w->again |
279 | =item $w->again |
272 | |
280 | |
273 | Similar to the C<start> method, but has special semantics for repeating timers: |
281 | Similar to the C<start> method, but has special semantics for repeating timers: |
274 | |
282 | |
|
|
283 | If the timer is active and non-repeating, it will be stopped. |
|
|
284 | |
275 | If the timer is active and repeating, reset the timeout to occur |
285 | If the timer is active and repeating, reset the timeout to occur |
276 | C<$repeat> seconds after now. |
286 | C<$repeat> seconds after now. |
277 | |
287 | |
278 | If the timer is active and non-repeating, it will be stopped. |
|
|
279 | |
|
|
280 | If the timer is in active and repeating, start it. |
288 | If the timer is inactive and repeating, start it using the repeat value. |
281 | |
289 | |
282 | Otherwise do nothing. |
290 | Otherwise do nothing. |
283 | |
291 | |
284 | This behaviour is useful when you have a timeout for some IO |
292 | This behaviour is useful when you have a timeout for some IO |
285 | operation. You create a timer object with the same value for C<$after> and |
293 | operation. You create a timer object with the same value for C<$after> and |
286 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
294 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
287 | on the timeout. |
295 | on the timeout. |
288 | |
296 | |
289 | |
297 | |
290 | =item $w = EV::periodic $at, $interval, $callback |
298 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
291 | |
299 | |
292 | =item $w = EV::periodic_ns $at, $interval, $callback |
300 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
293 | |
301 | |
294 | Similar to EV::timer, but the time is given as an absolute point in time |
302 | Similar to EV::timer, but is not based on relative timeouts but on |
295 | (C<$at>), plus an optional C<$interval>. |
303 | absolute times. Apart from creating "simple" timers that trigger "at" the |
|
|
304 | specified time, it can also be used for non-drifting absolute timers and |
|
|
305 | more complex, cron-like, setups that are not adversely affected by time |
|
|
306 | jumps (i.e. when the system clock is changed by explicit date -s or other |
|
|
307 | means such as ntpd). It is also the most complex watcher type in EV. |
296 | |
308 | |
297 | If the C<$interval> is zero, then the callback will be called at the time |
309 | It has three distinct "modes": |
298 | C<$at> if that is in the future, or as soon as possible if it is in the |
|
|
299 | past. It will not automatically repeat. |
|
|
300 | |
310 | |
301 | If the C<$interval> is nonzero, then the watcher will always be scheduled |
311 | =over 4 |
302 | to time out at the next C<$at + N * $interval> time. |
|
|
303 | |
312 | |
304 | This can be used to schedule a callback to run at very regular intervals, |
313 | =item * absolute timer ($interval = $reschedule_cb = 0) |
305 | as long as the processing time is less then the interval (otherwise |
314 | |
306 | obviously events will be skipped). |
315 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
|
|
316 | will not adjust when a time jump occurs, that is, if it is to be run |
|
|
317 | at January 1st 2011 then it will run when the system time reaches or |
|
|
318 | surpasses this time. |
|
|
319 | |
|
|
320 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
|
|
321 | |
|
|
322 | In this mode the watcher will always be scheduled to time out at the |
|
|
323 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
|
|
324 | regardless of any time jumps. |
|
|
325 | |
|
|
326 | This can be used to create timers that do not drift with respect to system |
|
|
327 | time: |
|
|
328 | |
|
|
329 | my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; |
|
|
330 | |
|
|
331 | That doesn't mean there will always be 3600 seconds in between triggers, |
|
|
332 | but only that the the clalback will be called when the system time shows a |
|
|
333 | full hour (UTC). |
307 | |
334 | |
308 | Another way to think about it (for the mathematically inclined) is that |
335 | Another way to think about it (for the mathematically inclined) is that |
309 | EV::periodic will try to run the callback at the next possible time where |
336 | EV::periodic will try to run the callback in this mode at the next |
310 | C<$time = $at (mod $interval)>, regardless of any time jumps. |
337 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
|
|
338 | jumps. |
311 | |
339 | |
312 | This periodic timer is based on "wallclock time", that is, if the clock |
340 | =item * manual reschedule mode ($reschedule_cb = coderef) |
313 | changes (C<ntp>, C<date -s> etc.), then the timer will nevertheless run at |
341 | |
314 | the specified time. This means it will never drift (it might jitter, but |
342 | In this mode $interval and $at are both being ignored. Instead, each |
315 | it will not drift). |
343 | time the periodic watcher gets scheduled, the reschedule callback |
|
|
344 | ($reschedule_cb) will be called with the watcher as first, and the current |
|
|
345 | time as second argument. |
|
|
346 | |
|
|
347 | I<This callback MUST NOT stop or destroy this or any other periodic |
|
|
348 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
|
|
349 | afterwards. |
|
|
350 | |
|
|
351 | It must return the next time to trigger, based on the passed time value |
|
|
352 | (that is, the lowest time value larger than to the second argument). It |
|
|
353 | will usually be called just before the callback will be triggered, but |
|
|
354 | might be called at other times, too. |
|
|
355 | |
|
|
356 | This can be used to create very complex timers, such as a timer that |
|
|
357 | triggers on each midnight, local time (actually 24 hours after the last |
|
|
358 | midnight, to keep the example simple. If you know a way to do it correctly |
|
|
359 | in about the same space (without requiring elaborate modules), drop me a |
|
|
360 | note :): |
|
|
361 | |
|
|
362 | my $daily = EV::periodic 0, 0, sub { |
|
|
363 | my ($w, $now) = @_; |
|
|
364 | |
|
|
365 | use Time::Local (); |
|
|
366 | my (undef, undef, undef, $d, $m, $y) = localtime $now; |
|
|
367 | 86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y |
|
|
368 | }, sub { |
|
|
369 | print "it's midnight or likely shortly after, now\n"; |
|
|
370 | }; |
|
|
371 | |
|
|
372 | =back |
316 | |
373 | |
317 | The C<periodic_ns> variant doesn't start (activate) the newly created watcher. |
374 | The C<periodic_ns> variant doesn't start (activate) the newly created watcher. |
318 | |
375 | |
319 | =item $w->set ($at, $interval) |
376 | =item $w->set ($at, $interval, $reschedule_cb) |
320 | |
377 | |
321 | Reconfigures the watcher, see the constructor above for details. Can be at |
378 | Reconfigures the watcher, see the constructor above for details. Can be at |
322 | any time. |
379 | any time. |
|
|
380 | |
|
|
381 | =item $w->again |
|
|
382 | |
|
|
383 | Simply stops and starts the watcher again. |
323 | |
384 | |
324 | |
385 | |
325 | =item $w = EV::signal $signal, $callback |
386 | =item $w = EV::signal $signal, $callback |
326 | |
387 | |
327 | =item $w = EV::signal_ns $signal, $callback |
388 | =item $w = EV::signal_ns $signal, $callback |
… | |
… | |
478 | }; |
539 | }; |
479 | |
540 | |
480 | default_loop |
541 | default_loop |
481 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
542 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
482 | |
543 | |
483 | push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"]; |
|
|
484 | |
|
|
485 | 1; |
544 | 1; |
486 | |
545 | |
487 | =head1 SEE ALSO |
546 | =head1 SEE ALSO |
488 | |
547 | |
489 | L<EV::DNS>, L<EV::AnyEvent>. |
548 | L<EV::DNS>. |
490 | |
549 | |
491 | =head1 AUTHOR |
550 | =head1 AUTHOR |
492 | |
551 | |
493 | Marc Lehmann <schmorp@schmorp.de> |
552 | Marc Lehmann <schmorp@schmorp.de> |
494 | http://home.schmorp.de/ |
553 | http://home.schmorp.de/ |