… | |
… | |
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::unloop 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.7001'; |
124 | our $VERSION = '4.15'; |
85 | use XSLoader; |
125 | use XSLoader; |
86 | XSLoader::load "EV", $VERSION; |
126 | XSLoader::load "EV", $VERSION; |
87 | } |
127 | } |
88 | |
128 | |
89 | @EV::IO::ISA = |
129 | @EV::IO::ISA = |
… | |
… | |
146 | Must be called after a fork in the child, before entering or continuing |
186 | 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 |
187 | 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 |
188 | this function automatically, at some performance loss (refer to the libev |
149 | documentation). |
189 | documentation). |
150 | |
190 | |
151 | =item $loop->loop_verify |
191 | =item $loop->verify |
152 | |
192 | |
153 | Calls C<ev_verify> to make internal consistency checks (for debugging |
193 | 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 |
194 | libev) and abort the program if any data structures were found to be |
155 | corrupted. |
195 | corrupted. |
156 | |
196 | |
… | |
… | |
250 | =item $backend = $loop->backend |
290 | =item $backend = $loop->backend |
251 | |
291 | |
252 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
292 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
253 | or EV::BACKEND_EPOLL). |
293 | or EV::BACKEND_EPOLL). |
254 | |
294 | |
255 | =item EV::loop [$flags] |
295 | =item $active = EV::run [$flags] |
256 | |
296 | |
257 | =item $loop->loop ([$flags]) |
297 | =item $active = $loop->run ([$flags]) |
258 | |
298 | |
259 | Begin checking for events and calling callbacks. It returns when a |
299 | Begin checking for events and calling callbacks. It returns when a |
260 | callback calls EV::unloop. |
300 | callback calls EV::unloop or the flasg are nonzero (in which case the |
|
|
301 | return value is true) or when there are no active watchers which reference |
|
|
302 | the loop (keepalive is true), in which case the return value will be |
|
|
303 | false. The returnv alue can generally be interpreted as "if true, there is |
|
|
304 | more work left to do". |
261 | |
305 | |
262 | The $flags argument can be one of the following: |
306 | The $flags argument can be one of the following: |
263 | |
307 | |
264 | 0 as above |
308 | 0 as above |
265 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
309 | 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) |
310 | EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait) |
267 | |
311 | |
268 | =item EV::unloop [$how] |
312 | =item EV::break [$how] |
269 | |
313 | |
270 | =item $loop->unloop ([$how]) |
314 | =item $loop->break ([$how]) |
271 | |
315 | |
272 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
316 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
273 | innermost call to EV::loop return. |
317 | innermost call to EV::loop return. |
274 | |
318 | |
275 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
319 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop will |
276 | fast as possible. |
320 | return as fast as possible. |
277 | |
321 | |
278 | =item $count = EV::loop_count |
322 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
323 | be cancelled. |
279 | |
324 | |
|
|
325 | =item $count = EV::iteration |
|
|
326 | |
280 | =item $count = $loop->loop_count |
327 | =item $count = $loop->iteration |
281 | |
328 | |
282 | Return the number of times the event loop has polled for new |
329 | Return the number of times the event loop has polled for new |
283 | events. Sometimes useful as a generation counter. |
330 | events. Sometimes useful as a generation counter. |
284 | |
331 | |
285 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
332 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
… | |
… | |
299 | timeout. Otherwise a EV::timer with this value will be started. |
346 | timeout. Otherwise a EV::timer with this value will be started. |
300 | |
347 | |
301 | When an error occurs or either the timeout or I/O watcher triggers, then |
348 | 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 |
349 | 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>, |
350 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
304 | C<EV::WRITE> and C<EV::TIMEOUT>). |
351 | C<EV::WRITE> and C<EV::TIMER>). |
305 | |
352 | |
306 | EV::once doesn't return anything: the watchers stay active till either |
353 | 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 |
354 | of them triggers, then they will be stopped and freed, and the callback |
308 | invoked. |
355 | invoked. |
309 | |
356 | |
310 | =item EV::feed_fd_event ($fd, $revents) |
357 | =item EV::feed_fd_event $fd, $revents |
311 | |
358 | |
312 | =item $loop->feed_fd_event ($fd, $revents) |
359 | =item $loop->feed_fd_event ($fd, $revents) |
313 | |
360 | |
314 | Feed an event on a file descriptor into EV. EV will react to this call as |
361 | 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 |
362 | 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>. |
363 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
317 | |
364 | |
318 | =item EV::feed_signal_event ($signal) |
365 | =item EV::feed_signal_event $signal |
319 | |
366 | |
320 | Feed a signal event into EV. EV will react to this call as if the signal |
367 | Feed a signal event into the default loop. EV will react to this call as |
321 | specified by C<$signal> had occured. |
368 | if the signal specified by C<$signal> had occured. |
|
|
369 | |
|
|
370 | =item EV::feed_signal $signal |
|
|
371 | |
|
|
372 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
|
|
373 | regardless of which loop has registered the signal, and is mainly useful |
|
|
374 | fro custom signal implementations. |
322 | |
375 | |
323 | =item EV::set_io_collect_interval $time |
376 | =item EV::set_io_collect_interval $time |
324 | |
377 | |
325 | =item $loop->set_io_collect_interval ($time) |
378 | =item $loop->set_io_collect_interval ($time) |
326 | |
379 | |
… | |
… | |
366 | |
419 | |
367 | Each watcher type has its associated bit in revents, so you can use the |
420 | 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 |
421 | 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, |
422 | 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 |
423 | 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 |
424 | (which can set both EV::READ and EV::WRITE bits). |
372 | uses EV::TIMEOUT). |
|
|
373 | |
425 | |
374 | In the rare case where one wants to create a watcher but not start it at |
426 | 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 |
427 | 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. |
428 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
377 | |
429 | |
… | |
… | |
456 | |
508 | |
457 | =item $previous_state = $w->keepalive ($bool) |
509 | =item $previous_state = $w->keepalive ($bool) |
458 | |
510 | |
459 | Normally, C<EV::loop> will return when there are no active watchers |
511 | 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 |
512 | (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), |
513 | 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 |
514 | 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 :). |
515 | finished (or they forgot to register some watchers for their task :). |
464 | |
516 | |
465 | Sometimes, however, this gets in your way, for example when the module |
517 | 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 |
518 | that calls C<EV::loop> (usually the main program) is not the same module |
… | |
… | |
942 | =item $w = $loop->check_ns ($callback) |
994 | =item $w = $loop->check_ns ($callback) |
943 | |
995 | |
944 | Call the callback just after the process wakes up again (after it has |
996 | Call the callback just after the process wakes up again (after it has |
945 | gathered events), but before any other callbacks have been invoked. |
997 | gathered events), but before any other callbacks have been invoked. |
946 | |
998 | |
947 | This is used to integrate other event-based software into the EV |
999 | This can be used to integrate other event-based software into the EV |
948 | mainloop: You register a prepare callback and in there, you create io and |
1000 | mainloop: You register a prepare callback and in there, you create io and |
949 | timer watchers as required by the other software. Here is a real-world |
1001 | timer watchers as required by the other software. Here is a real-world |
950 | example of integrating Net::SNMP (with some details left out): |
1002 | example of integrating Net::SNMP (with some details left out): |
951 | |
1003 | |
952 | our @snmp_watcher; |
1004 | our @snmp_watcher; |
… | |
… | |
986 | The callbacks of the created watchers will not be called as the watchers |
1038 | The callbacks of the created watchers will not be called as the watchers |
987 | are destroyed before this can happen (remember EV::check gets called |
1039 | are destroyed before this can happen (remember EV::check gets called |
988 | first). |
1040 | first). |
989 | |
1041 | |
990 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1042 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1043 | |
|
|
1044 | =item EV::CHECK constant issues |
|
|
1045 | |
|
|
1046 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1047 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1048 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1049 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1050 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1051 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1052 | safe side. |
991 | |
1053 | |
992 | =back |
1054 | =back |
993 | |
1055 | |
994 | |
1056 | |
995 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1057 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
1077 | |
1139 | |
1078 | =item $w = EV::async $callback |
1140 | =item $w = EV::async $callback |
1079 | |
1141 | |
1080 | =item $w = EV::async_ns $callback |
1142 | =item $w = EV::async_ns $callback |
1081 | |
1143 | |
|
|
1144 | =item $w = $loop->async ($callback) |
|
|
1145 | |
|
|
1146 | =item $w = $loop->async_ns ($callback) |
|
|
1147 | |
1082 | =item $w->send |
1148 | =item $w->send |
1083 | |
1149 | |
1084 | =item $bool = $w->async_pending |
1150 | =item $bool = $w->async_pending |
1085 | |
1151 | |
1086 | =back |
1152 | =back |
|
|
1153 | |
|
|
1154 | =head3 CLEANUP WATCHERS - how to clean up when the event loop goes away |
|
|
1155 | |
|
|
1156 | Cleanup watchers are not supported on the Perl level, they can only be |
|
|
1157 | used via XS currently. |
1087 | |
1158 | |
1088 | |
1159 | |
1089 | =head1 PERL SIGNALS |
1160 | =head1 PERL SIGNALS |
1090 | |
1161 | |
1091 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1162 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
… | |
… | |
1139 | |
1210 | |
1140 | 1; |
1211 | 1; |
1141 | |
1212 | |
1142 | =head1 SEE ALSO |
1213 | =head1 SEE ALSO |
1143 | |
1214 | |
|
|
1215 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1144 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1216 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1145 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1217 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1146 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1218 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1147 | event-loop agnostic and portable event driven programming. |
1219 | event-loop agnostic and portable event driven programming. |
1148 | |
1220 | |
1149 | =head1 AUTHOR |
1221 | =head1 AUTHOR |
1150 | |
1222 | |
1151 | Marc Lehmann <schmorp@schmorp.de> |
1223 | Marc Lehmann <schmorp@schmorp.de> |