… | |
… | |
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 flasg 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 returnv alue 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) |
… | |
… | |
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? |
… | |
… | |
677 | time: |
691 | time: |
678 | |
692 | |
679 | my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; |
693 | my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; |
680 | |
694 | |
681 | That doesn't mean there will always be 3600 seconds in between triggers, |
695 | 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 |
696 | but only that the the callback will be called when the system time shows a |
683 | full hour (UTC). |
697 | full hour (UTC). |
684 | |
698 | |
685 | Another way to think about it (for the mathematically inclined) is that |
699 | 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 |
700 | 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 |
701 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
… | |
… | |
1135 | |
1149 | |
1136 | =item $w = EV::async $callback |
1150 | =item $w = EV::async $callback |
1137 | |
1151 | |
1138 | =item $w = EV::async_ns $callback |
1152 | =item $w = EV::async_ns $callback |
1139 | |
1153 | |
|
|
1154 | =item $w = $loop->async ($callback) |
|
|
1155 | |
|
|
1156 | =item $w = $loop->async_ns ($callback) |
|
|
1157 | |
1140 | =item $w->send |
1158 | =item $w->send |
1141 | |
1159 | |
1142 | =item $bool = $w->async_pending |
1160 | =item $bool = $w->async_pending |
1143 | |
1161 | |
1144 | =back |
1162 | =back |
|
|
1163 | |
|
|
1164 | =head3 CLEANUP WATCHERS - how to clean up when the event loop goes away |
|
|
1165 | |
|
|
1166 | Cleanup watchers are not supported on the Perl level, they can only be |
|
|
1167 | used via XS currently. |
1145 | |
1168 | |
1146 | |
1169 | |
1147 | =head1 PERL SIGNALS |
1170 | =head1 PERL SIGNALS |
1148 | |
1171 | |
1149 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1172 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |