… | |
… | |
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 | |
|
|
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 = '2.0'; |
124 | our $VERSION = '4.03'; |
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 | |
91 | @EV::Loop::Default::ISA = "EV::Loop"; |
143 | @EV::Loop::Default::ISA = "EV::Loop"; |
92 | |
144 | |
93 | =head1 EVENT LOOPS |
145 | =head1 EVENT LOOPS |
… | |
… | |
104 | default loop as this is fastest (perl-wise), best supported by other |
156 | default loop as this is fastest (perl-wise), best supported by other |
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
157 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
106 | |
158 | |
107 | For specific programs you can create additional event loops dynamically. |
159 | For specific programs you can create additional event loops dynamically. |
108 | |
160 | |
109 | =over 4 |
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. |
110 | |
166 | |
|
|
167 | =over 4 |
|
|
168 | |
111 | =item $loop = new EV::loop [$flags] |
169 | =item $loop = new EV::Loop [$flags] |
112 | |
170 | |
113 | Create a new event loop as per the specified flags. Please refer to the |
171 | Create a new event loop as per the specified flags. Please refer to |
114 | C<ev_loop_new ()> function description in the libev documentation |
172 | 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>) |
173 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
116 | for more info. |
174 | or locally-installed as F<EV::libev> manpage) for more info. |
117 | |
175 | |
118 | The loop will automatically be destroyed when it is no longer referenced |
176 | The loop will automatically be destroyed when it is no longer referenced |
119 | by any watcher and the loop object goes out of scope. |
177 | by any watcher and the loop object goes out of scope. |
120 | |
178 | |
121 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
179 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
122 | is protected by this module. |
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. |
123 | |
183 | |
124 | =item $loop->loop_fork |
184 | =item $loop->loop_fork |
125 | |
185 | |
126 | Must be called after a fork in the child, before entering or continuing |
186 | 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 |
187 | 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 |
188 | this function automatically, at some performance loss (refer to the libev |
129 | documentation). |
189 | documentation). |
130 | |
190 | |
|
|
191 | =item $loop->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 | |
131 | =item $loop = EV::default_loop [$flags] |
197 | =item $loop = EV::default_loop [$flags] |
132 | |
198 | |
133 | Return the default loop (which is a singleton object). |
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. |
134 | |
204 | |
135 | =back |
205 | =back |
136 | |
206 | |
137 | |
207 | |
138 | =head1 BASIC INTERFACE |
208 | =head1 BASIC INTERFACE |
… | |
… | |
155 | |
225 | |
156 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
226 | 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 |
227 | 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). |
228 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
159 | |
229 | |
|
|
230 | =item EV::sleep $seconds |
|
|
231 | |
|
|
232 | Block the process for the given number of (fractional) seconds. |
|
|
233 | |
160 | =item $time = EV::time |
234 | =item $time = EV::time |
161 | |
235 | |
162 | Returns the current time in (fractional) seconds since the epoch. |
236 | Returns the current time in (fractional) seconds since the epoch. |
163 | |
237 | |
164 | =item $time = EV::now |
238 | =item $time = EV::now |
165 | |
239 | |
166 | =item $time = $loop->now |
240 | =item $time = $loop->now |
167 | |
241 | |
168 | 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 |
169 | 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 |
170 | usually faster then calling EV::time. |
244 | usually faster then calling EV::time. |
171 | |
245 | |
|
|
246 | =item EV::now_update |
|
|
247 | |
|
|
248 | =item $loop->now_update |
|
|
249 | |
|
|
250 | Establishes the current time by querying the kernel, updating the time |
|
|
251 | returned by C<EV::now> in the progress. This is a costly operation and |
|
|
252 | is usually done automatically within C<EV::loop>. |
|
|
253 | |
|
|
254 | This function is rarely useful, but when some event callback runs for a |
|
|
255 | very long time without entering the event loop, updating libev's idea of |
|
|
256 | the current time is a good idea. |
|
|
257 | |
|
|
258 | =item EV::suspend |
|
|
259 | |
|
|
260 | =item $loop->suspend |
|
|
261 | |
|
|
262 | =item EV::resume |
|
|
263 | |
|
|
264 | =item $loop->resume |
|
|
265 | |
|
|
266 | These two functions suspend and resume a loop, for use when the loop is |
|
|
267 | not used for a while and timeouts should not be processed. |
|
|
268 | |
|
|
269 | A typical use case would be an interactive program such as a game: When |
|
|
270 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
271 | would be best to handle timeouts as if no time had actually passed while |
|
|
272 | the program was suspended. This can be achieved by calling C<suspend> |
|
|
273 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
274 | C<resume> directly afterwards to resume timer processing. |
|
|
275 | |
|
|
276 | Effectively, all C<timer> watchers will be delayed by the time spend |
|
|
277 | between C<suspend> and C<resume>, and all C<periodic> watchers |
|
|
278 | will be rescheduled (that is, they will lose any events that would have |
|
|
279 | occured while suspended). |
|
|
280 | |
|
|
281 | After calling C<suspend> you B<must not> call I<any> function on the given |
|
|
282 | loop other than C<resume>, and you B<must not> call C<resume> |
|
|
283 | without a previous call to C<suspend>. |
|
|
284 | |
|
|
285 | Calling C<suspend>/C<resume> has the side effect of updating the event |
|
|
286 | loop time (see C<now_update>). |
|
|
287 | |
172 | =item $backend = EV::backend |
288 | =item $backend = EV::backend |
173 | |
289 | |
174 | =item $backend = $loop->backend |
290 | =item $backend = $loop->backend |
175 | |
291 | |
176 | 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 |
177 | or EV::METHOD_EPOLL). |
293 | or EV::BACKEND_EPOLL). |
178 | |
294 | |
179 | =item EV::loop [$flags] |
295 | =item EV::loop [$flags] |
180 | |
296 | |
181 | =item $loop->loop ([$flags]) |
297 | =item $loop->loop ([$flags]) |
182 | |
298 | |
183 | Begin checking for events and calling callbacks. It returns when a |
299 | Begin checking for events and calling callbacks. It returns when a |
184 | callback calls EV::unloop. |
300 | callback calls EV::unloop. |
185 | |
301 | |
186 | The $flags argument can be one of the following: |
302 | The $flags argument can be one of the following: |
187 | |
303 | |
188 | 0 as above |
304 | 0 as above |
189 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
305 | EV::LOOP_ONCE block at most once (wait, but do not loop) |
190 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
306 | EV::LOOP_NOWAIT do not block at all (fetch/handle events but do not wait) |
191 | |
307 | |
192 | =item EV::unloop [$how] |
308 | =item EV::break [$how] |
193 | |
309 | |
194 | =item $loop->unloop ([$how]) |
310 | =item $loop->break ([$how]) |
195 | |
311 | |
196 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
312 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
197 | innermost call to EV::loop return. |
313 | innermost call to EV::loop return. |
198 | |
314 | |
199 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
315 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop will |
200 | fast as possible. |
316 | return as fast as possible. |
|
|
317 | |
|
|
318 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
319 | be cancelled. |
201 | |
320 | |
202 | =item $count = EV::loop_count |
321 | =item $count = EV::loop_count |
203 | |
322 | |
204 | =item $count = $loop->loop_count |
323 | =item $count = $loop->loop_count |
205 | |
324 | |
206 | Return the number of times the event loop has polled for new |
325 | Return the number of times the event loop has polled for new |
207 | events. Sometiems useful as a generation counter. |
326 | events. Sometimes useful as a generation counter. |
208 | |
327 | |
209 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
328 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
210 | |
329 | |
211 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
330 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
212 | |
331 | |
… | |
… | |
223 | timeout. Otherwise a EV::timer with this value will be started. |
342 | timeout. Otherwise a EV::timer with this value will be started. |
224 | |
343 | |
225 | When an error occurs or either the timeout or I/O watcher triggers, then |
344 | When an error occurs or either the timeout or I/O watcher triggers, then |
226 | the callback will be called with the received event set (in general |
345 | the callback will be called with the received event set (in general |
227 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
346 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
228 | C<EV::WRITE> and C<EV::TIMEOUT>). |
347 | C<EV::WRITE> and C<EV::TIMER>). |
229 | |
348 | |
230 | EV::once doesn't return anything: the watchers stay active till either |
349 | EV::once doesn't return anything: the watchers stay active till either |
231 | of them triggers, then they will be stopped and freed, and the callback |
350 | of them triggers, then they will be stopped and freed, and the callback |
232 | invoked. |
351 | invoked. |
233 | |
352 | |
234 | =item EV::feed_fd_event ($fd, $revents) |
353 | =item EV::feed_fd_event $fd, $revents |
235 | |
354 | |
236 | =item $loop->feed_fd_event ($fd, $revents) |
355 | =item $loop->feed_fd_event ($fd, $revents) |
237 | |
356 | |
238 | Feed an event on a file descriptor into EV. EV will react to this call as |
357 | Feed an event on a file descriptor into EV. EV will react to this call as |
239 | if the readyness notifications specified by C<$revents> (a combination of |
358 | if the readyness notifications specified by C<$revents> (a combination of |
240 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
359 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
241 | |
360 | |
242 | =item EV::feed_signal_event ($signal) |
361 | =item EV::feed_signal_event $signal |
243 | |
362 | |
244 | Feed a signal event into EV. EV will react to this call as if the signal |
363 | Feed a signal event into the default loop. EV will react to this call as |
245 | specified by C<$signal> had occured. |
364 | if the signal specified by C<$signal> had occured. |
|
|
365 | |
|
|
366 | =item EV::feed_signal $signal |
|
|
367 | |
|
|
368 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
|
|
369 | regardless of which loop has registered the signal, and is mainly useful |
|
|
370 | fro custom signal implementations. |
246 | |
371 | |
247 | =item EV::set_io_collect_interval $time |
372 | =item EV::set_io_collect_interval $time |
248 | |
373 | |
249 | =item $loop->set_io_collect_interval ($time) |
374 | =item $loop->set_io_collect_interval ($time) |
250 | |
375 | |
… | |
… | |
252 | |
377 | |
253 | =item $loop->set_timeout_collect_interval ($time) |
378 | =item $loop->set_timeout_collect_interval ($time) |
254 | |
379 | |
255 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
380 | 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 |
381 | 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 |
382 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
258 | a more detailed discussion. |
383 | (locally installed as F<EV::libev>) for a more detailed discussion. |
|
|
384 | |
|
|
385 | =item $count = EV::pending_count |
|
|
386 | |
|
|
387 | =item $count = $loop->pending_count |
|
|
388 | |
|
|
389 | Returns the number of currently pending watchers. |
|
|
390 | |
|
|
391 | =item EV::invoke_pending |
|
|
392 | |
|
|
393 | =item $loop->invoke_pending |
|
|
394 | |
|
|
395 | Invoke all currently pending watchers. |
259 | |
396 | |
260 | =back |
397 | =back |
261 | |
398 | |
262 | |
399 | |
263 | =head1 WATCHER OBJECTS |
400 | =head1 WATCHER OBJECTS |
264 | |
401 | |
265 | A watcher is an object that gets created to record your interest in some |
402 | 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 |
403 | event. For instance, if you want to wait for STDIN to become readable, you |
267 | would create an EV::io watcher for that: |
404 | would create an EV::io watcher for that: |
268 | |
405 | |
269 | my $watcher = EV::io *STDIN, EV::READ, sub { |
406 | my $watcher = EV::io *STDIN, EV::READ, sub { |
270 | my ($watcher, $revents) = @_; |
407 | my ($watcher, $revents) = @_; |
271 | warn "yeah, STDIN should now be readable without blocking!\n" |
408 | warn "yeah, STDIN should now be readable without blocking!\n" |
272 | }; |
409 | }; |
273 | |
410 | |
274 | All watchers can be active (waiting for events) or inactive (paused). Only |
411 | All watchers can be active (waiting for events) or inactive (paused). Only |
275 | active watchers will have their callbacks invoked. All callbacks will be |
412 | 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 |
413 | called with at least two arguments: the watcher and a bitmask of received |
277 | events. |
414 | events. |
278 | |
415 | |
279 | Each watcher type has its associated bit in revents, so you can use the |
416 | 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 |
417 | 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, |
418 | 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 |
419 | 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 |
420 | (which can set both EV::READ and EV::WRITE bits). |
284 | uses EV::TIMEOUT). |
|
|
285 | |
421 | |
286 | In the rare case where one wants to create a watcher but not start it at |
422 | In the rare case where one wants to create a watcher but not start it at |
287 | the same time, each constructor has a variant with a trailing C<_ns> in |
423 | the same time, each constructor has a variant with a trailing C<_ns> in |
288 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
424 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
289 | |
425 | |
… | |
… | |
368 | |
504 | |
369 | =item $previous_state = $w->keepalive ($bool) |
505 | =item $previous_state = $w->keepalive ($bool) |
370 | |
506 | |
371 | Normally, C<EV::loop> will return when there are no active watchers |
507 | Normally, C<EV::loop> will return when there are no active watchers |
372 | (which is a "deadlock" because no progress can be made anymore). This is |
508 | (which is a "deadlock" because no progress can be made anymore). This is |
373 | convinient because it allows you to start your watchers (and your jobs), |
509 | convenient because it allows you to start your watchers (and your jobs), |
374 | call C<EV::loop> once and when it returns you know that all your jobs are |
510 | call C<EV::loop> once and when it returns you know that all your jobs are |
375 | finished (or they forgot to register some watchers for their task :). |
511 | finished (or they forgot to register some watchers for their task :). |
376 | |
512 | |
377 | Sometimes, however, this gets in your way, for example when the module |
513 | Sometimes, however, this gets in your way, for example when the module |
378 | that calls C<EV::loop> (usually the main program) is not the same module |
514 | that calls C<EV::loop> (usually the main program) is not the same module |
… | |
… | |
382 | because you happen to have this long-running UDP port watcher. |
518 | because you happen to have this long-running UDP port watcher. |
383 | |
519 | |
384 | In this case you can clear the keepalive status, which means that even |
520 | 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. |
521 | though your watcher is active, it won't keep C<EV::loop> from returning. |
386 | |
522 | |
387 | The initial value for keepalive is true (enabled), and you cna change it |
523 | The initial value for keepalive is true (enabled), and you can change it |
388 | any time. |
524 | any time. |
389 | |
525 | |
390 | Example: Register an I/O watcher for some UDP socket but do not keep the |
526 | 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. |
527 | event loop from running just because of that watcher. |
392 | |
528 | |
393 | my $udp_socket = ... |
529 | my $udp_socket = ... |
394 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
530 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
395 | $1000udp_watcher->keepalive (0); |
531 | $udp_watcher->keepalive (0); |
396 | |
532 | |
397 | =item $loop = $w->loop |
533 | =item $loop = $w->loop |
398 | |
534 | |
399 | Return the loop that this watcher is attached to. |
535 | Return the loop that this watcher is attached to. |
400 | |
536 | |
… | |
… | |
529 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
665 | 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 |
666 | 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 |
667 | at January 1st 2011 then it will run when the system time reaches or |
532 | surpasses this time. |
668 | surpasses this time. |
533 | |
669 | |
534 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
670 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
535 | |
671 | |
536 | In this mode the watcher will always be scheduled to time out at the |
672 | 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, |
673 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
538 | regardless of any time jumps. |
674 | regardless of any time jumps. |
539 | |
675 | |
… | |
… | |
557 | time the periodic watcher gets scheduled, the reschedule callback |
693 | time the periodic watcher gets scheduled, the reschedule callback |
558 | ($reschedule_cb) will be called with the watcher as first, and the current |
694 | ($reschedule_cb) will be called with the watcher as first, and the current |
559 | time as second argument. |
695 | time as second argument. |
560 | |
696 | |
561 | I<This callback MUST NOT stop or destroy this or any other periodic |
697 | 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 |
698 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
563 | afterwards. |
699 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
700 | and start a C<EV::prepare> watcher for this task. |
564 | |
701 | |
565 | It must return the next time to trigger, based on the passed time value |
702 | 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 |
703 | (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 |
704 | argument). It will usually be called just before the callback will be |
568 | might be called at other times, too. |
705 | triggered, but might be called at other times, too. |
569 | |
706 | |
570 | This can be used to create very complex timers, such as a timer that |
707 | 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 |
708 | 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 |
709 | 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 |
710 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
609 | |
746 | |
610 | =item $w = EV::signal $signal, $callback |
747 | =item $w = EV::signal $signal, $callback |
611 | |
748 | |
612 | =item $w = EV::signal_ns $signal, $callback |
749 | =item $w = EV::signal_ns $signal, $callback |
613 | |
750 | |
|
|
751 | =item $w = $loop->signal ($signal, $callback) |
|
|
752 | |
|
|
753 | =item $w = $loop->signal_ns ($signal, $callback) |
|
|
754 | |
614 | Call the callback when $signal is received (the signal can be specified by |
755 | Call the callback when $signal is received (the signal can be specified by |
615 | number or by name, just as with C<kill> or C<%SIG>). |
756 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
757 | |
|
|
758 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
759 | signal from two EV loops will crash the program immediately or cause data |
|
|
760 | corruption. |
616 | |
761 | |
617 | EV will grab the signal for the process (the kernel only allows one |
762 | EV will grab the signal for the process (the kernel only allows one |
618 | component to receive a signal at a time) when you start a signal watcher, |
763 | component to receive a signal at a time) when you start a signal watcher, |
619 | and removes it again when you stop it. Perl does the same when you |
764 | and removes it again when you stop it. Perl does the same when you |
620 | add/remove callbacks to C<%SIG>, so watch out. |
765 | add/remove callbacks to C<%SIG>, so watch out. |
… | |
… | |
640 | |
785 | |
641 | =head3 CHILD WATCHERS - watch out for process status changes |
786 | =head3 CHILD WATCHERS - watch out for process status changes |
642 | |
787 | |
643 | =over 4 |
788 | =over 4 |
644 | |
789 | |
645 | =item $w = EV::child $pid, $callback |
790 | =item $w = EV::child $pid, $trace, $callback |
646 | |
791 | |
647 | =item $w = EV::child_ns $pid, $callback |
792 | =item $w = EV::child_ns $pid, $trace, $callback |
648 | |
793 | |
649 | =item $w = $loop->child ($pid, $callback) |
794 | =item $w = $loop->child ($pid, $trace, $callback) |
650 | |
795 | |
651 | =item $w = $loop->child_ns ($pid, $callback) |
796 | =item $w = $loop->child_ns ($pid, $trace, $callback) |
652 | |
797 | |
653 | Call the callback when a status change for pid C<$pid> (or any pid if |
798 | 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 |
799 | if C<$pid> is 0) has been received (a status change happens when the |
|
|
800 | process terminates or is killed, or, when trace is true, additionally when |
|
|
801 | 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 |
802 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
656 | changed/zombie children and call the callback. |
803 | changed/zombie children and call the callback. |
657 | |
804 | |
658 | It is valid (and fully supported) to install a child watcher after a child |
805 | 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 |
806 | 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 |
813 | You can have as many pid watchers per pid as you want, they will all be |
667 | called. |
814 | called. |
668 | |
815 | |
669 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
816 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
670 | |
817 | |
671 | =item $w->set ($pid) |
818 | =item $w->set ($pid, $trace) |
672 | |
819 | |
673 | Reconfigures the watcher, see the constructor above for details. Can be called at |
820 | Reconfigures the watcher, see the constructor above for details. Can be called at |
674 | any time. |
821 | any time. |
675 | |
822 | |
676 | =item $current_pid = $w->pid |
823 | =item $current_pid = $w->pid |
677 | |
|
|
678 | =item $old_pid = $w->pid ($new_pid) |
|
|
679 | |
824 | |
680 | Returns the previously set process id and optionally set a new one. |
825 | Returns the previously set process id and optionally set a new one. |
681 | |
826 | |
682 | =item $exit_status = $w->rstatus |
827 | =item $exit_status = $w->rstatus |
683 | |
828 | |
… | |
… | |
845 | =item $w = $loop->check_ns ($callback) |
990 | =item $w = $loop->check_ns ($callback) |
846 | |
991 | |
847 | Call the callback just after the process wakes up again (after it has |
992 | Call the callback just after the process wakes up again (after it has |
848 | gathered events), but before any other callbacks have been invoked. |
993 | gathered events), but before any other callbacks have been invoked. |
849 | |
994 | |
850 | This is used to integrate other event-based software into the EV |
995 | This can be used to integrate other event-based software into the EV |
851 | mainloop: You register a prepare callback and in there, you create io and |
996 | mainloop: You register a prepare callback and in there, you create io and |
852 | timer watchers as required by the other software. Here is a real-world |
997 | timer watchers as required by the other software. Here is a real-world |
853 | example of integrating Net::SNMP (with some details left out): |
998 | example of integrating Net::SNMP (with some details left out): |
854 | |
999 | |
855 | our @snmp_watcher; |
1000 | our @snmp_watcher; |
… | |
… | |
885 | # make the dispatcher handle any new stuff |
1030 | # make the dispatcher handle any new stuff |
886 | ... not shown |
1031 | ... not shown |
887 | }; |
1032 | }; |
888 | |
1033 | |
889 | The callbacks of the created watchers will not be called as the watchers |
1034 | 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 |
1035 | are destroyed before this can happen (remember EV::check gets called |
891 | first). |
1036 | first). |
892 | |
1037 | |
893 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1038 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1039 | |
|
|
1040 | =item EV::CHECK constant issues |
|
|
1041 | |
|
|
1042 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1043 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1044 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1045 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1046 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1047 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1048 | safe side. |
894 | |
1049 | |
895 | =back |
1050 | =back |
896 | |
1051 | |
897 | |
1052 | |
898 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1053 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
926 | loop, other types of watchers might be handled in a delayed or incorrect |
1081 | loop, other types of watchers might be handled in a delayed or incorrect |
927 | fashion and must not be used). |
1082 | fashion and must not be used). |
928 | |
1083 | |
929 | See the libev documentation at |
1084 | 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_> |
1085 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
931 | for more details. |
1086 | (locally installed as F<EV::libev>) for more details. |
932 | |
1087 | |
933 | In short, this watcher is most useful on BSD systems without working |
1088 | 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: |
1089 | kqueue to still be able to handle a large number of sockets: |
935 | |
1090 | |
936 | my $socket_loop; |
1091 | my $socket_loop; |
937 | |
1092 | |
938 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
1093 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
939 | if ( |
1094 | if ( |
940 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
1095 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
941 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
1096 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
942 | ) { |
1097 | ) { |
943 | # use kqueue for sockets |
1098 | # use kqueue for sockets |
944 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
1099 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
945 | } |
1100 | } |
946 | |
1101 | |
947 | # use the default loop otherwise |
1102 | # use the default loop otherwise |
948 | $socket_loop ||= EV::default_loop; |
1103 | $socket_loop ||= EV::default_loop; |
949 | |
1104 | |
950 | =over 4 |
1105 | =over 4 |
951 | |
1106 | |
952 | =item $w = EV::embed $otherloop, $callback |
1107 | =item $w = EV::embed $otherloop[, $callback] |
953 | |
1108 | |
954 | =item $w = EV::embed_ns $otherloop, $callback |
1109 | =item $w = EV::embed_ns $otherloop[, $callback] |
955 | |
1110 | |
956 | =item $w = $loop->embed ($otherloop, $callback) |
1111 | =item $w = $loop->embed ($otherloop[, $callback]) |
957 | |
1112 | |
958 | =item $w = $loop->embed_ns ($otherloop, $callback) |
1113 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
959 | |
1114 | |
960 | Call the callback when the embedded event loop (C<$otherloop>) has any |
1115 | 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 |
1116 | 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 |
1117 | embedded event loop will be managed automatically (which is recommended), |
963 | automatically. |
1118 | otherwise you have to invoke C<sweep> yourself. |
964 | |
1119 | |
965 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
1120 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1121 | |
|
|
1122 | =back |
|
|
1123 | |
|
|
1124 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
1125 | |
|
|
1126 | Async watchers are provided by EV, but have little use in perl directly, |
|
|
1127 | as perl neither supports threads running in parallel nor direct access to |
|
|
1128 | signal handlers or other contexts where they could be of value. |
|
|
1129 | |
|
|
1130 | It is, however, possible to use them from the XS level. |
|
|
1131 | |
|
|
1132 | Please see the libev documentation for further details. |
|
|
1133 | |
|
|
1134 | =over 4 |
|
|
1135 | |
|
|
1136 | =item $w = EV::async $callback |
|
|
1137 | |
|
|
1138 | =item $w = EV::async_ns $callback |
|
|
1139 | |
|
|
1140 | =item $w->send |
|
|
1141 | |
|
|
1142 | =item $bool = $w->async_pending |
966 | |
1143 | |
967 | =back |
1144 | =back |
968 | |
1145 | |
969 | |
1146 | |
970 | =head1 PERL SIGNALS |
1147 | =head1 PERL SIGNALS |
… | |
… | |
984 | my $async_check = EV::check sub { }; |
1161 | my $async_check = EV::check sub { }; |
985 | |
1162 | |
986 | This ensures that perl gets into control for a short time to handle any |
1163 | This ensures that perl gets into control for a short time to handle any |
987 | pending signals, and also ensures (slightly) slower overall operation. |
1164 | pending signals, and also ensures (slightly) slower overall operation. |
988 | |
1165 | |
989 | =head1 THREADS |
1166 | =head1 ITHREADS |
990 | |
1167 | |
991 | Threads are not supported by this module in any way. Perl pseudo-threads |
1168 | Ithreads are not supported by this module in any way. Perl pseudo-threads |
992 | is evil stuff and must die. As soon as Perl gains real threads I will work |
1169 | is evil stuff and must die. Real threads as provided by Coro are fully |
993 | on thread support for it. |
1170 | supported (and enhanced support is available via L<Coro::EV>). |
994 | |
1171 | |
995 | =head1 FORK |
1172 | =head1 FORK |
996 | |
1173 | |
997 | Most of the "improved" event delivering mechanisms of modern operating |
1174 | Most of the "improved" event delivering mechanisms of modern operating |
998 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
1175 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
… | |
… | |
1020 | |
1197 | |
1021 | 1; |
1198 | 1; |
1022 | |
1199 | |
1023 | =head1 SEE ALSO |
1200 | =head1 SEE ALSO |
1024 | |
1201 | |
|
|
1202 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1025 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1203 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1026 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1204 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1027 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1205 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1206 | event-loop agnostic and portable event driven programming. |
1028 | |
1207 | |
1029 | =head1 AUTHOR |
1208 | =head1 AUTHOR |
1030 | |
1209 | |
1031 | Marc Lehmann <schmorp@schmorp.de> |
1210 | Marc Lehmann <schmorp@schmorp.de> |
1032 | http://home.schmorp.de/ |
1211 | http://home.schmorp.de/ |
1033 | |
1212 | |
1034 | =cut |
1213 | =cut |
1035 | |
1214 | |