… | |
… | |
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 |
… | |
… | |
76 | |
85 | |
77 | =cut |
86 | =cut |
78 | |
87 | |
79 | package EV; |
88 | package EV; |
80 | |
89 | |
81 | no warnings; |
90 | use common::sense; |
82 | use strict; |
|
|
83 | |
91 | |
84 | BEGIN { |
92 | BEGIN { |
85 | our $VERSION = '3.53'; |
93 | our $VERSION = '4.00'; |
86 | use XSLoader; |
94 | use XSLoader; |
87 | XSLoader::load "EV", $VERSION; |
95 | XSLoader::load "EV", $VERSION; |
88 | } |
96 | } |
89 | |
97 | |
90 | @EV::IO::ISA = |
98 | @EV::IO::ISA = |
… | |
… | |
125 | will then also service the kqueue loop to some extent. See the example in |
133 | will then also service the kqueue loop to some extent. See the example in |
126 | the section about embed watchers for an example on how to achieve that. |
134 | the section about embed watchers for an example on how to achieve that. |
127 | |
135 | |
128 | =over 4 |
136 | =over 4 |
129 | |
137 | |
130 | =item $loop = new EV::loop [$flags] |
138 | =item $loop = new EV::Loop [$flags] |
131 | |
139 | |
132 | Create a new event loop as per the specified flags. Please refer to |
140 | Create a new event loop as per the specified flags. Please refer to |
133 | the C<ev_loop_new ()> function description in the libev documentation |
141 | the C<ev_loop_new ()> function description in the libev documentation |
134 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
142 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
135 | or locally-installed as F<EV::libev> manpage) for more info. |
143 | or locally-installed as F<EV::libev> manpage) for more info. |
… | |
… | |
202 | |
210 | |
203 | Returns the time the last event loop iteration has been started. This |
211 | 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 |
212 | is the time that (relative) timers are based on, and referring to it is |
205 | usually faster then calling EV::time. |
213 | usually faster then calling EV::time. |
206 | |
214 | |
|
|
215 | =item EV::now_update |
|
|
216 | |
|
|
217 | =item $loop->now_update |
|
|
218 | |
|
|
219 | Establishes the current time by querying the kernel, updating the time |
|
|
220 | returned by C<EV::now> in the progress. This is a costly operation and |
|
|
221 | is usually done automatically within C<EV::loop>. |
|
|
222 | |
|
|
223 | This function is rarely useful, but when some event callback runs for a |
|
|
224 | very long time without entering the event loop, updating libev's idea of |
|
|
225 | the current time is a good idea. |
|
|
226 | |
|
|
227 | =item EV::suspend |
|
|
228 | |
|
|
229 | =item $loop->suspend |
|
|
230 | |
|
|
231 | =item EV::resume |
|
|
232 | |
|
|
233 | =item $loop->resume |
|
|
234 | |
|
|
235 | These two functions suspend and resume a loop, for use when the loop is |
|
|
236 | not used for a while and timeouts should not be processed. |
|
|
237 | |
|
|
238 | A typical use case would be an interactive program such as a game: When |
|
|
239 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
240 | would be best to handle timeouts as if no time had actually passed while |
|
|
241 | the program was suspended. This can be achieved by calling C<suspend> |
|
|
242 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
243 | C<resume> directly afterwards to resume timer processing. |
|
|
244 | |
|
|
245 | Effectively, all C<timer> watchers will be delayed by the time spend |
|
|
246 | between C<suspend> and C<resume>, and all C<periodic> watchers |
|
|
247 | will be rescheduled (that is, they will lose any events that would have |
|
|
248 | occured while suspended). |
|
|
249 | |
|
|
250 | After calling C<suspend> you B<must not> call I<any> function on the given |
|
|
251 | loop other than C<resume>, and you B<must not> call C<resume> |
|
|
252 | without a previous call to C<suspend>. |
|
|
253 | |
|
|
254 | Calling C<suspend>/C<resume> has the side effect of updating the event |
|
|
255 | loop time (see C<now_update>). |
|
|
256 | |
207 | =item $backend = EV::backend |
257 | =item $backend = EV::backend |
208 | |
258 | |
209 | =item $backend = $loop->backend |
259 | =item $backend = $loop->backend |
210 | |
260 | |
211 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
261 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
… | |
… | |
258 | timeout. Otherwise a EV::timer with this value will be started. |
308 | timeout. Otherwise a EV::timer with this value will be started. |
259 | |
309 | |
260 | When an error occurs or either the timeout or I/O watcher triggers, then |
310 | 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 |
311 | 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>, |
312 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
263 | C<EV::WRITE> and C<EV::TIMEOUT>). |
313 | C<EV::WRITE> and C<EV::TIMER>). |
264 | |
314 | |
265 | EV::once doesn't return anything: the watchers stay active till either |
315 | 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 |
316 | of them triggers, then they will be stopped and freed, and the callback |
267 | invoked. |
317 | invoked. |
268 | |
318 | |
… | |
… | |
290 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
340 | 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 |
341 | 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> |
342 | 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. |
343 | (locally installed as F<EV::libev>) for a more detailed discussion. |
294 | |
344 | |
|
|
345 | =item $count = EV::pending_count |
|
|
346 | |
|
|
347 | =item $count = $loop->pending_count |
|
|
348 | |
|
|
349 | Returns the number of currently pending watchers. |
|
|
350 | |
|
|
351 | =item EV::invoke_pending |
|
|
352 | |
|
|
353 | =item $loop->invoke_pending |
|
|
354 | |
|
|
355 | Invoke all currently pending watchers. |
|
|
356 | |
295 | =back |
357 | =back |
296 | |
358 | |
297 | |
359 | |
298 | =head1 WATCHER OBJECTS |
360 | =head1 WATCHER OBJECTS |
299 | |
361 | |
… | |
… | |
313 | |
375 | |
314 | Each watcher type has its associated bit in revents, so you can use the |
376 | 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 |
377 | 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, |
378 | 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 |
379 | 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 |
380 | (which can set both EV::READ and EV::WRITE bits). |
319 | uses EV::TIMEOUT). |
|
|
320 | |
381 | |
321 | In the rare case where one wants to create a watcher but not start it at |
382 | 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 |
383 | 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. |
384 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
324 | |
385 | |
… | |
… | |
403 | |
464 | |
404 | =item $previous_state = $w->keepalive ($bool) |
465 | =item $previous_state = $w->keepalive ($bool) |
405 | |
466 | |
406 | Normally, C<EV::loop> will return when there are no active watchers |
467 | 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 |
468 | (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), |
469 | 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 |
470 | 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 :). |
471 | finished (or they forgot to register some watchers for their task :). |
411 | |
472 | |
412 | Sometimes, however, this gets in your way, for example when the module |
473 | 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 |
474 | that calls C<EV::loop> (usually the main program) is not the same module |
… | |
… | |
645 | |
706 | |
646 | =item $w = EV::signal $signal, $callback |
707 | =item $w = EV::signal $signal, $callback |
647 | |
708 | |
648 | =item $w = EV::signal_ns $signal, $callback |
709 | =item $w = EV::signal_ns $signal, $callback |
649 | |
710 | |
|
|
711 | =item $w = $loop->signal ($signal, $callback) |
|
|
712 | |
|
|
713 | =item $w = $loop->signal_ns ($signal, $callback) |
|
|
714 | |
650 | Call the callback when $signal is received (the signal can be specified by |
715 | 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>). |
716 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
717 | |
|
|
718 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
719 | signal from two EV loops will crash the program immediately or cause data |
|
|
720 | corruption. |
652 | |
721 | |
653 | EV will grab the signal for the process (the kernel only allows one |
722 | 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, |
723 | 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 |
724 | and removes it again when you stop it. Perl does the same when you |
656 | add/remove callbacks to C<%SIG>, so watch out. |
725 | add/remove callbacks to C<%SIG>, so watch out. |
… | |
… | |
881 | =item $w = $loop->check_ns ($callback) |
950 | =item $w = $loop->check_ns ($callback) |
882 | |
951 | |
883 | Call the callback just after the process wakes up again (after it has |
952 | Call the callback just after the process wakes up again (after it has |
884 | gathered events), but before any other callbacks have been invoked. |
953 | gathered events), but before any other callbacks have been invoked. |
885 | |
954 | |
886 | This is used to integrate other event-based software into the EV |
955 | 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 |
956 | 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 |
957 | timer watchers as required by the other software. Here is a real-world |
889 | example of integrating Net::SNMP (with some details left out): |
958 | example of integrating Net::SNMP (with some details left out): |
890 | |
959 | |
891 | our @snmp_watcher; |
960 | our @snmp_watcher; |
… | |
… | |
925 | The callbacks of the created watchers will not be called as the watchers |
994 | 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 |
995 | are destroyed before this can happen (remember EV::check gets called |
927 | first). |
996 | first). |
928 | |
997 | |
929 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
998 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
999 | |
|
|
1000 | =item EV::CHECK constant issues |
|
|
1001 | |
|
|
1002 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1003 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1004 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1005 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1006 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1007 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1008 | safe side. |
930 | |
1009 | |
931 | =back |
1010 | =back |
932 | |
1011 | |
933 | |
1012 | |
934 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1013 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
1002 | |
1081 | |
1003 | =back |
1082 | =back |
1004 | |
1083 | |
1005 | =head3 ASYNC WATCHERS - how to wake up another event loop |
1084 | =head3 ASYNC WATCHERS - how to wake up another event loop |
1006 | |
1085 | |
1007 | Async watchers are provided by EV, but have little use in perl directly, as perl |
1086 | 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 |
1087 | as perl neither supports threads running in parallel nor direct access to |
1009 | contexts where they could be of value. |
1088 | signal handlers or other contexts where they could be of value. |
1010 | |
1089 | |
1011 | It is, however, possible to use them from the XS level. |
1090 | It is, however, possible to use them from the XS level. |
1012 | |
1091 | |
1013 | Please see the libev documentation for further details. |
1092 | Please see the libev documentation for further details. |
1014 | |
1093 | |
… | |
… | |
1042 | my $async_check = EV::check sub { }; |
1121 | my $async_check = EV::check sub { }; |
1043 | |
1122 | |
1044 | This ensures that perl gets into control for a short time to handle any |
1123 | This ensures that perl gets into control for a short time to handle any |
1045 | pending signals, and also ensures (slightly) slower overall operation. |
1124 | pending signals, and also ensures (slightly) slower overall operation. |
1046 | |
1125 | |
1047 | =head1 THREADS |
1126 | =head1 ITHREADS |
1048 | |
1127 | |
1049 | Threads are not supported by this module in any way. Perl pseudo-threads |
1128 | 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 |
1129 | is evil stuff and must die. Real threads as provided by Coro are fully |
1051 | on thread support for it. |
1130 | supported (and enhanced support is available via L<Coro::EV>). |
1052 | |
1131 | |
1053 | =head1 FORK |
1132 | =head1 FORK |
1054 | |
1133 | |
1055 | Most of the "improved" event delivering mechanisms of modern operating |
1134 | 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 |
1135 | systems have quite a few problems with fork(2) (to put it bluntly: it is |