… | |
… | |
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.18'; |
124 | our $VERSION = 4.22; |
125 | use XSLoader; |
125 | use XSLoader; |
126 | local $^W = 0; # avoid spurious warning |
126 | local $^W = 0; # avoid spurious warning |
127 | XSLoader::load "EV", $VERSION; |
127 | XSLoader::load "EV", $VERSION; |
128 | } |
128 | } |
129 | |
129 | |
… | |
… | |
296 | =item $active = EV::run [$flags] |
296 | =item $active = EV::run [$flags] |
297 | |
297 | |
298 | =item $active = $loop->run ([$flags]) |
298 | =item $active = $loop->run ([$flags]) |
299 | |
299 | |
300 | Begin checking for events and calling callbacks. It returns when a |
300 | Begin checking for events and calling callbacks. It returns when a |
301 | callback calls EV::break or the flasg are nonzero (in which case the |
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 |
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 |
303 | the loop (keepalive is true), in which case the return value will be |
304 | false. The returnv alue can generally be interpreted as "if true, there is |
304 | false. The return value can generally be interpreted as "if true, there is |
305 | more work left to do". |
305 | more work left to do". |
306 | |
306 | |
307 | The $flags argument can be one of the following: |
307 | The $flags argument can be one of the following: |
308 | |
308 | |
309 | 0 as above |
309 | 0 as above |
… | |
… | |
598 | |
598 | |
599 | =item $w = $loop->timer ($after, $repeat, $callback) |
599 | =item $w = $loop->timer ($after, $repeat, $callback) |
600 | |
600 | |
601 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
601 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
602 | |
602 | |
603 | 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 |
604 | 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 |
605 | value as $after) after the callback returns. |
605 | the $repeat value as $after) after the callback returns. |
606 | |
606 | |
607 | 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> |
608 | 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 |
609 | 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 |
610 | 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, |
… | |
… | |
614 | 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 |
615 | clock, the timer will nevertheless run (roughly) the same time. |
615 | clock, the timer will nevertheless run (roughly) the same time. |
616 | |
616 | |
617 | 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. |
618 | |
618 | |
619 | =item $w->set ($after, $repeat) |
619 | =item $w->set ($after, $repeat = 0) |
620 | |
620 | |
621 | 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 |
622 | any time. |
622 | any time. |
623 | |
623 | |
624 | =item $w->again |
624 | =item $w->again |
|
|
625 | |
|
|
626 | =item $w->again ($repeat) |
625 | |
627 | |
626 | 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: |
627 | |
629 | |
628 | 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. |
629 | |
631 | |
… | |
… | |
636 | |
638 | |
637 | 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 |
638 | 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 |
639 | 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 |
640 | 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. |
641 | |
650 | |
642 | =back |
651 | =back |
643 | |
652 | |
644 | |
653 | |
645 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
654 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
… | |
… | |
673 | surpasses this time. |
682 | surpasses this time. |
674 | |
683 | |
675 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
684 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
676 | |
685 | |
677 | 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 |
678 | 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, |
679 | 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>. |
680 | |
690 | |
681 | 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 |
682 | time: |
692 | time: |
683 | |
693 | |
684 | 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" }; |