… | |
… | |
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::run; # loop until EV::unloop is called or all watchers stop |
53 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
53 | EV::run EV::RUN_ONCE; # block until at least one event could be handled |
54 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
54 | EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block |
|
|
55 | |
|
|
56 | =head1 BEFORE YOU START USING THIS MODULE |
|
|
57 | |
|
|
58 | If you only need timer, I/O, signal, child and idle watchers and not the |
|
|
59 | advanced functionality of this module, consider using L<AnyEvent> instead, |
|
|
60 | specifically the simplified API described in L<AE>. |
|
|
61 | |
|
|
62 | When used with EV as backend, the L<AE> API is as fast as the native L<EV> |
|
|
63 | API, but your programs/modules will still run with many other event loops. |
55 | |
64 | |
56 | =head1 DESCRIPTION |
65 | =head1 DESCRIPTION |
57 | |
66 | |
58 | This module provides an interface to libev |
67 | This module provides an interface to libev |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
68 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
60 | below is comprehensive, one might also consult the documentation of libev |
69 | 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 |
70 | 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 |
71 | 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 |
72 | discussion on the available backends, or how to force a specific backend |
64 | because it has much more detailed information. |
73 | with C<LIBEV_FLAGS>, or just about in any case because it has much more |
|
|
74 | detailed information. |
|
|
75 | |
|
|
76 | This module is very fast and scalable. It is actually so fast that you |
|
|
77 | can use it through the L<AnyEvent> module, stay portable to other event |
|
|
78 | loops (if you don't rely on any watcher types not available through it) |
|
|
79 | and still be faster than with any other event loop currently supported in |
|
|
80 | Perl. |
|
|
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 | |
|
|
113 | =head2 MODULE EXPORTS |
|
|
114 | |
|
|
115 | This module does not export any symbols. |
65 | |
116 | |
66 | =cut |
117 | =cut |
67 | |
118 | |
68 | package EV; |
119 | package EV; |
69 | |
120 | |
70 | use strict; |
121 | use common::sense; |
71 | |
122 | |
72 | BEGIN { |
123 | BEGIN { |
73 | our $VERSION = '1.8'; |
124 | our $VERSION = '4.15'; |
74 | use XSLoader; |
125 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
126 | XSLoader::load "EV", $VERSION; |
76 | } |
127 | } |
77 | |
128 | |
78 | @EV::IO::ISA = |
129 | @EV::IO::ISA = |
… | |
… | |
84 | @EV::Idle::ISA = |
135 | @EV::Idle::ISA = |
85 | @EV::Prepare::ISA = |
136 | @EV::Prepare::ISA = |
86 | @EV::Check::ISA = |
137 | @EV::Check::ISA = |
87 | @EV::Embed::ISA = |
138 | @EV::Embed::ISA = |
88 | @EV::Fork::ISA = |
139 | @EV::Fork::ISA = |
|
|
140 | @EV::Async::ISA = |
89 | "EV::Watcher"; |
141 | "EV::Watcher"; |
90 | |
142 | |
|
|
143 | @EV::Loop::Default::ISA = "EV::Loop"; |
|
|
144 | |
|
|
145 | =head1 EVENT LOOPS |
|
|
146 | |
|
|
147 | EV supports multiple event loops: There is a single "default event loop" |
|
|
148 | that can handle everything including signals and child watchers, and any |
|
|
149 | number of "dynamic event loops" that can use different backends (with |
|
|
150 | various limitations), but no child and signal watchers. |
|
|
151 | |
|
|
152 | You do not have to do anything to create the default event loop: When |
|
|
153 | the module is loaded a suitable backend is selected on the premise of |
|
|
154 | selecting a working backend (which for example rules out kqueue on most |
|
|
155 | BSDs). Modules should, unless they have "special needs" always use the |
|
|
156 | default loop as this is fastest (perl-wise), best supported by other |
|
|
157 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
|
|
158 | |
|
|
159 | For specific programs you can create additional event loops dynamically. |
|
|
160 | |
|
|
161 | If you want to take advantage of kqueue (which often works properly for |
|
|
162 | sockets only) even though the default loop doesn't enable it, you can |
|
|
163 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
164 | will then also service the kqueue loop to some extent. See the example in |
|
|
165 | the section about embed watchers for an example on how to achieve that. |
|
|
166 | |
|
|
167 | =over 4 |
|
|
168 | |
|
|
169 | =item $loop = new EV::Loop [$flags] |
|
|
170 | |
|
|
171 | Create a new event loop as per the specified flags. Please refer to |
|
|
172 | the C<ev_loop_new ()> function description in the libev documentation |
|
|
173 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
|
|
174 | or locally-installed as F<EV::libev> manpage) for more info. |
|
|
175 | |
|
|
176 | The loop will automatically be destroyed when it is no longer referenced |
|
|
177 | by any watcher and the loop object goes out of scope. |
|
|
178 | |
|
|
179 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
|
|
180 | is recommended, as only the default event loop is protected by this |
|
|
181 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
182 | necessary, as C<EV::embed> automatically does the right thing on fork. |
|
|
183 | |
|
|
184 | =item $loop->loop_fork |
|
|
185 | |
|
|
186 | Must be called after a fork in the child, before entering or continuing |
|
|
187 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
|
|
188 | this function automatically, at some performance loss (refer to the libev |
|
|
189 | documentation). |
|
|
190 | |
|
|
191 | =item $loop->verify |
|
|
192 | |
|
|
193 | Calls C<ev_verify> to make internal consistency checks (for debugging |
|
|
194 | libev) and abort the program if any data structures were found to be |
|
|
195 | corrupted. |
|
|
196 | |
|
|
197 | =item $loop = EV::default_loop [$flags] |
|
|
198 | |
|
|
199 | Return the default loop (which is a singleton object). Since this module |
|
|
200 | already creates the default loop with default flags, specifying flags here |
|
|
201 | will not have any effect unless you destroy the default loop first, which |
|
|
202 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
203 | keep the pieces. |
|
|
204 | |
|
|
205 | =back |
|
|
206 | |
|
|
207 | |
91 | =head1 BASIC INTERFACE |
208 | =head1 BASIC INTERFACE |
92 | |
209 | |
93 | =over 4 |
210 | =over 4 |
94 | |
211 | |
95 | =item $EV::DIED |
212 | =item $EV::DIED |
96 | |
213 | |
97 | Must contain a reference to a function that is called when a callback |
214 | Must contain a reference to a function that is called when a callback |
98 | throws an exception (with $@ containing thr error). The default prints an |
215 | throws an exception (with $@ containing the error). The default prints an |
99 | informative message and continues. |
216 | informative message and continues. |
100 | |
217 | |
101 | If this callback throws an exception it will be silently ignored. |
218 | If this callback throws an exception it will be silently ignored. |
102 | |
219 | |
|
|
220 | =item $flags = EV::supported_backends |
|
|
221 | |
|
|
222 | =item $flags = EV::recommended_backends |
|
|
223 | |
|
|
224 | =item $flags = EV::embeddable_backends |
|
|
225 | |
|
|
226 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
|
|
227 | instance of EV, the set of recommended backends (supposed to be good) for |
|
|
228 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
|
|
229 | |
|
|
230 | =item EV::sleep $seconds |
|
|
231 | |
|
|
232 | Block the process for the given number of (fractional) seconds. |
|
|
233 | |
103 | =item $time = EV::time |
234 | =item $time = EV::time |
104 | |
235 | |
105 | Returns the current time in (fractional) seconds since the epoch. |
236 | Returns the current time in (fractional) seconds since the epoch. |
106 | |
237 | |
107 | =item $time = EV::now |
238 | =item $time = EV::now |
108 | |
239 | |
|
|
240 | =item $time = $loop->now |
|
|
241 | |
109 | 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 |
110 | is the time that (relative) timers are based on, and refering to it is |
243 | is the time that (relative) timers are based on, and referring to it is |
111 | usually faster then calling EV::time. |
244 | usually faster then calling EV::time. |
112 | |
245 | |
113 | =item $method = EV::method |
246 | =item EV::now_update |
114 | |
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 | |
|
|
288 | =item $backend = EV::backend |
|
|
289 | |
|
|
290 | =item $backend = $loop->backend |
|
|
291 | |
115 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
292 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
116 | or EV::METHOD_EPOLL). |
293 | or EV::BACKEND_EPOLL). |
117 | |
294 | |
118 | =item EV::loop [$flags] |
295 | =item $active = EV::run [$flags] |
|
|
296 | |
|
|
297 | =item $active = $loop->run ([$flags]) |
119 | |
298 | |
120 | Begin checking for events and calling callbacks. It returns when a |
299 | Begin checking for events and calling callbacks. It returns when a |
121 | callback calls EV::unloop. |
300 | callback calls EV::unloop or the flasg are nonzero (in which case the |
|
|
301 | return value is true) or when there are no active watchers which reference |
|
|
302 | the loop (keepalive is true), in which case the return value will be |
|
|
303 | false. The returnv alue can generally be interpreted as "if true, there is |
|
|
304 | more work left to do". |
122 | |
305 | |
123 | The $flags argument can be one of the following: |
306 | The $flags argument can be one of the following: |
124 | |
307 | |
125 | 0 as above |
308 | 0 as above |
126 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
309 | EV::RUN_ONCE block at most once (wait, but do not loop) |
127 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
310 | EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait) |
128 | |
311 | |
129 | =item EV::unloop [$how] |
312 | =item EV::break [$how] |
130 | |
313 | |
|
|
314 | =item $loop->break ([$how]) |
|
|
315 | |
131 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
316 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
132 | innermost call to EV::loop return. |
317 | innermost call to EV::loop return. |
133 | |
318 | |
134 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
319 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop will |
135 | fast as possible. |
320 | return as fast as possible. |
136 | |
321 | |
137 | =item $count = EV::loop_count |
322 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
323 | be cancelled. |
|
|
324 | |
|
|
325 | =item $count = EV::iteration |
|
|
326 | |
|
|
327 | =item $count = $loop->iteration |
138 | |
328 | |
139 | Return the number of times the event loop has polled for new |
329 | Return the number of times the event loop has polled for new |
140 | events. Sometiems useful as a generation counter. |
330 | events. Sometimes useful as a generation counter. |
141 | |
331 | |
142 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
332 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
333 | |
|
|
334 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
143 | |
335 | |
144 | This function rolls together an I/O and a timer watcher for a single |
336 | This function rolls together an I/O and a timer watcher for a single |
145 | one-shot event without the need for managing a watcher object. |
337 | one-shot event without the need for managing a watcher object. |
146 | |
338 | |
147 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
339 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
… | |
… | |
153 | If timeout is C<undef> or negative, then there will be no |
345 | If timeout is C<undef> or negative, then there will be no |
154 | timeout. Otherwise a EV::timer with this value will be started. |
346 | timeout. Otherwise a EV::timer with this value will be started. |
155 | |
347 | |
156 | When an error occurs or either the timeout or I/O watcher triggers, then |
348 | When an error occurs or either the timeout or I/O watcher triggers, then |
157 | the callback will be called with the received event set (in general |
349 | the callback will be called with the received event set (in general |
158 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
350 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
159 | C<EV::WRITE> and C<EV::TIMEOUT>). |
351 | C<EV::WRITE> and C<EV::TIMER>). |
160 | |
352 | |
161 | EV::once doesn't return anything: the watchers stay active till either |
353 | EV::once doesn't return anything: the watchers stay active till either |
162 | of them triggers, then they will be stopped and freed, and the callback |
354 | of them triggers, then they will be stopped and freed, and the callback |
163 | invoked. |
355 | invoked. |
164 | |
356 | |
165 | =back |
357 | =item EV::feed_fd_event $fd, $revents |
166 | |
358 | |
|
|
359 | =item $loop->feed_fd_event ($fd, $revents) |
|
|
360 | |
|
|
361 | Feed an event on a file descriptor into EV. EV will react to this call as |
|
|
362 | if the readyness notifications specified by C<$revents> (a combination of |
|
|
363 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
|
|
364 | |
|
|
365 | =item EV::feed_signal_event $signal |
|
|
366 | |
|
|
367 | Feed a signal event into the default loop. EV will react to this call as |
|
|
368 | if the signal specified by C<$signal> had occured. |
|
|
369 | |
|
|
370 | =item EV::feed_signal $signal |
|
|
371 | |
|
|
372 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
|
|
373 | regardless of which loop has registered the signal, and is mainly useful |
|
|
374 | fro custom signal implementations. |
|
|
375 | |
|
|
376 | =item EV::set_io_collect_interval $time |
|
|
377 | |
|
|
378 | =item $loop->set_io_collect_interval ($time) |
|
|
379 | |
|
|
380 | =item EV::set_timeout_collect_interval $time |
|
|
381 | |
|
|
382 | =item $loop->set_timeout_collect_interval ($time) |
|
|
383 | |
|
|
384 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
|
|
385 | wait interval for timer events. See the libev documentation at |
|
|
386 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
|
|
387 | (locally installed as F<EV::libev>) for a more detailed discussion. |
|
|
388 | |
|
|
389 | =item $count = EV::pending_count |
|
|
390 | |
|
|
391 | =item $count = $loop->pending_count |
|
|
392 | |
|
|
393 | Returns the number of currently pending watchers. |
|
|
394 | |
|
|
395 | =item EV::invoke_pending |
|
|
396 | |
|
|
397 | =item $loop->invoke_pending |
|
|
398 | |
|
|
399 | Invoke all currently pending watchers. |
|
|
400 | |
|
|
401 | =back |
|
|
402 | |
|
|
403 | |
167 | =head2 WATCHER OBJECTS |
404 | =head1 WATCHER OBJECTS |
168 | |
405 | |
169 | A watcher is an object that gets created to record your interest in some |
406 | A watcher is an object that gets created to record your interest in some |
170 | event. For instance, if you want to wait for STDIN to become readable, you |
407 | event. For instance, if you want to wait for STDIN to become readable, you |
171 | would create an EV::io watcher for that: |
408 | would create an EV::io watcher for that: |
172 | |
409 | |
173 | my $watcher = EV::io *STDIN, EV::READ, sub { |
410 | my $watcher = EV::io *STDIN, EV::READ, sub { |
174 | my ($watcher, $revents) = @_; |
411 | my ($watcher, $revents) = @_; |
175 | warn "yeah, STDIN should not be readable without blocking!\n" |
412 | warn "yeah, STDIN should now be readable without blocking!\n" |
176 | }; |
413 | }; |
177 | |
414 | |
178 | All watchers can be active (waiting for events) or inactive (paused). Only |
415 | All watchers can be active (waiting for events) or inactive (paused). Only |
179 | active watchers will have their callbacks invoked. All callbacks will be |
416 | active watchers will have their callbacks invoked. All callbacks will be |
180 | called with at least two arguments: the watcher and a bitmask of received |
417 | called with at least two arguments: the watcher and a bitmask of received |
181 | events. |
418 | events. |
182 | |
419 | |
183 | Each watcher type has its associated bit in revents, so you can use the |
420 | Each watcher type has its associated bit in revents, so you can use the |
184 | same callback for multiple watchers. The event mask is named after the |
421 | same callback for multiple watchers. The event mask is named after the |
185 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
422 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
186 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
423 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
187 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
424 | (which can set both EV::READ and EV::WRITE bits). |
188 | uses EV::TIMEOUT). |
|
|
189 | |
425 | |
190 | In the rare case where one wants to create a watcher but not start it at |
426 | In the rare case where one wants to create a watcher but not start it at |
191 | the same time, each constructor has a variant with a trailing C<_ns> in |
427 | the same time, each constructor has a variant with a trailing C<_ns> in |
192 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
428 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
193 | |
429 | |
… | |
… | |
253 | The default priority of any newly-created watcher is 0. |
489 | The default priority of any newly-created watcher is 0. |
254 | |
490 | |
255 | Note that the priority semantics have not yet been fleshed out and are |
491 | Note that the priority semantics have not yet been fleshed out and are |
256 | subject to almost certain change. |
492 | subject to almost certain change. |
257 | |
493 | |
258 | =item $w->trigger ($revents) |
494 | =item $w->invoke ($revents) |
259 | |
495 | |
260 | Call the callback *now* with the given event mask. |
496 | Call the callback *now* with the given event mask. |
|
|
497 | |
|
|
498 | =item $w->feed_event ($revents) |
|
|
499 | |
|
|
500 | Feed some events on this watcher into EV. EV will react to this call as if |
|
|
501 | the watcher had received the given C<$revents> mask. |
|
|
502 | |
|
|
503 | =item $revents = $w->clear_pending |
|
|
504 | |
|
|
505 | If the watcher is pending, this function clears its pending status and |
|
|
506 | returns its C<$revents> bitset (as if its callback was invoked). If the |
|
|
507 | watcher isn't pending it does nothing and returns C<0>. |
261 | |
508 | |
262 | =item $previous_state = $w->keepalive ($bool) |
509 | =item $previous_state = $w->keepalive ($bool) |
263 | |
510 | |
264 | Normally, C<EV::loop> will return when there are no active watchers |
511 | Normally, C<EV::loop> will return when there are no active watchers |
265 | (which is a "deadlock" because no progress can be made anymore). This is |
512 | (which is a "deadlock" because no progress can be made anymore). This is |
266 | convinient because it allows you to start your watchers (and your jobs), |
513 | convenient because it allows you to start your watchers (and your jobs), |
267 | call C<EV::loop> once and when it returns you know that all your jobs are |
514 | call C<EV::loop> once and when it returns you know that all your jobs are |
268 | finished (or they forgot to register some watchers for their task :). |
515 | finished (or they forgot to register some watchers for their task :). |
269 | |
516 | |
270 | Sometimes, however, this gets in your way, for example when you the module |
517 | Sometimes, however, this gets in your way, for example when the module |
271 | that calls C<EV::loop> (usually the main program) is not the same module |
518 | that calls C<EV::loop> (usually the main program) is not the same module |
272 | as a long-living watcher (for example a DNS client module written by |
519 | as a long-living watcher (for example a DNS client module written by |
273 | somebody else even). Then you might want any outstanding requests to be |
520 | somebody else even). Then you might want any outstanding requests to be |
274 | handled, but you would not want to keep C<EV::loop> from returning just |
521 | handled, but you would not want to keep C<EV::loop> from returning just |
275 | because you happen to have this long-running UDP port watcher. |
522 | because you happen to have this long-running UDP port watcher. |
276 | |
523 | |
277 | In this case you can clear the keepalive status, which means that even |
524 | In this case you can clear the keepalive status, which means that even |
278 | though your watcher is active, it won't keep C<EV::loop> from returning. |
525 | though your watcher is active, it won't keep C<EV::loop> from returning. |
279 | |
526 | |
280 | The initial value for keepalive is true (enabled), and you cna change it |
527 | The initial value for keepalive is true (enabled), and you can change it |
281 | any time. |
528 | any time. |
282 | |
529 | |
283 | Example: Register an I/O watcher for some UDP socket but do not keep the |
530 | Example: Register an I/O watcher for some UDP socket but do not keep the |
284 | event loop from running just because of that watcher. |
531 | event loop from running just because of that watcher. |
285 | |
532 | |
286 | my $udp_socket = ... |
533 | my $udp_socket = ... |
287 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
534 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
288 | $udp_watcher->keepalive (0); |
535 | $udp_watcher->keepalive (0); |
289 | |
536 | |
290 | =back |
537 | =item $loop = $w->loop |
291 | |
538 | |
|
|
539 | Return the loop that this watcher is attached to. |
292 | |
540 | |
|
|
541 | =back |
|
|
542 | |
|
|
543 | |
293 | =head2 WATCHER TYPES |
544 | =head1 WATCHER TYPES |
294 | |
545 | |
295 | Each of the following subsections describes a single watcher type. |
546 | Each of the following subsections describes a single watcher type. |
296 | |
547 | |
297 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
548 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
298 | |
549 | |
299 | =over 4 |
550 | =over 4 |
300 | |
551 | |
301 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
552 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
302 | |
553 | |
303 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
554 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
|
|
555 | |
|
|
556 | =item $w = $loop->io ($fileno_or_fh, $eventmask, $callback) |
|
|
557 | |
|
|
558 | =item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback) |
304 | |
559 | |
305 | As long as the returned watcher object is alive, call the C<$callback> |
560 | As long as the returned watcher object is alive, call the C<$callback> |
306 | when at least one of events specified in C<$eventmask> occurs. |
561 | when at least one of events specified in C<$eventmask> occurs. |
307 | |
562 | |
308 | The $eventmask can be one or more of these constants ORed together: |
563 | The $eventmask can be one or more of these constants ORed together: |
… | |
… | |
337 | =over 4 |
592 | =over 4 |
338 | |
593 | |
339 | =item $w = EV::timer $after, $repeat, $callback |
594 | =item $w = EV::timer $after, $repeat, $callback |
340 | |
595 | |
341 | =item $w = EV::timer_ns $after, $repeat, $callback |
596 | =item $w = EV::timer_ns $after, $repeat, $callback |
|
|
597 | |
|
|
598 | =item $w = $loop->timer ($after, $repeat, $callback) |
|
|
599 | |
|
|
600 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
342 | |
601 | |
343 | Calls the callback after C<$after> seconds (which may be fractional). If |
602 | Calls the callback after C<$after> seconds (which may be fractional). If |
344 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
603 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
345 | value as $after) after the callback returns. |
604 | value as $after) after the callback returns. |
346 | |
605 | |
… | |
… | |
387 | =over 4 |
646 | =over 4 |
388 | |
647 | |
389 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
648 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
390 | |
649 | |
391 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
650 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
|
|
651 | |
|
|
652 | =item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) |
|
|
653 | |
|
|
654 | =item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback) |
392 | |
655 | |
393 | Similar to EV::timer, but is not based on relative timeouts but on |
656 | Similar to EV::timer, but is not based on relative timeouts but on |
394 | absolute times. Apart from creating "simple" timers that trigger "at" the |
657 | absolute times. Apart from creating "simple" timers that trigger "at" the |
395 | specified time, it can also be used for non-drifting absolute timers and |
658 | specified time, it can also be used for non-drifting absolute timers and |
396 | more complex, cron-like, setups that are not adversely affected by time |
659 | more complex, cron-like, setups that are not adversely affected by time |
… | |
… | |
406 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
669 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
407 | will not adjust when a time jump occurs, that is, if it is to be run |
670 | will not adjust when a time jump occurs, that is, if it is to be run |
408 | at January 1st 2011 then it will run when the system time reaches or |
671 | at January 1st 2011 then it will run when the system time reaches or |
409 | surpasses this time. |
672 | surpasses this time. |
410 | |
673 | |
411 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
674 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
412 | |
675 | |
413 | In this mode the watcher will always be scheduled to time out at the |
676 | In this mode the watcher will always be scheduled to time out at the |
414 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
677 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
415 | regardless of any time jumps. |
678 | regardless of any time jumps. |
416 | |
679 | |
… | |
… | |
434 | time the periodic watcher gets scheduled, the reschedule callback |
697 | time the periodic watcher gets scheduled, the reschedule callback |
435 | ($reschedule_cb) will be called with the watcher as first, and the current |
698 | ($reschedule_cb) will be called with the watcher as first, and the current |
436 | time as second argument. |
699 | time as second argument. |
437 | |
700 | |
438 | I<This callback MUST NOT stop or destroy this or any other periodic |
701 | I<This callback MUST NOT stop or destroy this or any other periodic |
439 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
702 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
440 | afterwards. |
703 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
704 | and start a C<EV::prepare> watcher for this task. |
441 | |
705 | |
442 | It must return the next time to trigger, based on the passed time value |
706 | It must return the next time to trigger, based on the passed time value |
443 | (that is, the lowest time value larger than to the second argument). It |
707 | (that is, the lowest time value larger than or equal to to the second |
444 | will usually be called just before the callback will be triggered, but |
708 | argument). It will usually be called just before the callback will be |
445 | might be called at other times, too. |
709 | triggered, but might be called at other times, too. |
446 | |
710 | |
447 | This can be used to create very complex timers, such as a timer that |
711 | This can be used to create very complex timers, such as a timer that |
448 | triggers on each midnight, local time (actually 24 hours after the last |
712 | triggers on each midnight, local time (actually 24 hours after the last |
449 | midnight, to keep the example simple. If you know a way to do it correctly |
713 | midnight, to keep the example simple. If you know a way to do it correctly |
450 | in about the same space (without requiring elaborate modules), drop me a |
714 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
471 | |
735 | |
472 | =item $w->again |
736 | =item $w->again |
473 | |
737 | |
474 | Simply stops and starts the watcher again. |
738 | Simply stops and starts the watcher again. |
475 | |
739 | |
|
|
740 | =item $time = $w->at |
|
|
741 | |
|
|
742 | Return the time that the watcher is expected to trigger next. |
|
|
743 | |
476 | =back |
744 | =back |
477 | |
745 | |
478 | |
746 | |
479 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
747 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
480 | |
748 | |
481 | =over 4 |
749 | =over 4 |
482 | |
750 | |
483 | =item $w = EV::signal $signal, $callback |
751 | =item $w = EV::signal $signal, $callback |
484 | |
752 | |
485 | =item $w = EV::signal_ns $signal, $callback |
753 | =item $w = EV::signal_ns $signal, $callback |
|
|
754 | |
|
|
755 | =item $w = $loop->signal ($signal, $callback) |
|
|
756 | |
|
|
757 | =item $w = $loop->signal_ns ($signal, $callback) |
486 | |
758 | |
487 | Call the callback when $signal is received (the signal can be specified by |
759 | Call the callback when $signal is received (the signal can be specified by |
488 | number or by name, just as with C<kill> or C<%SIG>). |
760 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
761 | |
|
|
762 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
763 | signal from two EV loops will crash the program immediately or cause data |
|
|
764 | corruption. |
489 | |
765 | |
490 | EV will grab the signal for the process (the kernel only allows one |
766 | EV will grab the signal for the process (the kernel only allows one |
491 | component to receive a signal at a time) when you start a signal watcher, |
767 | component to receive a signal at a time) when you start a signal watcher, |
492 | and removes it again when you stop it. Perl does the same when you |
768 | and removes it again when you stop it. Perl does the same when you |
493 | add/remove callbacks to C<%SIG>, so watch out. |
769 | add/remove callbacks to C<%SIG>, so watch out. |
… | |
… | |
513 | |
789 | |
514 | =head3 CHILD WATCHERS - watch out for process status changes |
790 | =head3 CHILD WATCHERS - watch out for process status changes |
515 | |
791 | |
516 | =over 4 |
792 | =over 4 |
517 | |
793 | |
518 | =item $w = EV::child $pid, $callback |
794 | =item $w = EV::child $pid, $trace, $callback |
519 | |
795 | |
520 | =item $w = EV::child_ns $pid, $callback |
796 | =item $w = EV::child_ns $pid, $trace, $callback |
521 | |
797 | |
|
|
798 | =item $w = $loop->child ($pid, $trace, $callback) |
|
|
799 | |
|
|
800 | =item $w = $loop->child_ns ($pid, $trace, $callback) |
|
|
801 | |
522 | Call the callback when a status change for pid C<$pid> (or any pid if |
802 | Call the callback when a status change for pid C<$pid> (or any pid |
523 | C<$pid> is 0) has been received. More precisely: when the process receives |
803 | if C<$pid> is 0) has been received (a status change happens when the |
|
|
804 | process terminates or is killed, or, when trace is true, additionally when |
|
|
805 | it is stopped or continued). More precisely: when the process receives |
524 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
806 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
525 | changed/zombie children and call the callback. |
807 | changed/zombie children and call the callback. |
526 | |
808 | |
527 | It is valid (and fully supported) to install a child watcher after a child |
809 | It is valid (and fully supported) to install a child watcher after a child |
528 | has exited but before the event loop has started its next iteration (for |
810 | has exited but before the event loop has started its next iteration (for |
… | |
… | |
535 | You can have as many pid watchers per pid as you want, they will all be |
817 | You can have as many pid watchers per pid as you want, they will all be |
536 | called. |
818 | called. |
537 | |
819 | |
538 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
820 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
539 | |
821 | |
540 | =item $w->set ($pid) |
822 | =item $w->set ($pid, $trace) |
541 | |
823 | |
542 | Reconfigures the watcher, see the constructor above for details. Can be called at |
824 | Reconfigures the watcher, see the constructor above for details. Can be called at |
543 | any time. |
825 | any time. |
544 | |
826 | |
545 | =item $current_pid = $w->pid |
827 | =item $current_pid = $w->pid |
546 | |
828 | |
547 | =item $old_pid = $w->pid ($new_pid) |
|
|
548 | |
|
|
549 | Returns the previously set process id and optionally set a new one. |
829 | Returns the previously set process id and optionally set a new one. |
550 | |
830 | |
551 | =item $exit_status = $w->rstatus |
831 | =item $exit_status = $w->rstatus |
552 | |
832 | |
553 | Return the exit/wait status (as returned by waitpid, see the waitpid entry |
833 | Return the exit/wait status (as returned by waitpid, see the waitpid entry |
… | |
… | |
566 | =over 4 |
846 | =over 4 |
567 | |
847 | |
568 | =item $w = EV::stat $path, $interval, $callback |
848 | =item $w = EV::stat $path, $interval, $callback |
569 | |
849 | |
570 | =item $w = EV::stat_ns $path, $interval, $callback |
850 | =item $w = EV::stat_ns $path, $interval, $callback |
|
|
851 | |
|
|
852 | =item $w = $loop->stat ($path, $interval, $callback) |
|
|
853 | |
|
|
854 | =item $w = $loop->stat_ns ($path, $interval, $callback) |
571 | |
855 | |
572 | Call the callback when a file status change has been detected on |
856 | Call the callback when a file status change has been detected on |
573 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
857 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
574 | to "path does not exist" is a status change like any other. |
858 | to "path does not exist" is a status change like any other. |
575 | |
859 | |
… | |
… | |
645 | =over 4 |
929 | =over 4 |
646 | |
930 | |
647 | =item $w = EV::idle $callback |
931 | =item $w = EV::idle $callback |
648 | |
932 | |
649 | =item $w = EV::idle_ns $callback |
933 | =item $w = EV::idle_ns $callback |
|
|
934 | |
|
|
935 | =item $w = $loop->idle ($callback) |
|
|
936 | |
|
|
937 | =item $w = $loop->idle_ns ($callback) |
650 | |
938 | |
651 | Call the callback when there are no other pending watchers of the same or |
939 | Call the callback when there are no other pending watchers of the same or |
652 | higher priority (excluding check, prepare and other idle watchers of the |
940 | higher priority (excluding check, prepare and other idle watchers of the |
653 | same or lower priority, of course). They are called idle watchers because |
941 | same or lower priority, of course). They are called idle watchers because |
654 | when the watcher is the highest priority pending event in the process, the |
942 | when the watcher is the highest priority pending event in the process, the |
… | |
… | |
677 | |
965 | |
678 | =item $w = EV::prepare $callback |
966 | =item $w = EV::prepare $callback |
679 | |
967 | |
680 | =item $w = EV::prepare_ns $callback |
968 | =item $w = EV::prepare_ns $callback |
681 | |
969 | |
|
|
970 | =item $w = $loop->prepare ($callback) |
|
|
971 | |
|
|
972 | =item $w = $loop->prepare_ns ($callback) |
|
|
973 | |
682 | Call the callback just before the process would block. You can still |
974 | Call the callback just before the process would block. You can still |
683 | create/modify any watchers at this point. |
975 | create/modify any watchers at this point. |
684 | |
976 | |
685 | See the EV::check watcher, below, for explanations and an example. |
977 | See the EV::check watcher, below, for explanations and an example. |
686 | |
978 | |
… | |
… | |
695 | |
987 | |
696 | =item $w = EV::check $callback |
988 | =item $w = EV::check $callback |
697 | |
989 | |
698 | =item $w = EV::check_ns $callback |
990 | =item $w = EV::check_ns $callback |
699 | |
991 | |
|
|
992 | =item $w = $loop->check ($callback) |
|
|
993 | |
|
|
994 | =item $w = $loop->check_ns ($callback) |
|
|
995 | |
700 | Call the callback just after the process wakes up again (after it has |
996 | Call the callback just after the process wakes up again (after it has |
701 | gathered events), but before any other callbacks have been invoked. |
997 | gathered events), but before any other callbacks have been invoked. |
702 | |
998 | |
703 | This is used to integrate other event-based software into the EV |
999 | This can be used to integrate other event-based software into the EV |
704 | mainloop: You register a prepare callback and in there, you create io and |
1000 | mainloop: You register a prepare callback and in there, you create io and |
705 | timer watchers as required by the other software. Here is a real-world |
1001 | timer watchers as required by the other software. Here is a real-world |
706 | example of integrating Net::SNMP (with some details left out): |
1002 | example of integrating Net::SNMP (with some details left out): |
707 | |
1003 | |
708 | our @snmp_watcher; |
1004 | our @snmp_watcher; |
… | |
… | |
738 | # make the dispatcher handle any new stuff |
1034 | # make the dispatcher handle any new stuff |
739 | ... not shown |
1035 | ... not shown |
740 | }; |
1036 | }; |
741 | |
1037 | |
742 | The callbacks of the created watchers will not be called as the watchers |
1038 | The callbacks of the created watchers will not be called as the watchers |
743 | are destroyed before this cna happen (remember EV::check gets called |
1039 | are destroyed before this can happen (remember EV::check gets called |
744 | first). |
1040 | first). |
745 | |
1041 | |
746 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1042 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1043 | |
|
|
1044 | =item EV::CHECK constant issues |
|
|
1045 | |
|
|
1046 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1047 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1048 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1049 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1050 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1051 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1052 | safe side. |
747 | |
1053 | |
748 | =back |
1054 | =back |
749 | |
1055 | |
750 | |
1056 | |
751 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1057 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
758 | |
1064 | |
759 | =item $w = EV::fork $callback |
1065 | =item $w = EV::fork $callback |
760 | |
1066 | |
761 | =item $w = EV::fork_ns $callback |
1067 | =item $w = EV::fork_ns $callback |
762 | |
1068 | |
|
|
1069 | =item $w = $loop->fork ($callback) |
|
|
1070 | |
|
|
1071 | =item $w = $loop->fork_ns ($callback) |
|
|
1072 | |
763 | Call the callback before the event loop is resumed in the child process |
1073 | Call the callback before the event loop is resumed in the child process |
764 | after a fork. |
1074 | after a fork. |
765 | |
1075 | |
766 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
1076 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
767 | |
1077 | |
768 | =back |
1078 | =back |
|
|
1079 | |
|
|
1080 | |
|
|
1081 | =head3 EMBED WATCHERS - when one backend isn't enough... |
|
|
1082 | |
|
|
1083 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
1084 | into another (currently only IO events are supported in the embedded |
|
|
1085 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
1086 | fashion and must not be used). |
|
|
1087 | |
|
|
1088 | See the libev documentation at |
|
|
1089 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
|
|
1090 | (locally installed as F<EV::libev>) for more details. |
|
|
1091 | |
|
|
1092 | In short, this watcher is most useful on BSD systems without working |
|
|
1093 | kqueue to still be able to handle a large number of sockets: |
|
|
1094 | |
|
|
1095 | my $socket_loop; |
|
|
1096 | |
|
|
1097 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
|
|
1098 | if ( |
|
|
1099 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
|
|
1100 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
|
|
1101 | ) { |
|
|
1102 | # use kqueue for sockets |
|
|
1103 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
|
|
1104 | } |
|
|
1105 | |
|
|
1106 | # use the default loop otherwise |
|
|
1107 | $socket_loop ||= EV::default_loop; |
|
|
1108 | |
|
|
1109 | =over 4 |
|
|
1110 | |
|
|
1111 | =item $w = EV::embed $otherloop[, $callback] |
|
|
1112 | |
|
|
1113 | =item $w = EV::embed_ns $otherloop[, $callback] |
|
|
1114 | |
|
|
1115 | =item $w = $loop->embed ($otherloop[, $callback]) |
|
|
1116 | |
|
|
1117 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
|
|
1118 | |
|
|
1119 | Call the callback when the embedded event loop (C<$otherloop>) has any |
|
|
1120 | I/O activity. The C<$callback> is optional: if it is missing, then the |
|
|
1121 | embedded event loop will be managed automatically (which is recommended), |
|
|
1122 | otherwise you have to invoke C<sweep> yourself. |
|
|
1123 | |
|
|
1124 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1125 | |
|
|
1126 | =back |
|
|
1127 | |
|
|
1128 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
1129 | |
|
|
1130 | Async watchers are provided by EV, but have little use in perl directly, |
|
|
1131 | as perl neither supports threads running in parallel nor direct access to |
|
|
1132 | signal handlers or other contexts where they could be of value. |
|
|
1133 | |
|
|
1134 | It is, however, possible to use them from the XS level. |
|
|
1135 | |
|
|
1136 | Please see the libev documentation for further details. |
|
|
1137 | |
|
|
1138 | =over 4 |
|
|
1139 | |
|
|
1140 | =item $w = EV::async $callback |
|
|
1141 | |
|
|
1142 | =item $w = EV::async_ns $callback |
|
|
1143 | |
|
|
1144 | =item $w = $loop->async ($callback) |
|
|
1145 | |
|
|
1146 | =item $w = $loop->async_ns ($callback) |
|
|
1147 | |
|
|
1148 | =item $w->send |
|
|
1149 | |
|
|
1150 | =item $bool = $w->async_pending |
|
|
1151 | |
|
|
1152 | =back |
|
|
1153 | |
|
|
1154 | =head3 CLEANUP WATCHERS - how to clean up when the event loop goes away |
|
|
1155 | |
|
|
1156 | Cleanup watchers are not supported on the Perl level, they can only be |
|
|
1157 | used via XS currently. |
769 | |
1158 | |
770 | |
1159 | |
771 | =head1 PERL SIGNALS |
1160 | =head1 PERL SIGNALS |
772 | |
1161 | |
773 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1162 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
… | |
… | |
782 | to be called on every event loop iteration by installing a C<EV::check> |
1171 | to be called on every event loop iteration by installing a C<EV::check> |
783 | watcher: |
1172 | watcher: |
784 | |
1173 | |
785 | my $async_check = EV::check sub { }; |
1174 | my $async_check = EV::check sub { }; |
786 | |
1175 | |
787 | This ensures that perl shortly gets into control for a short time, and |
1176 | This ensures that perl gets into control for a short time to handle any |
788 | also ensures slower overall operation. |
1177 | pending signals, and also ensures (slightly) slower overall operation. |
789 | |
1178 | |
790 | =head1 THREADS |
1179 | =head1 ITHREADS |
791 | |
1180 | |
792 | Threads are not supported by this module in any way. Perl pseudo-threads |
1181 | Ithreads are not supported by this module in any way. Perl pseudo-threads |
793 | is evil stuff and must die. As soon as Perl gains real threads I will work |
1182 | is evil stuff and must die. Real threads as provided by Coro are fully |
794 | on thread support for it. |
1183 | supported (and enhanced support is available via L<Coro::EV>). |
795 | |
1184 | |
796 | =head1 FORK |
1185 | =head1 FORK |
797 | |
1186 | |
798 | Most of the "improved" event delivering mechanisms of modern operating |
1187 | Most of the "improved" event delivering mechanisms of modern operating |
799 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
1188 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
… | |
… | |
815 | our $DIED = sub { |
1204 | our $DIED = sub { |
816 | warn "EV: error in callback (ignoring): $@"; |
1205 | warn "EV: error in callback (ignoring): $@"; |
817 | }; |
1206 | }; |
818 | |
1207 | |
819 | default_loop |
1208 | default_loop |
820 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
1209 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?'; |
821 | |
1210 | |
822 | 1; |
1211 | 1; |
823 | |
1212 | |
824 | =head1 SEE ALSO |
1213 | =head1 SEE ALSO |
825 | |
1214 | |
|
|
1215 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
826 | L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1216 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
827 | event loop), L<Coro::EV> (efficient coroutines with EV). |
1217 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
|
|
1218 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1219 | event-loop agnostic and portable event driven programming. |
828 | |
1220 | |
829 | =head1 AUTHOR |
1221 | =head1 AUTHOR |
830 | |
1222 | |
831 | Marc Lehmann <schmorp@schmorp.de> |
1223 | Marc Lehmann <schmorp@schmorp.de> |
832 | http://home.schmorp.de/ |
1224 | http://home.schmorp.de/ |
833 | |
1225 | |
834 | =cut |
1226 | =cut |
835 | |
1227 | |