… | |
… | |
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::run; # 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::run EV::RUN_ONCE; # 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::run EV::RUN_NOWAIT; # 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 | |
… | |
… | |
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.10'; |
124 | our $VERSION = 4.22; |
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 = |
… | |
… | |
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::run [$flags] |
296 | =item $active = EV::run [$flags] |
296 | |
297 | |
297 | =item $loop->run ([$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::RUN_ONCE block at most once (wait, but do not loop) |
310 | EV::RUN_ONCE block at most once (wait, but do not loop) |
… | |
… | |
337 | | 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 |
338 | 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 |
339 | C<$fh_or_undef> and C<0> for C<$events>). |
344 | C<$fh_or_undef> and C<0> for C<$events>). |
340 | |
345 | |
341 | 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 |
342 | timeout. Otherwise a EV::timer with this value will be started. |
347 | timeout. Otherwise an C<EV::timer> with this value will be started. |
343 | |
348 | |
344 | 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 |
345 | 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 |
346 | 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>, |
347 | C<EV::WRITE> and C<EV::TIMER>). |
352 | C<EV::WRITE> and C<EV::TIMER>). |
… | |
… | |
593 | |
598 | |
594 | =item $w = $loop->timer ($after, $repeat, $callback) |
599 | =item $w = $loop->timer ($after, $repeat, $callback) |
595 | |
600 | |
596 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
601 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
597 | |
602 | |
598 | 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 |
599 | 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 |
600 | value as $after) after the callback returns. |
605 | the $repeat value as $after) after the callback returns. |
601 | |
606 | |
602 | 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> |
603 | 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 |
604 | 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 |
605 | 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, |
… | |
… | |
609 | 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 |
610 | clock, the timer will nevertheless run (roughly) the same time. |
615 | clock, the timer will nevertheless run (roughly) the same time. |
611 | |
616 | |
612 | 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. |
613 | |
618 | |
614 | =item $w->set ($after, $repeat) |
619 | =item $w->set ($after, $repeat = 0) |
615 | |
620 | |
616 | 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 |
617 | any time. |
622 | any time. |
618 | |
623 | |
619 | =item $w->again |
624 | =item $w->again |
|
|
625 | |
|
|
626 | =item $w->again ($repeat) |
620 | |
627 | |
621 | 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: |
622 | |
629 | |
623 | 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. |
624 | |
631 | |
… | |
… | |
631 | |
638 | |
632 | 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 |
633 | 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 |
634 | 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 |
635 | 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. |
636 | |
650 | |
637 | =back |
651 | =back |
638 | |
652 | |
639 | |
653 | |
640 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
654 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
… | |
… | |
668 | surpasses this time. |
682 | surpasses this time. |
669 | |
683 | |
670 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
684 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
671 | |
685 | |
672 | 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 |
673 | 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, |
674 | 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>. |
675 | |
690 | |
676 | 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 |
677 | time: |
692 | time: |
678 | |
693 | |
679 | 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" }; |
680 | |
695 | |
681 | 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, |
682 | 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 |
683 | full hour (UTC). |
698 | full hour (UTC). |
684 | |
699 | |
685 | 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 |
686 | 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 |
687 | 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 |
… | |
… | |
695 | time as second argument. |
710 | time as second argument. |
696 | |
711 | |
697 | 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 |
698 | 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 |
699 | 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 |
700 | and start a C<EV::prepare> watcher for this task. |
715 | and start an C<EV::prepare> watcher for this task. |
701 | |
716 | |
702 | 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 |
703 | (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 |
704 | 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 |
705 | triggered, but might be called at other times, too. |
720 | triggered, but might be called at other times, too. |
706 | |
721 | |
707 | 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 |
708 | 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 |
709 | midnight, to keep the example simple. If you know a way to do it correctly |
724 | midnight, to keep the example simple): |
710 | in about the same space (without requiring elaborate modules), drop me a |
|
|
711 | note :): |
|
|
712 | |
725 | |
713 | my $daily = EV::periodic 0, 0, sub { |
726 | my $daily = EV::periodic 0, 0, sub { |
714 | my ($w, $now) = @_; |
727 | my ($w, $now) = @_; |
715 | |
728 | |
716 | use Time::Local (); |
729 | use Time::Local (); |
717 | my (undef, undef, undef, $d, $m, $y) = localtime $now; |
730 | my (undef, undef, undef, $d, $m, $y) = localtime $now; |
718 | 86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y |
731 | Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y |
719 | }, sub { |
732 | }, sub { |
720 | print "it's midnight or likely shortly after, now\n"; |
733 | print "it's midnight or likely shortly after, now\n"; |
721 | }; |
734 | }; |
722 | |
735 | |
723 | =back |
736 | =back |
… | |
… | |
1135 | |
1148 | |
1136 | =item $w = EV::async $callback |
1149 | =item $w = EV::async $callback |
1137 | |
1150 | |
1138 | =item $w = EV::async_ns $callback |
1151 | =item $w = EV::async_ns $callback |
1139 | |
1152 | |
|
|
1153 | =item $w = $loop->async ($callback) |
|
|
1154 | |
|
|
1155 | =item $w = $loop->async_ns ($callback) |
|
|
1156 | |
1140 | =item $w->send |
1157 | =item $w->send |
1141 | |
1158 | |
1142 | =item $bool = $w->async_pending |
1159 | =item $bool = $w->async_pending |
1143 | |
1160 | |
1144 | =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. |
1145 | |
1167 | |
1146 | |
1168 | |
1147 | =head1 PERL SIGNALS |
1169 | =head1 PERL SIGNALS |
1148 | |
1170 | |
1149 | 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 |