… | |
… | |
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, $status) = @_; |
41 | my ($w, $revents) = @_; |
|
|
42 | my $status = $w->rstatus; |
46 | }; |
43 | }; |
47 | |
44 | |
48 | # MAINLOOP |
45 | # MAINLOOP |
49 | EV::loop; # loop until EV::loop_done is called |
46 | EV::loop; # loop until EV::unloop is called or all watchers stop |
50 | 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 |
51 | 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 |
52 | |
49 | |
53 | =head1 DESCRIPTION |
50 | =head1 DESCRIPTION |
54 | |
51 | |
… | |
… | |
60 | package EV; |
57 | package EV; |
61 | |
58 | |
62 | use strict; |
59 | use strict; |
63 | |
60 | |
64 | BEGIN { |
61 | BEGIN { |
65 | our $VERSION = '0.1'; |
62 | our $VERSION = '1.0'; |
66 | use XSLoader; |
63 | use XSLoader; |
67 | XSLoader::load "EV", $VERSION; |
64 | XSLoader::load "EV", $VERSION; |
68 | } |
65 | } |
69 | |
66 | |
70 | @EV::Io::ISA = |
67 | @EV::Io::ISA = |
… | |
… | |
96 | |
93 | |
97 | Returns the time the last event loop iteration has been started. This |
94 | Returns the time the last event loop iteration has been started. This |
98 | is the time that (relative) timers are based on, and refering to it is |
95 | is the time that (relative) timers are based on, and refering to it is |
99 | usually faster then calling EV::time. |
96 | usually faster then calling EV::time. |
100 | |
97 | |
101 | =item $method = EV::ev_method |
98 | =item $method = EV::method |
102 | |
99 | |
103 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
100 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
104 | or EV::METHOD_EPOLL). |
101 | or EV::METHOD_EPOLL). |
105 | |
102 | |
106 | =item EV::loop [$flags] |
103 | =item EV::loop [$flags] |
107 | |
104 | |
108 | Begin checking for events and calling callbacks. It returns when a |
105 | Begin checking for events and calling callbacks. It returns when a |
109 | callback calls EV::loop_done. |
106 | callback calls EV::unloop. |
110 | |
107 | |
111 | The $flags argument can be one of the following: |
108 | The $flags argument can be one of the following: |
112 | |
109 | |
113 | 0 as above |
110 | 0 as above |
114 | 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) |
115 | 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) |
116 | |
113 | |
117 | =item EV::loop_done [$how] |
114 | =item EV::unloop [$how] |
118 | |
115 | |
119 | 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 |
120 | call to EV::loop return. |
117 | innermost call to EV::loop return. |
121 | |
118 | |
122 | 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 |
123 | fast as possible. |
120 | fast as possible. |
124 | |
121 | |
125 | =back |
122 | =back |
126 | |
123 | |
127 | =head2 WATCHER |
124 | =head2 WATCHER |
… | |
… | |
184 | |
181 | |
185 | =item $bool = $w->is_active |
182 | =item $bool = $w->is_active |
186 | |
183 | |
187 | Returns true if the watcher is active, false otherwise. |
184 | Returns true if the watcher is active, false otherwise. |
188 | |
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 | |
189 | =item $current_cb = $w->cb |
198 | =item $current_cb = $w->cb |
190 | |
199 | |
191 | =item $old_cb = $w->cb ($new_cb) |
200 | =item $old_cb = $w->cb ($new_cb) |
192 | |
201 | |
193 | 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 |
… | |
… | |
249 | 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, |
250 | 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 |
251 | callback returns. |
260 | callback returns. |
252 | |
261 | |
253 | 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> |
254 | 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 |
255 | 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 |
256 | 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. |
257 | |
267 | |
258 | 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 |
259 | 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 |
260 | clock, the timer will nevertheless run (roughly) the same time. |
270 | clock, the timer will nevertheless run (roughly) the same time. |
261 | |
271 | |
262 | 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. |
263 | |
273 | |
… | |
… | |
268 | |
278 | |
269 | =item $w->again |
279 | =item $w->again |
270 | |
280 | |
271 | 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: |
272 | |
282 | |
|
|
283 | If the timer is active and non-repeating, it will be stopped. |
|
|
284 | |
273 | 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 |
274 | C<$repeat> seconds after now. |
286 | C<$repeat> seconds after now. |
275 | |
287 | |
276 | If the timer is active and non-repeating, it will be stopped. |
|
|
277 | |
|
|
278 | If the timer is in active and repeating, start it. |
288 | If the timer is inactive and repeating, start it using the repeat value. |
279 | |
289 | |
280 | Otherwise do nothing. |
290 | Otherwise do nothing. |
281 | |
291 | |
282 | 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 |
283 | 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 |
284 | 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 |
285 | on the timeout. |
295 | on the timeout. |
286 | |
296 | |
287 | |
297 | |
288 | =item $w = EV::periodic $at, $interval, $callback |
298 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
289 | |
299 | |
290 | =item $w = EV::periodic_ns $at, $interval, $callback |
300 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
291 | |
301 | |
292 | 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 |
293 | (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. |
294 | |
308 | |
295 | If the C<$interval> is zero, then the callback will be called at the time |
309 | It has three distinct "modes": |
296 | C<$at> if that is in the future, or as soon as possible if it is in the |
|
|
297 | past. It will not automatically repeat. |
|
|
298 | |
310 | |
299 | If the C<$interval> is nonzero, then the watcher will always be scheduled |
311 | =over 4 |
300 | to time out at the next C<$at + N * $interval> time. |
|
|
301 | |
312 | |
302 | This can be used to schedule a callback to run at very regular intervals, |
313 | =item * absolute timer ($interval = $reschedule_cb = 0) |
303 | as long as the processing time is less then the interval (otherwise |
314 | |
304 | 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). |
305 | |
334 | |
306 | 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 |
307 | 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 |
308 | 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. |
309 | |
339 | |
310 | This periodic timer is based on "wallclock time", that is, if the clock |
340 | =item * manual reschedule mode ($reschedule_cb = coderef) |
311 | changes (C<ntp>, C<date -s> etc.), then the timer will nevertheless run at |
341 | |
312 | 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 |
313 | 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 |
314 | |
373 | |
315 | 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. |
316 | |
375 | |
317 | =item $w->set ($at, $interval) |
376 | =item $w->set ($at, $interval, $reschedule_cb) |
318 | |
377 | |
319 | 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 |
320 | any time. |
379 | any time. |
|
|
380 | |
|
|
381 | =item $w->again |
|
|
382 | |
|
|
383 | Simply stops and starts the watcher again. |
321 | |
384 | |
322 | |
385 | |
323 | =item $w = EV::signal $signal, $callback |
386 | =item $w = EV::signal $signal, $callback |
324 | |
387 | |
325 | =item $w = EV::signal_ns $signal, $callback |
388 | =item $w = EV::signal_ns $signal, $callback |
… | |
… | |
356 | Call the callback when a status change for pid C<$pid> (or any pid |
419 | Call the callback when a status change for pid C<$pid> (or any pid |
357 | if C<$pid> is 0) has been received. More precisely: when the process |
420 | if C<$pid> is 0) has been received. More precisely: when the process |
358 | receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all |
421 | receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all |
359 | changed/zombie children and call the callback. |
422 | changed/zombie children and call the callback. |
360 | |
423 | |
361 | Unlike all other callbacks, this callback will be called with an |
424 | You can access both status and pid by using the C<rstatus> and C<rpid> |
362 | additional third argument which is the exit status. See the C<waitpid> |
425 | methods on the watcher object. |
363 | function for details. |
|
|
364 | |
426 | |
365 | You can have as many pid watchers per pid as you want. |
427 | You can have as many pid watchers per pid as you want. |
366 | |
428 | |
367 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
429 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
368 | |
430 | |
… | |
… | |
374 | =item $current_pid = $w->pid |
436 | =item $current_pid = $w->pid |
375 | |
437 | |
376 | =item $old_pid = $w->pid ($new_pid) |
438 | =item $old_pid = $w->pid ($new_pid) |
377 | |
439 | |
378 | Returns the previously set process id and optionally set a new one. |
440 | Returns the previously set process id and optionally set a new one. |
|
|
441 | |
|
|
442 | =item $exit_status = $w->rstatus |
|
|
443 | |
|
|
444 | Return the exit/wait status (as returned by waitpid, see the waitpid entry |
|
|
445 | in perlfunc). |
|
|
446 | |
|
|
447 | =item $pid = $w->rpid |
|
|
448 | |
|
|
449 | Return the pid of the awaited child (useful when you have installed a |
|
|
450 | watcher for all pids). |
379 | |
451 | |
380 | |
452 | |
381 | =item $w = EV::idle $callback |
453 | =item $w = EV::idle $callback |
382 | |
454 | |
383 | =item $w = EV::idle_ns $callback |
455 | =item $w = EV::idle_ns $callback |
… | |
… | |
464 | |
536 | |
465 | our $DIED = sub { |
537 | our $DIED = sub { |
466 | warn "EV: error in callback (ignoring): $@"; |
538 | warn "EV: error in callback (ignoring): $@"; |
467 | }; |
539 | }; |
468 | |
540 | |
469 | init; |
541 | default_loop |
470 | |
542 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
471 | push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"]; |
|
|
472 | |
543 | |
473 | 1; |
544 | 1; |
474 | |
545 | |
475 | =head1 SEE ALSO |
546 | =head1 SEE ALSO |
476 | |
547 | |
477 | L<EV::DNS>, L<EV::AnyEvent>. |
548 | L<EV::DNS>. |
478 | |
549 | |
479 | =head1 AUTHOR |
550 | =head1 AUTHOR |
480 | |
551 | |
481 | Marc Lehmann <schmorp@schmorp.de> |
552 | Marc Lehmann <schmorp@schmorp.de> |
482 | http://home.schmorp.de/ |
553 | http://home.schmorp.de/ |