… | |
… | |
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 |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
61 | libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or |
62 | watcher semantics or some discussion on the available backends, or how to |
62 | F<perldoc EV::libev>) for more subtle details on watcher semantics or some |
63 | force a specific backend with C<LIBEV_FLAGS>, or just about in any case |
63 | discussion on the available backends, or how to force a specific backend |
64 | because it has much more detailed information. |
64 | with C<LIBEV_FLAGS>, or just about in any case because it has much more |
|
|
65 | detailed information. |
|
|
66 | |
|
|
67 | This module is very fast and scalable. It is actually so fast that you |
|
|
68 | 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) |
|
|
70 | and still be faster than with any other event loop currently supported in |
|
|
71 | Perl. |
|
|
72 | |
|
|
73 | =head2 MODULE EXPORTS |
|
|
74 | |
|
|
75 | This module does not export any symbols. |
65 | |
76 | |
66 | =cut |
77 | =cut |
67 | |
78 | |
68 | package EV; |
79 | package EV; |
69 | |
80 | |
|
|
81 | no warnings; |
70 | use strict; |
82 | use strict; |
71 | |
83 | |
72 | BEGIN { |
84 | BEGIN { |
73 | our $VERSION = '2.0'; |
85 | our $VERSION = '3.53'; |
74 | use XSLoader; |
86 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
87 | XSLoader::load "EV", $VERSION; |
76 | } |
88 | } |
77 | |
89 | |
78 | @EV::IO::ISA = |
90 | @EV::IO::ISA = |
… | |
… | |
84 | @EV::Idle::ISA = |
96 | @EV::Idle::ISA = |
85 | @EV::Prepare::ISA = |
97 | @EV::Prepare::ISA = |
86 | @EV::Check::ISA = |
98 | @EV::Check::ISA = |
87 | @EV::Embed::ISA = |
99 | @EV::Embed::ISA = |
88 | @EV::Fork::ISA = |
100 | @EV::Fork::ISA = |
|
|
101 | @EV::Async::ISA = |
89 | "EV::Watcher"; |
102 | "EV::Watcher"; |
90 | |
103 | |
91 | @EV::Loop::Default::ISA = "EV::Loop"; |
104 | @EV::Loop::Default::ISA = "EV::Loop"; |
92 | |
105 | |
93 | =head1 EVENT LOOPS |
106 | =head1 EVENT LOOPS |
… | |
… | |
104 | default loop as this is fastest (perl-wise), best supported by other |
117 | default loop as this is fastest (perl-wise), best supported by other |
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
118 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
106 | |
119 | |
107 | For specific programs you can create additional event loops dynamically. |
120 | For specific programs you can create additional event loops dynamically. |
108 | |
121 | |
109 | =over 4 |
122 | If you want to take advantage of kqueue (which often works properly for |
|
|
123 | sockets only) even though the default loop doesn't enable it, you can |
|
|
124 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
125 | 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. |
110 | |
127 | |
|
|
128 | =over 4 |
|
|
129 | |
111 | =item $loop = new EV::loop [$flags] |
130 | =item $loop = new EV::Loop [$flags] |
112 | |
131 | |
113 | Create a new event loop as per the specified flags. Please refer to the |
132 | Create a new event loop as per the specified flags. Please refer to |
114 | C<ev_loop_new ()> function description in the libev documentation |
133 | the C<ev_loop_new ()> function description in the libev documentation |
115 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) |
134 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
116 | for more info. |
135 | or locally-installed as F<EV::libev> manpage) for more info. |
117 | |
136 | |
118 | The loop will automatically be destroyed when it is no longer referenced |
137 | The loop will automatically be destroyed when it is no longer referenced |
119 | by any watcher and the loop object goes out of scope. |
138 | by any watcher and the loop object goes out of scope. |
120 | |
139 | |
121 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
140 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
122 | is protected by this module. |
141 | is recommended, as only the default event loop is protected by this |
|
|
142 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
143 | necessary, as C<EV::embed> automatically does the right thing on fork. |
123 | |
144 | |
124 | =item $loop->loop_fork |
145 | =item $loop->loop_fork |
125 | |
146 | |
126 | Must be called after a fork in the child, before entering or continuing |
147 | 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 |
148 | 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 |
149 | this function automatically, at some performance loss (refer to the libev |
129 | documentation). |
150 | documentation). |
130 | |
151 | |
|
|
152 | =item $loop->loop_verify |
|
|
153 | |
|
|
154 | Calls C<ev_verify> to make internal consistency checks (for debugging |
|
|
155 | libev) and abort the program if any data structures were found to be |
|
|
156 | corrupted. |
|
|
157 | |
131 | =item $loop = EV::default_loop [$flags] |
158 | =item $loop = EV::default_loop [$flags] |
132 | |
159 | |
133 | Return the default loop (which is a singleton object). |
160 | Return the default loop (which is a singleton object). Since this module |
|
|
161 | already creates the default loop with default flags, specifying flags here |
|
|
162 | will not have any effect unless you destroy the default loop first, which |
|
|
163 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
164 | keep the pieces. |
134 | |
165 | |
135 | =back |
166 | =back |
136 | |
167 | |
137 | |
168 | |
138 | =head1 BASIC INTERFACE |
169 | =head1 BASIC INTERFACE |
… | |
… | |
155 | |
186 | |
156 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
187 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
157 | instance of EV, the set of recommended backends (supposed to be good) for |
188 | instance of EV, the set of recommended backends (supposed to be good) for |
158 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
189 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
159 | |
190 | |
|
|
191 | =item EV::sleep $seconds |
|
|
192 | |
|
|
193 | Block the process for the given number of (fractional) seconds. |
|
|
194 | |
160 | =item $time = EV::time |
195 | =item $time = EV::time |
161 | |
196 | |
162 | Returns the current time in (fractional) seconds since the epoch. |
197 | Returns the current time in (fractional) seconds since the epoch. |
163 | |
198 | |
164 | =item $time = EV::now |
199 | =item $time = EV::now |
165 | |
200 | |
166 | =item $time = $loop->now |
201 | =item $time = $loop->now |
167 | |
202 | |
168 | Returns the time the last event loop iteration has been started. This |
203 | Returns the time the last event loop iteration has been started. This |
169 | is the time that (relative) timers are based on, and refering to it is |
204 | is the time that (relative) timers are based on, and referring to it is |
170 | usually faster then calling EV::time. |
205 | usually faster then calling EV::time. |
171 | |
206 | |
|
|
207 | =item EV::now_update |
|
|
208 | |
|
|
209 | =item $loop->now_update |
|
|
210 | |
|
|
211 | Establishes the current time by querying the kernel, updating the time |
|
|
212 | returned by C<EV::now> in the progress. This is a costly operation and |
|
|
213 | is usually done automatically within C<EV::loop>. |
|
|
214 | |
|
|
215 | This function is rarely useful, but when some event callback runs for a |
|
|
216 | very long time without entering the event loop, updating libev's idea of |
|
|
217 | the current time is a good idea. |
|
|
218 | |
|
|
219 | =item EV::suspend |
|
|
220 | |
|
|
221 | =item $loop->suspend |
|
|
222 | |
|
|
223 | =item EV::resume |
|
|
224 | |
|
|
225 | =item $loop->resume |
|
|
226 | |
|
|
227 | These two functions suspend and resume a loop, for use when the loop is |
|
|
228 | not used for a while and timeouts should not be processed. |
|
|
229 | |
|
|
230 | A typical use case would be an interactive program such as a game: When |
|
|
231 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
232 | would be best to handle timeouts as if no time had actually passed while |
|
|
233 | the program was suspended. This can be achieved by calling C<suspend> |
|
|
234 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
235 | C<resume> directly afterwards to resume timer processing. |
|
|
236 | |
|
|
237 | Effectively, all C<timer> watchers will be delayed by the time spend |
|
|
238 | between C<suspend> and C<resume>, and all C<periodic> watchers |
|
|
239 | will be rescheduled (that is, they will lose any events that would have |
|
|
240 | occured while suspended). |
|
|
241 | |
|
|
242 | After calling C<suspend> you B<must not> call I<any> function on the given |
|
|
243 | loop other than C<resume>, and you B<must not> call C<resume> |
|
|
244 | without a previous call to C<suspend>. |
|
|
245 | |
|
|
246 | Calling C<suspend>/C<resume> has the side effect of updating the event |
|
|
247 | loop time (see C<now_update>). |
|
|
248 | |
172 | =item $backend = EV::backend |
249 | =item $backend = EV::backend |
173 | |
250 | |
174 | =item $backend = $loop->backend |
251 | =item $backend = $loop->backend |
175 | |
252 | |
176 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
253 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
177 | or EV::METHOD_EPOLL). |
254 | or EV::BACKEND_EPOLL). |
178 | |
255 | |
179 | =item EV::loop [$flags] |
256 | =item EV::loop [$flags] |
180 | |
257 | |
181 | =item $loop->loop ([$flags]) |
258 | =item $loop->loop ([$flags]) |
182 | |
259 | |
… | |
… | |
202 | =item $count = EV::loop_count |
279 | =item $count = EV::loop_count |
203 | |
280 | |
204 | =item $count = $loop->loop_count |
281 | =item $count = $loop->loop_count |
205 | |
282 | |
206 | Return the number of times the event loop has polled for new |
283 | Return the number of times the event loop has polled for new |
207 | events. Sometiems useful as a generation counter. |
284 | events. Sometimes useful as a generation counter. |
208 | |
285 | |
209 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
286 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
210 | |
287 | |
211 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
288 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
212 | |
289 | |
… | |
… | |
252 | |
329 | |
253 | =item $loop->set_timeout_collect_interval ($time) |
330 | =item $loop->set_timeout_collect_interval ($time) |
254 | |
331 | |
255 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
332 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
256 | wait interval for timer events. See the libev documentation at |
333 | wait interval for timer events. See the libev documentation at |
257 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
334 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
258 | a more detailed discussion. |
335 | (locally installed as F<EV::libev>) for a more detailed discussion. |
259 | |
336 | |
260 | =back |
337 | =back |
261 | |
338 | |
262 | |
339 | |
263 | =head1 WATCHER OBJECTS |
340 | =head1 WATCHER OBJECTS |
264 | |
341 | |
265 | A watcher is an object that gets created to record your interest in some |
342 | A watcher is an object that gets created to record your interest in some |
266 | event. For instance, if you want to wait for STDIN to become readable, you |
343 | event. For instance, if you want to wait for STDIN to become readable, you |
267 | would create an EV::io watcher for that: |
344 | would create an EV::io watcher for that: |
268 | |
345 | |
269 | my $watcher = EV::io *STDIN, EV::READ, sub { |
346 | my $watcher = EV::io *STDIN, EV::READ, sub { |
270 | my ($watcher, $revents) = @_; |
347 | my ($watcher, $revents) = @_; |
271 | warn "yeah, STDIN should now be readable without blocking!\n" |
348 | warn "yeah, STDIN should now be readable without blocking!\n" |
272 | }; |
349 | }; |
273 | |
350 | |
274 | All watchers can be active (waiting for events) or inactive (paused). Only |
351 | All watchers can be active (waiting for events) or inactive (paused). Only |
275 | active watchers will have their callbacks invoked. All callbacks will be |
352 | active watchers will have their callbacks invoked. All callbacks will be |
276 | called with at least two arguments: the watcher and a bitmask of received |
353 | called with at least two arguments: the watcher and a bitmask of received |
277 | events. |
354 | events. |
278 | |
355 | |
279 | Each watcher type has its associated bit in revents, so you can use the |
356 | Each watcher type has its associated bit in revents, so you can use the |
280 | same callback for multiple watchers. The event mask is named after the |
357 | same callback for multiple watchers. The event mask is named after the |
281 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
358 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
282 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
359 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
283 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
360 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
284 | uses EV::TIMEOUT). |
361 | uses EV::TIMEOUT). |
285 | |
362 | |
286 | In the rare case where one wants to create a watcher but not start it at |
363 | In the rare case where one wants to create a watcher but not start it at |
… | |
… | |
382 | because you happen to have this long-running UDP port watcher. |
459 | because you happen to have this long-running UDP port watcher. |
383 | |
460 | |
384 | In this case you can clear the keepalive status, which means that even |
461 | In this case you can clear the keepalive status, which means that even |
385 | though your watcher is active, it won't keep C<EV::loop> from returning. |
462 | though your watcher is active, it won't keep C<EV::loop> from returning. |
386 | |
463 | |
387 | The initial value for keepalive is true (enabled), and you cna change it |
464 | The initial value for keepalive is true (enabled), and you can change it |
388 | any time. |
465 | any time. |
389 | |
466 | |
390 | Example: Register an I/O watcher for some UDP socket but do not keep the |
467 | Example: Register an I/O watcher for some UDP socket but do not keep the |
391 | event loop from running just because of that watcher. |
468 | event loop from running just because of that watcher. |
392 | |
469 | |
393 | my $udp_socket = ... |
470 | my $udp_socket = ... |
394 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
471 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
395 | $1000udp_watcher->keepalive (0); |
472 | $udp_watcher->keepalive (0); |
396 | |
473 | |
397 | =item $loop = $w->loop |
474 | =item $loop = $w->loop |
398 | |
475 | |
399 | Return the loop that this watcher is attached to. |
476 | Return the loop that this watcher is attached to. |
400 | |
477 | |
… | |
… | |
529 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
606 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
530 | will not adjust when a time jump occurs, that is, if it is to be run |
607 | will not adjust when a time jump occurs, that is, if it is to be run |
531 | at January 1st 2011 then it will run when the system time reaches or |
608 | at January 1st 2011 then it will run when the system time reaches or |
532 | surpasses this time. |
609 | surpasses this time. |
533 | |
610 | |
534 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
611 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
535 | |
612 | |
536 | In this mode the watcher will always be scheduled to time out at the |
613 | In this mode the watcher will always be scheduled to time out at the |
537 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
614 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
538 | regardless of any time jumps. |
615 | regardless of any time jumps. |
539 | |
616 | |
… | |
… | |
557 | time the periodic watcher gets scheduled, the reschedule callback |
634 | time the periodic watcher gets scheduled, the reschedule callback |
558 | ($reschedule_cb) will be called with the watcher as first, and the current |
635 | ($reschedule_cb) will be called with the watcher as first, and the current |
559 | time as second argument. |
636 | time as second argument. |
560 | |
637 | |
561 | I<This callback MUST NOT stop or destroy this or any other periodic |
638 | I<This callback MUST NOT stop or destroy this or any other periodic |
562 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
639 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
563 | afterwards. |
640 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
641 | and start a C<EV::prepare> watcher for this task. |
564 | |
642 | |
565 | It must return the next time to trigger, based on the passed time value |
643 | It must return the next time to trigger, based on the passed time value |
566 | (that is, the lowest time value larger than to the second argument). It |
644 | (that is, the lowest time value larger than or equal to to the second |
567 | will usually be called just before the callback will be triggered, but |
645 | argument). It will usually be called just before the callback will be |
568 | might be called at other times, too. |
646 | triggered, but might be called at other times, too. |
569 | |
647 | |
570 | This can be used to create very complex timers, such as a timer that |
648 | This can be used to create very complex timers, such as a timer that |
571 | triggers on each midnight, local time (actually 24 hours after the last |
649 | triggers on each midnight, local time (actually 24 hours after the last |
572 | midnight, to keep the example simple. If you know a way to do it correctly |
650 | midnight, to keep the example simple. If you know a way to do it correctly |
573 | in about the same space (without requiring elaborate modules), drop me a |
651 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
640 | |
718 | |
641 | =head3 CHILD WATCHERS - watch out for process status changes |
719 | =head3 CHILD WATCHERS - watch out for process status changes |
642 | |
720 | |
643 | =over 4 |
721 | =over 4 |
644 | |
722 | |
645 | =item $w = EV::child $pid, $callback |
723 | =item $w = EV::child $pid, $trace, $callback |
646 | |
724 | |
647 | =item $w = EV::child_ns $pid, $callback |
725 | =item $w = EV::child_ns $pid, $trace, $callback |
648 | |
726 | |
649 | =item $w = $loop->child ($pid, $callback) |
727 | =item $w = $loop->child ($pid, $trace, $callback) |
650 | |
728 | |
651 | =item $w = $loop->child_ns ($pid, $callback) |
729 | =item $w = $loop->child_ns ($pid, $trace, $callback) |
652 | |
730 | |
653 | Call the callback when a status change for pid C<$pid> (or any pid if |
731 | Call the callback when a status change for pid C<$pid> (or any pid |
654 | C<$pid> is 0) has been received. More precisely: when the process receives |
732 | if C<$pid> is 0) has been received (a status change happens when the |
|
|
733 | process terminates or is killed, or, when trace is true, additionally when |
|
|
734 | it is stopped or continued). More precisely: when the process receives |
655 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
735 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
656 | changed/zombie children and call the callback. |
736 | changed/zombie children and call the callback. |
657 | |
737 | |
658 | It is valid (and fully supported) to install a child watcher after a child |
738 | It is valid (and fully supported) to install a child watcher after a child |
659 | has exited but before the event loop has started its next iteration (for |
739 | has exited but before the event loop has started its next iteration (for |
… | |
… | |
666 | You can have as many pid watchers per pid as you want, they will all be |
746 | You can have as many pid watchers per pid as you want, they will all be |
667 | called. |
747 | called. |
668 | |
748 | |
669 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
749 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
670 | |
750 | |
671 | =item $w->set ($pid) |
751 | =item $w->set ($pid, $trace) |
672 | |
752 | |
673 | Reconfigures the watcher, see the constructor above for details. Can be called at |
753 | Reconfigures the watcher, see the constructor above for details. Can be called at |
674 | any time. |
754 | any time. |
675 | |
755 | |
676 | =item $current_pid = $w->pid |
756 | =item $current_pid = $w->pid |
677 | |
|
|
678 | =item $old_pid = $w->pid ($new_pid) |
|
|
679 | |
757 | |
680 | Returns the previously set process id and optionally set a new one. |
758 | Returns the previously set process id and optionally set a new one. |
681 | |
759 | |
682 | =item $exit_status = $w->rstatus |
760 | =item $exit_status = $w->rstatus |
683 | |
761 | |
… | |
… | |
885 | # make the dispatcher handle any new stuff |
963 | # make the dispatcher handle any new stuff |
886 | ... not shown |
964 | ... not shown |
887 | }; |
965 | }; |
888 | |
966 | |
889 | The callbacks of the created watchers will not be called as the watchers |
967 | The callbacks of the created watchers will not be called as the watchers |
890 | are destroyed before this cna happen (remember EV::check gets called |
968 | are destroyed before this can happen (remember EV::check gets called |
891 | first). |
969 | first). |
892 | |
970 | |
893 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
971 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
894 | |
972 | |
895 | =back |
973 | =back |
… | |
… | |
926 | loop, other types of watchers might be handled in a delayed or incorrect |
1004 | loop, other types of watchers might be handled in a delayed or incorrect |
927 | fashion and must not be used). |
1005 | fashion and must not be used). |
928 | |
1006 | |
929 | See the libev documentation at |
1007 | See the libev documentation at |
930 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
1008 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
931 | for more details. |
1009 | (locally installed as F<EV::libev>) for more details. |
932 | |
1010 | |
933 | In short, this watcher is most useful on BSD systems without working |
1011 | In short, this watcher is most useful on BSD systems without working |
934 | kqueue to still be able to handle a large number of sockets: |
1012 | kqueue to still be able to handle a large number of sockets: |
935 | |
1013 | |
936 | my $socket_loop; |
1014 | my $socket_loop; |
937 | |
1015 | |
938 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
1016 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
939 | if ( |
1017 | if ( |
940 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
1018 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
941 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
1019 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
942 | ) { |
1020 | ) { |
943 | # use kqueue for sockets |
1021 | # use kqueue for sockets |
944 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
1022 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
945 | } |
1023 | } |
946 | |
1024 | |
947 | # use the default loop otherwise |
1025 | # use the default loop otherwise |
948 | $socket_loop ||= EV::default_loop; |
1026 | $socket_loop ||= EV::default_loop; |
949 | |
1027 | |
950 | =over 4 |
1028 | =over 4 |
951 | |
1029 | |
952 | =item $w = EV::embed $otherloop, $callback |
1030 | =item $w = EV::embed $otherloop[, $callback] |
953 | |
1031 | |
954 | =item $w = EV::embed_ns $otherloop, $callback |
1032 | =item $w = EV::embed_ns $otherloop[, $callback] |
955 | |
1033 | |
956 | =item $w = $loop->embed ($otherloop, $callback) |
1034 | =item $w = $loop->embed ($otherloop[, $callback]) |
957 | |
1035 | |
958 | =item $w = $loop->embed_ns ($otherloop, $callback) |
1036 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
959 | |
1037 | |
960 | Call the callback when the embedded event loop (C<$otherloop>) has any |
1038 | Call the callback when the embedded event loop (C<$otherloop>) has any |
961 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
1039 | I/O activity. The C<$callback> is optional: if it is missing, then the |
962 | this version of EV, which means the embedded event loop will be managed |
1040 | embedded event loop will be managed automatically (which is recommended), |
963 | automatically. |
1041 | otherwise you have to invoke C<sweep> yourself. |
964 | |
1042 | |
965 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
1043 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1044 | |
|
|
1045 | =back |
|
|
1046 | |
|
|
1047 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
1048 | |
|
|
1049 | Async watchers are provided by EV, but have little use in perl directly, as perl |
|
|
1050 | neither supports threads nor direct access to signal handlers or other |
|
|
1051 | contexts where they could be of value. |
|
|
1052 | |
|
|
1053 | It is, however, possible to use them from the XS level. |
|
|
1054 | |
|
|
1055 | Please see the libev documentation for further details. |
|
|
1056 | |
|
|
1057 | =over 4 |
|
|
1058 | |
|
|
1059 | =item $w = EV::async $callback |
|
|
1060 | |
|
|
1061 | =item $w = EV::async_ns $callback |
|
|
1062 | |
|
|
1063 | =item $w->send |
|
|
1064 | |
|
|
1065 | =item $bool = $w->async_pending |
966 | |
1066 | |
967 | =back |
1067 | =back |
968 | |
1068 | |
969 | |
1069 | |
970 | =head1 PERL SIGNALS |
1070 | =head1 PERL SIGNALS |
… | |
… | |
1022 | |
1122 | |
1023 | =head1 SEE ALSO |
1123 | =head1 SEE ALSO |
1024 | |
1124 | |
1025 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1125 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1026 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1126 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1027 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1127 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1128 | event-loop agnostic and portable event driven programming. |
1028 | |
1129 | |
1029 | =head1 AUTHOR |
1130 | =head1 AUTHOR |
1030 | |
1131 | |
1031 | Marc Lehmann <schmorp@schmorp.de> |
1132 | Marc Lehmann <schmorp@schmorp.de> |
1032 | http://home.schmorp.de/ |
1133 | http://home.schmorp.de/ |
1033 | |
1134 | |
1034 | =cut |
1135 | =cut |
1035 | |
1136 | |