… | |
… | |
51 | # MAINLOOP |
51 | # MAINLOOP |
52 | EV::loop; # loop until EV::unloop is called or all watchers stop |
52 | EV::loop; # 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::loop EV::LOOP_ONESHOT; # 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::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
55 | |
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. |
|
|
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 |
60 | below is comprehensive, one might also consult the documentation of |
69 | below is comprehensive, one might also consult the documentation of |
… | |
… | |
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 |
78 | |
118 | |
79 | package EV; |
119 | package EV; |
80 | |
120 | |
81 | no warnings; |
121 | use common::sense; |
82 | use strict; |
|
|
83 | |
122 | |
84 | BEGIN { |
123 | BEGIN { |
85 | our $VERSION = '3.53'; |
124 | our $VERSION = '4.01'; |
86 | use XSLoader; |
125 | use XSLoader; |
87 | XSLoader::load "EV", $VERSION; |
126 | XSLoader::load "EV", $VERSION; |
88 | } |
127 | } |
89 | |
128 | |
90 | @EV::IO::ISA = |
129 | @EV::IO::ISA = |
… | |
… | |
202 | |
241 | |
203 | Returns the time the last event loop iteration has been started. This |
242 | Returns the time the last event loop iteration has been started. This |
204 | is the time that (relative) timers are based on, and referring to it is |
243 | is the time that (relative) timers are based on, and referring to it is |
205 | usually faster then calling EV::time. |
244 | usually faster then calling EV::time. |
206 | |
245 | |
|
|
246 | =item EV::now_update |
|
|
247 | |
|
|
248 | =item $loop->now_update |
|
|
249 | |
|
|
250 | Establishes the current time by querying the kernel, updating the time |
|
|
251 | returned by C<EV::now> in the progress. This is a costly operation and |
|
|
252 | is usually done automatically within C<EV::loop>. |
|
|
253 | |
|
|
254 | This function is rarely useful, but when some event callback runs for a |
|
|
255 | very long time without entering the event loop, updating libev's idea of |
|
|
256 | the current time is a good idea. |
|
|
257 | |
|
|
258 | =item EV::suspend |
|
|
259 | |
|
|
260 | =item $loop->suspend |
|
|
261 | |
|
|
262 | =item EV::resume |
|
|
263 | |
|
|
264 | =item $loop->resume |
|
|
265 | |
|
|
266 | These two functions suspend and resume a loop, for use when the loop is |
|
|
267 | not used for a while and timeouts should not be processed. |
|
|
268 | |
|
|
269 | A typical use case would be an interactive program such as a game: When |
|
|
270 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
271 | would be best to handle timeouts as if no time had actually passed while |
|
|
272 | the program was suspended. This can be achieved by calling C<suspend> |
|
|
273 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
274 | C<resume> directly afterwards to resume timer processing. |
|
|
275 | |
|
|
276 | Effectively, all C<timer> watchers will be delayed by the time spend |
|
|
277 | between C<suspend> and C<resume>, and all C<periodic> watchers |
|
|
278 | will be rescheduled (that is, they will lose any events that would have |
|
|
279 | occured while suspended). |
|
|
280 | |
|
|
281 | After calling C<suspend> you B<must not> call I<any> function on the given |
|
|
282 | loop other than C<resume>, and you B<must not> call C<resume> |
|
|
283 | without a previous call to C<suspend>. |
|
|
284 | |
|
|
285 | Calling C<suspend>/C<resume> has the side effect of updating the event |
|
|
286 | loop time (see C<now_update>). |
|
|
287 | |
207 | =item $backend = EV::backend |
288 | =item $backend = EV::backend |
208 | |
289 | |
209 | =item $backend = $loop->backend |
290 | =item $backend = $loop->backend |
210 | |
291 | |
211 | 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 |
… | |
… | |
258 | timeout. Otherwise a EV::timer with this value will be started. |
339 | timeout. Otherwise a EV::timer with this value will be started. |
259 | |
340 | |
260 | When an error occurs or either the timeout or I/O watcher triggers, then |
341 | When an error occurs or either the timeout or I/O watcher triggers, then |
261 | the callback will be called with the received event set (in general |
342 | the callback will be called with the received event set (in general |
262 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
343 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
263 | C<EV::WRITE> and C<EV::TIMEOUT>). |
344 | C<EV::WRITE> and C<EV::TIMER>). |
264 | |
345 | |
265 | EV::once doesn't return anything: the watchers stay active till either |
346 | EV::once doesn't return anything: the watchers stay active till either |
266 | of them triggers, then they will be stopped and freed, and the callback |
347 | of them triggers, then they will be stopped and freed, and the callback |
267 | invoked. |
348 | invoked. |
268 | |
349 | |
… | |
… | |
290 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
371 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
291 | wait interval for timer events. See the libev documentation at |
372 | wait interval for timer events. See the libev documentation at |
292 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
373 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
293 | (locally installed as F<EV::libev>) for a more detailed discussion. |
374 | (locally installed as F<EV::libev>) for a more detailed discussion. |
294 | |
375 | |
|
|
376 | =item $count = EV::pending_count |
|
|
377 | |
|
|
378 | =item $count = $loop->pending_count |
|
|
379 | |
|
|
380 | Returns the number of currently pending watchers. |
|
|
381 | |
|
|
382 | =item EV::invoke_pending |
|
|
383 | |
|
|
384 | =item $loop->invoke_pending |
|
|
385 | |
|
|
386 | Invoke all currently pending watchers. |
|
|
387 | |
295 | =back |
388 | =back |
296 | |
389 | |
297 | |
390 | |
298 | =head1 WATCHER OBJECTS |
391 | =head1 WATCHER OBJECTS |
299 | |
392 | |
… | |
… | |
313 | |
406 | |
314 | Each watcher type has its associated bit in revents, so you can use the |
407 | Each watcher type has its associated bit in revents, so you can use the |
315 | same callback for multiple watchers. The event mask is named after the |
408 | same callback for multiple watchers. The event mask is named after the |
316 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
409 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
317 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
410 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
318 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
411 | (which can set both EV::READ and EV::WRITE bits). |
319 | uses EV::TIMEOUT). |
|
|
320 | |
412 | |
321 | In the rare case where one wants to create a watcher but not start it at |
413 | In the rare case where one wants to create a watcher but not start it at |
322 | the same time, each constructor has a variant with a trailing C<_ns> in |
414 | the same time, each constructor has a variant with a trailing C<_ns> in |
323 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
415 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
324 | |
416 | |
… | |
… | |
403 | |
495 | |
404 | =item $previous_state = $w->keepalive ($bool) |
496 | =item $previous_state = $w->keepalive ($bool) |
405 | |
497 | |
406 | Normally, C<EV::loop> will return when there are no active watchers |
498 | Normally, C<EV::loop> will return when there are no active watchers |
407 | (which is a "deadlock" because no progress can be made anymore). This is |
499 | (which is a "deadlock" because no progress can be made anymore). This is |
408 | convinient because it allows you to start your watchers (and your jobs), |
500 | convenient because it allows you to start your watchers (and your jobs), |
409 | call C<EV::loop> once and when it returns you know that all your jobs are |
501 | call C<EV::loop> once and when it returns you know that all your jobs are |
410 | finished (or they forgot to register some watchers for their task :). |
502 | finished (or they forgot to register some watchers for their task :). |
411 | |
503 | |
412 | Sometimes, however, this gets in your way, for example when the module |
504 | Sometimes, however, this gets in your way, for example when the module |
413 | that calls C<EV::loop> (usually the main program) is not the same module |
505 | that calls C<EV::loop> (usually the main program) is not the same module |
… | |
… | |
645 | |
737 | |
646 | =item $w = EV::signal $signal, $callback |
738 | =item $w = EV::signal $signal, $callback |
647 | |
739 | |
648 | =item $w = EV::signal_ns $signal, $callback |
740 | =item $w = EV::signal_ns $signal, $callback |
649 | |
741 | |
|
|
742 | =item $w = $loop->signal ($signal, $callback) |
|
|
743 | |
|
|
744 | =item $w = $loop->signal_ns ($signal, $callback) |
|
|
745 | |
650 | Call the callback when $signal is received (the signal can be specified by |
746 | Call the callback when $signal is received (the signal can be specified by |
651 | number or by name, just as with C<kill> or C<%SIG>). |
747 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
748 | |
|
|
749 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
750 | signal from two EV loops will crash the program immediately or cause data |
|
|
751 | corruption. |
652 | |
752 | |
653 | EV will grab the signal for the process (the kernel only allows one |
753 | EV will grab the signal for the process (the kernel only allows one |
654 | component to receive a signal at a time) when you start a signal watcher, |
754 | component to receive a signal at a time) when you start a signal watcher, |
655 | and removes it again when you stop it. Perl does the same when you |
755 | and removes it again when you stop it. Perl does the same when you |
656 | add/remove callbacks to C<%SIG>, so watch out. |
756 | add/remove callbacks to C<%SIG>, so watch out. |
… | |
… | |
881 | =item $w = $loop->check_ns ($callback) |
981 | =item $w = $loop->check_ns ($callback) |
882 | |
982 | |
883 | Call the callback just after the process wakes up again (after it has |
983 | Call the callback just after the process wakes up again (after it has |
884 | gathered events), but before any other callbacks have been invoked. |
984 | gathered events), but before any other callbacks have been invoked. |
885 | |
985 | |
886 | This is used to integrate other event-based software into the EV |
986 | This can be used to integrate other event-based software into the EV |
887 | mainloop: You register a prepare callback and in there, you create io and |
987 | mainloop: You register a prepare callback and in there, you create io and |
888 | timer watchers as required by the other software. Here is a real-world |
988 | timer watchers as required by the other software. Here is a real-world |
889 | example of integrating Net::SNMP (with some details left out): |
989 | example of integrating Net::SNMP (with some details left out): |
890 | |
990 | |
891 | our @snmp_watcher; |
991 | our @snmp_watcher; |
… | |
… | |
925 | The callbacks of the created watchers will not be called as the watchers |
1025 | The callbacks of the created watchers will not be called as the watchers |
926 | are destroyed before this can happen (remember EV::check gets called |
1026 | are destroyed before this can happen (remember EV::check gets called |
927 | first). |
1027 | first). |
928 | |
1028 | |
929 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1029 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1030 | |
|
|
1031 | =item EV::CHECK constant issues |
|
|
1032 | |
|
|
1033 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1034 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1035 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1036 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1037 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1038 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1039 | safe side. |
930 | |
1040 | |
931 | =back |
1041 | =back |
932 | |
1042 | |
933 | |
1043 | |
934 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1044 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
1002 | |
1112 | |
1003 | =back |
1113 | =back |
1004 | |
1114 | |
1005 | =head3 ASYNC WATCHERS - how to wake up another event loop |
1115 | =head3 ASYNC WATCHERS - how to wake up another event loop |
1006 | |
1116 | |
1007 | Async watchers are provided by EV, but have little use in perl directly, as perl |
1117 | Async watchers are provided by EV, but have little use in perl directly, |
1008 | neither supports threads nor direct access to signal handlers or other |
1118 | as perl neither supports threads running in parallel nor direct access to |
1009 | contexts where they could be of value. |
1119 | signal handlers or other contexts where they could be of value. |
1010 | |
1120 | |
1011 | It is, however, possible to use them from the XS level. |
1121 | It is, however, possible to use them from the XS level. |
1012 | |
1122 | |
1013 | Please see the libev documentation for further details. |
1123 | Please see the libev documentation for further details. |
1014 | |
1124 | |
… | |
… | |
1042 | my $async_check = EV::check sub { }; |
1152 | my $async_check = EV::check sub { }; |
1043 | |
1153 | |
1044 | This ensures that perl gets into control for a short time to handle any |
1154 | This ensures that perl gets into control for a short time to handle any |
1045 | pending signals, and also ensures (slightly) slower overall operation. |
1155 | pending signals, and also ensures (slightly) slower overall operation. |
1046 | |
1156 | |
1047 | =head1 THREADS |
1157 | =head1 ITHREADS |
1048 | |
1158 | |
1049 | Threads are not supported by this module in any way. Perl pseudo-threads |
1159 | Ithreads are not supported by this module in any way. Perl pseudo-threads |
1050 | is evil stuff and must die. As soon as Perl gains real threads I will work |
1160 | is evil stuff and must die. Real threads as provided by Coro are fully |
1051 | on thread support for it. |
1161 | supported (and enhanced support is available via L<Coro::EV>). |
1052 | |
1162 | |
1053 | =head1 FORK |
1163 | =head1 FORK |
1054 | |
1164 | |
1055 | Most of the "improved" event delivering mechanisms of modern operating |
1165 | Most of the "improved" event delivering mechanisms of modern operating |
1056 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
1166 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
… | |
… | |
1078 | |
1188 | |
1079 | 1; |
1189 | 1; |
1080 | |
1190 | |
1081 | =head1 SEE ALSO |
1191 | =head1 SEE ALSO |
1082 | |
1192 | |
|
|
1193 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1083 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1194 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1084 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1195 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1085 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1196 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1086 | event-loop agnostic and portable event driven programming. |
1197 | event-loop agnostic and portable event driven programming. |
1087 | |
1198 | |
1088 | =head1 AUTHOR |
1199 | =head1 AUTHOR |
1089 | |
1200 | |
1090 | Marc Lehmann <schmorp@schmorp.de> |
1201 | Marc Lehmann <schmorp@schmorp.de> |