… | |
… | |
2 | |
2 | |
3 | EV - perl interface to libev, a high performance full-featured event loop |
3 | EV - perl interface to libev, a high performance full-featured event loop |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use EV; |
7 | use EV; |
|
|
8 | |
|
|
9 | # TIMERS |
|
|
10 | |
|
|
11 | my $w = EV::timer 2, 0, sub { |
|
|
12 | warn "is called after 2s"; |
|
|
13 | }; |
|
|
14 | |
|
|
15 | my $w = EV::timer 2, 2, sub { |
|
|
16 | warn "is called roughly every 2s (repeat = 2)"; |
|
|
17 | }; |
|
|
18 | |
|
|
19 | undef $w; # destroy event watcher again |
|
|
20 | |
|
|
21 | my $w = EV::periodic 0, 60, 0, sub { |
|
|
22 | warn "is called every minute, on the minute, exactly"; |
|
|
23 | }; |
|
|
24 | |
|
|
25 | # IO |
|
|
26 | |
|
|
27 | my $w = EV::io *STDIN, EV::READ, sub { |
|
|
28 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
|
|
29 | warn "stdin is readable, you entered: ", <STDIN>; |
|
|
30 | }; |
|
|
31 | |
|
|
32 | # SIGNALS |
|
|
33 | |
|
|
34 | my $w = EV::signal 'QUIT', sub { |
|
|
35 | warn "sigquit received\n"; |
|
|
36 | }; |
|
|
37 | |
|
|
38 | # CHILD/PID STATUS CHANGES |
8 | |
39 | |
9 | # TIMERS |
40 | my $w = EV::child 666, 0, sub { |
|
|
41 | my ($w, $revents) = @_; |
|
|
42 | my $status = $w->rstatus; |
|
|
43 | }; |
10 | |
44 | |
11 | my $w = EV::timer 2, 0, sub { |
|
|
12 | warn "is called after 2s"; |
|
|
13 | }; |
|
|
14 | |
|
|
15 | my $w = EV::timer 2, 2, sub { |
|
|
16 | warn "is called roughly every 2s (repeat = 2)"; |
|
|
17 | }; |
|
|
18 | |
|
|
19 | undef $w; # destroy event watcher again |
|
|
20 | |
|
|
21 | my $w = EV::periodic 0, 60, 0, sub { |
|
|
22 | warn "is called every minute, on the minute, exactly"; |
|
|
23 | }; |
|
|
24 | |
|
|
25 | # IO |
|
|
26 | |
|
|
27 | my $w = EV::io *STDIN, EV::READ, sub { |
|
|
28 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
|
|
29 | warn "stdin is readable, you entered: ", <STDIN>; |
|
|
30 | }; |
|
|
31 | |
|
|
32 | # SIGNALS |
|
|
33 | |
|
|
34 | my $w = EV::signal 'QUIT', sub { |
|
|
35 | warn "sigquit received\n"; |
|
|
36 | }; |
|
|
37 | |
|
|
38 | # CHILD/PID STATUS CHANGES |
|
|
39 | |
|
|
40 | my $w = EV::child 666, sub { |
|
|
41 | my ($w, $revents) = @_; |
|
|
42 | my $status = $w->rstatus; |
|
|
43 | }; |
|
|
44 | |
|
|
45 | # STAT CHANGES |
45 | # STAT CHANGES |
46 | my $w = EV::stat "/etc/passwd", 10, sub { |
46 | my $w = EV::stat "/etc/passwd", 10, sub { |
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::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 DESCRIPTION |
56 | =head1 DESCRIPTION |
57 | |
57 | |
58 | This module provides an interface to libev |
58 | This module provides an interface to libev |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
60 | below is comprehensive, one might also consult the documentation of libev |
60 | below is comprehensive, one might also consult the documentation of libev |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
61 | itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more |
62 | watcher semantics or some discussion on the available backends, or how to |
62 | subtle details on watcher semantics or some discussion on the available |
63 | force a specific backend with C<LIBEV_FLAGS>, or just about in any case |
63 | backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just |
64 | because it has much more detailed information. |
64 | about in any case because it has much more detailed information. |
|
|
65 | |
|
|
66 | This module is very fast and scalable. It is actually so fast that you |
|
|
67 | can use it through the L<AnyEvent> module, stay portable to other event |
|
|
68 | loops (if you don't rely on any watcher types not available through it) |
|
|
69 | and still be faster than with any other event loop currently supported in |
|
|
70 | Perl. |
65 | |
71 | |
66 | =cut |
72 | =cut |
67 | |
73 | |
68 | package EV; |
74 | package EV; |
69 | |
75 | |
70 | use strict; |
76 | use strict; |
71 | |
77 | |
72 | BEGIN { |
78 | BEGIN { |
73 | our $VERSION = '2.0'; |
79 | our $VERSION = '3.42'; |
74 | use XSLoader; |
80 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
81 | XSLoader::load "EV", $VERSION; |
76 | } |
82 | } |
77 | |
83 | |
78 | @EV::IO::ISA = |
84 | @EV::IO::ISA = |
… | |
… | |
84 | @EV::Idle::ISA = |
90 | @EV::Idle::ISA = |
85 | @EV::Prepare::ISA = |
91 | @EV::Prepare::ISA = |
86 | @EV::Check::ISA = |
92 | @EV::Check::ISA = |
87 | @EV::Embed::ISA = |
93 | @EV::Embed::ISA = |
88 | @EV::Fork::ISA = |
94 | @EV::Fork::ISA = |
|
|
95 | @EV::Async::ISA = |
89 | "EV::Watcher"; |
96 | "EV::Watcher"; |
90 | |
97 | |
91 | @EV::Loop::Default::ISA = "EV::Loop"; |
98 | @EV::Loop::Default::ISA = "EV::Loop"; |
92 | |
99 | |
93 | =head1 EVENT LOOPS |
100 | =head1 EVENT LOOPS |
… | |
… | |
102 | selecting a working backend (which for example rules out kqueue on most |
109 | selecting a working backend (which for example rules out kqueue on most |
103 | BSDs). Modules should, unless they have "special needs" always use the |
110 | BSDs). Modules should, unless they have "special needs" always use the |
104 | default loop as this is fastest (perl-wise), best supported by other |
111 | default loop as this is fastest (perl-wise), best supported by other |
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
112 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
106 | |
113 | |
107 | For specific programs you cna create additional event loops dynamically. |
114 | For specific programs you can create additional event loops dynamically. |
|
|
115 | |
|
|
116 | If you want to take avdantage of kqueue (which often works properly for |
|
|
117 | sockets only) even though the default loop doesn't enable it, you can |
|
|
118 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
119 | will then also service the kqueue loop to some extent. See the example in |
|
|
120 | the section about embed watchers for an example on how to achieve that. |
108 | |
121 | |
109 | =over 4 |
122 | =over 4 |
110 | |
123 | |
111 | =item $loop = new EV::loop [$flags] |
124 | =item $loop = new EV::loop [$flags] |
112 | |
125 | |
… | |
… | |
123 | |
136 | |
124 | =item $loop->loop_fork |
137 | =item $loop->loop_fork |
125 | |
138 | |
126 | Must be called after a fork in the child, before entering or continuing |
139 | Must be called after a fork in the child, before entering or continuing |
127 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
140 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
128 | this fucntion automatically, at some performance loss (refer to the libev |
141 | this function automatically, at some performance loss (refer to the libev |
129 | documentation). |
142 | documentation). |
|
|
143 | |
|
|
144 | =item $loop->loop_verify |
|
|
145 | |
|
|
146 | Calls C<ev_verify> to make internal consistency checks (for debugging |
|
|
147 | libev) and abort the program if any data structures were found to be |
|
|
148 | corrupted. |
|
|
149 | |
|
|
150 | =item $loop = EV::default_loop [$flags] |
|
|
151 | |
|
|
152 | Return the default loop (which is a singleton object). Since this module |
|
|
153 | already creates the default loop with default flags, specifying flags here |
|
|
154 | will not have any effect unless you destroy the default loop first, which |
|
|
155 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
156 | keep the pieces. |
130 | |
157 | |
131 | =back |
158 | =back |
132 | |
159 | |
133 | |
160 | |
134 | =head1 BASIC INTERFACE |
161 | =head1 BASIC INTERFACE |
… | |
… | |
140 | Must contain a reference to a function that is called when a callback |
167 | Must contain a reference to a function that is called when a callback |
141 | throws an exception (with $@ containing the error). The default prints an |
168 | throws an exception (with $@ containing the error). The default prints an |
142 | informative message and continues. |
169 | informative message and continues. |
143 | |
170 | |
144 | If this callback throws an exception it will be silently ignored. |
171 | If this callback throws an exception it will be silently ignored. |
|
|
172 | |
|
|
173 | =item $flags = EV::supported_backends |
|
|
174 | |
|
|
175 | =item $flags = EV::recommended_backends |
|
|
176 | |
|
|
177 | =item $flags = EV::embeddable_backends |
|
|
178 | |
|
|
179 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
|
|
180 | instance of EV, the set of recommended backends (supposed to be good) for |
|
|
181 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
|
|
182 | |
|
|
183 | =item EV::sleep $seconds |
|
|
184 | |
|
|
185 | Block the process for the given number of (fractional) seconds. |
145 | |
186 | |
146 | =item $time = EV::time |
187 | =item $time = EV::time |
147 | |
188 | |
148 | Returns the current time in (fractional) seconds since the epoch. |
189 | Returns the current time in (fractional) seconds since the epoch. |
149 | |
190 | |
… | |
… | |
208 | If timeout is C<undef> or negative, then there will be no |
249 | If timeout is C<undef> or negative, then there will be no |
209 | timeout. Otherwise a EV::timer with this value will be started. |
250 | timeout. Otherwise a EV::timer with this value will be started. |
210 | |
251 | |
211 | When an error occurs or either the timeout or I/O watcher triggers, then |
252 | When an error occurs or either the timeout or I/O watcher triggers, then |
212 | the callback will be called with the received event set (in general |
253 | the callback will be called with the received event set (in general |
213 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
254 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
214 | C<EV::WRITE> and C<EV::TIMEOUT>). |
255 | C<EV::WRITE> and C<EV::TIMEOUT>). |
215 | |
256 | |
216 | EV::once doesn't return anything: the watchers stay active till either |
257 | EV::once doesn't return anything: the watchers stay active till either |
217 | of them triggers, then they will be stopped and freed, and the callback |
258 | of them triggers, then they will be stopped and freed, and the callback |
218 | invoked. |
259 | invoked. |
… | |
… | |
228 | =item EV::feed_signal_event ($signal) |
269 | =item EV::feed_signal_event ($signal) |
229 | |
270 | |
230 | Feed a signal event into EV. EV will react to this call as if the signal |
271 | Feed a signal event into EV. EV will react to this call as if the signal |
231 | specified by C<$signal> had occured. |
272 | specified by C<$signal> had occured. |
232 | |
273 | |
|
|
274 | =item EV::set_io_collect_interval $time |
|
|
275 | |
|
|
276 | =item $loop->set_io_collect_interval ($time) |
|
|
277 | |
|
|
278 | =item EV::set_timeout_collect_interval $time |
|
|
279 | |
|
|
280 | =item $loop->set_timeout_collect_interval ($time) |
|
|
281 | |
|
|
282 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
|
|
283 | wait interval for timer events. See the libev documentation at |
|
|
284 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
|
|
285 | a more detailed discussion. |
|
|
286 | |
233 | =back |
287 | =back |
234 | |
288 | |
235 | |
289 | |
236 | =head1 WATCHER OBJECTS |
290 | =head1 WATCHER OBJECTS |
237 | |
291 | |
238 | A watcher is an object that gets created to record your interest in some |
292 | A watcher is an object that gets created to record your interest in some |
239 | event. For instance, if you want to wait for STDIN to become readable, you |
293 | event. For instance, if you want to wait for STDIN to become readable, you |
240 | would create an EV::io watcher for that: |
294 | would create an EV::io watcher for that: |
241 | |
295 | |
242 | my $watcher = EV::io *STDIN, EV::READ, sub { |
296 | my $watcher = EV::io *STDIN, EV::READ, sub { |
243 | my ($watcher, $revents) = @_; |
297 | my ($watcher, $revents) = @_; |
244 | warn "yeah, STDIN should not be readable without blocking!\n" |
298 | warn "yeah, STDIN should now be readable without blocking!\n" |
245 | }; |
299 | }; |
246 | |
300 | |
247 | All watchers can be active (waiting for events) or inactive (paused). Only |
301 | All watchers can be active (waiting for events) or inactive (paused). Only |
248 | active watchers will have their callbacks invoked. All callbacks will be |
302 | active watchers will have their callbacks invoked. All callbacks will be |
249 | called with at least two arguments: the watcher and a bitmask of received |
303 | called with at least two arguments: the watcher and a bitmask of received |
250 | events. |
304 | events. |
… | |
… | |
333 | Feed some events on this watcher into EV. EV will react to this call as if |
387 | Feed some events on this watcher into EV. EV will react to this call as if |
334 | the watcher had received the given C<$revents> mask. |
388 | the watcher had received the given C<$revents> mask. |
335 | |
389 | |
336 | =item $revents = $w->clear_pending |
390 | =item $revents = $w->clear_pending |
337 | |
391 | |
338 | If the watcher is pending, this function returns clears its pending status |
392 | If the watcher is pending, this function clears its pending status and |
339 | and returns its C<$revents> bitset (as if its callback was invoked). If the |
393 | returns its C<$revents> bitset (as if its callback was invoked). If the |
340 | watcher isn't pending it does nothing and returns C<0>. |
394 | watcher isn't pending it does nothing and returns C<0>. |
341 | |
395 | |
342 | =item $previous_state = $w->keepalive ($bool) |
396 | =item $previous_state = $w->keepalive ($bool) |
343 | |
397 | |
344 | Normally, C<EV::loop> will return when there are no active watchers |
398 | Normally, C<EV::loop> will return when there are no active watchers |
345 | (which is a "deadlock" because no progress can be made anymore). This is |
399 | (which is a "deadlock" because no progress can be made anymore). This is |
346 | convinient because it allows you to start your watchers (and your jobs), |
400 | convinient because it allows you to start your watchers (and your jobs), |
347 | call C<EV::loop> once and when it returns you know that all your jobs are |
401 | call C<EV::loop> once and when it returns you know that all your jobs are |
348 | finished (or they forgot to register some watchers for their task :). |
402 | finished (or they forgot to register some watchers for their task :). |
349 | |
403 | |
350 | Sometimes, however, this gets in your way, for example when you the module |
404 | Sometimes, however, this gets in your way, for example when the module |
351 | that calls C<EV::loop> (usually the main program) is not the same module |
405 | that calls C<EV::loop> (usually the main program) is not the same module |
352 | as a long-living watcher (for example a DNS client module written by |
406 | as a long-living watcher (for example a DNS client module written by |
353 | somebody else even). Then you might want any outstanding requests to be |
407 | somebody else even). Then you might want any outstanding requests to be |
354 | handled, but you would not want to keep C<EV::loop> from returning just |
408 | handled, but you would not want to keep C<EV::loop> from returning just |
355 | because you happen to have this long-running UDP port watcher. |
409 | because you happen to have this long-running UDP port watcher. |
… | |
… | |
363 | Example: Register an I/O watcher for some UDP socket but do not keep the |
417 | Example: Register an I/O watcher for some UDP socket but do not keep the |
364 | event loop from running just because of that watcher. |
418 | event loop from running just because of that watcher. |
365 | |
419 | |
366 | my $udp_socket = ... |
420 | my $udp_socket = ... |
367 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
421 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
368 | $1000udp_watcher->keepalive (0); |
422 | $udp_watcher->keepalive (0); |
369 | |
423 | |
370 | =item $loop = $w->loop |
424 | =item $loop = $w->loop |
371 | |
425 | |
372 | Return the loop that this watcher is attached to. |
426 | Return the loop that this watcher is attached to. |
373 | |
427 | |
… | |
… | |
502 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
556 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
503 | will not adjust when a time jump occurs, that is, if it is to be run |
557 | will not adjust when a time jump occurs, that is, if it is to be run |
504 | at January 1st 2011 then it will run when the system time reaches or |
558 | at January 1st 2011 then it will run when the system time reaches or |
505 | surpasses this time. |
559 | surpasses this time. |
506 | |
560 | |
507 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
561 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
508 | |
562 | |
509 | In this mode the watcher will always be scheduled to time out at the |
563 | In this mode the watcher will always be scheduled to time out at the |
510 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
564 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
511 | regardless of any time jumps. |
565 | regardless of any time jumps. |
512 | |
566 | |
… | |
… | |
530 | time the periodic watcher gets scheduled, the reschedule callback |
584 | time the periodic watcher gets scheduled, the reschedule callback |
531 | ($reschedule_cb) will be called with the watcher as first, and the current |
585 | ($reschedule_cb) will be called with the watcher as first, and the current |
532 | time as second argument. |
586 | time as second argument. |
533 | |
587 | |
534 | I<This callback MUST NOT stop or destroy this or any other periodic |
588 | I<This callback MUST NOT stop or destroy this or any other periodic |
535 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
589 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
536 | afterwards. |
590 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
591 | and start a C<EV::prepare> watcher for this task. |
537 | |
592 | |
538 | It must return the next time to trigger, based on the passed time value |
593 | It must return the next time to trigger, based on the passed time value |
539 | (that is, the lowest time value larger than to the second argument). It |
594 | (that is, the lowest time value larger than or equal to to the second |
540 | will usually be called just before the callback will be triggered, but |
595 | argument). It will usually be called just before the callback will be |
541 | might be called at other times, too. |
596 | triggered, but might be called at other times, too. |
542 | |
597 | |
543 | This can be used to create very complex timers, such as a timer that |
598 | This can be used to create very complex timers, such as a timer that |
544 | triggers on each midnight, local time (actually 24 hours after the last |
599 | triggers on each midnight, local time (actually 24 hours after the last |
545 | midnight, to keep the example simple. If you know a way to do it correctly |
600 | midnight, to keep the example simple. If you know a way to do it correctly |
546 | in about the same space (without requiring elaborate modules), drop me a |
601 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
613 | |
668 | |
614 | =head3 CHILD WATCHERS - watch out for process status changes |
669 | =head3 CHILD WATCHERS - watch out for process status changes |
615 | |
670 | |
616 | =over 4 |
671 | =over 4 |
617 | |
672 | |
618 | =item $w = EV::child $pid, $callback |
673 | =item $w = EV::child $pid, $trace, $callback |
619 | |
674 | |
620 | =item $w = EV::child_ns $pid, $callback |
675 | =item $w = EV::child_ns $pid, $trace, $callback |
621 | |
676 | |
622 | =item $w = $loop->child ($pid, $callback) |
677 | =item $w = $loop->child ($pid, $trace, $callback) |
623 | |
678 | |
624 | =item $w = $loop->child_ns ($pid, $callback) |
679 | =item $w = $loop->child_ns ($pid, $trace, $callback) |
625 | |
680 | |
626 | Call the callback when a status change for pid C<$pid> (or any pid if |
681 | Call the callback when a status change for pid C<$pid> (or any pid |
627 | C<$pid> is 0) has been received. More precisely: when the process receives |
682 | if C<$pid> is 0) has been received (a status change happens when the |
|
|
683 | process terminates or is killed, or, when trace is true, additionally when |
|
|
684 | it is stopped or continued). More precisely: when the process receives |
628 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
685 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
629 | changed/zombie children and call the callback. |
686 | changed/zombie children and call the callback. |
630 | |
687 | |
631 | It is valid (and fully supported) to install a child watcher after a child |
688 | It is valid (and fully supported) to install a child watcher after a child |
632 | has exited but before the event loop has started its next iteration (for |
689 | has exited but before the event loop has started its next iteration (for |
… | |
… | |
639 | You can have as many pid watchers per pid as you want, they will all be |
696 | You can have as many pid watchers per pid as you want, they will all be |
640 | called. |
697 | called. |
641 | |
698 | |
642 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
699 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
643 | |
700 | |
644 | =item $w->set ($pid) |
701 | =item $w->set ($pid, $trace) |
645 | |
702 | |
646 | Reconfigures the watcher, see the constructor above for details. Can be called at |
703 | Reconfigures the watcher, see the constructor above for details. Can be called at |
647 | any time. |
704 | any time. |
648 | |
705 | |
649 | =item $current_pid = $w->pid |
706 | =item $current_pid = $w->pid |
650 | |
|
|
651 | =item $old_pid = $w->pid ($new_pid) |
|
|
652 | |
707 | |
653 | Returns the previously set process id and optionally set a new one. |
708 | Returns the previously set process id and optionally set a new one. |
654 | |
709 | |
655 | =item $exit_status = $w->rstatus |
710 | =item $exit_status = $w->rstatus |
656 | |
711 | |
… | |
… | |
886 | |
941 | |
887 | Call the callback before the event loop is resumed in the child process |
942 | Call the callback before the event loop is resumed in the child process |
888 | after a fork. |
943 | after a fork. |
889 | |
944 | |
890 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
945 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
|
|
946 | |
|
|
947 | =back |
|
|
948 | |
|
|
949 | |
|
|
950 | =head3 EMBED WATCHERS - when one backend isn't enough... |
|
|
951 | |
|
|
952 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
953 | into another (currently only IO events are supported in the embedded |
|
|
954 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
955 | fashion and must not be used). |
|
|
956 | |
|
|
957 | See the libev documentation at |
|
|
958 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
|
|
959 | for more details. |
|
|
960 | |
|
|
961 | In short, this watcher is most useful on BSD systems without working |
|
|
962 | kqueue to still be able to handle a large number of sockets: |
|
|
963 | |
|
|
964 | my $socket_loop; |
|
|
965 | |
|
|
966 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
|
|
967 | if ( |
|
|
968 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
|
|
969 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
|
|
970 | ) { |
|
|
971 | # use kqueue for sockets |
|
|
972 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
|
|
973 | } |
|
|
974 | |
|
|
975 | # use the default loop otherwise |
|
|
976 | $socket_loop ||= EV::default_loop; |
|
|
977 | |
|
|
978 | =over 4 |
|
|
979 | |
|
|
980 | =item $w = EV::embed $otherloop, $callback |
|
|
981 | |
|
|
982 | =item $w = EV::embed_ns $otherloop, $callback |
|
|
983 | |
|
|
984 | =item $w = $loop->embed ($otherloop, $callback) |
|
|
985 | |
|
|
986 | =item $w = $loop->embed_ns ($otherloop, $callback) |
|
|
987 | |
|
|
988 | Call the callback when the embedded event loop (C<$otherloop>) has any |
|
|
989 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
|
|
990 | this version of EV, which means the embedded event loop will be managed |
|
|
991 | automatically. |
|
|
992 | |
|
|
993 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
994 | |
|
|
995 | =back |
|
|
996 | |
|
|
997 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
998 | |
|
|
999 | Async watchers are provided by EV, but have little use in perl directly, as perl |
|
|
1000 | neither supports threads nor direct access to signal handlers or other |
|
|
1001 | contexts where they could be of value. |
|
|
1002 | |
|
|
1003 | It is, however, possible to use them from the XS level. |
|
|
1004 | |
|
|
1005 | Please see the libev documentation for further details. |
|
|
1006 | |
|
|
1007 | =over 4 |
|
|
1008 | |
|
|
1009 | =item $w = EV::async $callback |
|
|
1010 | |
|
|
1011 | =item $w = EV::async_ns $callback |
|
|
1012 | |
|
|
1013 | =item $w->send |
|
|
1014 | |
|
|
1015 | =item $bool = $w->async_pending |
891 | |
1016 | |
892 | =back |
1017 | =back |
893 | |
1018 | |
894 | |
1019 | |
895 | =head1 PERL SIGNALS |
1020 | =head1 PERL SIGNALS |
… | |
… | |
947 | |
1072 | |
948 | =head1 SEE ALSO |
1073 | =head1 SEE ALSO |
949 | |
1074 | |
950 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1075 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
951 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1076 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
952 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1077 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1078 | event-loop agnostic and portable event driven programming. |
953 | |
1079 | |
954 | =head1 AUTHOR |
1080 | =head1 AUTHOR |
955 | |
1081 | |
956 | Marc Lehmann <schmorp@schmorp.de> |
1082 | Marc Lehmann <schmorp@schmorp.de> |
957 | http://home.schmorp.de/ |
1083 | http://home.schmorp.de/ |
958 | |
1084 | |
959 | =cut |
1085 | =cut |
960 | |
1086 | |