… | |
… | |
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, |
… | |
… | |
77 | can use it through the L<AnyEvent> module, stay portable to other event |
77 | can use it through the L<AnyEvent> module, stay portable to other event |
78 | loops (if you don't rely on any watcher types not available through it) |
78 | loops (if you don't rely on any watcher types not available through it) |
79 | and still be faster than with any other event loop currently supported in |
79 | and still be faster than with any other event loop currently supported in |
80 | Perl. |
80 | Perl. |
81 | |
81 | |
|
|
82 | =head2 PORTING FROM EV 3.X to 4.X |
|
|
83 | |
|
|
84 | EV version 4 introduces a number of incompatible changes summarised |
|
|
85 | here. According to the depreciation strategy used by libev, there is a |
|
|
86 | compatibility layer in place so programs should continue to run unchanged |
|
|
87 | (the XS interface lacks this layer, so programs using that one need to be |
|
|
88 | updated). |
|
|
89 | |
|
|
90 | This compatibility layer will be switched off in some future release. |
|
|
91 | |
|
|
92 | All changes relevant to Perl are renames of symbols, functions and |
|
|
93 | methods: |
|
|
94 | |
|
|
95 | EV::loop => EV::run |
|
|
96 | EV::LOOP_NONBLOCK => EV::RUN_NOWAIT |
|
|
97 | EV::LOOP_ONESHOT => EV::RUN_ONCE |
|
|
98 | |
|
|
99 | EV::unloop => EV::break |
|
|
100 | EV::UNLOOP_CANCEL => EV::BREAK_CANCEL |
|
|
101 | EV::UNLOOP_ONE => EV::BREAK_ONE |
|
|
102 | EV::UNLOOP_ALL => EV::BREAK_ALL |
|
|
103 | |
|
|
104 | EV::TIMEOUT => EV::TIMER |
|
|
105 | |
|
|
106 | EV::loop_count => EV::iteration |
|
|
107 | EV::loop_depth => EV::depth |
|
|
108 | EV::loop_verify => EV::verify |
|
|
109 | |
|
|
110 | The loop object methods corresponding to the functions above have been |
|
|
111 | similarly renamed. |
|
|
112 | |
82 | =head2 MODULE EXPORTS |
113 | =head2 MODULE EXPORTS |
83 | |
114 | |
84 | This module does not export any symbols. |
115 | This module does not export any symbols. |
85 | |
116 | |
86 | =cut |
117 | =cut |
… | |
… | |
88 | package EV; |
119 | package EV; |
89 | |
120 | |
90 | use common::sense; |
121 | use common::sense; |
91 | |
122 | |
92 | BEGIN { |
123 | BEGIN { |
93 | our $VERSION = '4.00'; |
124 | our $VERSION = 4.22; |
94 | use XSLoader; |
125 | use XSLoader; |
|
|
126 | local $^W = 0; # avoid spurious warning |
95 | XSLoader::load "EV", $VERSION; |
127 | XSLoader::load "EV", $VERSION; |
96 | } |
128 | } |
97 | |
129 | |
98 | @EV::IO::ISA = |
130 | @EV::IO::ISA = |
99 | @EV::Timer::ISA = |
131 | @EV::Timer::ISA = |
… | |
… | |
155 | 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 |
156 | 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 |
157 | this function automatically, at some performance loss (refer to the libev |
189 | this function automatically, at some performance loss (refer to the libev |
158 | documentation). |
190 | documentation). |
159 | |
191 | |
160 | =item $loop->loop_verify |
192 | =item $loop->verify |
161 | |
193 | |
162 | Calls C<ev_verify> to make internal consistency checks (for debugging |
194 | Calls C<ev_verify> to make internal consistency checks (for debugging |
163 | 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 |
164 | corrupted. |
196 | corrupted. |
165 | |
197 | |
… | |
… | |
259 | =item $backend = $loop->backend |
291 | =item $backend = $loop->backend |
260 | |
292 | |
261 | 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 |
262 | or EV::BACKEND_EPOLL). |
294 | or EV::BACKEND_EPOLL). |
263 | |
295 | |
264 | =item EV::loop [$flags] |
296 | =item $active = EV::run [$flags] |
265 | |
297 | |
266 | =item $loop->loop ([$flags]) |
298 | =item $active = $loop->run ([$flags]) |
267 | |
299 | |
268 | Begin checking for events and calling callbacks. It returns when a |
300 | Begin checking for events and calling callbacks. It returns when a |
269 | 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". |
270 | |
306 | |
271 | The $flags argument can be one of the following: |
307 | The $flags argument can be one of the following: |
272 | |
308 | |
273 | 0 as above |
309 | 0 as above |
274 | 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) |
275 | 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) |
276 | |
312 | |
277 | =item EV::unloop [$how] |
313 | =item EV::break [$how] |
278 | |
314 | |
279 | =item $loop->unloop ([$how]) |
315 | =item $loop->break ([$how]) |
280 | |
316 | |
281 | 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 |
282 | innermost call to EV::loop return. |
318 | innermost call to EV::loop return. |
283 | |
319 | |
284 | 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 |
285 | fast as possible. |
321 | return as fast as possible. |
286 | |
322 | |
287 | =item $count = EV::loop_count |
323 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
324 | be cancelled. |
288 | |
325 | |
|
|
326 | =item $count = EV::iteration |
|
|
327 | |
289 | =item $count = $loop->loop_count |
328 | =item $count = $loop->iteration |
290 | |
329 | |
291 | 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 |
292 | events. Sometimes useful as a generation counter. |
331 | events. Sometimes useful as a generation counter. |
293 | |
332 | |
294 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
333 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
… | |
… | |
314 | |
353 | |
315 | 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 |
316 | 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 |
317 | invoked. |
356 | invoked. |
318 | |
357 | |
319 | =item EV::feed_fd_event ($fd, $revents) |
358 | =item EV::feed_fd_event $fd, $revents |
320 | |
359 | |
321 | =item $loop->feed_fd_event ($fd, $revents) |
360 | =item $loop->feed_fd_event ($fd, $revents) |
322 | |
361 | |
323 | 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 |
324 | if the readyness notifications specified by C<$revents> (a combination of |
363 | if the readyness notifications specified by C<$revents> (a combination of |
325 | 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>. |
326 | |
365 | |
327 | =item EV::feed_signal_event ($signal) |
366 | =item EV::feed_signal_event $signal |
328 | |
367 | |
329 | 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 |
330 | 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. |
331 | |
376 | |
332 | =item EV::set_io_collect_interval $time |
377 | =item EV::set_io_collect_interval $time |
333 | |
378 | |
334 | =item $loop->set_io_collect_interval ($time) |
379 | =item $loop->set_io_collect_interval ($time) |
335 | |
380 | |
… | |
… | |
553 | |
598 | |
554 | =item $w = $loop->timer ($after, $repeat, $callback) |
599 | =item $w = $loop->timer ($after, $repeat, $callback) |
555 | |
600 | |
556 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
601 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
557 | |
602 | |
558 | 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 |
559 | 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 |
560 | value as $after) after the callback returns. |
605 | the $repeat value as $after) after the callback returns. |
561 | |
606 | |
562 | 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> |
563 | 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 |
564 | 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 |
565 | 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, |
… | |
… | |
569 | 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 |
570 | clock, the timer will nevertheless run (roughly) the same time. |
615 | clock, the timer will nevertheless run (roughly) the same time. |
571 | |
616 | |
572 | 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. |
573 | |
618 | |
574 | =item $w->set ($after, $repeat) |
619 | =item $w->set ($after, $repeat = 0) |
575 | |
620 | |
576 | 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 |
577 | any time. |
622 | any time. |
578 | |
623 | |
579 | =item $w->again |
624 | =item $w->again |
|
|
625 | |
|
|
626 | =item $w->again ($repeat) |
580 | |
627 | |
581 | 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: |
582 | |
629 | |
583 | 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. |
584 | |
631 | |
… | |
… | |
591 | |
638 | |
592 | 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 |
593 | 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 |
594 | 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 |
595 | 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. |
596 | |
650 | |
597 | =back |
651 | =back |
598 | |
652 | |
599 | |
653 | |
600 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
654 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
… | |
… | |
628 | surpasses this time. |
682 | surpasses this time. |
629 | |
683 | |
630 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
684 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
631 | |
685 | |
632 | 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 |
633 | 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, |
634 | 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>. |
635 | |
690 | |
636 | 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 |
637 | time: |
692 | time: |
638 | |
693 | |
639 | 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" }; |
640 | |
695 | |
641 | 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, |
642 | 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 |
643 | full hour (UTC). |
698 | full hour (UTC). |
644 | |
699 | |
645 | 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 |
646 | 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 |
647 | 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 |
… | |
… | |
1095 | |
1150 | |
1096 | =item $w = EV::async $callback |
1151 | =item $w = EV::async $callback |
1097 | |
1152 | |
1098 | =item $w = EV::async_ns $callback |
1153 | =item $w = EV::async_ns $callback |
1099 | |
1154 | |
|
|
1155 | =item $w = $loop->async ($callback) |
|
|
1156 | |
|
|
1157 | =item $w = $loop->async_ns ($callback) |
|
|
1158 | |
1100 | =item $w->send |
1159 | =item $w->send |
1101 | |
1160 | |
1102 | =item $bool = $w->async_pending |
1161 | =item $bool = $w->async_pending |
1103 | |
1162 | |
1104 | =back |
1163 | =back |
|
|
1164 | |
|
|
1165 | =head3 CLEANUP WATCHERS - how to clean up when the event loop goes away |
|
|
1166 | |
|
|
1167 | Cleanup watchers are not supported on the Perl level, they can only be |
|
|
1168 | used via XS currently. |
1105 | |
1169 | |
1106 | |
1170 | |
1107 | =head1 PERL SIGNALS |
1171 | =head1 PERL SIGNALS |
1108 | |
1172 | |
1109 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1173 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
… | |
… | |
1157 | |
1221 | |
1158 | 1; |
1222 | 1; |
1159 | |
1223 | |
1160 | =head1 SEE ALSO |
1224 | =head1 SEE ALSO |
1161 | |
1225 | |
|
|
1226 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1162 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1227 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1163 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1228 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1164 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1229 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1165 | event-loop agnostic and portable event driven programming. |
1230 | event-loop agnostic and portable event driven programming. |
1166 | |
1231 | |
1167 | =head1 AUTHOR |
1232 | =head1 AUTHOR |
1168 | |
1233 | |
1169 | Marc Lehmann <schmorp@schmorp.de> |
1234 | Marc Lehmann <schmorp@schmorp.de> |