… | |
… | |
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 | |
|
|
56 | =head1 BEFORE YOU START USING THIS MODULE |
|
|
57 | |
|
|
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, |
|
|
60 | specifically the simplified API described in L<AE>. |
|
|
61 | |
|
|
62 | When used with EV as backend, the L<AE> API is as fast as the native L<EV> |
|
|
63 | API, but your programs/modules will still run with many other event loops. |
55 | |
64 | |
56 | =head1 DESCRIPTION |
65 | =head1 DESCRIPTION |
57 | |
66 | |
58 | This module provides an interface to libev |
67 | This module provides an interface to libev |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
68 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
… | |
… | |
68 | 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 |
69 | 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) |
70 | 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 |
71 | Perl. |
80 | Perl. |
72 | |
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 | |
73 | =head2 MODULE EXPORTS |
113 | =head2 MODULE EXPORTS |
74 | |
114 | |
75 | This module does not export any symbols. |
115 | This module does not export any symbols. |
76 | |
116 | |
77 | =cut |
117 | =cut |
… | |
… | |
79 | package EV; |
119 | package EV; |
80 | |
120 | |
81 | use common::sense; |
121 | use common::sense; |
82 | |
122 | |
83 | BEGIN { |
123 | BEGIN { |
84 | our $VERSION = '3.8'; |
124 | our $VERSION = 4.21; |
85 | use XSLoader; |
125 | use XSLoader; |
|
|
126 | local $^W = 0; # avoid spurious warning |
86 | XSLoader::load "EV", $VERSION; |
127 | XSLoader::load "EV", $VERSION; |
87 | } |
128 | } |
88 | |
129 | |
89 | @EV::IO::ISA = |
130 | @EV::IO::ISA = |
90 | @EV::Timer::ISA = |
131 | @EV::Timer::ISA = |
… | |
… | |
146 | 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 |
147 | 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 |
148 | this function automatically, at some performance loss (refer to the libev |
189 | this function automatically, at some performance loss (refer to the libev |
149 | documentation). |
190 | documentation). |
150 | |
191 | |
151 | =item $loop->loop_verify |
192 | =item $loop->verify |
152 | |
193 | |
153 | Calls C<ev_verify> to make internal consistency checks (for debugging |
194 | Calls C<ev_verify> to make internal consistency checks (for debugging |
154 | 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 |
155 | corrupted. |
196 | corrupted. |
156 | |
197 | |
… | |
… | |
250 | =item $backend = $loop->backend |
291 | =item $backend = $loop->backend |
251 | |
292 | |
252 | 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 |
253 | or EV::BACKEND_EPOLL). |
294 | or EV::BACKEND_EPOLL). |
254 | |
295 | |
255 | =item EV::loop [$flags] |
296 | =item $active = EV::run [$flags] |
256 | |
297 | |
257 | =item $loop->loop ([$flags]) |
298 | =item $active = $loop->run ([$flags]) |
258 | |
299 | |
259 | Begin checking for events and calling callbacks. It returns when a |
300 | Begin checking for events and calling callbacks. It returns when a |
260 | 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". |
261 | |
306 | |
262 | The $flags argument can be one of the following: |
307 | The $flags argument can be one of the following: |
263 | |
308 | |
264 | 0 as above |
309 | 0 as above |
265 | 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) |
266 | 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) |
267 | |
312 | |
268 | =item EV::unloop [$how] |
313 | =item EV::break [$how] |
269 | |
314 | |
270 | =item $loop->unloop ([$how]) |
315 | =item $loop->break ([$how]) |
271 | |
316 | |
272 | 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 |
273 | innermost call to EV::loop return. |
318 | innermost call to EV::loop return. |
274 | |
319 | |
275 | 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 |
276 | fast as possible. |
321 | return as fast as possible. |
277 | |
322 | |
278 | =item $count = EV::loop_count |
323 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
324 | be cancelled. |
279 | |
325 | |
|
|
326 | =item $count = EV::iteration |
|
|
327 | |
280 | =item $count = $loop->loop_count |
328 | =item $count = $loop->iteration |
281 | |
329 | |
282 | 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 |
283 | events. Sometimes useful as a generation counter. |
331 | events. Sometimes useful as a generation counter. |
284 | |
332 | |
285 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
333 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
… | |
… | |
299 | timeout. Otherwise a EV::timer with this value will be started. |
347 | timeout. Otherwise a EV::timer with this value will be started. |
300 | |
348 | |
301 | 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 |
302 | 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 |
303 | 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>, |
304 | C<EV::WRITE> and C<EV::TIMEOUT>). |
352 | C<EV::WRITE> and C<EV::TIMER>). |
305 | |
353 | |
306 | 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 |
307 | 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 |
308 | invoked. |
356 | invoked. |
309 | |
357 | |
310 | =item EV::feed_fd_event ($fd, $revents) |
358 | =item EV::feed_fd_event $fd, $revents |
311 | |
359 | |
312 | =item $loop->feed_fd_event ($fd, $revents) |
360 | =item $loop->feed_fd_event ($fd, $revents) |
313 | |
361 | |
314 | 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 |
315 | if the readyness notifications specified by C<$revents> (a combination of |
363 | if the readyness notifications specified by C<$revents> (a combination of |
316 | 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>. |
317 | |
365 | |
318 | =item EV::feed_signal_event ($signal) |
366 | =item EV::feed_signal_event $signal |
319 | |
367 | |
320 | 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 |
321 | 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. |
322 | |
376 | |
323 | =item EV::set_io_collect_interval $time |
377 | =item EV::set_io_collect_interval $time |
324 | |
378 | |
325 | =item $loop->set_io_collect_interval ($time) |
379 | =item $loop->set_io_collect_interval ($time) |
326 | |
380 | |
… | |
… | |
366 | |
420 | |
367 | Each watcher type has its associated bit in revents, so you can use the |
421 | Each watcher type has its associated bit in revents, so you can use the |
368 | same callback for multiple watchers. The event mask is named after the |
422 | same callback for multiple watchers. The event mask is named after the |
369 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
423 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
370 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
424 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
371 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
425 | (which can set both EV::READ and EV::WRITE bits). |
372 | uses EV::TIMEOUT). |
|
|
373 | |
426 | |
374 | In the rare case where one wants to create a watcher but not start it at |
427 | In the rare case where one wants to create a watcher but not start it at |
375 | the same time, each constructor has a variant with a trailing C<_ns> in |
428 | the same time, each constructor has a variant with a trailing C<_ns> in |
376 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
429 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
377 | |
430 | |
… | |
… | |
456 | |
509 | |
457 | =item $previous_state = $w->keepalive ($bool) |
510 | =item $previous_state = $w->keepalive ($bool) |
458 | |
511 | |
459 | Normally, C<EV::loop> will return when there are no active watchers |
512 | Normally, C<EV::loop> will return when there are no active watchers |
460 | (which is a "deadlock" because no progress can be made anymore). This is |
513 | (which is a "deadlock" because no progress can be made anymore). This is |
461 | convinient because it allows you to start your watchers (and your jobs), |
514 | convenient because it allows you to start your watchers (and your jobs), |
462 | call C<EV::loop> once and when it returns you know that all your jobs are |
515 | call C<EV::loop> once and when it returns you know that all your jobs are |
463 | finished (or they forgot to register some watchers for their task :). |
516 | finished (or they forgot to register some watchers for their task :). |
464 | |
517 | |
465 | Sometimes, however, this gets in your way, for example when the module |
518 | Sometimes, however, this gets in your way, for example when the module |
466 | that calls C<EV::loop> (usually the main program) is not the same module |
519 | that calls C<EV::loop> (usually the main program) is not the same module |
… | |
… | |
561 | 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 |
562 | clock, the timer will nevertheless run (roughly) the same time. |
615 | clock, the timer will nevertheless run (roughly) the same time. |
563 | |
616 | |
564 | 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. |
565 | |
618 | |
566 | =item $w->set ($after, $repeat) |
619 | =item $w->set ($after, $repeat = 0) |
567 | |
620 | |
568 | 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 |
569 | any time. |
622 | any time. |
570 | |
623 | |
571 | =item $w->again |
624 | =item $w->again |
|
|
625 | |
|
|
626 | =item $w->again ($repeat) |
572 | |
627 | |
573 | 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: |
574 | |
629 | |
575 | 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. |
576 | |
631 | |
… | |
… | |
583 | |
638 | |
584 | 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 |
585 | 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 |
586 | 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 |
587 | 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. |
588 | |
650 | |
589 | =back |
651 | =back |
590 | |
652 | |
591 | |
653 | |
592 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
654 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
… | |
… | |
629 | time: |
691 | time: |
630 | |
692 | |
631 | 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" }; |
632 | |
694 | |
633 | 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, |
634 | 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 |
635 | full hour (UTC). |
697 | full hour (UTC). |
636 | |
698 | |
637 | 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 |
638 | 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 |
639 | 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 |
… | |
… | |
698 | |
760 | |
699 | =item $w = EV::signal $signal, $callback |
761 | =item $w = EV::signal $signal, $callback |
700 | |
762 | |
701 | =item $w = EV::signal_ns $signal, $callback |
763 | =item $w = EV::signal_ns $signal, $callback |
702 | |
764 | |
|
|
765 | =item $w = $loop->signal ($signal, $callback) |
|
|
766 | |
|
|
767 | =item $w = $loop->signal_ns ($signal, $callback) |
|
|
768 | |
703 | Call the callback when $signal is received (the signal can be specified by |
769 | Call the callback when $signal is received (the signal can be specified by |
704 | number or by name, just as with C<kill> or C<%SIG>). |
770 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
771 | |
|
|
772 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
773 | signal from two EV loops will crash the program immediately or cause data |
|
|
774 | corruption. |
705 | |
775 | |
706 | EV will grab the signal for the process (the kernel only allows one |
776 | EV will grab the signal for the process (the kernel only allows one |
707 | component to receive a signal at a time) when you start a signal watcher, |
777 | component to receive a signal at a time) when you start a signal watcher, |
708 | and removes it again when you stop it. Perl does the same when you |
778 | and removes it again when you stop it. Perl does the same when you |
709 | add/remove callbacks to C<%SIG>, so watch out. |
779 | add/remove callbacks to C<%SIG>, so watch out. |
… | |
… | |
934 | =item $w = $loop->check_ns ($callback) |
1004 | =item $w = $loop->check_ns ($callback) |
935 | |
1005 | |
936 | Call the callback just after the process wakes up again (after it has |
1006 | Call the callback just after the process wakes up again (after it has |
937 | gathered events), but before any other callbacks have been invoked. |
1007 | gathered events), but before any other callbacks have been invoked. |
938 | |
1008 | |
939 | This is used to integrate other event-based software into the EV |
1009 | This can be used to integrate other event-based software into the EV |
940 | mainloop: You register a prepare callback and in there, you create io and |
1010 | mainloop: You register a prepare callback and in there, you create io and |
941 | timer watchers as required by the other software. Here is a real-world |
1011 | timer watchers as required by the other software. Here is a real-world |
942 | example of integrating Net::SNMP (with some details left out): |
1012 | example of integrating Net::SNMP (with some details left out): |
943 | |
1013 | |
944 | our @snmp_watcher; |
1014 | our @snmp_watcher; |
… | |
… | |
978 | The callbacks of the created watchers will not be called as the watchers |
1048 | The callbacks of the created watchers will not be called as the watchers |
979 | are destroyed before this can happen (remember EV::check gets called |
1049 | are destroyed before this can happen (remember EV::check gets called |
980 | first). |
1050 | first). |
981 | |
1051 | |
982 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1052 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1053 | |
|
|
1054 | =item EV::CHECK constant issues |
|
|
1055 | |
|
|
1056 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1057 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1058 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1059 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1060 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1061 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1062 | safe side. |
983 | |
1063 | |
984 | =back |
1064 | =back |
985 | |
1065 | |
986 | |
1066 | |
987 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1067 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
1069 | |
1149 | |
1070 | =item $w = EV::async $callback |
1150 | =item $w = EV::async $callback |
1071 | |
1151 | |
1072 | =item $w = EV::async_ns $callback |
1152 | =item $w = EV::async_ns $callback |
1073 | |
1153 | |
|
|
1154 | =item $w = $loop->async ($callback) |
|
|
1155 | |
|
|
1156 | =item $w = $loop->async_ns ($callback) |
|
|
1157 | |
1074 | =item $w->send |
1158 | =item $w->send |
1075 | |
1159 | |
1076 | =item $bool = $w->async_pending |
1160 | =item $bool = $w->async_pending |
1077 | |
1161 | |
1078 | =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. |
1079 | |
1168 | |
1080 | |
1169 | |
1081 | =head1 PERL SIGNALS |
1170 | =head1 PERL SIGNALS |
1082 | |
1171 | |
1083 | 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 |
… | |
… | |
1131 | |
1220 | |
1132 | 1; |
1221 | 1; |
1133 | |
1222 | |
1134 | =head1 SEE ALSO |
1223 | =head1 SEE ALSO |
1135 | |
1224 | |
|
|
1225 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1136 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1226 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1137 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1227 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1138 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1228 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1139 | event-loop agnostic and portable event driven programming. |
1229 | event-loop agnostic and portable event driven programming. |
1140 | |
1230 | |
1141 | =head1 AUTHOR |
1231 | =head1 AUTHOR |
1142 | |
1232 | |
1143 | Marc Lehmann <schmorp@schmorp.de> |
1233 | Marc Lehmann <schmorp@schmorp.de> |