… | |
… | |
47 | my ($w, $revents) = @_; |
47 | my ($w, $revents) = @_; |
48 | warn $w->path, " has changed somehow.\n"; |
48 | warn $w->path, " has changed somehow.\n"; |
49 | }; |
49 | }; |
50 | |
50 | |
51 | # MAINLOOP |
51 | # MAINLOOP |
52 | EV::loop; # loop until EV::unloop is called or all watchers stop |
52 | EV::run; # loop until EV::break is called or all watchers stop |
53 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
53 | EV::run EV::RUN_ONCE; # block until at least one event could be handled |
54 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
54 | EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block |
55 | |
55 | |
56 | =head1 BEFORE YOU START USING THIS MODULE |
56 | =head1 BEFORE YOU START USING THIS MODULE |
57 | |
57 | |
58 | If you only need timer, I/O, signal, child and idle watchers and not the |
58 | If you only need timer, I/O, signal, child and idle watchers and not the |
59 | advanced functionality of this module, consider using L<AnyEvent> instead, |
59 | advanced functionality of this module, consider using L<AnyEvent> instead, |
… | |
… | |
119 | package EV; |
119 | package EV; |
120 | |
120 | |
121 | use common::sense; |
121 | use common::sense; |
122 | |
122 | |
123 | BEGIN { |
123 | BEGIN { |
124 | our $VERSION = '4.01'; |
124 | our $VERSION = 4.25; |
125 | use XSLoader; |
125 | use XSLoader; |
|
|
126 | local $^W = 0; # avoid spurious warning |
126 | XSLoader::load "EV", $VERSION; |
127 | XSLoader::load "EV", $VERSION; |
127 | } |
128 | } |
128 | |
129 | |
129 | @EV::IO::ISA = |
130 | @EV::IO::ISA = |
130 | @EV::Timer::ISA = |
131 | @EV::Timer::ISA = |
… | |
… | |
186 | Must be called after a fork in the child, before entering or continuing |
187 | Must be called after a fork in the child, before entering or continuing |
187 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
188 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
188 | this function automatically, at some performance loss (refer to the libev |
189 | this function automatically, at some performance loss (refer to the libev |
189 | documentation). |
190 | documentation). |
190 | |
191 | |
191 | =item $loop->loop_verify |
192 | =item $loop->verify |
192 | |
193 | |
193 | Calls C<ev_verify> to make internal consistency checks (for debugging |
194 | Calls C<ev_verify> to make internal consistency checks (for debugging |
194 | libev) and abort the program if any data structures were found to be |
195 | libev) and abort the program if any data structures were found to be |
195 | corrupted. |
196 | corrupted. |
196 | |
197 | |
… | |
… | |
290 | =item $backend = $loop->backend |
291 | =item $backend = $loop->backend |
291 | |
292 | |
292 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
293 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
293 | or EV::BACKEND_EPOLL). |
294 | or EV::BACKEND_EPOLL). |
294 | |
295 | |
295 | =item EV::loop [$flags] |
296 | =item $active = EV::run [$flags] |
296 | |
297 | |
297 | =item $loop->loop ([$flags]) |
298 | =item $active = $loop->run ([$flags]) |
298 | |
299 | |
299 | Begin checking for events and calling callbacks. It returns when a |
300 | Begin checking for events and calling callbacks. It returns when a |
300 | callback calls EV::unloop. |
301 | callback calls EV::break or the flags are nonzero (in which case the |
|
|
302 | return value is true) or when there are no active watchers which reference |
|
|
303 | the loop (keepalive is true), in which case the return value will be |
|
|
304 | false. The return value can generally be interpreted as "if true, there is |
|
|
305 | more work left to do". |
301 | |
306 | |
302 | The $flags argument can be one of the following: |
307 | The $flags argument can be one of the following: |
303 | |
308 | |
304 | 0 as above |
309 | 0 as above |
305 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
310 | EV::RUN_ONCE block at most once (wait, but do not loop) |
306 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
311 | EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait) |
307 | |
312 | |
308 | =item EV::unloop [$how] |
313 | =item EV::break [$how] |
309 | |
314 | |
310 | =item $loop->unloop ([$how]) |
315 | =item $loop->break ([$how]) |
311 | |
316 | |
312 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
317 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
313 | innermost call to EV::loop return. |
318 | innermost call to EV::loop return. |
314 | |
319 | |
315 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
320 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop will |
316 | fast as possible. |
321 | return as fast as possible. |
317 | |
322 | |
318 | =item $count = EV::loop_count |
323 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
324 | be cancelled. |
319 | |
325 | |
|
|
326 | =item $count = EV::iteration |
|
|
327 | |
320 | =item $count = $loop->loop_count |
328 | =item $count = $loop->iteration |
321 | |
329 | |
322 | Return the number of times the event loop has polled for new |
330 | Return the number of times the event loop has polled for new |
323 | events. Sometimes useful as a generation counter. |
331 | events. Sometimes useful as a generation counter. |
324 | |
332 | |
325 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
333 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
… | |
… | |
334 | | EV::WRITE>, indicating the type of I/O event you want to wait for. If |
342 | | EV::WRITE>, indicating the type of I/O event you want to wait for. If |
335 | you do not want to wait for some I/O event, specify C<undef> for |
343 | you do not want to wait for some I/O event, specify C<undef> for |
336 | C<$fh_or_undef> and C<0> for C<$events>). |
344 | C<$fh_or_undef> and C<0> for C<$events>). |
337 | |
345 | |
338 | If timeout is C<undef> or negative, then there will be no |
346 | If timeout is C<undef> or negative, then there will be no |
339 | timeout. Otherwise a EV::timer with this value will be started. |
347 | timeout. Otherwise an C<EV::timer> with this value will be started. |
340 | |
348 | |
341 | When an error occurs or either the timeout or I/O watcher triggers, then |
349 | When an error occurs or either the timeout or I/O watcher triggers, then |
342 | the callback will be called with the received event set (in general |
350 | the callback will be called with the received event set (in general |
343 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
351 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
344 | C<EV::WRITE> and C<EV::TIMER>). |
352 | C<EV::WRITE> and C<EV::TIMER>). |
345 | |
353 | |
346 | EV::once doesn't return anything: the watchers stay active till either |
354 | EV::once doesn't return anything: the watchers stay active till either |
347 | of them triggers, then they will be stopped and freed, and the callback |
355 | of them triggers, then they will be stopped and freed, and the callback |
348 | invoked. |
356 | invoked. |
349 | |
357 | |
350 | =item EV::feed_fd_event ($fd, $revents) |
358 | =item EV::feed_fd_event $fd, $revents |
351 | |
359 | |
352 | =item $loop->feed_fd_event ($fd, $revents) |
360 | =item $loop->feed_fd_event ($fd, $revents) |
353 | |
361 | |
354 | Feed an event on a file descriptor into EV. EV will react to this call as |
362 | Feed an event on a file descriptor into EV. EV will react to this call as |
355 | if the readyness notifications specified by C<$revents> (a combination of |
363 | if the readyness notifications specified by C<$revents> (a combination of |
356 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
364 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
357 | |
365 | |
358 | =item EV::feed_signal_event ($signal) |
366 | =item EV::feed_signal_event $signal |
359 | |
367 | |
360 | Feed a signal event into EV. EV will react to this call as if the signal |
368 | Feed a signal event into the default loop. EV will react to this call as |
361 | specified by C<$signal> had occured. |
369 | if the signal specified by C<$signal> had occured. |
|
|
370 | |
|
|
371 | =item EV::feed_signal $signal |
|
|
372 | |
|
|
373 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
|
|
374 | regardless of which loop has registered the signal, and is mainly useful |
|
|
375 | fro custom signal implementations. |
362 | |
376 | |
363 | =item EV::set_io_collect_interval $time |
377 | =item EV::set_io_collect_interval $time |
364 | |
378 | |
365 | =item $loop->set_io_collect_interval ($time) |
379 | =item $loop->set_io_collect_interval ($time) |
366 | |
380 | |
… | |
… | |
584 | |
598 | |
585 | =item $w = $loop->timer ($after, $repeat, $callback) |
599 | =item $w = $loop->timer ($after, $repeat, $callback) |
586 | |
600 | |
587 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
601 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
588 | |
602 | |
589 | Calls the callback after C<$after> seconds (which may be fractional). If |
603 | Calls the callback after C<$after> seconds (which may be fractional or |
590 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
604 | negative). If C<$repeat> is non-zero, the timer will be restarted (with |
591 | value as $after) after the callback returns. |
605 | the $repeat value as $after) after the callback returns. |
592 | |
606 | |
593 | This means that the callback would be called roughly after C<$after> |
607 | This means that the callback would be called roughly after C<$after> |
594 | seconds, and then every C<$repeat> seconds. The timer does his best not |
608 | seconds, and then every C<$repeat> seconds. The timer does his best not |
595 | to drift, but it will not invoke the timer more often then once per event |
609 | to drift, but it will not invoke the timer more often then once per event |
596 | loop iteration, and might drift in other cases. If that isn't acceptable, |
610 | loop iteration, and might drift in other cases. If that isn't acceptable, |
… | |
… | |
600 | in front of the machine while the timer is running and changes the system |
614 | in front of the machine while the timer is running and changes the system |
601 | clock, the timer will nevertheless run (roughly) the same time. |
615 | clock, the timer will nevertheless run (roughly) the same time. |
602 | |
616 | |
603 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
617 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
604 | |
618 | |
605 | =item $w->set ($after, $repeat) |
619 | =item $w->set ($after, $repeat = 0) |
606 | |
620 | |
607 | Reconfigures the watcher, see the constructor above for details. Can be called at |
621 | Reconfigures the watcher, see the constructor above for details. Can be called at |
608 | any time. |
622 | any time. |
609 | |
623 | |
610 | =item $w->again |
624 | =item $w->again |
|
|
625 | |
|
|
626 | =item $w->again ($repeat) |
611 | |
627 | |
612 | Similar to the C<start> method, but has special semantics for repeating timers: |
628 | Similar to the C<start> method, but has special semantics for repeating timers: |
613 | |
629 | |
614 | If the timer is active and non-repeating, it will be stopped. |
630 | If the timer is active and non-repeating, it will be stopped. |
615 | |
631 | |
… | |
… | |
622 | |
638 | |
623 | This behaviour is useful when you have a timeout for some IO |
639 | This behaviour is useful when you have a timeout for some IO |
624 | operation. You create a timer object with the same value for C<$after> and |
640 | operation. You create a timer object with the same value for C<$after> and |
625 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
641 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
626 | on the timeout. |
642 | on the timeout. |
|
|
643 | |
|
|
644 | If called with a C<$repeat> argument, then it uses this a timer repeat |
|
|
645 | value. |
|
|
646 | |
|
|
647 | =item $after = $w->remaining |
|
|
648 | |
|
|
649 | Calculates and returns the remaining time till the timer will fire. |
627 | |
650 | |
628 | =back |
651 | =back |
629 | |
652 | |
630 | |
653 | |
631 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
654 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
… | |
… | |
659 | surpasses this time. |
682 | surpasses this time. |
660 | |
683 | |
661 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
684 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
662 | |
685 | |
663 | In this mode the watcher will always be scheduled to time out at the |
686 | In this mode the watcher will always be scheduled to time out at the |
664 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
687 | next C<$at + N * $interval> time (for the lowest integer N) and then repeat, |
665 | regardless of any time jumps. |
688 | regardless of any time jumps. Note that, since C<N> can be negative, the |
|
|
689 | first trigger can happen before C<$at>. |
666 | |
690 | |
667 | This can be used to create timers that do not drift with respect to system |
691 | This can be used to create timers that do not drift with respect to system |
668 | time: |
692 | time: |
669 | |
693 | |
670 | my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; |
694 | my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; |
671 | |
695 | |
672 | That doesn't mean there will always be 3600 seconds in between triggers, |
696 | That doesn't mean there will always be 3600 seconds in between triggers, |
673 | but only that the the clalback will be called when the system time shows a |
697 | but only that the the callback will be called when the system time shows a |
674 | full hour (UTC). |
698 | full hour (UTC). |
675 | |
699 | |
676 | Another way to think about it (for the mathematically inclined) is that |
700 | Another way to think about it (for the mathematically inclined) is that |
677 | EV::periodic will try to run the callback in this mode at the next |
701 | EV::periodic will try to run the callback in this mode at the next |
678 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
702 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
… | |
… | |
686 | time as second argument. |
710 | time as second argument. |
687 | |
711 | |
688 | I<This callback MUST NOT stop or destroy this or any other periodic |
712 | I<This callback MUST NOT stop or destroy this or any other periodic |
689 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
713 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
690 | you need to stop it, return 1e30 and stop it afterwards. You may create |
714 | you need to stop it, return 1e30 and stop it afterwards. You may create |
691 | and start a C<EV::prepare> watcher for this task. |
715 | and start an C<EV::prepare> watcher for this task. |
692 | |
716 | |
693 | It must return the next time to trigger, based on the passed time value |
717 | It must return the next time to trigger, based on the passed time value |
694 | (that is, the lowest time value larger than or equal to to the second |
718 | (that is, the lowest time value larger than or equal to to the second |
695 | argument). It will usually be called just before the callback will be |
719 | argument). It will usually be called just before the callback will be |
696 | triggered, but might be called at other times, too. |
720 | triggered, but might be called at other times, too. |
697 | |
721 | |
698 | This can be used to create very complex timers, such as a timer that |
722 | This can be used to create very complex timers, such as a timer that |
699 | triggers on each midnight, local time (actually 24 hours after the last |
723 | triggers on each midnight, local time (actually one day after the last |
700 | midnight, to keep the example simple. If you know a way to do it correctly |
724 | midnight, to keep the example simple): |
701 | in about the same space (without requiring elaborate modules), drop me a |
|
|
702 | note :): |
|
|
703 | |
725 | |
704 | my $daily = EV::periodic 0, 0, sub { |
726 | my $daily = EV::periodic 0, 0, sub { |
705 | my ($w, $now) = @_; |
727 | my ($w, $now) = @_; |
706 | |
728 | |
707 | use Time::Local (); |
729 | use Time::Local (); |
708 | my (undef, undef, undef, $d, $m, $y) = localtime $now; |
730 | my (undef, undef, undef, $d, $m, $y) = localtime $now; |
709 | 86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y |
731 | Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y |
710 | }, sub { |
732 | }, sub { |
711 | print "it's midnight or likely shortly after, now\n"; |
733 | print "it's midnight or likely shortly after, now\n"; |
712 | }; |
734 | }; |
713 | |
735 | |
714 | =back |
736 | =back |
… | |
… | |
1126 | |
1148 | |
1127 | =item $w = EV::async $callback |
1149 | =item $w = EV::async $callback |
1128 | |
1150 | |
1129 | =item $w = EV::async_ns $callback |
1151 | =item $w = EV::async_ns $callback |
1130 | |
1152 | |
|
|
1153 | =item $w = $loop->async ($callback) |
|
|
1154 | |
|
|
1155 | =item $w = $loop->async_ns ($callback) |
|
|
1156 | |
1131 | =item $w->send |
1157 | =item $w->send |
1132 | |
1158 | |
1133 | =item $bool = $w->async_pending |
1159 | =item $bool = $w->async_pending |
1134 | |
1160 | |
1135 | =back |
1161 | =back |
|
|
1162 | |
|
|
1163 | =head3 CLEANUP WATCHERS - how to clean up when the event loop goes away |
|
|
1164 | |
|
|
1165 | Cleanup watchers are not supported on the Perl level, they can only be |
|
|
1166 | used via XS currently. |
1136 | |
1167 | |
1137 | |
1168 | |
1138 | =head1 PERL SIGNALS |
1169 | =head1 PERL SIGNALS |
1139 | |
1170 | |
1140 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1171 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |