| … | |
… | |
| 2 | EV - perl interface to libev, a high performance full-featured event |
2 | EV - perl interface to libev, a high performance full-featured event |
| 3 | loop |
3 | loop |
| 4 | |
4 | |
| 5 | SYNOPSIS |
5 | SYNOPSIS |
| 6 | use EV; |
6 | use EV; |
| 7 | |
7 | |
| 8 | # TIMERS |
8 | # TIMERS |
| 9 | |
9 | |
| 10 | my $w = EV::timer 2, 0, sub { |
10 | my $w = EV::timer 2, 0, sub { |
| 11 | warn "is called after 2s"; |
11 | warn "is called after 2s"; |
| 12 | }; |
12 | }; |
| 13 | |
13 | |
| 14 | my $w = EV::timer 2, 2, sub { |
14 | my $w = EV::timer 2, 2, sub { |
| 15 | warn "is called roughly every 2s (repeat = 2)"; |
15 | warn "is called roughly every 2s (repeat = 2)"; |
| 16 | }; |
16 | }; |
| 17 | |
17 | |
| 18 | undef $w; # destroy event watcher again |
18 | undef $w; # destroy event watcher again |
| 19 | |
19 | |
| 20 | my $w = EV::periodic 0, 60, 0, sub { |
20 | my $w = EV::periodic 0, 60, 0, sub { |
| 21 | warn "is called every minute, on the minute, exactly"; |
21 | warn "is called every minute, on the minute, exactly"; |
| 22 | }; |
22 | }; |
|
|
23 | |
| 23 | |
24 | # IO |
| 24 | # IO |
25 | |
| 25 | |
|
|
| 26 | my $w = EV::io *STDIN, EV::READ, sub { |
26 | my $w = EV::io *STDIN, EV::READ, sub { |
| 27 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
27 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
| 28 | warn "stdin is readable, you entered: ", <STDIN>; |
28 | warn "stdin is readable, you entered: ", <STDIN>; |
| 29 | }; |
29 | }; |
| 30 | |
30 | |
| 31 | # SIGNALS |
31 | # SIGNALS |
| 32 | |
32 | |
| 33 | my $w = EV::signal 'QUIT', sub { |
33 | my $w = EV::signal 'QUIT', sub { |
| 34 | warn "sigquit received\n"; |
34 | warn "sigquit received\n"; |
| 35 | }; |
35 | }; |
| 36 | |
36 | |
| 37 | # CHILD/PID STATUS CHANGES |
37 | # CHILD/PID STATUS CHANGES |
| 38 | |
38 | |
| 39 | my $w = EV::child 666, 0, sub { |
39 | my $w = EV::child 666, 0, sub { |
| 40 | my ($w, $revents) = @_; |
40 | my ($w, $revents) = @_; |
| 41 | my $status = $w->rstatus; |
41 | my $status = $w->rstatus; |
| 42 | }; |
42 | }; |
| 43 | |
43 | |
| 44 | # STAT CHANGES |
44 | # STAT CHANGES |
| 45 | my $w = EV::stat "/etc/passwd", 10, sub { |
45 | my $w = EV::stat "/etc/passwd", 10, sub { |
| 46 | my ($w, $revents) = @_; |
46 | my ($w, $revents) = @_; |
| 47 | warn $w->path, " has changed somehow.\n"; |
47 | warn $w->path, " has changed somehow.\n"; |
| 48 | }; |
48 | }; |
| 49 | |
49 | |
| 50 | # MAINLOOP |
50 | # MAINLOOP |
| 51 | EV::loop; # loop until EV::unloop is called or all watchers stop |
51 | EV::run; # loop until EV::unloop is called or all watchers stop |
| 52 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
52 | EV::run EV::RUN_ONCE; # block until at least one event could be handled |
| 53 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
53 | EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block |
|
|
54 | |
|
|
55 | BEFORE YOU START USING THIS MODULE |
|
|
56 | If you only need timer, I/O, signal, child and idle watchers and not the |
|
|
57 | advanced functionality of this module, consider using AnyEvent instead, |
|
|
58 | specifically the simplified API described in AE. |
|
|
59 | |
|
|
60 | When used with EV as backend, the AE API is as fast as the native EV |
|
|
61 | API, but your programs/modules will still run with many other event |
|
|
62 | loops. |
| 54 | |
63 | |
| 55 | DESCRIPTION |
64 | DESCRIPTION |
| 56 | This module provides an interface to libev |
65 | This module provides an interface to libev |
| 57 | (<http://software.schmorp.de/pkg/libev.html>). While the documentation |
66 | (<http://software.schmorp.de/pkg/libev.html>). While the documentation |
| 58 | below is comprehensive, one might also consult the documentation of |
67 | below is comprehensive, one might also consult the documentation of |
| … | |
… | |
| 66 | can use it through the AnyEvent module, stay portable to other event |
75 | can use it through the AnyEvent module, stay portable to other event |
| 67 | loops (if you don't rely on any watcher types not available through it) |
76 | loops (if you don't rely on any watcher types not available through it) |
| 68 | and still be faster than with any other event loop currently supported |
77 | and still be faster than with any other event loop currently supported |
| 69 | in Perl. |
78 | in Perl. |
| 70 | |
79 | |
|
|
80 | PORTING FROM EV 3.X to 4.X |
|
|
81 | EV version 4 introduces a number of incompatible changes summarised |
|
|
82 | here. According to the depreciation strategy used by libev, there is a |
|
|
83 | compatibility layer in place so programs should continue to run |
|
|
84 | unchanged (the XS interface lacks this layer, so programs using that one |
|
|
85 | need to be updated). |
|
|
86 | |
|
|
87 | This compatibility layer will be switched off in some future release. |
|
|
88 | |
|
|
89 | All changes relevant to Perl are renames of symbols, functions and |
|
|
90 | methods: |
|
|
91 | |
|
|
92 | EV::loop => EV::run |
|
|
93 | EV::LOOP_NONBLOCK => EV::RUN_NOWAIT |
|
|
94 | EV::LOOP_ONESHOT => EV::RUN_ONCE |
|
|
95 | |
|
|
96 | EV::unloop => EV::break |
|
|
97 | EV::UNLOOP_CANCEL => EV::BREAK_CANCEL |
|
|
98 | EV::UNLOOP_ONE => EV::BREAK_ONE |
|
|
99 | EV::UNLOOP_ALL => EV::BREAK_ALL |
|
|
100 | |
|
|
101 | EV::TIMEOUT => EV::TIMER |
|
|
102 | |
|
|
103 | EV::loop_count => EV::iteration |
|
|
104 | EV::loop_depth => EV::depth |
|
|
105 | EV::loop_verify => EV::verify |
|
|
106 | |
|
|
107 | The loop object methods corresponding to the functions above have been |
|
|
108 | similarly renamed. |
|
|
109 | |
| 71 | MODULE EXPORTS |
110 | MODULE EXPORTS |
| 72 | This module does not export any symbols. |
111 | This module does not export any symbols. |
| 73 | |
112 | |
| 74 | EVENT LOOPS |
113 | EVENT LOOPS |
| 75 | EV supports multiple event loops: There is a single "default event loop" |
114 | EV supports multiple event loops: There is a single "default event loop" |
| … | |
… | |
| 91 | *embed* a kqueue loop into the default loop: running the default loop |
130 | *embed* a kqueue loop into the default loop: running the default loop |
| 92 | will then also service the kqueue loop to some extent. See the example |
131 | will then also service the kqueue loop to some extent. See the example |
| 93 | in the section about embed watchers for an example on how to achieve |
132 | in the section about embed watchers for an example on how to achieve |
| 94 | that. |
133 | that. |
| 95 | |
134 | |
| 96 | $loop = new EV::loop [$flags] |
135 | $loop = new EV::Loop [$flags] |
| 97 | Create a new event loop as per the specified flags. Please refer to |
136 | Create a new event loop as per the specified flags. Please refer to |
| 98 | the "ev_loop_new ()" function description in the libev documentation |
137 | the "ev_loop_new ()" function description in the libev documentation |
| 99 | (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTI |
138 | (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTI |
| 100 | ONS>, or locally-installed as EV::libev manpage) for more info. |
139 | ONS>, or locally-installed as EV::libev manpage) for more info. |
| 101 | |
140 | |
| … | |
… | |
| 112 | Must be called after a fork in the child, before entering or |
151 | Must be called after a fork in the child, before entering or |
| 113 | continuing the event loop. An alternative is to use |
152 | continuing the event loop. An alternative is to use |
| 114 | "EV::FLAG_FORKCHECK" which calls this function automatically, at |
153 | "EV::FLAG_FORKCHECK" which calls this function automatically, at |
| 115 | some performance loss (refer to the libev documentation). |
154 | some performance loss (refer to the libev documentation). |
| 116 | |
155 | |
| 117 | $loop->loop_verify |
156 | $loop->verify |
| 118 | Calls "ev_verify" to make internal consistency checks (for debugging |
157 | Calls "ev_verify" to make internal consistency checks (for debugging |
| 119 | libev) and abort the program if any data structures were found to be |
158 | libev) and abort the program if any data structures were found to be |
| 120 | corrupted. |
159 | corrupted. |
| 121 | |
160 | |
| 122 | $loop = EV::default_loop [$flags] |
161 | $loop = EV::default_loop [$flags] |
| … | |
… | |
| 152 | $time = $loop->now |
191 | $time = $loop->now |
| 153 | Returns the time the last event loop iteration has been started. |
192 | Returns the time the last event loop iteration has been started. |
| 154 | This is the time that (relative) timers are based on, and referring |
193 | This is the time that (relative) timers are based on, and referring |
| 155 | to it is usually faster then calling EV::time. |
194 | to it is usually faster then calling EV::time. |
| 156 | |
195 | |
|
|
196 | EV::now_update |
|
|
197 | $loop->now_update |
|
|
198 | Establishes the current time by querying the kernel, updating the |
|
|
199 | time returned by "EV::now" in the progress. This is a costly |
|
|
200 | operation and is usually done automatically within "EV::loop". |
|
|
201 | |
|
|
202 | This function is rarely useful, but when some event callback runs |
|
|
203 | for a very long time without entering the event loop, updating |
|
|
204 | libev's idea of the current time is a good idea. |
|
|
205 | |
|
|
206 | EV::suspend |
|
|
207 | $loop->suspend |
|
|
208 | EV::resume |
|
|
209 | $loop->resume |
|
|
210 | These two functions suspend and resume a loop, for use when the loop |
|
|
211 | is not used for a while and timeouts should not be processed. |
|
|
212 | |
|
|
213 | A typical use case would be an interactive program such as a game: |
|
|
214 | When the user presses "^Z" to suspend the game and resumes it an |
|
|
215 | hour later it would be best to handle timeouts as if no time had |
|
|
216 | actually passed while the program was suspended. This can be |
|
|
217 | achieved by calling "suspend" in your "SIGTSTP" handler, sending |
|
|
218 | yourself a "SIGSTOP" and calling "resume" directly afterwards to |
|
|
219 | resume timer processing. |
|
|
220 | |
|
|
221 | Effectively, all "timer" watchers will be delayed by the time spend |
|
|
222 | between "suspend" and "resume", and all "periodic" watchers will be |
|
|
223 | rescheduled (that is, they will lose any events that would have |
|
|
224 | occured while suspended). |
|
|
225 | |
|
|
226 | After calling "suspend" you must not call *any* function on the |
|
|
227 | given loop other than "resume", and you must not call "resume" |
|
|
228 | without a previous call to "suspend". |
|
|
229 | |
|
|
230 | Calling "suspend"/"resume" has the side effect of updating the event |
|
|
231 | loop time (see "now_update"). |
|
|
232 | |
| 157 | $backend = EV::backend |
233 | $backend = EV::backend |
| 158 | $backend = $loop->backend |
234 | $backend = $loop->backend |
| 159 | Returns an integer describing the backend used by libev |
235 | Returns an integer describing the backend used by libev |
| 160 | (EV::BACKEND_SELECT or EV::BACKEND_EPOLL). |
236 | (EV::BACKEND_SELECT or EV::BACKEND_EPOLL). |
| 161 | |
237 | |
| 162 | EV::loop [$flags] |
238 | $active = EV::run [$flags] |
| 163 | $loop->loop ([$flags]) |
239 | $active = $loop->run ([$flags]) |
| 164 | Begin checking for events and calling callbacks. It returns when a |
240 | Begin checking for events and calling callbacks. It returns when a |
| 165 | callback calls EV::unloop. |
241 | callback calls EV::unloop or the flasg are nonzero (in which case |
|
|
242 | the return value is true) or when there are no active watchers which |
|
|
243 | reference the loop (keepalive is true), in which case the return |
|
|
244 | value will be false. The returnv alue can generally be interpreted |
|
|
245 | as "if true, there is more work left to do". |
| 166 | |
246 | |
| 167 | The $flags argument can be one of the following: |
247 | The $flags argument can be one of the following: |
| 168 | |
248 | |
| 169 | 0 as above |
249 | 0 as above |
| 170 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
250 | EV::RUN_ONCE block at most once (wait, but do not loop) |
| 171 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
251 | EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait) |
| 172 | |
252 | |
| 173 | EV::unloop [$how] |
253 | EV::break [$how] |
| 174 | $loop->unloop ([$how]) |
254 | $loop->break ([$how]) |
| 175 | When called with no arguments or an argument of EV::UNLOOP_ONE, |
255 | When called with no arguments or an argument of EV::BREAK_ONE, makes |
| 176 | makes the innermost call to EV::loop return. |
256 | the innermost call to EV::loop return. |
| 177 | |
257 | |
| 178 | When called with an argument of EV::UNLOOP_ALL, all calls to |
258 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop |
| 179 | EV::loop will return as fast as possible. |
259 | will return as fast as possible. |
| 180 | |
260 | |
| 181 | $count = EV::loop_count |
261 | When called with an argument of EV::BREAK_CANCEL, any pending break |
| 182 | $count = $loop->loop_count |
262 | will be cancelled. |
|
|
263 | |
|
|
264 | $count = EV::iteration |
|
|
265 | $count = $loop->iteration |
| 183 | Return the number of times the event loop has polled for new events. |
266 | Return the number of times the event loop has polled for new events. |
| 184 | Sometimes useful as a generation counter. |
267 | Sometimes useful as a generation counter. |
| 185 | |
268 | |
| 186 | EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
269 | EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
| 187 | $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
270 | $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
| … | |
… | |
| 198 | Otherwise a EV::timer with this value will be started. |
281 | Otherwise a EV::timer with this value will be started. |
| 199 | |
282 | |
| 200 | When an error occurs or either the timeout or I/O watcher triggers, |
283 | When an error occurs or either the timeout or I/O watcher triggers, |
| 201 | then the callback will be called with the received event set (in |
284 | then the callback will be called with the received event set (in |
| 202 | general you can expect it to be a combination of "EV::ERROR", |
285 | general you can expect it to be a combination of "EV::ERROR", |
| 203 | "EV::READ", "EV::WRITE" and "EV::TIMEOUT"). |
286 | "EV::READ", "EV::WRITE" and "EV::TIMER"). |
| 204 | |
287 | |
| 205 | EV::once doesn't return anything: the watchers stay active till |
288 | EV::once doesn't return anything: the watchers stay active till |
| 206 | either of them triggers, then they will be stopped and freed, and |
289 | either of them triggers, then they will be stopped and freed, and |
| 207 | the callback invoked. |
290 | the callback invoked. |
| 208 | |
291 | |
| 209 | EV::feed_fd_event ($fd, $revents) |
292 | EV::feed_fd_event $fd, $revents |
| 210 | $loop->feed_fd_event ($fd, $revents) |
293 | $loop->feed_fd_event ($fd, $revents) |
| 211 | Feed an event on a file descriptor into EV. EV will react to this |
294 | Feed an event on a file descriptor into EV. EV will react to this |
| 212 | call as if the readyness notifications specified by $revents (a |
295 | call as if the readyness notifications specified by $revents (a |
| 213 | combination of "EV::READ" and "EV::WRITE") happened on the file |
296 | combination of "EV::READ" and "EV::WRITE") happened on the file |
| 214 | descriptor $fd. |
297 | descriptor $fd. |
| 215 | |
298 | |
| 216 | EV::feed_signal_event ($signal) |
299 | EV::feed_signal_event $signal |
| 217 | Feed a signal event into EV. EV will react to this call as if the |
300 | Feed a signal event into the default loop. EV will react to this |
| 218 | signal specified by $signal had occured. |
301 | call as if the signal specified by $signal had occured. |
|
|
302 | |
|
|
303 | EV::feed_signal $signal |
|
|
304 | Feed a signal event into EV - unlike "EV::feed_signal_event", this |
|
|
305 | works regardless of which loop has registered the signal, and is |
|
|
306 | mainly useful fro custom signal implementations. |
| 219 | |
307 | |
| 220 | EV::set_io_collect_interval $time |
308 | EV::set_io_collect_interval $time |
| 221 | $loop->set_io_collect_interval ($time) |
309 | $loop->set_io_collect_interval ($time) |
| 222 | EV::set_timeout_collect_interval $time |
310 | EV::set_timeout_collect_interval $time |
| 223 | $loop->set_timeout_collect_interval ($time) |
311 | $loop->set_timeout_collect_interval ($time) |
| … | |
… | |
| 226 | the libev documentation at |
314 | the libev documentation at |
| 227 | <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT |
315 | <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT |
| 228 | ROLLING_THE_EVENT_LOOP> (locally installed as EV::libev) for a more |
316 | ROLLING_THE_EVENT_LOOP> (locally installed as EV::libev) for a more |
| 229 | detailed discussion. |
317 | detailed discussion. |
| 230 | |
318 | |
|
|
319 | $count = EV::pending_count |
|
|
320 | $count = $loop->pending_count |
|
|
321 | Returns the number of currently pending watchers. |
|
|
322 | |
|
|
323 | EV::invoke_pending |
|
|
324 | $loop->invoke_pending |
|
|
325 | Invoke all currently pending watchers. |
|
|
326 | |
| 231 | WATCHER OBJECTS |
327 | WATCHER OBJECTS |
| 232 | A watcher is an object that gets created to record your interest in some |
328 | A watcher is an object that gets created to record your interest in some |
| 233 | event. For instance, if you want to wait for STDIN to become readable, |
329 | event. For instance, if you want to wait for STDIN to become readable, |
| 234 | you would create an EV::io watcher for that: |
330 | you would create an EV::io watcher for that: |
| 235 | |
331 | |
| … | |
… | |
| 245 | |
341 | |
| 246 | Each watcher type has its associated bit in revents, so you can use the |
342 | Each watcher type has its associated bit in revents, so you can use the |
| 247 | same callback for multiple watchers. The event mask is named after the |
343 | same callback for multiple watchers. The event mask is named after the |
| 248 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
344 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
| 249 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O |
345 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O |
| 250 | events (which can set both EV::READ and EV::WRITE bits), and EV::timer |
346 | events (which can set both EV::READ and EV::WRITE bits). |
| 251 | (which uses EV::TIMEOUT). |
|
|
| 252 | |
347 | |
| 253 | In the rare case where one wants to create a watcher but not start it at |
348 | In the rare case where one wants to create a watcher but not start it at |
| 254 | the same time, each constructor has a variant with a trailing "_ns" in |
349 | the same time, each constructor has a variant with a trailing "_ns" in |
| 255 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
350 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
| 256 | |
351 | |
| … | |
… | |
| 321 | the watcher isn't pending it does nothing and returns 0. |
416 | the watcher isn't pending it does nothing and returns 0. |
| 322 | |
417 | |
| 323 | $previous_state = $w->keepalive ($bool) |
418 | $previous_state = $w->keepalive ($bool) |
| 324 | Normally, "EV::loop" will return when there are no active watchers |
419 | Normally, "EV::loop" will return when there are no active watchers |
| 325 | (which is a "deadlock" because no progress can be made anymore). |
420 | (which is a "deadlock" because no progress can be made anymore). |
| 326 | This is convinient because it allows you to start your watchers (and |
421 | This is convenient because it allows you to start your watchers (and |
| 327 | your jobs), call "EV::loop" once and when it returns you know that |
422 | your jobs), call "EV::loop" once and when it returns you know that |
| 328 | all your jobs are finished (or they forgot to register some watchers |
423 | all your jobs are finished (or they forgot to register some watchers |
| 329 | for their task :). |
424 | for their task :). |
| 330 | |
425 | |
| 331 | Sometimes, however, this gets in your way, for example when the |
426 | Sometimes, however, this gets in your way, for example when the |
| … | |
… | |
| 522 | Return the time that the watcher is expected to trigger next. |
617 | Return the time that the watcher is expected to trigger next. |
| 523 | |
618 | |
| 524 | SIGNAL WATCHERS - signal me when a signal gets signalled! |
619 | SIGNAL WATCHERS - signal me when a signal gets signalled! |
| 525 | $w = EV::signal $signal, $callback |
620 | $w = EV::signal $signal, $callback |
| 526 | $w = EV::signal_ns $signal, $callback |
621 | $w = EV::signal_ns $signal, $callback |
|
|
622 | $w = $loop->signal ($signal, $callback) |
|
|
623 | $w = $loop->signal_ns ($signal, $callback) |
| 527 | Call the callback when $signal is received (the signal can be |
624 | Call the callback when $signal is received (the signal can be |
| 528 | specified by number or by name, just as with "kill" or %SIG). |
625 | specified by number or by name, just as with "kill" or %SIG). |
|
|
626 | |
|
|
627 | Only one event loop can grab a given signal - attempting to grab the |
|
|
628 | same signal from two EV loops will crash the program immediately or |
|
|
629 | cause data corruption. |
| 529 | |
630 | |
| 530 | EV will grab the signal for the process (the kernel only allows one |
631 | EV will grab the signal for the process (the kernel only allows one |
| 531 | component to receive a signal at a time) when you start a signal |
632 | component to receive a signal at a time) when you start a signal |
| 532 | watcher, and removes it again when you stop it. Perl does the same |
633 | watcher, and removes it again when you stop it. Perl does the same |
| 533 | when you add/remove callbacks to %SIG, so watch out. |
634 | when you add/remove callbacks to %SIG, so watch out. |
| … | |
… | |
| 707 | $w = $loop->check_ns ($callback) |
808 | $w = $loop->check_ns ($callback) |
| 708 | Call the callback just after the process wakes up again (after it |
809 | Call the callback just after the process wakes up again (after it |
| 709 | has gathered events), but before any other callbacks have been |
810 | has gathered events), but before any other callbacks have been |
| 710 | invoked. |
811 | invoked. |
| 711 | |
812 | |
| 712 | This is used to integrate other event-based software into the EV |
813 | This can be used to integrate other event-based software into the EV |
| 713 | mainloop: You register a prepare callback and in there, you create |
814 | mainloop: You register a prepare callback and in there, you create |
| 714 | io and timer watchers as required by the other software. Here is a |
815 | io and timer watchers as required by the other software. Here is a |
| 715 | real-world example of integrating Net::SNMP (with some details left |
816 | real-world example of integrating Net::SNMP (with some details left |
| 716 | out): |
817 | out): |
| 717 | |
818 | |
| … | |
… | |
| 753 | watchers are destroyed before this can happen (remember EV::check |
854 | watchers are destroyed before this can happen (remember EV::check |
| 754 | gets called first). |
855 | gets called first). |
| 755 | |
856 | |
| 756 | The "check_ns" variant doesn't start (activate) the newly created |
857 | The "check_ns" variant doesn't start (activate) the newly created |
| 757 | watcher. |
858 | watcher. |
|
|
859 | |
|
|
860 | EV::CHECK constant issues |
|
|
861 | Like all other watcher types, there is a bitmask constant for use in |
|
|
862 | $revents and other places. The "EV::CHECK" is special as it has the |
|
|
863 | same name as the "CHECK" sub called by Perl. This doesn't cause big |
|
|
864 | issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
865 | constant must be *inlined*, i.e. runtime calls will not work. That |
|
|
866 | means that as long as you always "use EV" and then "EV::CHECK" you |
|
|
867 | are on the safe side. |
| 758 | |
868 | |
| 759 | FORK WATCHERS - the audacity to resume the event loop after a fork |
869 | FORK WATCHERS - the audacity to resume the event loop after a fork |
| 760 | Fork watchers are called when a "fork ()" was detected. The invocation |
870 | Fork watchers are called when a "fork ()" was detected. The invocation |
| 761 | is done before the event loop blocks next and before "check" watchers |
871 | is done before the event loop blocks next and before "check" watchers |
| 762 | are being called, and only in the child after the fork. |
872 | are being called, and only in the child after the fork. |
| … | |
… | |
| 783 | |
893 | |
| 784 | In short, this watcher is most useful on BSD systems without working |
894 | In short, this watcher is most useful on BSD systems without working |
| 785 | kqueue to still be able to handle a large number of sockets: |
895 | kqueue to still be able to handle a large number of sockets: |
| 786 | |
896 | |
| 787 | my $socket_loop; |
897 | my $socket_loop; |
| 788 | |
898 | |
| 789 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
899 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
| 790 | if ( |
900 | if ( |
| 791 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
901 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
| 792 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
902 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
| 793 | ) { |
903 | ) { |
| 794 | # use kqueue for sockets |
904 | # use kqueue for sockets |
| 795 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
905 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
| 796 | } |
906 | } |
| 797 | |
907 | |
| 798 | # use the default loop otherwise |
908 | # use the default loop otherwise |
| 799 | $socket_loop ||= EV::default_loop; |
909 | $socket_loop ||= EV::default_loop; |
| 800 | |
910 | |
| 801 | $w = EV::embed $otherloop[, $callback] |
911 | $w = EV::embed $otherloop[, $callback] |
| 802 | $w = EV::embed_ns $otherloop[, $callback] |
912 | $w = EV::embed_ns $otherloop[, $callback] |
| 803 | $w = $loop->embed ($otherloop[, $callback]) |
913 | $w = $loop->embed ($otherloop[, $callback]) |
| … | |
… | |
| 810 | The "embed_ns" variant doesn't start (activate) the newly created |
920 | The "embed_ns" variant doesn't start (activate) the newly created |
| 811 | watcher. |
921 | watcher. |
| 812 | |
922 | |
| 813 | ASYNC WATCHERS - how to wake up another event loop |
923 | ASYNC WATCHERS - how to wake up another event loop |
| 814 | Async watchers are provided by EV, but have little use in perl directly, |
924 | Async watchers are provided by EV, but have little use in perl directly, |
| 815 | as perl neither supports threads nor direct access to signal handlers or |
925 | as perl neither supports threads running in parallel nor direct access |
| 816 | other contexts where they could be of value. |
926 | to signal handlers or other contexts where they could be of value. |
| 817 | |
927 | |
| 818 | It is, however, possible to use them from the XS level. |
928 | It is, however, possible to use them from the XS level. |
| 819 | |
929 | |
| 820 | Please see the libev documentation for further details. |
930 | Please see the libev documentation for further details. |
| 821 | |
931 | |
| 822 | $w = EV::async $callback |
932 | $w = EV::async $callback |
| 823 | $w = EV::async_ns $callback |
933 | $w = EV::async_ns $callback |
|
|
934 | $w = $loop->async ($callback) |
|
|
935 | $w = $loop->async_ns ($callback) |
| 824 | $w->send |
936 | $w->send |
| 825 | $bool = $w->async_pending |
937 | $bool = $w->async_pending |
|
|
938 | |
|
|
939 | CLEANUP WATCHERS - how to clean up when the event loop goes away |
|
|
940 | Cleanup watchers are not supported on the Perl level, they can only be |
|
|
941 | used via XS currently. |
| 826 | |
942 | |
| 827 | PERL SIGNALS |
943 | PERL SIGNALS |
| 828 | While Perl signal handling (%SIG) is not affected by EV, the behaviour |
944 | While Perl signal handling (%SIG) is not affected by EV, the behaviour |
| 829 | with EV is as the same as any other C library: Perl-signals will only be |
945 | with EV is as the same as any other C library: Perl-signals will only be |
| 830 | handled when Perl runs, which means your signal handler might be invoked |
946 | handled when Perl runs, which means your signal handler might be invoked |
| … | |
… | |
| 840 | my $async_check = EV::check sub { }; |
956 | my $async_check = EV::check sub { }; |
| 841 | |
957 | |
| 842 | This ensures that perl gets into control for a short time to handle any |
958 | This ensures that perl gets into control for a short time to handle any |
| 843 | pending signals, and also ensures (slightly) slower overall operation. |
959 | pending signals, and also ensures (slightly) slower overall operation. |
| 844 | |
960 | |
| 845 | THREADS |
961 | ITHREADS |
| 846 | Threads are not supported by this module in any way. Perl pseudo-threads |
962 | Ithreads are not supported by this module in any way. Perl |
| 847 | is evil stuff and must die. As soon as Perl gains real threads I will |
963 | pseudo-threads is evil stuff and must die. Real threads as provided by |
| 848 | work on thread support for it. |
964 | Coro are fully supported (and enhanced support is available via |
|
|
965 | Coro::EV). |
| 849 | |
966 | |
| 850 | FORK |
967 | FORK |
| 851 | Most of the "improved" event delivering mechanisms of modern operating |
968 | Most of the "improved" event delivering mechanisms of modern operating |
| 852 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
969 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
| 853 | not supported and usually destructive). Libev makes it possible to work |
970 | not supported and usually destructive). Libev makes it possible to work |
| … | |
… | |
| 863 | |
980 | |
| 864 | On win32, there is no notion of fork so all this doesn't apply, of |
981 | On win32, there is no notion of fork so all this doesn't apply, of |
| 865 | course. |
982 | course. |
| 866 | |
983 | |
| 867 | SEE ALSO |
984 | SEE ALSO |
| 868 | EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event |
985 | EV::MakeMaker - MakeMaker interface to XS API, EV::ADNS (asynchronous |
| 869 | loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines |
986 | DNS), Glib::EV (makes Glib/Gtk2 use EV as event loop), EV::Glib (embed |
| 870 | with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop |
987 | Glib into EV), Coro::EV (efficient thread integration), Net::SNMP::EV |
| 871 | agnostic and portable event driven programming. |
988 | (asynchronous SNMP), AnyEvent for event-loop agnostic and portable event |
|
|
989 | driven programming. |
| 872 | |
990 | |
| 873 | AUTHOR |
991 | AUTHOR |
| 874 | Marc Lehmann <schmorp@schmorp.de> |
992 | Marc Lehmann <schmorp@schmorp.de> |
| 875 | http://home.schmorp.de/ |
993 | http://home.schmorp.de/ |
| 876 | |
994 | |
