… | |
… | |
9 | =head2 EXAMPLE PROGRAM |
9 | =head2 EXAMPLE PROGRAM |
10 | |
10 | |
11 | // a single header file is required |
11 | // a single header file is required |
12 | #include <ev.h> |
12 | #include <ev.h> |
13 | |
13 | |
|
|
14 | #include <stdio.h> // for puts |
|
|
15 | |
14 | // every watcher type has its own typedef'd struct |
16 | // every watcher type has its own typedef'd struct |
15 | // with the name ev_<type> |
17 | // with the name ev_TYPE |
16 | ev_io stdin_watcher; |
18 | ev_io stdin_watcher; |
17 | ev_timer timeout_watcher; |
19 | ev_timer timeout_watcher; |
18 | |
20 | |
19 | // all watcher callbacks have a similar signature |
21 | // all watcher callbacks have a similar signature |
20 | // this callback is called when data is readable on stdin |
22 | // this callback is called when data is readable on stdin |
21 | static void |
23 | static void |
22 | stdin_cb (EV_P_ struct ev_io *w, int revents) |
24 | stdin_cb (EV_P_ ev_io *w, int revents) |
23 | { |
25 | { |
24 | puts ("stdin ready"); |
26 | puts ("stdin ready"); |
25 | // for one-shot events, one must manually stop the watcher |
27 | // for one-shot events, one must manually stop the watcher |
26 | // with its corresponding stop function. |
28 | // with its corresponding stop function. |
27 | ev_io_stop (EV_A_ w); |
29 | ev_io_stop (EV_A_ w); |
… | |
… | |
30 | ev_unloop (EV_A_ EVUNLOOP_ALL); |
32 | ev_unloop (EV_A_ EVUNLOOP_ALL); |
31 | } |
33 | } |
32 | |
34 | |
33 | // another callback, this time for a time-out |
35 | // another callback, this time for a time-out |
34 | static void |
36 | static void |
35 | timeout_cb (EV_P_ struct ev_timer *w, int revents) |
37 | timeout_cb (EV_P_ ev_timer *w, int revents) |
36 | { |
38 | { |
37 | puts ("timeout"); |
39 | puts ("timeout"); |
38 | // this causes the innermost ev_loop to stop iterating |
40 | // this causes the innermost ev_loop to stop iterating |
39 | ev_unloop (EV_A_ EVUNLOOP_ONE); |
41 | ev_unloop (EV_A_ EVUNLOOP_ONE); |
40 | } |
42 | } |
… | |
… | |
60 | |
62 | |
61 | // unloop was called, so exit |
63 | // unloop was called, so exit |
62 | return 0; |
64 | return 0; |
63 | } |
65 | } |
64 | |
66 | |
65 | =head1 DESCRIPTION |
67 | =head1 ABOUT THIS DOCUMENT |
|
|
68 | |
|
|
69 | This document documents the libev software package. |
66 | |
70 | |
67 | The newest version of this document is also available as an html-formatted |
71 | The newest version of this document is also available as an html-formatted |
68 | web page you might find easier to navigate when reading it for the first |
72 | web page you might find easier to navigate when reading it for the first |
69 | time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
73 | time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
|
|
74 | |
|
|
75 | While this document tries to be as complete as possible in documenting |
|
|
76 | libev, its usage and the rationale behind its design, it is not a tutorial |
|
|
77 | on event-based programming, nor will it introduce event-based programming |
|
|
78 | with libev. |
|
|
79 | |
|
|
80 | Familarity with event based programming techniques in general is assumed |
|
|
81 | throughout this document. |
|
|
82 | |
|
|
83 | =head1 ABOUT LIBEV |
70 | |
84 | |
71 | Libev is an event loop: you register interest in certain events (such as a |
85 | Libev is an event loop: you register interest in certain events (such as a |
72 | file descriptor being readable or a timeout occurring), and it will manage |
86 | file descriptor being readable or a timeout occurring), and it will manage |
73 | these event sources and provide your program with events. |
87 | these event sources and provide your program with events. |
74 | |
88 | |
… | |
… | |
84 | =head2 FEATURES |
98 | =head2 FEATURES |
85 | |
99 | |
86 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
87 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
88 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
89 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
103 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
90 | with customised rescheduling (C<ev_periodic>), synchronous signals |
104 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
91 | (C<ev_signal>), process status change events (C<ev_child>), and event |
105 | timers (C<ev_timer>), absolute timers with customised rescheduling |
92 | watchers dealing with the event loop mechanism itself (C<ev_idle>, |
106 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
93 | C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as |
107 | change events (C<ev_child>), and event watchers dealing with the event |
94 | file watchers (C<ev_stat>) and even limited support for fork events |
108 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
95 | (C<ev_fork>). |
109 | C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even |
|
|
110 | limited support for fork events (C<ev_fork>). |
96 | |
111 | |
97 | It also is quite fast (see this |
112 | It also is quite fast (see this |
98 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
99 | for example). |
114 | for example). |
100 | |
115 | |
… | |
… | |
108 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
123 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
109 | this argument. |
124 | this argument. |
110 | |
125 | |
111 | =head2 TIME REPRESENTATION |
126 | =head2 TIME REPRESENTATION |
112 | |
127 | |
113 | Libev represents time as a single floating point number, representing the |
128 | Libev represents time as a single floating point number, representing |
114 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
129 | the (fractional) number of seconds since the (POSIX) epoch (somewhere |
115 | the beginning of 1970, details are complicated, don't ask). This type is |
130 | near the beginning of 1970, details are complicated, don't ask). This |
116 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
131 | type is called C<ev_tstamp>, which is what you should use too. It usually |
117 | to the C<double> type in C, and when you need to do any calculations on |
132 | aliases to the C<double> type in C. When you need to do any calculations |
118 | it, you should treat it as some floating point value. Unlike the name |
133 | on it, you should treat it as some floating point value. Unlike the name |
119 | component C<stamp> might indicate, it is also used for time differences |
134 | component C<stamp> might indicate, it is also used for time differences |
120 | throughout libev. |
135 | throughout libev. |
121 | |
136 | |
122 | =head1 ERROR HANDLING |
137 | =head1 ERROR HANDLING |
123 | |
138 | |
… | |
… | |
214 | C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for |
229 | C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for |
215 | recommended ones. |
230 | recommended ones. |
216 | |
231 | |
217 | See the description of C<ev_embed> watchers for more info. |
232 | See the description of C<ev_embed> watchers for more info. |
218 | |
233 | |
219 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
234 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT] |
220 | |
235 | |
221 | Sets the allocation function to use (the prototype is similar - the |
236 | Sets the allocation function to use (the prototype is similar - the |
222 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
237 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
223 | used to allocate and free memory (no surprises here). If it returns zero |
238 | used to allocate and free memory (no surprises here). If it returns zero |
224 | when memory needs to be allocated (C<size != 0>), the library might abort |
239 | when memory needs to be allocated (C<size != 0>), the library might abort |
… | |
… | |
250 | } |
265 | } |
251 | |
266 | |
252 | ... |
267 | ... |
253 | ev_set_allocator (persistent_realloc); |
268 | ev_set_allocator (persistent_realloc); |
254 | |
269 | |
255 | =item ev_set_syserr_cb (void (*cb)(const char *msg)); |
270 | =item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT] |
256 | |
271 | |
257 | Set the callback function to call on a retryable system call error (such |
272 | Set the callback function to call on a retryable system call error (such |
258 | as failed select, poll, epoll_wait). The message is a printable string |
273 | as failed select, poll, epoll_wait). The message is a printable string |
259 | indicating the system call or subsystem causing the problem. If this |
274 | indicating the system call or subsystem causing the problem. If this |
260 | callback is set, then libev will expect it to remedy the situation, no |
275 | callback is set, then libev will expect it to remedy the situation, no |
… | |
… | |
276 | |
291 | |
277 | =back |
292 | =back |
278 | |
293 | |
279 | =head1 FUNCTIONS CONTROLLING THE EVENT LOOP |
294 | =head1 FUNCTIONS CONTROLLING THE EVENT LOOP |
280 | |
295 | |
281 | An event loop is described by a C<struct ev_loop *>. The library knows two |
296 | An event loop is described by a C<struct ev_loop *> (the C<struct> |
282 | types of such loops, the I<default> loop, which supports signals and child |
297 | is I<not> optional in this case, as there is also an C<ev_loop> |
283 | events, and dynamically created loops which do not. |
298 | I<function>). |
|
|
299 | |
|
|
300 | The library knows two types of such loops, the I<default> loop, which |
|
|
301 | supports signals and child events, and dynamically created loops which do |
|
|
302 | not. |
284 | |
303 | |
285 | =over 4 |
304 | =over 4 |
286 | |
305 | |
287 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
306 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
288 | |
307 | |
… | |
… | |
294 | If you don't know what event loop to use, use the one returned from this |
313 | If you don't know what event loop to use, use the one returned from this |
295 | function. |
314 | function. |
296 | |
315 | |
297 | Note that this function is I<not> thread-safe, so if you want to use it |
316 | Note that this function is I<not> thread-safe, so if you want to use it |
298 | from multiple threads, you have to lock (note also that this is unlikely, |
317 | from multiple threads, you have to lock (note also that this is unlikely, |
299 | as loops cannot bes hared easily between threads anyway). |
318 | as loops cannot be shared easily between threads anyway). |
300 | |
319 | |
301 | The default loop is the only loop that can handle C<ev_signal> and |
320 | The default loop is the only loop that can handle C<ev_signal> and |
302 | C<ev_child> watchers, and to do this, it always registers a handler |
321 | C<ev_child> watchers, and to do this, it always registers a handler |
303 | for C<SIGCHLD>. If this is a problem for your application you can either |
322 | for C<SIGCHLD>. If this is a problem for your application you can either |
304 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
323 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
… | |
… | |
344 | flag. |
363 | flag. |
345 | |
364 | |
346 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
365 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
347 | environment variable. |
366 | environment variable. |
348 | |
367 | |
|
|
368 | =item C<EVFLAG_NOINOTIFY> |
|
|
369 | |
|
|
370 | When this flag is specified, then libev will not attempt to use the |
|
|
371 | I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and |
|
|
372 | testing, this flag can be useful to conserve inotify file descriptors, as |
|
|
373 | otherwise each loop using C<ev_stat> watchers consumes one inotify handle. |
|
|
374 | |
|
|
375 | =item C<EVFLAG_NOSIGFD> |
|
|
376 | |
|
|
377 | When this flag is specified, then libev will not attempt to use the |
|
|
378 | I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is |
|
|
379 | probably only useful to work around any bugs in libev. Consequently, this |
|
|
380 | flag might go away once the signalfd functionality is considered stable, |
|
|
381 | so it's useful mostly in environment variables and not in program code. |
|
|
382 | |
349 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
383 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
350 | |
384 | |
351 | This is your standard select(2) backend. Not I<completely> standard, as |
385 | This is your standard select(2) backend. Not I<completely> standard, as |
352 | libev tries to roll its own fd_set with no limits on the number of fds, |
386 | libev tries to roll its own fd_set with no limits on the number of fds, |
353 | but if that fails, expect a fairly low limit on the number of fds when |
387 | but if that fails, expect a fairly low limit on the number of fds when |
… | |
… | |
359 | writing a server, you should C<accept ()> in a loop to accept as many |
393 | writing a server, you should C<accept ()> in a loop to accept as many |
360 | connections as possible during one iteration. You might also want to have |
394 | connections as possible during one iteration. You might also want to have |
361 | a look at C<ev_set_io_collect_interval ()> to increase the amount of |
395 | a look at C<ev_set_io_collect_interval ()> to increase the amount of |
362 | readiness notifications you get per iteration. |
396 | readiness notifications you get per iteration. |
363 | |
397 | |
|
|
398 | This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the |
|
|
399 | C<writefds> set (and to work around Microsoft Windows bugs, also onto the |
|
|
400 | C<exceptfds> set on that platform). |
|
|
401 | |
364 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
402 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
365 | |
403 | |
366 | And this is your standard poll(2) backend. It's more complicated |
404 | And this is your standard poll(2) backend. It's more complicated |
367 | than select, but handles sparse fds better and has no artificial |
405 | than select, but handles sparse fds better and has no artificial |
368 | limit on the number of fds you can use (except it will slow down |
406 | limit on the number of fds you can use (except it will slow down |
369 | considerably with a lot of inactive fds). It scales similarly to select, |
407 | considerably with a lot of inactive fds). It scales similarly to select, |
370 | i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for |
408 | i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for |
371 | performance tips. |
409 | performance tips. |
372 | |
410 | |
|
|
411 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
|
|
412 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
|
|
413 | |
373 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
414 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
|
|
415 | |
|
|
416 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
|
|
417 | kernels). |
374 | |
418 | |
375 | For few fds, this backend is a bit little slower than poll and select, |
419 | For few fds, this backend is a bit little slower than poll and select, |
376 | but it scales phenomenally better. While poll and select usually scale |
420 | but it scales phenomenally better. While poll and select usually scale |
377 | like O(total_fds) where n is the total number of fds (or the highest fd), |
421 | like O(total_fds) where n is the total number of fds (or the highest fd), |
378 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
422 | epoll scales either O(1) or O(active_fds). |
379 | of shortcomings, such as silently dropping events in some hard-to-detect |
423 | |
380 | cases and requiring a system call per fd change, no fork support and bad |
424 | The epoll mechanism deserves honorable mention as the most misdesigned |
381 | support for dup. |
425 | of the more advanced event mechanisms: mere annoyances include silently |
|
|
426 | dropping file descriptors, requiring a system call per change per file |
|
|
427 | descriptor (and unnecessary guessing of parameters), problems with dup and |
|
|
428 | so on. The biggest issue is fork races, however - if a program forks then |
|
|
429 | I<both> parent and child process have to recreate the epoll set, which can |
|
|
430 | take considerable time (one syscall per file descriptor) and is of course |
|
|
431 | hard to detect. |
|
|
432 | |
|
|
433 | Epoll is also notoriously buggy - embedding epoll fds I<should> work, but |
|
|
434 | of course I<doesn't>, and epoll just loves to report events for totally |
|
|
435 | I<different> file descriptors (even already closed ones, so one cannot |
|
|
436 | even remove them from the set) than registered in the set (especially |
|
|
437 | on SMP systems). Libev tries to counter these spurious notifications by |
|
|
438 | employing an additional generation counter and comparing that against the |
|
|
439 | events to filter out spurious ones, recreating the set when required. |
382 | |
440 | |
383 | While stopping, setting and starting an I/O watcher in the same iteration |
441 | While stopping, setting and starting an I/O watcher in the same iteration |
384 | will result in some caching, there is still a system call per such incident |
442 | will result in some caching, there is still a system call per such |
385 | (because the fd could point to a different file description now), so its |
443 | incident (because the same I<file descriptor> could point to a different |
386 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
444 | I<file description> now), so its best to avoid that. Also, C<dup ()>'ed |
387 | very well if you register events for both fds. |
445 | file descriptors might not work very well if you register events for both |
388 | |
446 | file descriptors. |
389 | Please note that epoll sometimes generates spurious notifications, so you |
|
|
390 | need to use non-blocking I/O or other means to avoid blocking when no data |
|
|
391 | (or space) is available. |
|
|
392 | |
447 | |
393 | Best performance from this backend is achieved by not unregistering all |
448 | Best performance from this backend is achieved by not unregistering all |
394 | watchers for a file descriptor until it has been closed, if possible, i.e. |
449 | watchers for a file descriptor until it has been closed, if possible, |
395 | keep at least one watcher active per fd at all times. |
450 | i.e. keep at least one watcher active per fd at all times. Stopping and |
|
|
451 | starting a watcher (without re-setting it) also usually doesn't cause |
|
|
452 | extra overhead. A fork can both result in spurious notifications as well |
|
|
453 | as in libev having to destroy and recreate the epoll object, which can |
|
|
454 | take considerable time and thus should be avoided. |
|
|
455 | |
|
|
456 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
|
|
457 | faster than epoll for maybe up to a hundred file descriptors, depending on |
|
|
458 | the usage. So sad. |
396 | |
459 | |
397 | While nominally embeddable in other event loops, this feature is broken in |
460 | While nominally embeddable in other event loops, this feature is broken in |
398 | all kernel versions tested so far. |
461 | all kernel versions tested so far. |
|
|
462 | |
|
|
463 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
|
|
464 | C<EVBACKEND_POLL>. |
399 | |
465 | |
400 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
466 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
401 | |
467 | |
402 | Kqueue deserves special mention, as at the time of this writing, it |
468 | Kqueue deserves special mention, as at the time of this writing, it |
403 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
469 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
404 | with anything but sockets and pipes, except on Darwin, where of course |
470 | with anything but sockets and pipes, except on Darwin, where of course |
405 | it's completely useless). For this reason it's not being "auto-detected" |
471 | it's completely useless). Unlike epoll, however, whose brokenness |
|
|
472 | is by design, these kqueue bugs can (and eventually will) be fixed |
|
|
473 | without API changes to existing programs. For this reason it's not being |
406 | unless you explicitly specify it explicitly in the flags (i.e. using |
474 | "auto-detected" unless you explicitly specify it in the flags (i.e. using |
407 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
475 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
408 | system like NetBSD. |
476 | system like NetBSD. |
409 | |
477 | |
410 | You still can embed kqueue into a normal poll or select backend and use it |
478 | You still can embed kqueue into a normal poll or select backend and use it |
411 | only for sockets (after having made sure that sockets work with kqueue on |
479 | only for sockets (after having made sure that sockets work with kqueue on |
… | |
… | |
413 | |
481 | |
414 | It scales in the same way as the epoll backend, but the interface to the |
482 | It scales in the same way as the epoll backend, but the interface to the |
415 | kernel is more efficient (which says nothing about its actual speed, of |
483 | kernel is more efficient (which says nothing about its actual speed, of |
416 | course). While stopping, setting and starting an I/O watcher does never |
484 | course). While stopping, setting and starting an I/O watcher does never |
417 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
485 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
418 | two event changes per incident, support for C<fork ()> is very bad and it |
486 | two event changes per incident. Support for C<fork ()> is very bad (but |
419 | drops fds silently in similarly hard-to-detect cases. |
487 | sane, unlike epoll) and it drops fds silently in similarly hard-to-detect |
|
|
488 | cases |
420 | |
489 | |
421 | This backend usually performs well under most conditions. |
490 | This backend usually performs well under most conditions. |
422 | |
491 | |
423 | While nominally embeddable in other event loops, this doesn't work |
492 | While nominally embeddable in other event loops, this doesn't work |
424 | everywhere, so you might need to test for this. And since it is broken |
493 | everywhere, so you might need to test for this. And since it is broken |
425 | almost everywhere, you should only use it when you have a lot of sockets |
494 | almost everywhere, you should only use it when you have a lot of sockets |
426 | (for which it usually works), by embedding it into another event loop |
495 | (for which it usually works), by embedding it into another event loop |
427 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for |
496 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course |
428 | sockets. |
497 | also broken on OS X)) and, did I mention it, using it only for sockets. |
|
|
498 | |
|
|
499 | This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with |
|
|
500 | C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with |
|
|
501 | C<NOTE_EOF>. |
429 | |
502 | |
430 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
503 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
431 | |
504 | |
432 | This is not implemented yet (and might never be, unless you send me an |
505 | This is not implemented yet (and might never be, unless you send me an |
433 | implementation). According to reports, C</dev/poll> only supports sockets |
506 | implementation). According to reports, C</dev/poll> only supports sockets |
… | |
… | |
446 | While this backend scales well, it requires one system call per active |
519 | While this backend scales well, it requires one system call per active |
447 | file descriptor per loop iteration. For small and medium numbers of file |
520 | file descriptor per loop iteration. For small and medium numbers of file |
448 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
521 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
449 | might perform better. |
522 | might perform better. |
450 | |
523 | |
451 | On the positive side, ignoring the spurious readiness notifications, this |
524 | On the positive side, with the exception of the spurious readiness |
452 | backend actually performed to specification in all tests and is fully |
525 | notifications, this backend actually performed fully to specification |
453 | embeddable, which is a rare feat among the OS-specific backends. |
526 | in all tests and is fully embeddable, which is a rare feat among the |
|
|
527 | OS-specific backends (I vastly prefer correctness over speed hacks). |
|
|
528 | |
|
|
529 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
|
|
530 | C<EVBACKEND_POLL>. |
454 | |
531 | |
455 | =item C<EVBACKEND_ALL> |
532 | =item C<EVBACKEND_ALL> |
456 | |
533 | |
457 | Try all backends (even potentially broken ones that wouldn't be tried |
534 | Try all backends (even potentially broken ones that wouldn't be tried |
458 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
535 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
… | |
… | |
460 | |
537 | |
461 | It is definitely not recommended to use this flag. |
538 | It is definitely not recommended to use this flag. |
462 | |
539 | |
463 | =back |
540 | =back |
464 | |
541 | |
465 | If one or more of these are or'ed into the flags value, then only these |
542 | If one or more of the backend flags are or'ed into the flags value, |
466 | backends will be tried (in the reverse order as listed here). If none are |
543 | then only these backends will be tried (in the reverse order as listed |
467 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
544 | here). If none are specified, all backends in C<ev_recommended_backends |
|
|
545 | ()> will be tried. |
468 | |
546 | |
469 | The most typical usage is like this: |
547 | Example: This is the most typical usage. |
470 | |
548 | |
471 | if (!ev_default_loop (0)) |
549 | if (!ev_default_loop (0)) |
472 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
550 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
473 | |
551 | |
474 | Restrict libev to the select and poll backends, and do not allow |
552 | Example: Restrict libev to the select and poll backends, and do not allow |
475 | environment settings to be taken into account: |
553 | environment settings to be taken into account: |
476 | |
554 | |
477 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
555 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
478 | |
556 | |
479 | Use whatever libev has to offer, but make sure that kqueue is used if |
557 | Example: Use whatever libev has to offer, but make sure that kqueue is |
480 | available (warning, breaks stuff, best use only with your own private |
558 | used if available (warning, breaks stuff, best use only with your own |
481 | event loop and only if you know the OS supports your types of fds): |
559 | private event loop and only if you know the OS supports your types of |
|
|
560 | fds): |
482 | |
561 | |
483 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
562 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
484 | |
563 | |
485 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
564 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
486 | |
565 | |
… | |
… | |
507 | responsibility to either stop all watchers cleanly yourself I<before> |
586 | responsibility to either stop all watchers cleanly yourself I<before> |
508 | calling this function, or cope with the fact afterwards (which is usually |
587 | calling this function, or cope with the fact afterwards (which is usually |
509 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
588 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
510 | for example). |
589 | for example). |
511 | |
590 | |
512 | Note that certain global state, such as signal state, will not be freed by |
591 | Note that certain global state, such as signal state (and installed signal |
513 | this function, and related watchers (such as signal and child watchers) |
592 | handlers), will not be freed by this function, and related watchers (such |
514 | would need to be stopped manually. |
593 | as signal and child watchers) would need to be stopped manually. |
515 | |
594 | |
516 | In general it is not advisable to call this function except in the |
595 | In general it is not advisable to call this function except in the |
517 | rare occasion where you really need to free e.g. the signal handling |
596 | rare occasion where you really need to free e.g. the signal handling |
518 | pipe fds. If you need dynamically allocated loops it is better to use |
597 | pipe fds. If you need dynamically allocated loops it is better to use |
519 | C<ev_loop_new> and C<ev_loop_destroy>). |
598 | C<ev_loop_new> and C<ev_loop_destroy>. |
520 | |
599 | |
521 | =item ev_loop_destroy (loop) |
600 | =item ev_loop_destroy (loop) |
522 | |
601 | |
523 | Like C<ev_default_destroy>, but destroys an event loop created by an |
602 | Like C<ev_default_destroy>, but destroys an event loop created by an |
524 | earlier call to C<ev_loop_new>. |
603 | earlier call to C<ev_loop_new>. |
… | |
… | |
544 | |
623 | |
545 | =item ev_loop_fork (loop) |
624 | =item ev_loop_fork (loop) |
546 | |
625 | |
547 | Like C<ev_default_fork>, but acts on an event loop created by |
626 | Like C<ev_default_fork>, but acts on an event loop created by |
548 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
627 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
549 | after fork, and how you do this is entirely your own problem. |
628 | after fork that you want to re-use in the child, and how you do this is |
|
|
629 | entirely your own problem. |
550 | |
630 | |
551 | =item int ev_is_default_loop (loop) |
631 | =item int ev_is_default_loop (loop) |
552 | |
632 | |
553 | Returns true when the given loop actually is the default loop, false otherwise. |
633 | Returns true when the given loop is, in fact, the default loop, and false |
|
|
634 | otherwise. |
554 | |
635 | |
555 | =item unsigned int ev_loop_count (loop) |
636 | =item unsigned int ev_loop_count (loop) |
556 | |
637 | |
557 | Returns the count of loop iterations for the loop, which is identical to |
638 | Returns the count of loop iterations for the loop, which is identical to |
558 | the number of times libev did poll for new events. It starts at C<0> and |
639 | the number of times libev did poll for new events. It starts at C<0> and |
559 | happily wraps around with enough iterations. |
640 | happily wraps around with enough iterations. |
560 | |
641 | |
561 | This value can sometimes be useful as a generation counter of sorts (it |
642 | This value can sometimes be useful as a generation counter of sorts (it |
562 | "ticks" the number of loop iterations), as it roughly corresponds with |
643 | "ticks" the number of loop iterations), as it roughly corresponds with |
563 | C<ev_prepare> and C<ev_check> calls. |
644 | C<ev_prepare> and C<ev_check> calls. |
|
|
645 | |
|
|
646 | =item unsigned int ev_loop_depth (loop) |
|
|
647 | |
|
|
648 | Returns the number of times C<ev_loop> was entered minus the number of |
|
|
649 | times C<ev_loop> was exited, in other words, the recursion depth. |
|
|
650 | |
|
|
651 | Outside C<ev_loop>, this number is zero. In a callback, this number is |
|
|
652 | C<1>, unless C<ev_loop> was invoked recursively (or from another thread), |
|
|
653 | in which case it is higher. |
|
|
654 | |
|
|
655 | Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread |
|
|
656 | etc.), doesn't count as exit. |
564 | |
657 | |
565 | =item unsigned int ev_backend (loop) |
658 | =item unsigned int ev_backend (loop) |
566 | |
659 | |
567 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
660 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
568 | use. |
661 | use. |
… | |
… | |
583 | |
676 | |
584 | This function is rarely useful, but when some event callback runs for a |
677 | This function is rarely useful, but when some event callback runs for a |
585 | very long time without entering the event loop, updating libev's idea of |
678 | very long time without entering the event loop, updating libev's idea of |
586 | the current time is a good idea. |
679 | the current time is a good idea. |
587 | |
680 | |
588 | See also "The special problem of time updates" in the C<ev_timer> section. |
681 | See also L<The special problem of time updates> in the C<ev_timer> section. |
|
|
682 | |
|
|
683 | =item ev_suspend (loop) |
|
|
684 | |
|
|
685 | =item ev_resume (loop) |
|
|
686 | |
|
|
687 | These two functions suspend and resume a loop, for use when the loop is |
|
|
688 | not used for a while and timeouts should not be processed. |
|
|
689 | |
|
|
690 | A typical use case would be an interactive program such as a game: When |
|
|
691 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
692 | would be best to handle timeouts as if no time had actually passed while |
|
|
693 | the program was suspended. This can be achieved by calling C<ev_suspend> |
|
|
694 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
695 | C<ev_resume> directly afterwards to resume timer processing. |
|
|
696 | |
|
|
697 | Effectively, all C<ev_timer> watchers will be delayed by the time spend |
|
|
698 | between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers |
|
|
699 | will be rescheduled (that is, they will lose any events that would have |
|
|
700 | occured while suspended). |
|
|
701 | |
|
|
702 | After calling C<ev_suspend> you B<must not> call I<any> function on the |
|
|
703 | given loop other than C<ev_resume>, and you B<must not> call C<ev_resume> |
|
|
704 | without a previous call to C<ev_suspend>. |
|
|
705 | |
|
|
706 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
|
|
707 | event loop time (see C<ev_now_update>). |
589 | |
708 | |
590 | =item ev_loop (loop, int flags) |
709 | =item ev_loop (loop, int flags) |
591 | |
710 | |
592 | Finally, this is it, the event handler. This function usually is called |
711 | Finally, this is it, the event handler. This function usually is called |
593 | after you initialised all your watchers and you want to start handling |
712 | after you have initialised all your watchers and you want to start |
594 | events. |
713 | handling events. |
595 | |
714 | |
596 | If the flags argument is specified as C<0>, it will not return until |
715 | If the flags argument is specified as C<0>, it will not return until |
597 | either no event watchers are active anymore or C<ev_unloop> was called. |
716 | either no event watchers are active anymore or C<ev_unloop> was called. |
598 | |
717 | |
599 | Please note that an explicit C<ev_unloop> is usually better than |
718 | Please note that an explicit C<ev_unloop> is usually better than |
600 | relying on all watchers to be stopped when deciding when a program has |
719 | relying on all watchers to be stopped when deciding when a program has |
601 | finished (especially in interactive programs), but having a program that |
720 | finished (especially in interactive programs), but having a program |
602 | automatically loops as long as it has to and no longer by virtue of |
721 | that automatically loops as long as it has to and no longer by virtue |
603 | relying on its watchers stopping correctly is a thing of beauty. |
722 | of relying on its watchers stopping correctly, that is truly a thing of |
|
|
723 | beauty. |
604 | |
724 | |
605 | A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle |
725 | A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle |
606 | those events and any outstanding ones, but will not block your process in |
726 | those events and any already outstanding ones, but will not block your |
607 | case there are no events and will return after one iteration of the loop. |
727 | process in case there are no events and will return after one iteration of |
|
|
728 | the loop. |
608 | |
729 | |
609 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
730 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
610 | necessary) and will handle those and any outstanding ones. It will block |
731 | necessary) and will handle those and any already outstanding ones. It |
611 | your process until at least one new event arrives, and will return after |
732 | will block your process until at least one new event arrives (which could |
612 | one iteration of the loop. This is useful if you are waiting for some |
733 | be an event internal to libev itself, so there is no guarantee that a |
613 | external event in conjunction with something not expressible using other |
734 | user-registered callback will be called), and will return after one |
|
|
735 | iteration of the loop. |
|
|
736 | |
|
|
737 | This is useful if you are waiting for some external event in conjunction |
|
|
738 | with something not expressible using other libev watchers (i.e. "roll your |
614 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
739 | own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is |
615 | usually a better approach for this kind of thing. |
740 | usually a better approach for this kind of thing. |
616 | |
741 | |
617 | Here are the gory details of what C<ev_loop> does: |
742 | Here are the gory details of what C<ev_loop> does: |
618 | |
743 | |
619 | - Before the first iteration, call any pending watchers. |
744 | - Before the first iteration, call any pending watchers. |
… | |
… | |
629 | any active watchers at all will result in not sleeping). |
754 | any active watchers at all will result in not sleeping). |
630 | - Sleep if the I/O and timer collect interval say so. |
755 | - Sleep if the I/O and timer collect interval say so. |
631 | - Block the process, waiting for any events. |
756 | - Block the process, waiting for any events. |
632 | - Queue all outstanding I/O (fd) events. |
757 | - Queue all outstanding I/O (fd) events. |
633 | - Update the "event loop time" (ev_now ()), and do time jump adjustments. |
758 | - Update the "event loop time" (ev_now ()), and do time jump adjustments. |
634 | - Queue all outstanding timers. |
759 | - Queue all expired timers. |
635 | - Queue all outstanding periodics. |
760 | - Queue all expired periodics. |
636 | - Unless any events are pending now, queue all idle watchers. |
761 | - Unless any events are pending now, queue all idle watchers. |
637 | - Queue all check watchers. |
762 | - Queue all check watchers. |
638 | - Call all queued watchers in reverse order (i.e. check watchers first). |
763 | - Call all queued watchers in reverse order (i.e. check watchers first). |
639 | Signals and child watchers are implemented as I/O watchers, and will |
764 | Signals and child watchers are implemented as I/O watchers, and will |
640 | be handled here by queueing them when their watcher gets executed. |
765 | be handled here by queueing them when their watcher gets executed. |
… | |
… | |
657 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
782 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
658 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
783 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
659 | |
784 | |
660 | This "unloop state" will be cleared when entering C<ev_loop> again. |
785 | This "unloop state" will be cleared when entering C<ev_loop> again. |
661 | |
786 | |
|
|
787 | It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls. |
|
|
788 | |
662 | =item ev_ref (loop) |
789 | =item ev_ref (loop) |
663 | |
790 | |
664 | =item ev_unref (loop) |
791 | =item ev_unref (loop) |
665 | |
792 | |
666 | Ref/unref can be used to add or remove a reference count on the event |
793 | Ref/unref can be used to add or remove a reference count on the event |
667 | loop: Every watcher keeps one reference, and as long as the reference |
794 | loop: Every watcher keeps one reference, and as long as the reference |
668 | count is nonzero, C<ev_loop> will not return on its own. If you have |
795 | count is nonzero, C<ev_loop> will not return on its own. |
669 | a watcher you never unregister that should not keep C<ev_loop> from |
796 | |
670 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
797 | This is useful when you have a watcher that you never intend to |
|
|
798 | unregister, but that nevertheless should not keep C<ev_loop> from |
|
|
799 | returning. In such a case, call C<ev_unref> after starting, and C<ev_ref> |
|
|
800 | before stopping it. |
|
|
801 | |
671 | example, libev itself uses this for its internal signal pipe: It is not |
802 | As an example, libev itself uses this for its internal signal pipe: It |
672 | visible to the libev user and should not keep C<ev_loop> from exiting if |
803 | is not visible to the libev user and should not keep C<ev_loop> from |
673 | no event watchers registered by it are active. It is also an excellent |
804 | exiting if no event watchers registered by it are active. It is also an |
674 | way to do this for generic recurring timers or from within third-party |
805 | excellent way to do this for generic recurring timers or from within |
675 | libraries. Just remember to I<unref after start> and I<ref before stop> |
806 | third-party libraries. Just remember to I<unref after start> and I<ref |
676 | (but only if the watcher wasn't active before, or was active before, |
807 | before stop> (but only if the watcher wasn't active before, or was active |
677 | respectively). |
808 | before, respectively. Note also that libev might stop watchers itself |
|
|
809 | (e.g. non-repeating timers) in which case you have to C<ev_ref> |
|
|
810 | in the callback). |
678 | |
811 | |
679 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
812 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
680 | running when nothing else is active. |
813 | running when nothing else is active. |
681 | |
814 | |
682 | struct ev_signal exitsig; |
815 | ev_signal exitsig; |
683 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
816 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
684 | ev_signal_start (loop, &exitsig); |
817 | ev_signal_start (loop, &exitsig); |
685 | evf_unref (loop); |
818 | evf_unref (loop); |
686 | |
819 | |
687 | Example: For some weird reason, unregister the above signal handler again. |
820 | Example: For some weird reason, unregister the above signal handler again. |
… | |
… | |
701 | Setting these to a higher value (the C<interval> I<must> be >= C<0>) |
834 | Setting these to a higher value (the C<interval> I<must> be >= C<0>) |
702 | allows libev to delay invocation of I/O and timer/periodic callbacks |
835 | allows libev to delay invocation of I/O and timer/periodic callbacks |
703 | to increase efficiency of loop iterations (or to increase power-saving |
836 | to increase efficiency of loop iterations (or to increase power-saving |
704 | opportunities). |
837 | opportunities). |
705 | |
838 | |
706 | The background is that sometimes your program runs just fast enough to |
839 | The idea is that sometimes your program runs just fast enough to handle |
707 | handle one (or very few) event(s) per loop iteration. While this makes |
840 | one (or very few) event(s) per loop iteration. While this makes the |
708 | the program responsive, it also wastes a lot of CPU time to poll for new |
841 | program responsive, it also wastes a lot of CPU time to poll for new |
709 | events, especially with backends like C<select ()> which have a high |
842 | events, especially with backends like C<select ()> which have a high |
710 | overhead for the actual polling but can deliver many events at once. |
843 | overhead for the actual polling but can deliver many events at once. |
711 | |
844 | |
712 | By setting a higher I<io collect interval> you allow libev to spend more |
845 | By setting a higher I<io collect interval> you allow libev to spend more |
713 | time collecting I/O events, so you can handle more events per iteration, |
846 | time collecting I/O events, so you can handle more events per iteration, |
714 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
847 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
715 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
848 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
716 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
849 | introduce an additional C<ev_sleep ()> call into most loop iterations. The |
|
|
850 | sleep time ensures that libev will not poll for I/O events more often then |
|
|
851 | once per this interval, on average. |
717 | |
852 | |
718 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
853 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
719 | to spend more time collecting timeouts, at the expense of increased |
854 | to spend more time collecting timeouts, at the expense of increased |
720 | latency (the watcher callback will be called later). C<ev_io> watchers |
855 | latency/jitter/inexactness (the watcher callback will be called |
721 | will not be affected. Setting this to a non-null value will not introduce |
856 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
722 | any overhead in libev. |
857 | value will not introduce any overhead in libev. |
723 | |
858 | |
724 | Many (busy) programs can usually benefit by setting the I/O collect |
859 | Many (busy) programs can usually benefit by setting the I/O collect |
725 | interval to a value near C<0.1> or so, which is often enough for |
860 | interval to a value near C<0.1> or so, which is often enough for |
726 | interactive servers (of course not for games), likewise for timeouts. It |
861 | interactive servers (of course not for games), likewise for timeouts. It |
727 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
862 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
728 | as this approaches the timing granularity of most systems. |
863 | as this approaches the timing granularity of most systems. Note that if |
|
|
864 | you do transactions with the outside world and you can't increase the |
|
|
865 | parallelity, then this setting will limit your transaction rate (if you |
|
|
866 | need to poll once per transaction and the I/O collect interval is 0.01, |
|
|
867 | then you can't do more than 100 transations per second). |
729 | |
868 | |
730 | Setting the I<timeout collect interval> can improve the opportunity for |
869 | Setting the I<timeout collect interval> can improve the opportunity for |
731 | saving power, as the program will "bundle" timer callback invocations that |
870 | saving power, as the program will "bundle" timer callback invocations that |
732 | are "near" in time together, by delaying some, thus reducing the number of |
871 | are "near" in time together, by delaying some, thus reducing the number of |
733 | times the process sleeps and wakes up again. Another useful technique to |
872 | times the process sleeps and wakes up again. Another useful technique to |
734 | reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure |
873 | reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure |
735 | they fire on, say, one-second boundaries only. |
874 | they fire on, say, one-second boundaries only. |
736 | |
875 | |
|
|
876 | Example: we only need 0.1s timeout granularity, and we wish not to poll |
|
|
877 | more often than 100 times per second: |
|
|
878 | |
|
|
879 | ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); |
|
|
880 | ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
|
|
881 | |
|
|
882 | =item ev_invoke_pending (loop) |
|
|
883 | |
|
|
884 | This call will simply invoke all pending watchers while resetting their |
|
|
885 | pending state. Normally, C<ev_loop> does this automatically when required, |
|
|
886 | but when overriding the invoke callback this call comes handy. |
|
|
887 | |
|
|
888 | =item int ev_pending_count (loop) |
|
|
889 | |
|
|
890 | Returns the number of pending watchers - zero indicates that no watchers |
|
|
891 | are pending. |
|
|
892 | |
|
|
893 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
|
|
894 | |
|
|
895 | This overrides the invoke pending functionality of the loop: Instead of |
|
|
896 | invoking all pending watchers when there are any, C<ev_loop> will call |
|
|
897 | this callback instead. This is useful, for example, when you want to |
|
|
898 | invoke the actual watchers inside another context (another thread etc.). |
|
|
899 | |
|
|
900 | If you want to reset the callback, use C<ev_invoke_pending> as new |
|
|
901 | callback. |
|
|
902 | |
|
|
903 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
|
|
904 | |
|
|
905 | Sometimes you want to share the same loop between multiple threads. This |
|
|
906 | can be done relatively simply by putting mutex_lock/unlock calls around |
|
|
907 | each call to a libev function. |
|
|
908 | |
|
|
909 | However, C<ev_loop> can run an indefinite time, so it is not feasible to |
|
|
910 | wait for it to return. One way around this is to wake up the loop via |
|
|
911 | C<ev_unloop> and C<av_async_send>, another way is to set these I<release> |
|
|
912 | and I<acquire> callbacks on the loop. |
|
|
913 | |
|
|
914 | When set, then C<release> will be called just before the thread is |
|
|
915 | suspended waiting for new events, and C<acquire> is called just |
|
|
916 | afterwards. |
|
|
917 | |
|
|
918 | Ideally, C<release> will just call your mutex_unlock function, and |
|
|
919 | C<acquire> will just call the mutex_lock function again. |
|
|
920 | |
|
|
921 | While event loop modifications are allowed between invocations of |
|
|
922 | C<release> and C<acquire> (that's their only purpose after all), no |
|
|
923 | modifications done will affect the event loop, i.e. adding watchers will |
|
|
924 | have no effect on the set of file descriptors being watched, or the time |
|
|
925 | waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it |
|
|
926 | to take note of any changes you made. |
|
|
927 | |
|
|
928 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
|
|
929 | invocations of C<release> and C<acquire>. |
|
|
930 | |
|
|
931 | See also the locking example in the C<THREADS> section later in this |
|
|
932 | document. |
|
|
933 | |
|
|
934 | =item ev_set_userdata (loop, void *data) |
|
|
935 | |
|
|
936 | =item ev_userdata (loop) |
|
|
937 | |
|
|
938 | Set and retrieve a single C<void *> associated with a loop. When |
|
|
939 | C<ev_set_userdata> has never been called, then C<ev_userdata> returns |
|
|
940 | C<0.> |
|
|
941 | |
|
|
942 | These two functions can be used to associate arbitrary data with a loop, |
|
|
943 | and are intended solely for the C<invoke_pending_cb>, C<release> and |
|
|
944 | C<acquire> callbacks described above, but of course can be (ab-)used for |
|
|
945 | any other purpose as well. |
|
|
946 | |
737 | =item ev_loop_verify (loop) |
947 | =item ev_loop_verify (loop) |
738 | |
948 | |
739 | This function only does something when C<EV_VERIFY> support has been |
949 | This function only does something when C<EV_VERIFY> support has been |
740 | compiled in. It tries to go through all internal structures and checks |
950 | compiled in, which is the default for non-minimal builds. It tries to go |
741 | them for validity. If anything is found to be inconsistent, it will print |
951 | through all internal structures and checks them for validity. If anything |
742 | an error message to standard error and call C<abort ()>. |
952 | is found to be inconsistent, it will print an error message to standard |
|
|
953 | error and call C<abort ()>. |
743 | |
954 | |
744 | This can be used to catch bugs inside libev itself: under normal |
955 | This can be used to catch bugs inside libev itself: under normal |
745 | circumstances, this function will never abort as of course libev keeps its |
956 | circumstances, this function will never abort as of course libev keeps its |
746 | data structures consistent. |
957 | data structures consistent. |
747 | |
958 | |
748 | =back |
959 | =back |
749 | |
960 | |
750 | |
961 | |
751 | =head1 ANATOMY OF A WATCHER |
962 | =head1 ANATOMY OF A WATCHER |
752 | |
963 | |
|
|
964 | In the following description, uppercase C<TYPE> in names stands for the |
|
|
965 | watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer |
|
|
966 | watchers and C<ev_io_start> for I/O watchers. |
|
|
967 | |
753 | A watcher is a structure that you create and register to record your |
968 | A watcher is a structure that you create and register to record your |
754 | interest in some event. For instance, if you want to wait for STDIN to |
969 | interest in some event. For instance, if you want to wait for STDIN to |
755 | become readable, you would create an C<ev_io> watcher for that: |
970 | become readable, you would create an C<ev_io> watcher for that: |
756 | |
971 | |
757 | static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
972 | static void my_cb (struct ev_loop *loop, ev_io *w, int revents) |
758 | { |
973 | { |
759 | ev_io_stop (w); |
974 | ev_io_stop (w); |
760 | ev_unloop (loop, EVUNLOOP_ALL); |
975 | ev_unloop (loop, EVUNLOOP_ALL); |
761 | } |
976 | } |
762 | |
977 | |
763 | struct ev_loop *loop = ev_default_loop (0); |
978 | struct ev_loop *loop = ev_default_loop (0); |
|
|
979 | |
764 | struct ev_io stdin_watcher; |
980 | ev_io stdin_watcher; |
|
|
981 | |
765 | ev_init (&stdin_watcher, my_cb); |
982 | ev_init (&stdin_watcher, my_cb); |
766 | ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
983 | ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
767 | ev_io_start (loop, &stdin_watcher); |
984 | ev_io_start (loop, &stdin_watcher); |
|
|
985 | |
768 | ev_loop (loop, 0); |
986 | ev_loop (loop, 0); |
769 | |
987 | |
770 | As you can see, you are responsible for allocating the memory for your |
988 | As you can see, you are responsible for allocating the memory for your |
771 | watcher structures (and it is usually a bad idea to do this on the stack, |
989 | watcher structures (and it is I<usually> a bad idea to do this on the |
772 | although this can sometimes be quite valid). |
990 | stack). |
|
|
991 | |
|
|
992 | Each watcher has an associated watcher structure (called C<struct ev_TYPE> |
|
|
993 | or simply C<ev_TYPE>, as typedefs are provided for all watcher structs). |
773 | |
994 | |
774 | Each watcher structure must be initialised by a call to C<ev_init |
995 | Each watcher structure must be initialised by a call to C<ev_init |
775 | (watcher *, callback)>, which expects a callback to be provided. This |
996 | (watcher *, callback)>, which expects a callback to be provided. This |
776 | callback gets invoked each time the event occurs (or, in the case of I/O |
997 | callback gets invoked each time the event occurs (or, in the case of I/O |
777 | watchers, each time the event loop detects that the file descriptor given |
998 | watchers, each time the event loop detects that the file descriptor given |
778 | is readable and/or writable). |
999 | is readable and/or writable). |
779 | |
1000 | |
780 | Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro |
1001 | Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >> |
781 | with arguments specific to this watcher type. There is also a macro |
1002 | macro to configure it, with arguments specific to the watcher type. There |
782 | to combine initialisation and setting in one call: C<< ev_<type>_init |
1003 | is also a macro to combine initialisation and setting in one call: C<< |
783 | (watcher *, callback, ...) >>. |
1004 | ev_TYPE_init (watcher *, callback, ...) >>. |
784 | |
1005 | |
785 | To make the watcher actually watch out for events, you have to start it |
1006 | To make the watcher actually watch out for events, you have to start it |
786 | with a watcher-specific start function (C<< ev_<type>_start (loop, watcher |
1007 | with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher |
787 | *) >>), and you can stop watching for events at any time by calling the |
1008 | *) >>), and you can stop watching for events at any time by calling the |
788 | corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>. |
1009 | corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. |
789 | |
1010 | |
790 | As long as your watcher is active (has been started but not stopped) you |
1011 | As long as your watcher is active (has been started but not stopped) you |
791 | must not touch the values stored in it. Most specifically you must never |
1012 | must not touch the values stored in it. Most specifically you must never |
792 | reinitialise it or call its C<set> macro. |
1013 | reinitialise it or call its C<ev_TYPE_set> macro. |
793 | |
1014 | |
794 | Each and every callback receives the event loop pointer as first, the |
1015 | Each and every callback receives the event loop pointer as first, the |
795 | registered watcher structure as second, and a bitset of received events as |
1016 | registered watcher structure as second, and a bitset of received events as |
796 | third argument. |
1017 | third argument. |
797 | |
1018 | |
… | |
… | |
855 | |
1076 | |
856 | =item C<EV_ASYNC> |
1077 | =item C<EV_ASYNC> |
857 | |
1078 | |
858 | The given async watcher has been asynchronously notified (see C<ev_async>). |
1079 | The given async watcher has been asynchronously notified (see C<ev_async>). |
859 | |
1080 | |
|
|
1081 | =item C<EV_CUSTOM> |
|
|
1082 | |
|
|
1083 | Not ever sent (or otherwise used) by libev itself, but can be freely used |
|
|
1084 | by libev users to signal watchers (e.g. via C<ev_feed_event>). |
|
|
1085 | |
860 | =item C<EV_ERROR> |
1086 | =item C<EV_ERROR> |
861 | |
1087 | |
862 | An unspecified error has occurred, the watcher has been stopped. This might |
1088 | An unspecified error has occurred, the watcher has been stopped. This might |
863 | happen because the watcher could not be properly started because libev |
1089 | happen because the watcher could not be properly started because libev |
864 | ran out of memory, a file descriptor was found to be closed or any other |
1090 | ran out of memory, a file descriptor was found to be closed or any other |
|
|
1091 | problem. Libev considers these application bugs. |
|
|
1092 | |
865 | problem. You best act on it by reporting the problem and somehow coping |
1093 | You best act on it by reporting the problem and somehow coping with the |
866 | with the watcher being stopped. |
1094 | watcher being stopped. Note that well-written programs should not receive |
|
|
1095 | an error ever, so when your watcher receives it, this usually indicates a |
|
|
1096 | bug in your program. |
867 | |
1097 | |
868 | Libev will usually signal a few "dummy" events together with an error, |
1098 | Libev will usually signal a few "dummy" events together with an error, for |
869 | for example it might indicate that a fd is readable or writable, and if |
1099 | example it might indicate that a fd is readable or writable, and if your |
870 | your callbacks is well-written it can just attempt the operation and cope |
1100 | callbacks is well-written it can just attempt the operation and cope with |
871 | with the error from read() or write(). This will not work in multi-threaded |
1101 | the error from read() or write(). This will not work in multi-threaded |
872 | programs, though, so beware. |
1102 | programs, though, as the fd could already be closed and reused for another |
|
|
1103 | thing, so beware. |
873 | |
1104 | |
874 | =back |
1105 | =back |
875 | |
1106 | |
876 | =head2 GENERIC WATCHER FUNCTIONS |
1107 | =head2 GENERIC WATCHER FUNCTIONS |
877 | |
|
|
878 | In the following description, C<TYPE> stands for the watcher type, |
|
|
879 | e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers. |
|
|
880 | |
1108 | |
881 | =over 4 |
1109 | =over 4 |
882 | |
1110 | |
883 | =item C<ev_init> (ev_TYPE *watcher, callback) |
1111 | =item C<ev_init> (ev_TYPE *watcher, callback) |
884 | |
1112 | |
… | |
… | |
890 | which rolls both calls into one. |
1118 | which rolls both calls into one. |
891 | |
1119 | |
892 | You can reinitialise a watcher at any time as long as it has been stopped |
1120 | You can reinitialise a watcher at any time as long as it has been stopped |
893 | (or never started) and there are no pending events outstanding. |
1121 | (or never started) and there are no pending events outstanding. |
894 | |
1122 | |
895 | The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher, |
1123 | The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher, |
896 | int revents)>. |
1124 | int revents)>. |
897 | |
1125 | |
|
|
1126 | Example: Initialise an C<ev_io> watcher in two steps. |
|
|
1127 | |
|
|
1128 | ev_io w; |
|
|
1129 | ev_init (&w, my_cb); |
|
|
1130 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
|
|
1131 | |
898 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
1132 | =item C<ev_TYPE_set> (ev_TYPE *watcher, [args]) |
899 | |
1133 | |
900 | This macro initialises the type-specific parts of a watcher. You need to |
1134 | This macro initialises the type-specific parts of a watcher. You need to |
901 | call C<ev_init> at least once before you call this macro, but you can |
1135 | call C<ev_init> at least once before you call this macro, but you can |
902 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1136 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
903 | macro on a watcher that is active (it can be pending, however, which is a |
1137 | macro on a watcher that is active (it can be pending, however, which is a |
904 | difference to the C<ev_init> macro). |
1138 | difference to the C<ev_init> macro). |
905 | |
1139 | |
906 | Although some watcher types do not have type-specific arguments |
1140 | Although some watcher types do not have type-specific arguments |
907 | (e.g. C<ev_prepare>) you still need to call its C<set> macro. |
1141 | (e.g. C<ev_prepare>) you still need to call its C<set> macro. |
908 | |
1142 | |
|
|
1143 | See C<ev_init>, above, for an example. |
|
|
1144 | |
909 | =item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args]) |
1145 | =item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args]) |
910 | |
1146 | |
911 | This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro |
1147 | This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro |
912 | calls into a single call. This is the most convenient method to initialise |
1148 | calls into a single call. This is the most convenient method to initialise |
913 | a watcher. The same limitations apply, of course. |
1149 | a watcher. The same limitations apply, of course. |
914 | |
1150 | |
|
|
1151 | Example: Initialise and set an C<ev_io> watcher in one step. |
|
|
1152 | |
|
|
1153 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
|
|
1154 | |
915 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
1155 | =item C<ev_TYPE_start> (loop, ev_TYPE *watcher) |
916 | |
1156 | |
917 | Starts (activates) the given watcher. Only active watchers will receive |
1157 | Starts (activates) the given watcher. Only active watchers will receive |
918 | events. If the watcher is already active nothing will happen. |
1158 | events. If the watcher is already active nothing will happen. |
919 | |
1159 | |
|
|
1160 | Example: Start the C<ev_io> watcher that is being abused as example in this |
|
|
1161 | whole section. |
|
|
1162 | |
|
|
1163 | ev_io_start (EV_DEFAULT_UC, &w); |
|
|
1164 | |
920 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
1165 | =item C<ev_TYPE_stop> (loop, ev_TYPE *watcher) |
921 | |
1166 | |
922 | Stops the given watcher again (if active) and clears the pending |
1167 | Stops the given watcher if active, and clears the pending status (whether |
|
|
1168 | the watcher was active or not). |
|
|
1169 | |
923 | status. It is possible that stopped watchers are pending (for example, |
1170 | It is possible that stopped watchers are pending - for example, |
924 | non-repeating timers are being stopped when they become pending), but |
1171 | non-repeating timers are being stopped when they become pending - but |
925 | C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If |
1172 | calling C<ev_TYPE_stop> ensures that the watcher is neither active nor |
926 | you want to free or reuse the memory used by the watcher it is therefore a |
1173 | pending. If you want to free or reuse the memory used by the watcher it is |
927 | good idea to always call its C<ev_TYPE_stop> function. |
1174 | therefore a good idea to always call its C<ev_TYPE_stop> function. |
928 | |
1175 | |
929 | =item bool ev_is_active (ev_TYPE *watcher) |
1176 | =item bool ev_is_active (ev_TYPE *watcher) |
930 | |
1177 | |
931 | Returns a true value iff the watcher is active (i.e. it has been started |
1178 | Returns a true value iff the watcher is active (i.e. it has been started |
932 | and not yet been stopped). As long as a watcher is active you must not modify |
1179 | and not yet been stopped). As long as a watcher is active you must not modify |
… | |
… | |
948 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1195 | =item ev_cb_set (ev_TYPE *watcher, callback) |
949 | |
1196 | |
950 | Change the callback. You can change the callback at virtually any time |
1197 | Change the callback. You can change the callback at virtually any time |
951 | (modulo threads). |
1198 | (modulo threads). |
952 | |
1199 | |
953 | =item ev_set_priority (ev_TYPE *watcher, priority) |
1200 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
954 | |
1201 | |
955 | =item int ev_priority (ev_TYPE *watcher) |
1202 | =item int ev_priority (ev_TYPE *watcher) |
956 | |
1203 | |
957 | Set and query the priority of the watcher. The priority is a small |
1204 | Set and query the priority of the watcher. The priority is a small |
958 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1205 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
959 | (default: C<-2>). Pending watchers with higher priority will be invoked |
1206 | (default: C<-2>). Pending watchers with higher priority will be invoked |
960 | before watchers with lower priority, but priority will not keep watchers |
1207 | before watchers with lower priority, but priority will not keep watchers |
961 | from being executed (except for C<ev_idle> watchers). |
1208 | from being executed (except for C<ev_idle> watchers). |
962 | |
1209 | |
963 | This means that priorities are I<only> used for ordering callback |
|
|
964 | invocation after new events have been received. This is useful, for |
|
|
965 | example, to reduce latency after idling, or more often, to bind two |
|
|
966 | watchers on the same event and make sure one is called first. |
|
|
967 | |
|
|
968 | If you need to suppress invocation when higher priority events are pending |
1210 | If you need to suppress invocation when higher priority events are pending |
969 | you need to look at C<ev_idle> watchers, which provide this functionality. |
1211 | you need to look at C<ev_idle> watchers, which provide this functionality. |
970 | |
1212 | |
971 | You I<must not> change the priority of a watcher as long as it is active or |
1213 | You I<must not> change the priority of a watcher as long as it is active or |
972 | pending. |
1214 | pending. |
973 | |
1215 | |
|
|
1216 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
|
|
1217 | fine, as long as you do not mind that the priority value you query might |
|
|
1218 | or might not have been clamped to the valid range. |
|
|
1219 | |
974 | The default priority used by watchers when no priority has been set is |
1220 | The default priority used by watchers when no priority has been set is |
975 | always C<0>, which is supposed to not be too high and not be too low :). |
1221 | always C<0>, which is supposed to not be too high and not be too low :). |
976 | |
1222 | |
977 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
1223 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
978 | fine, as long as you do not mind that the priority value you query might |
1224 | priorities. |
979 | or might not have been adjusted to be within valid range. |
|
|
980 | |
1225 | |
981 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1226 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
982 | |
1227 | |
983 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1228 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
984 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
1229 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
985 | can deal with that fact. |
1230 | can deal with that fact, as both are simply passed through to the |
|
|
1231 | callback. |
986 | |
1232 | |
987 | =item int ev_clear_pending (loop, ev_TYPE *watcher) |
1233 | =item int ev_clear_pending (loop, ev_TYPE *watcher) |
988 | |
1234 | |
989 | If the watcher is pending, this function returns clears its pending status |
1235 | If the watcher is pending, this function clears its pending status and |
990 | and returns its C<revents> bitset (as if its callback was invoked). If the |
1236 | returns its C<revents> bitset (as if its callback was invoked). If the |
991 | watcher isn't pending it does nothing and returns C<0>. |
1237 | watcher isn't pending it does nothing and returns C<0>. |
992 | |
1238 | |
|
|
1239 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
|
|
1240 | callback to be invoked, which can be accomplished with this function. |
|
|
1241 | |
|
|
1242 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
|
|
1243 | |
|
|
1244 | Feeds the given event set into the event loop, as if the specified event |
|
|
1245 | had happened for the specified watcher (which must be a pointer to an |
|
|
1246 | initialised but not necessarily started event watcher). Obviously you must |
|
|
1247 | not free the watcher as long as it has pending events. |
|
|
1248 | |
|
|
1249 | Stopping the watcher, letting libev invoke it, or calling |
|
|
1250 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
|
|
1251 | not started in the first place. |
|
|
1252 | |
|
|
1253 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
|
|
1254 | functions that do not need a watcher. |
|
|
1255 | |
993 | =back |
1256 | =back |
994 | |
1257 | |
995 | |
1258 | |
996 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1259 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
997 | |
1260 | |
998 | Each watcher has, by default, a member C<void *data> that you can change |
1261 | Each watcher has, by default, a member C<void *data> that you can change |
999 | and read at any time, libev will completely ignore it. This can be used |
1262 | and read at any time: libev will completely ignore it. This can be used |
1000 | to associate arbitrary data with your watcher. If you need more data and |
1263 | to associate arbitrary data with your watcher. If you need more data and |
1001 | don't want to allocate memory and store a pointer to it in that data |
1264 | don't want to allocate memory and store a pointer to it in that data |
1002 | member, you can also "subclass" the watcher type and provide your own |
1265 | member, you can also "subclass" the watcher type and provide your own |
1003 | data: |
1266 | data: |
1004 | |
1267 | |
1005 | struct my_io |
1268 | struct my_io |
1006 | { |
1269 | { |
1007 | struct ev_io io; |
1270 | ev_io io; |
1008 | int otherfd; |
1271 | int otherfd; |
1009 | void *somedata; |
1272 | void *somedata; |
1010 | struct whatever *mostinteresting; |
1273 | struct whatever *mostinteresting; |
1011 | } |
1274 | }; |
|
|
1275 | |
|
|
1276 | ... |
|
|
1277 | struct my_io w; |
|
|
1278 | ev_io_init (&w.io, my_cb, fd, EV_READ); |
1012 | |
1279 | |
1013 | And since your callback will be called with a pointer to the watcher, you |
1280 | And since your callback will be called with a pointer to the watcher, you |
1014 | can cast it back to your own type: |
1281 | can cast it back to your own type: |
1015 | |
1282 | |
1016 | static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) |
1283 | static void my_cb (struct ev_loop *loop, ev_io *w_, int revents) |
1017 | { |
1284 | { |
1018 | struct my_io *w = (struct my_io *)w_; |
1285 | struct my_io *w = (struct my_io *)w_; |
1019 | ... |
1286 | ... |
1020 | } |
1287 | } |
1021 | |
1288 | |
1022 | More interesting and less C-conformant ways of casting your callback type |
1289 | More interesting and less C-conformant ways of casting your callback type |
1023 | instead have been omitted. |
1290 | instead have been omitted. |
1024 | |
1291 | |
1025 | Another common scenario is having some data structure with multiple |
1292 | Another common scenario is to use some data structure with multiple |
1026 | watchers: |
1293 | embedded watchers: |
1027 | |
1294 | |
1028 | struct my_biggy |
1295 | struct my_biggy |
1029 | { |
1296 | { |
1030 | int some_data; |
1297 | int some_data; |
1031 | ev_timer t1; |
1298 | ev_timer t1; |
1032 | ev_timer t2; |
1299 | ev_timer t2; |
1033 | } |
1300 | } |
1034 | |
1301 | |
1035 | In this case getting the pointer to C<my_biggy> is a bit more complicated, |
1302 | In this case getting the pointer to C<my_biggy> is a bit more |
1036 | you need to use C<offsetof>: |
1303 | complicated: Either you store the address of your C<my_biggy> struct |
|
|
1304 | in the C<data> member of the watcher (for woozies), or you need to use |
|
|
1305 | some pointer arithmetic using C<offsetof> inside your watchers (for real |
|
|
1306 | programmers): |
1037 | |
1307 | |
1038 | #include <stddef.h> |
1308 | #include <stddef.h> |
1039 | |
1309 | |
1040 | static void |
1310 | static void |
1041 | t1_cb (EV_P_ struct ev_timer *w, int revents) |
1311 | t1_cb (EV_P_ ev_timer *w, int revents) |
1042 | { |
1312 | { |
1043 | struct my_biggy big = (struct my_biggy * |
1313 | struct my_biggy big = (struct my_biggy *) |
1044 | (((char *)w) - offsetof (struct my_biggy, t1)); |
1314 | (((char *)w) - offsetof (struct my_biggy, t1)); |
1045 | } |
1315 | } |
1046 | |
1316 | |
1047 | static void |
1317 | static void |
1048 | t2_cb (EV_P_ struct ev_timer *w, int revents) |
1318 | t2_cb (EV_P_ ev_timer *w, int revents) |
1049 | { |
1319 | { |
1050 | struct my_biggy big = (struct my_biggy * |
1320 | struct my_biggy big = (struct my_biggy *) |
1051 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1321 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1052 | } |
1322 | } |
|
|
1323 | |
|
|
1324 | =head2 WATCHER PRIORITY MODELS |
|
|
1325 | |
|
|
1326 | Many event loops support I<watcher priorities>, which are usually small |
|
|
1327 | integers that influence the ordering of event callback invocation |
|
|
1328 | between watchers in some way, all else being equal. |
|
|
1329 | |
|
|
1330 | In libev, Watcher priorities can be set using C<ev_set_priority>. See its |
|
|
1331 | description for the more technical details such as the actual priority |
|
|
1332 | range. |
|
|
1333 | |
|
|
1334 | There are two common ways how these these priorities are being interpreted |
|
|
1335 | by event loops: |
|
|
1336 | |
|
|
1337 | In the more common lock-out model, higher priorities "lock out" invocation |
|
|
1338 | of lower priority watchers, which means as long as higher priority |
|
|
1339 | watchers receive events, lower priority watchers are not being invoked. |
|
|
1340 | |
|
|
1341 | The less common only-for-ordering model uses priorities solely to order |
|
|
1342 | callback invocation within a single event loop iteration: Higher priority |
|
|
1343 | watchers are invoked before lower priority ones, but they all get invoked |
|
|
1344 | before polling for new events. |
|
|
1345 | |
|
|
1346 | Libev uses the second (only-for-ordering) model for all its watchers |
|
|
1347 | except for idle watchers (which use the lock-out model). |
|
|
1348 | |
|
|
1349 | The rationale behind this is that implementing the lock-out model for |
|
|
1350 | watchers is not well supported by most kernel interfaces, and most event |
|
|
1351 | libraries will just poll for the same events again and again as long as |
|
|
1352 | their callbacks have not been executed, which is very inefficient in the |
|
|
1353 | common case of one high-priority watcher locking out a mass of lower |
|
|
1354 | priority ones. |
|
|
1355 | |
|
|
1356 | Static (ordering) priorities are most useful when you have two or more |
|
|
1357 | watchers handling the same resource: a typical usage example is having an |
|
|
1358 | C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle |
|
|
1359 | timeouts. Under load, data might be received while the program handles |
|
|
1360 | other jobs, but since timers normally get invoked first, the timeout |
|
|
1361 | handler will be executed before checking for data. In that case, giving |
|
|
1362 | the timer a lower priority than the I/O watcher ensures that I/O will be |
|
|
1363 | handled first even under adverse conditions (which is usually, but not |
|
|
1364 | always, what you want). |
|
|
1365 | |
|
|
1366 | Since idle watchers use the "lock-out" model, meaning that idle watchers |
|
|
1367 | will only be executed when no same or higher priority watchers have |
|
|
1368 | received events, they can be used to implement the "lock-out" model when |
|
|
1369 | required. |
|
|
1370 | |
|
|
1371 | For example, to emulate how many other event libraries handle priorities, |
|
|
1372 | you can associate an C<ev_idle> watcher to each such watcher, and in |
|
|
1373 | the normal watcher callback, you just start the idle watcher. The real |
|
|
1374 | processing is done in the idle watcher callback. This causes libev to |
|
|
1375 | continously poll and process kernel event data for the watcher, but when |
|
|
1376 | the lock-out case is known to be rare (which in turn is rare :), this is |
|
|
1377 | workable. |
|
|
1378 | |
|
|
1379 | Usually, however, the lock-out model implemented that way will perform |
|
|
1380 | miserably under the type of load it was designed to handle. In that case, |
|
|
1381 | it might be preferable to stop the real watcher before starting the |
|
|
1382 | idle watcher, so the kernel will not have to process the event in case |
|
|
1383 | the actual processing will be delayed for considerable time. |
|
|
1384 | |
|
|
1385 | Here is an example of an I/O watcher that should run at a strictly lower |
|
|
1386 | priority than the default, and which should only process data when no |
|
|
1387 | other events are pending: |
|
|
1388 | |
|
|
1389 | ev_idle idle; // actual processing watcher |
|
|
1390 | ev_io io; // actual event watcher |
|
|
1391 | |
|
|
1392 | static void |
|
|
1393 | io_cb (EV_P_ ev_io *w, int revents) |
|
|
1394 | { |
|
|
1395 | // stop the I/O watcher, we received the event, but |
|
|
1396 | // are not yet ready to handle it. |
|
|
1397 | ev_io_stop (EV_A_ w); |
|
|
1398 | |
|
|
1399 | // start the idle watcher to ahndle the actual event. |
|
|
1400 | // it will not be executed as long as other watchers |
|
|
1401 | // with the default priority are receiving events. |
|
|
1402 | ev_idle_start (EV_A_ &idle); |
|
|
1403 | } |
|
|
1404 | |
|
|
1405 | static void |
|
|
1406 | idle_cb (EV_P_ ev_idle *w, int revents) |
|
|
1407 | { |
|
|
1408 | // actual processing |
|
|
1409 | read (STDIN_FILENO, ...); |
|
|
1410 | |
|
|
1411 | // have to start the I/O watcher again, as |
|
|
1412 | // we have handled the event |
|
|
1413 | ev_io_start (EV_P_ &io); |
|
|
1414 | } |
|
|
1415 | |
|
|
1416 | // initialisation |
|
|
1417 | ev_idle_init (&idle, idle_cb); |
|
|
1418 | ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ); |
|
|
1419 | ev_io_start (EV_DEFAULT_ &io); |
|
|
1420 | |
|
|
1421 | In the "real" world, it might also be beneficial to start a timer, so that |
|
|
1422 | low-priority connections can not be locked out forever under load. This |
|
|
1423 | enables your program to keep a lower latency for important connections |
|
|
1424 | during short periods of high load, while not completely locking out less |
|
|
1425 | important ones. |
1053 | |
1426 | |
1054 | |
1427 | |
1055 | =head1 WATCHER TYPES |
1428 | =head1 WATCHER TYPES |
1056 | |
1429 | |
1057 | This section describes each watcher in detail, but will not repeat |
1430 | This section describes each watcher in detail, but will not repeat |
… | |
… | |
1081 | In general you can register as many read and/or write event watchers per |
1454 | In general you can register as many read and/or write event watchers per |
1082 | fd as you want (as long as you don't confuse yourself). Setting all file |
1455 | fd as you want (as long as you don't confuse yourself). Setting all file |
1083 | descriptors to non-blocking mode is also usually a good idea (but not |
1456 | descriptors to non-blocking mode is also usually a good idea (but not |
1084 | required if you know what you are doing). |
1457 | required if you know what you are doing). |
1085 | |
1458 | |
1086 | If you must do this, then force the use of a known-to-be-good backend |
1459 | If you cannot use non-blocking mode, then force the use of a |
1087 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
1460 | known-to-be-good backend (at the time of this writing, this includes only |
1088 | C<EVBACKEND_POLL>). |
1461 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file |
|
|
1462 | descriptors for which non-blocking operation makes no sense (such as |
|
|
1463 | files) - libev doesn't guarentee any specific behaviour in that case. |
1089 | |
1464 | |
1090 | Another thing you have to watch out for is that it is quite easy to |
1465 | Another thing you have to watch out for is that it is quite easy to |
1091 | receive "spurious" readiness notifications, that is your callback might |
1466 | receive "spurious" readiness notifications, that is your callback might |
1092 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1467 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1093 | because there is no data. Not only are some backends known to create a |
1468 | because there is no data. Not only are some backends known to create a |
1094 | lot of those (for example Solaris ports), it is very easy to get into |
1469 | lot of those (for example Solaris ports), it is very easy to get into |
1095 | this situation even with a relatively standard program structure. Thus |
1470 | this situation even with a relatively standard program structure. Thus |
1096 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
1471 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
1097 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
1472 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
1098 | |
1473 | |
1099 | If you cannot run the fd in non-blocking mode (for example you should not |
1474 | If you cannot run the fd in non-blocking mode (for example you should |
1100 | play around with an Xlib connection), then you have to separately re-test |
1475 | not play around with an Xlib connection), then you have to separately |
1101 | whether a file descriptor is really ready with a known-to-be good interface |
1476 | re-test whether a file descriptor is really ready with a known-to-be good |
1102 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1477 | interface such as poll (fortunately in our Xlib example, Xlib already |
1103 | its own, so its quite safe to use). |
1478 | does this on its own, so its quite safe to use). Some people additionally |
|
|
1479 | use C<SIGALRM> and an interval timer, just to be sure you won't block |
|
|
1480 | indefinitely. |
|
|
1481 | |
|
|
1482 | But really, best use non-blocking mode. |
1104 | |
1483 | |
1105 | =head3 The special problem of disappearing file descriptors |
1484 | =head3 The special problem of disappearing file descriptors |
1106 | |
1485 | |
1107 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1486 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1108 | descriptor (either by calling C<close> explicitly or by any other means, |
1487 | descriptor (either due to calling C<close> explicitly or any other means, |
1109 | such as C<dup>). The reason is that you register interest in some file |
1488 | such as C<dup2>). The reason is that you register interest in some file |
1110 | descriptor, but when it goes away, the operating system will silently drop |
1489 | descriptor, but when it goes away, the operating system will silently drop |
1111 | this interest. If another file descriptor with the same number then is |
1490 | this interest. If another file descriptor with the same number then is |
1112 | registered with libev, there is no efficient way to see that this is, in |
1491 | registered with libev, there is no efficient way to see that this is, in |
1113 | fact, a different file descriptor. |
1492 | fact, a different file descriptor. |
1114 | |
1493 | |
… | |
… | |
1145 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
1524 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
1146 | C<EVBACKEND_POLL>. |
1525 | C<EVBACKEND_POLL>. |
1147 | |
1526 | |
1148 | =head3 The special problem of SIGPIPE |
1527 | =head3 The special problem of SIGPIPE |
1149 | |
1528 | |
1150 | While not really specific to libev, it is easy to forget about SIGPIPE: |
1529 | While not really specific to libev, it is easy to forget about C<SIGPIPE>: |
1151 | when writing to a pipe whose other end has been closed, your program gets |
1530 | when writing to a pipe whose other end has been closed, your program gets |
1152 | send a SIGPIPE, which, by default, aborts your program. For most programs |
1531 | sent a SIGPIPE, which, by default, aborts your program. For most programs |
1153 | this is sensible behaviour, for daemons, this is usually undesirable. |
1532 | this is sensible behaviour, for daemons, this is usually undesirable. |
1154 | |
1533 | |
1155 | So when you encounter spurious, unexplained daemon exits, make sure you |
1534 | So when you encounter spurious, unexplained daemon exits, make sure you |
1156 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1535 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1157 | somewhere, as that would have given you a big clue). |
1536 | somewhere, as that would have given you a big clue). |
… | |
… | |
1164 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1543 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1165 | |
1544 | |
1166 | =item ev_io_set (ev_io *, int fd, int events) |
1545 | =item ev_io_set (ev_io *, int fd, int events) |
1167 | |
1546 | |
1168 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1547 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1169 | receive events for and events is either C<EV_READ>, C<EV_WRITE> or |
1548 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or |
1170 | C<EV_READ | EV_WRITE> to receive the given events. |
1549 | C<EV_READ | EV_WRITE>, to express the desire to receive the given events. |
1171 | |
1550 | |
1172 | =item int fd [read-only] |
1551 | =item int fd [read-only] |
1173 | |
1552 | |
1174 | The file descriptor being watched. |
1553 | The file descriptor being watched. |
1175 | |
1554 | |
… | |
… | |
1184 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1563 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1185 | readable, but only once. Since it is likely line-buffered, you could |
1564 | readable, but only once. Since it is likely line-buffered, you could |
1186 | attempt to read a whole line in the callback. |
1565 | attempt to read a whole line in the callback. |
1187 | |
1566 | |
1188 | static void |
1567 | static void |
1189 | stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1568 | stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents) |
1190 | { |
1569 | { |
1191 | ev_io_stop (loop, w); |
1570 | ev_io_stop (loop, w); |
1192 | .. read from stdin here (or from w->fd) and haqndle any I/O errors |
1571 | .. read from stdin here (or from w->fd) and handle any I/O errors |
1193 | } |
1572 | } |
1194 | |
1573 | |
1195 | ... |
1574 | ... |
1196 | struct ev_loop *loop = ev_default_init (0); |
1575 | struct ev_loop *loop = ev_default_init (0); |
1197 | struct ev_io stdin_readable; |
1576 | ev_io stdin_readable; |
1198 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1577 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1199 | ev_io_start (loop, &stdin_readable); |
1578 | ev_io_start (loop, &stdin_readable); |
1200 | ev_loop (loop, 0); |
1579 | ev_loop (loop, 0); |
1201 | |
1580 | |
1202 | |
1581 | |
… | |
… | |
1205 | Timer watchers are simple relative timers that generate an event after a |
1584 | Timer watchers are simple relative timers that generate an event after a |
1206 | given time, and optionally repeating in regular intervals after that. |
1585 | given time, and optionally repeating in regular intervals after that. |
1207 | |
1586 | |
1208 | The timers are based on real time, that is, if you register an event that |
1587 | The timers are based on real time, that is, if you register an event that |
1209 | times out after an hour and you reset your system clock to January last |
1588 | times out after an hour and you reset your system clock to January last |
1210 | year, it will still time out after (roughly) and hour. "Roughly" because |
1589 | year, it will still time out after (roughly) one hour. "Roughly" because |
1211 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1590 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1212 | monotonic clock option helps a lot here). |
1591 | monotonic clock option helps a lot here). |
1213 | |
1592 | |
1214 | The callback is guaranteed to be invoked only after its timeout has passed, |
1593 | The callback is guaranteed to be invoked only I<after> its timeout has |
1215 | but if multiple timers become ready during the same loop iteration then |
1594 | passed (not I<at>, so on systems with very low-resolution clocks this |
1216 | order of execution is undefined. |
1595 | might introduce a small delay). If multiple timers become ready during the |
|
|
1596 | same loop iteration then the ones with earlier time-out values are invoked |
|
|
1597 | before ones of the same priority with later time-out values (but this is |
|
|
1598 | no longer true when a callback calls C<ev_loop> recursively). |
|
|
1599 | |
|
|
1600 | =head3 Be smart about timeouts |
|
|
1601 | |
|
|
1602 | Many real-world problems involve some kind of timeout, usually for error |
|
|
1603 | recovery. A typical example is an HTTP request - if the other side hangs, |
|
|
1604 | you want to raise some error after a while. |
|
|
1605 | |
|
|
1606 | What follows are some ways to handle this problem, from obvious and |
|
|
1607 | inefficient to smart and efficient. |
|
|
1608 | |
|
|
1609 | In the following, a 60 second activity timeout is assumed - a timeout that |
|
|
1610 | gets reset to 60 seconds each time there is activity (e.g. each time some |
|
|
1611 | data or other life sign was received). |
|
|
1612 | |
|
|
1613 | =over 4 |
|
|
1614 | |
|
|
1615 | =item 1. Use a timer and stop, reinitialise and start it on activity. |
|
|
1616 | |
|
|
1617 | This is the most obvious, but not the most simple way: In the beginning, |
|
|
1618 | start the watcher: |
|
|
1619 | |
|
|
1620 | ev_timer_init (timer, callback, 60., 0.); |
|
|
1621 | ev_timer_start (loop, timer); |
|
|
1622 | |
|
|
1623 | Then, each time there is some activity, C<ev_timer_stop> it, initialise it |
|
|
1624 | and start it again: |
|
|
1625 | |
|
|
1626 | ev_timer_stop (loop, timer); |
|
|
1627 | ev_timer_set (timer, 60., 0.); |
|
|
1628 | ev_timer_start (loop, timer); |
|
|
1629 | |
|
|
1630 | This is relatively simple to implement, but means that each time there is |
|
|
1631 | some activity, libev will first have to remove the timer from its internal |
|
|
1632 | data structure and then add it again. Libev tries to be fast, but it's |
|
|
1633 | still not a constant-time operation. |
|
|
1634 | |
|
|
1635 | =item 2. Use a timer and re-start it with C<ev_timer_again> inactivity. |
|
|
1636 | |
|
|
1637 | This is the easiest way, and involves using C<ev_timer_again> instead of |
|
|
1638 | C<ev_timer_start>. |
|
|
1639 | |
|
|
1640 | To implement this, configure an C<ev_timer> with a C<repeat> value |
|
|
1641 | of C<60> and then call C<ev_timer_again> at start and each time you |
|
|
1642 | successfully read or write some data. If you go into an idle state where |
|
|
1643 | you do not expect data to travel on the socket, you can C<ev_timer_stop> |
|
|
1644 | the timer, and C<ev_timer_again> will automatically restart it if need be. |
|
|
1645 | |
|
|
1646 | That means you can ignore both the C<ev_timer_start> function and the |
|
|
1647 | C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> |
|
|
1648 | member and C<ev_timer_again>. |
|
|
1649 | |
|
|
1650 | At start: |
|
|
1651 | |
|
|
1652 | ev_init (timer, callback); |
|
|
1653 | timer->repeat = 60.; |
|
|
1654 | ev_timer_again (loop, timer); |
|
|
1655 | |
|
|
1656 | Each time there is some activity: |
|
|
1657 | |
|
|
1658 | ev_timer_again (loop, timer); |
|
|
1659 | |
|
|
1660 | It is even possible to change the time-out on the fly, regardless of |
|
|
1661 | whether the watcher is active or not: |
|
|
1662 | |
|
|
1663 | timer->repeat = 30.; |
|
|
1664 | ev_timer_again (loop, timer); |
|
|
1665 | |
|
|
1666 | This is slightly more efficient then stopping/starting the timer each time |
|
|
1667 | you want to modify its timeout value, as libev does not have to completely |
|
|
1668 | remove and re-insert the timer from/into its internal data structure. |
|
|
1669 | |
|
|
1670 | It is, however, even simpler than the "obvious" way to do it. |
|
|
1671 | |
|
|
1672 | =item 3. Let the timer time out, but then re-arm it as required. |
|
|
1673 | |
|
|
1674 | This method is more tricky, but usually most efficient: Most timeouts are |
|
|
1675 | relatively long compared to the intervals between other activity - in |
|
|
1676 | our example, within 60 seconds, there are usually many I/O events with |
|
|
1677 | associated activity resets. |
|
|
1678 | |
|
|
1679 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
|
|
1680 | but remember the time of last activity, and check for a real timeout only |
|
|
1681 | within the callback: |
|
|
1682 | |
|
|
1683 | ev_tstamp last_activity; // time of last activity |
|
|
1684 | |
|
|
1685 | static void |
|
|
1686 | callback (EV_P_ ev_timer *w, int revents) |
|
|
1687 | { |
|
|
1688 | ev_tstamp now = ev_now (EV_A); |
|
|
1689 | ev_tstamp timeout = last_activity + 60.; |
|
|
1690 | |
|
|
1691 | // if last_activity + 60. is older than now, we did time out |
|
|
1692 | if (timeout < now) |
|
|
1693 | { |
|
|
1694 | // timeout occured, take action |
|
|
1695 | } |
|
|
1696 | else |
|
|
1697 | { |
|
|
1698 | // callback was invoked, but there was some activity, re-arm |
|
|
1699 | // the watcher to fire in last_activity + 60, which is |
|
|
1700 | // guaranteed to be in the future, so "again" is positive: |
|
|
1701 | w->repeat = timeout - now; |
|
|
1702 | ev_timer_again (EV_A_ w); |
|
|
1703 | } |
|
|
1704 | } |
|
|
1705 | |
|
|
1706 | To summarise the callback: first calculate the real timeout (defined |
|
|
1707 | as "60 seconds after the last activity"), then check if that time has |
|
|
1708 | been reached, which means something I<did>, in fact, time out. Otherwise |
|
|
1709 | the callback was invoked too early (C<timeout> is in the future), so |
|
|
1710 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1711 | a timeout then. |
|
|
1712 | |
|
|
1713 | Note how C<ev_timer_again> is used, taking advantage of the |
|
|
1714 | C<ev_timer_again> optimisation when the timer is already running. |
|
|
1715 | |
|
|
1716 | This scheme causes more callback invocations (about one every 60 seconds |
|
|
1717 | minus half the average time between activity), but virtually no calls to |
|
|
1718 | libev to change the timeout. |
|
|
1719 | |
|
|
1720 | To start the timer, simply initialise the watcher and set C<last_activity> |
|
|
1721 | to the current time (meaning we just have some activity :), then call the |
|
|
1722 | callback, which will "do the right thing" and start the timer: |
|
|
1723 | |
|
|
1724 | ev_init (timer, callback); |
|
|
1725 | last_activity = ev_now (loop); |
|
|
1726 | callback (loop, timer, EV_TIMEOUT); |
|
|
1727 | |
|
|
1728 | And when there is some activity, simply store the current time in |
|
|
1729 | C<last_activity>, no libev calls at all: |
|
|
1730 | |
|
|
1731 | last_actiivty = ev_now (loop); |
|
|
1732 | |
|
|
1733 | This technique is slightly more complex, but in most cases where the |
|
|
1734 | time-out is unlikely to be triggered, much more efficient. |
|
|
1735 | |
|
|
1736 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1737 | callback :) - just change the timeout and invoke the callback, which will |
|
|
1738 | fix things for you. |
|
|
1739 | |
|
|
1740 | =item 4. Wee, just use a double-linked list for your timeouts. |
|
|
1741 | |
|
|
1742 | If there is not one request, but many thousands (millions...), all |
|
|
1743 | employing some kind of timeout with the same timeout value, then one can |
|
|
1744 | do even better: |
|
|
1745 | |
|
|
1746 | When starting the timeout, calculate the timeout value and put the timeout |
|
|
1747 | at the I<end> of the list. |
|
|
1748 | |
|
|
1749 | Then use an C<ev_timer> to fire when the timeout at the I<beginning> of |
|
|
1750 | the list is expected to fire (for example, using the technique #3). |
|
|
1751 | |
|
|
1752 | When there is some activity, remove the timer from the list, recalculate |
|
|
1753 | the timeout, append it to the end of the list again, and make sure to |
|
|
1754 | update the C<ev_timer> if it was taken from the beginning of the list. |
|
|
1755 | |
|
|
1756 | This way, one can manage an unlimited number of timeouts in O(1) time for |
|
|
1757 | starting, stopping and updating the timers, at the expense of a major |
|
|
1758 | complication, and having to use a constant timeout. The constant timeout |
|
|
1759 | ensures that the list stays sorted. |
|
|
1760 | |
|
|
1761 | =back |
|
|
1762 | |
|
|
1763 | So which method the best? |
|
|
1764 | |
|
|
1765 | Method #2 is a simple no-brain-required solution that is adequate in most |
|
|
1766 | situations. Method #3 requires a bit more thinking, but handles many cases |
|
|
1767 | better, and isn't very complicated either. In most case, choosing either |
|
|
1768 | one is fine, with #3 being better in typical situations. |
|
|
1769 | |
|
|
1770 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
|
|
1771 | rather complicated, but extremely efficient, something that really pays |
|
|
1772 | off after the first million or so of active timers, i.e. it's usually |
|
|
1773 | overkill :) |
1217 | |
1774 | |
1218 | =head3 The special problem of time updates |
1775 | =head3 The special problem of time updates |
1219 | |
1776 | |
1220 | Establishing the current time is a costly operation (it usually takes at |
1777 | Establishing the current time is a costly operation (it usually takes at |
1221 | least two system calls): EV therefore updates its idea of the current |
1778 | least two system calls): EV therefore updates its idea of the current |
1222 | time only before and after C<ev_loop> polls for new events, which causes |
1779 | time only before and after C<ev_loop> collects new events, which causes a |
1223 | a growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1780 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1224 | lots of events. |
1781 | lots of events in one iteration. |
1225 | |
1782 | |
1226 | The relative timeouts are calculated relative to the C<ev_now ()> |
1783 | The relative timeouts are calculated relative to the C<ev_now ()> |
1227 | time. This is usually the right thing as this timestamp refers to the time |
1784 | time. This is usually the right thing as this timestamp refers to the time |
1228 | of the event triggering whatever timeout you are modifying/starting. If |
1785 | of the event triggering whatever timeout you are modifying/starting. If |
1229 | you suspect event processing to be delayed and you I<need> to base the |
1786 | you suspect event processing to be delayed and you I<need> to base the |
1230 | timeout on the current time, use something like this to adjust for this: |
1787 | timeout on the current time, use something like this to adjust for this: |
1231 | |
1788 | |
1232 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
1789 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
1233 | |
1790 | |
1234 | If the event loop is suspended for a long time, one can also force an |
1791 | If the event loop is suspended for a long time, you can also force an |
1235 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1792 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1236 | ()>. |
1793 | ()>. |
|
|
1794 | |
|
|
1795 | =head3 The special problems of suspended animation |
|
|
1796 | |
|
|
1797 | When you leave the server world it is quite customary to hit machines that |
|
|
1798 | can suspend/hibernate - what happens to the clocks during such a suspend? |
|
|
1799 | |
|
|
1800 | Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes |
|
|
1801 | all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue |
|
|
1802 | to run until the system is suspended, but they will not advance while the |
|
|
1803 | system is suspended. That means, on resume, it will be as if the program |
|
|
1804 | was frozen for a few seconds, but the suspend time will not be counted |
|
|
1805 | towards C<ev_timer> when a monotonic clock source is used. The real time |
|
|
1806 | clock advanced as expected, but if it is used as sole clocksource, then a |
|
|
1807 | long suspend would be detected as a time jump by libev, and timers would |
|
|
1808 | be adjusted accordingly. |
|
|
1809 | |
|
|
1810 | I would not be surprised to see different behaviour in different between |
|
|
1811 | operating systems, OS versions or even different hardware. |
|
|
1812 | |
|
|
1813 | The other form of suspend (job control, or sending a SIGSTOP) will see a |
|
|
1814 | time jump in the monotonic clocks and the realtime clock. If the program |
|
|
1815 | is suspended for a very long time, and monotonic clock sources are in use, |
|
|
1816 | then you can expect C<ev_timer>s to expire as the full suspension time |
|
|
1817 | will be counted towards the timers. When no monotonic clock source is in |
|
|
1818 | use, then libev will again assume a timejump and adjust accordingly. |
|
|
1819 | |
|
|
1820 | It might be beneficial for this latter case to call C<ev_suspend> |
|
|
1821 | and C<ev_resume> in code that handles C<SIGTSTP>, to at least get |
|
|
1822 | deterministic behaviour in this case (you can do nothing against |
|
|
1823 | C<SIGSTOP>). |
1237 | |
1824 | |
1238 | =head3 Watcher-Specific Functions and Data Members |
1825 | =head3 Watcher-Specific Functions and Data Members |
1239 | |
1826 | |
1240 | =over 4 |
1827 | =over 4 |
1241 | |
1828 | |
… | |
… | |
1265 | If the timer is started but non-repeating, stop it (as if it timed out). |
1852 | If the timer is started but non-repeating, stop it (as if it timed out). |
1266 | |
1853 | |
1267 | If the timer is repeating, either start it if necessary (with the |
1854 | If the timer is repeating, either start it if necessary (with the |
1268 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1855 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1269 | |
1856 | |
1270 | This sounds a bit complicated, but here is a useful and typical |
1857 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1271 | example: Imagine you have a TCP connection and you want a so-called idle |
1858 | usage example. |
1272 | timeout, that is, you want to be called when there have been, say, 60 |
|
|
1273 | seconds of inactivity on the socket. The easiest way to do this is to |
|
|
1274 | configure an C<ev_timer> with a C<repeat> value of C<60> and then call |
|
|
1275 | C<ev_timer_again> each time you successfully read or write some data. If |
|
|
1276 | you go into an idle state where you do not expect data to travel on the |
|
|
1277 | socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will |
|
|
1278 | automatically restart it if need be. |
|
|
1279 | |
1859 | |
1280 | That means you can ignore the C<after> value and C<ev_timer_start> |
1860 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
1281 | altogether and only ever use the C<repeat> value and C<ev_timer_again>: |
|
|
1282 | |
1861 | |
1283 | ev_timer_init (timer, callback, 0., 5.); |
1862 | Returns the remaining time until a timer fires. If the timer is active, |
1284 | ev_timer_again (loop, timer); |
1863 | then this time is relative to the current event loop time, otherwise it's |
1285 | ... |
1864 | the timeout value currently configured. |
1286 | timer->again = 17.; |
|
|
1287 | ev_timer_again (loop, timer); |
|
|
1288 | ... |
|
|
1289 | timer->again = 10.; |
|
|
1290 | ev_timer_again (loop, timer); |
|
|
1291 | |
1865 | |
1292 | This is more slightly efficient then stopping/starting the timer each time |
1866 | That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns |
1293 | you want to modify its timeout value. |
1867 | C<5>. When the timer is started and one second passes, C<ev_timer_remain> |
|
|
1868 | will return C<4>. When the timer expires and is restarted, it will return |
|
|
1869 | roughly C<7> (likely slightly less as callback invocation takes some time, |
|
|
1870 | too), and so on. |
1294 | |
1871 | |
1295 | =item ev_tstamp repeat [read-write] |
1872 | =item ev_tstamp repeat [read-write] |
1296 | |
1873 | |
1297 | The current C<repeat> value. Will be used each time the watcher times out |
1874 | The current C<repeat> value. Will be used each time the watcher times out |
1298 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1875 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
1299 | which is also when any modifications are taken into account. |
1876 | which is also when any modifications are taken into account. |
1300 | |
1877 | |
1301 | =back |
1878 | =back |
1302 | |
1879 | |
1303 | =head3 Examples |
1880 | =head3 Examples |
1304 | |
1881 | |
1305 | Example: Create a timer that fires after 60 seconds. |
1882 | Example: Create a timer that fires after 60 seconds. |
1306 | |
1883 | |
1307 | static void |
1884 | static void |
1308 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1885 | one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents) |
1309 | { |
1886 | { |
1310 | .. one minute over, w is actually stopped right here |
1887 | .. one minute over, w is actually stopped right here |
1311 | } |
1888 | } |
1312 | |
1889 | |
1313 | struct ev_timer mytimer; |
1890 | ev_timer mytimer; |
1314 | ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1891 | ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1315 | ev_timer_start (loop, &mytimer); |
1892 | ev_timer_start (loop, &mytimer); |
1316 | |
1893 | |
1317 | Example: Create a timeout timer that times out after 10 seconds of |
1894 | Example: Create a timeout timer that times out after 10 seconds of |
1318 | inactivity. |
1895 | inactivity. |
1319 | |
1896 | |
1320 | static void |
1897 | static void |
1321 | timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1898 | timeout_cb (struct ev_loop *loop, ev_timer *w, int revents) |
1322 | { |
1899 | { |
1323 | .. ten seconds without any activity |
1900 | .. ten seconds without any activity |
1324 | } |
1901 | } |
1325 | |
1902 | |
1326 | struct ev_timer mytimer; |
1903 | ev_timer mytimer; |
1327 | ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1904 | ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1328 | ev_timer_again (&mytimer); /* start timer */ |
1905 | ev_timer_again (&mytimer); /* start timer */ |
1329 | ev_loop (loop, 0); |
1906 | ev_loop (loop, 0); |
1330 | |
1907 | |
1331 | // and in some piece of code that gets executed on any "activity": |
1908 | // and in some piece of code that gets executed on any "activity": |
… | |
… | |
1336 | =head2 C<ev_periodic> - to cron or not to cron? |
1913 | =head2 C<ev_periodic> - to cron or not to cron? |
1337 | |
1914 | |
1338 | Periodic watchers are also timers of a kind, but they are very versatile |
1915 | Periodic watchers are also timers of a kind, but they are very versatile |
1339 | (and unfortunately a bit complex). |
1916 | (and unfortunately a bit complex). |
1340 | |
1917 | |
1341 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
1918 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
1342 | but on wall clock time (absolute time). You can tell a periodic watcher |
1919 | relative time, the physical time that passes) but on wall clock time |
1343 | to trigger after some specific point in time. For example, if you tell a |
1920 | (absolute time, the thing you can read on your calender or clock). The |
1344 | periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () |
1921 | difference is that wall clock time can run faster or slower than real |
1345 | + 10.>, that is, an absolute time not a delay) and then reset your system |
1922 | time, and time jumps are not uncommon (e.g. when you adjust your |
1346 | clock to January of the previous year, then it will take more than year |
1923 | wrist-watch). |
1347 | to trigger the event (unlike an C<ev_timer>, which would still trigger |
|
|
1348 | roughly 10 seconds later as it uses a relative timeout). |
|
|
1349 | |
1924 | |
|
|
1925 | You can tell a periodic watcher to trigger after some specific point |
|
|
1926 | in time: for example, if you tell a periodic watcher to trigger "in 10 |
|
|
1927 | seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time |
|
|
1928 | not a delay) and then reset your system clock to January of the previous |
|
|
1929 | year, then it will take a year or more to trigger the event (unlike an |
|
|
1930 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
|
|
1931 | it, as it uses a relative timeout). |
|
|
1932 | |
1350 | C<ev_periodic>s can also be used to implement vastly more complex timers, |
1933 | C<ev_periodic> watchers can also be used to implement vastly more complex |
1351 | such as triggering an event on each "midnight, local time", or other |
1934 | timers, such as triggering an event on each "midnight, local time", or |
1352 | complicated, rules. |
1935 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
|
|
1936 | those cannot react to time jumps. |
1353 | |
1937 | |
1354 | As with timers, the callback is guaranteed to be invoked only when the |
1938 | As with timers, the callback is guaranteed to be invoked only when the |
1355 | time (C<at>) has passed, but if multiple periodic timers become ready |
1939 | point in time where it is supposed to trigger has passed. If multiple |
1356 | during the same loop iteration then order of execution is undefined. |
1940 | timers become ready during the same loop iteration then the ones with |
|
|
1941 | earlier time-out values are invoked before ones with later time-out values |
|
|
1942 | (but this is no longer true when a callback calls C<ev_loop> recursively). |
1357 | |
1943 | |
1358 | =head3 Watcher-Specific Functions and Data Members |
1944 | =head3 Watcher-Specific Functions and Data Members |
1359 | |
1945 | |
1360 | =over 4 |
1946 | =over 4 |
1361 | |
1947 | |
1362 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
1948 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb) |
1363 | |
1949 | |
1364 | =item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) |
1950 | =item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb) |
1365 | |
1951 | |
1366 | Lots of arguments, lets sort it out... There are basically three modes of |
1952 | Lots of arguments, let's sort it out... There are basically three modes of |
1367 | operation, and we will explain them from simplest to complex: |
1953 | operation, and we will explain them from simplest to most complex: |
1368 | |
1954 | |
1369 | =over 4 |
1955 | =over 4 |
1370 | |
1956 | |
1371 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1957 | =item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0) |
1372 | |
1958 | |
1373 | In this configuration the watcher triggers an event after the wall clock |
1959 | In this configuration the watcher triggers an event after the wall clock |
1374 | time C<at> has passed and doesn't repeat. It will not adjust when a time |
1960 | time C<offset> has passed. It will not repeat and will not adjust when a |
1375 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1961 | time jump occurs, that is, if it is to be run at January 1st 2011 then it |
1376 | run when the system time reaches or surpasses this time. |
1962 | will be stopped and invoked when the system clock reaches or surpasses |
|
|
1963 | this point in time. |
1377 | |
1964 | |
1378 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1965 | =item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0) |
1379 | |
1966 | |
1380 | In this mode the watcher will always be scheduled to time out at the next |
1967 | In this mode the watcher will always be scheduled to time out at the next |
1381 | C<at + N * interval> time (for some integer N, which can also be negative) |
1968 | C<offset + N * interval> time (for some integer N, which can also be |
1382 | and then repeat, regardless of any time jumps. |
1969 | negative) and then repeat, regardless of any time jumps. The C<offset> |
|
|
1970 | argument is merely an offset into the C<interval> periods. |
1383 | |
1971 | |
1384 | This can be used to create timers that do not drift with respect to system |
1972 | This can be used to create timers that do not drift with respect to the |
1385 | time, for example, here is a C<ev_periodic> that triggers each hour, on |
1973 | system clock, for example, here is an C<ev_periodic> that triggers each |
1386 | the hour: |
1974 | hour, on the hour (with respect to UTC): |
1387 | |
1975 | |
1388 | ev_periodic_set (&periodic, 0., 3600., 0); |
1976 | ev_periodic_set (&periodic, 0., 3600., 0); |
1389 | |
1977 | |
1390 | This doesn't mean there will always be 3600 seconds in between triggers, |
1978 | This doesn't mean there will always be 3600 seconds in between triggers, |
1391 | but only that the callback will be called when the system time shows a |
1979 | but only that the callback will be called when the system time shows a |
1392 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1980 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1393 | by 3600. |
1981 | by 3600. |
1394 | |
1982 | |
1395 | Another way to think about it (for the mathematically inclined) is that |
1983 | Another way to think about it (for the mathematically inclined) is that |
1396 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1984 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1397 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1985 | time where C<time = offset (mod interval)>, regardless of any time jumps. |
1398 | |
1986 | |
1399 | For numerical stability it is preferable that the C<at> value is near |
1987 | For numerical stability it is preferable that the C<offset> value is near |
1400 | C<ev_now ()> (the current time), but there is no range requirement for |
1988 | C<ev_now ()> (the current time), but there is no range requirement for |
1401 | this value, and in fact is often specified as zero. |
1989 | this value, and in fact is often specified as zero. |
1402 | |
1990 | |
1403 | Note also that there is an upper limit to how often a timer can fire (CPU |
1991 | Note also that there is an upper limit to how often a timer can fire (CPU |
1404 | speed for example), so if C<interval> is very small then timing stability |
1992 | speed for example), so if C<interval> is very small then timing stability |
1405 | will of course deteriorate. Libev itself tries to be exact to be about one |
1993 | will of course deteriorate. Libev itself tries to be exact to be about one |
1406 | millisecond (if the OS supports it and the machine is fast enough). |
1994 | millisecond (if the OS supports it and the machine is fast enough). |
1407 | |
1995 | |
1408 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1996 | =item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback) |
1409 | |
1997 | |
1410 | In this mode the values for C<interval> and C<at> are both being |
1998 | In this mode the values for C<interval> and C<offset> are both being |
1411 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1999 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1412 | reschedule callback will be called with the watcher as first, and the |
2000 | reschedule callback will be called with the watcher as first, and the |
1413 | current time as second argument. |
2001 | current time as second argument. |
1414 | |
2002 | |
1415 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
2003 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever, |
1416 | ever, or make ANY event loop modifications whatsoever>. |
2004 | or make ANY other event loop modifications whatsoever, unless explicitly |
|
|
2005 | allowed by documentation here>. |
1417 | |
2006 | |
1418 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
2007 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
1419 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
2008 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
1420 | only event loop modification you are allowed to do). |
2009 | only event loop modification you are allowed to do). |
1421 | |
2010 | |
1422 | The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic |
2011 | The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic |
1423 | *w, ev_tstamp now)>, e.g.: |
2012 | *w, ev_tstamp now)>, e.g.: |
1424 | |
2013 | |
|
|
2014 | static ev_tstamp |
1425 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
2015 | my_rescheduler (ev_periodic *w, ev_tstamp now) |
1426 | { |
2016 | { |
1427 | return now + 60.; |
2017 | return now + 60.; |
1428 | } |
2018 | } |
1429 | |
2019 | |
1430 | It must return the next time to trigger, based on the passed time value |
2020 | It must return the next time to trigger, based on the passed time value |
… | |
… | |
1450 | a different time than the last time it was called (e.g. in a crond like |
2040 | a different time than the last time it was called (e.g. in a crond like |
1451 | program when the crontabs have changed). |
2041 | program when the crontabs have changed). |
1452 | |
2042 | |
1453 | =item ev_tstamp ev_periodic_at (ev_periodic *) |
2043 | =item ev_tstamp ev_periodic_at (ev_periodic *) |
1454 | |
2044 | |
1455 | When active, returns the absolute time that the watcher is supposed to |
2045 | When active, returns the absolute time that the watcher is supposed |
1456 | trigger next. |
2046 | to trigger next. This is not the same as the C<offset> argument to |
|
|
2047 | C<ev_periodic_set>, but indeed works even in interval and manual |
|
|
2048 | rescheduling modes. |
1457 | |
2049 | |
1458 | =item ev_tstamp offset [read-write] |
2050 | =item ev_tstamp offset [read-write] |
1459 | |
2051 | |
1460 | When repeating, this contains the offset value, otherwise this is the |
2052 | When repeating, this contains the offset value, otherwise this is the |
1461 | absolute point in time (the C<at> value passed to C<ev_periodic_set>). |
2053 | absolute point in time (the C<offset> value passed to C<ev_periodic_set>, |
|
|
2054 | although libev might modify this value for better numerical stability). |
1462 | |
2055 | |
1463 | Can be modified any time, but changes only take effect when the periodic |
2056 | Can be modified any time, but changes only take effect when the periodic |
1464 | timer fires or C<ev_periodic_again> is being called. |
2057 | timer fires or C<ev_periodic_again> is being called. |
1465 | |
2058 | |
1466 | =item ev_tstamp interval [read-write] |
2059 | =item ev_tstamp interval [read-write] |
1467 | |
2060 | |
1468 | The current interval value. Can be modified any time, but changes only |
2061 | The current interval value. Can be modified any time, but changes only |
1469 | take effect when the periodic timer fires or C<ev_periodic_again> is being |
2062 | take effect when the periodic timer fires or C<ev_periodic_again> is being |
1470 | called. |
2063 | called. |
1471 | |
2064 | |
1472 | =item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write] |
2065 | =item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write] |
1473 | |
2066 | |
1474 | The current reschedule callback, or C<0>, if this functionality is |
2067 | The current reschedule callback, or C<0>, if this functionality is |
1475 | switched off. Can be changed any time, but changes only take effect when |
2068 | switched off. Can be changed any time, but changes only take effect when |
1476 | the periodic timer fires or C<ev_periodic_again> is being called. |
2069 | the periodic timer fires or C<ev_periodic_again> is being called. |
1477 | |
2070 | |
1478 | =back |
2071 | =back |
1479 | |
2072 | |
1480 | =head3 Examples |
2073 | =head3 Examples |
1481 | |
2074 | |
1482 | Example: Call a callback every hour, or, more precisely, whenever the |
2075 | Example: Call a callback every hour, or, more precisely, whenever the |
1483 | system clock is divisible by 3600. The callback invocation times have |
2076 | system time is divisible by 3600. The callback invocation times have |
1484 | potentially a lot of jitter, but good long-term stability. |
2077 | potentially a lot of jitter, but good long-term stability. |
1485 | |
2078 | |
1486 | static void |
2079 | static void |
1487 | clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
2080 | clock_cb (struct ev_loop *loop, ev_io *w, int revents) |
1488 | { |
2081 | { |
1489 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
2082 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
1490 | } |
2083 | } |
1491 | |
2084 | |
1492 | struct ev_periodic hourly_tick; |
2085 | ev_periodic hourly_tick; |
1493 | ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
2086 | ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1494 | ev_periodic_start (loop, &hourly_tick); |
2087 | ev_periodic_start (loop, &hourly_tick); |
1495 | |
2088 | |
1496 | Example: The same as above, but use a reschedule callback to do it: |
2089 | Example: The same as above, but use a reschedule callback to do it: |
1497 | |
2090 | |
1498 | #include <math.h> |
2091 | #include <math.h> |
1499 | |
2092 | |
1500 | static ev_tstamp |
2093 | static ev_tstamp |
1501 | my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
2094 | my_scheduler_cb (ev_periodic *w, ev_tstamp now) |
1502 | { |
2095 | { |
1503 | return fmod (now, 3600.) + 3600.; |
2096 | return now + (3600. - fmod (now, 3600.)); |
1504 | } |
2097 | } |
1505 | |
2098 | |
1506 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
2099 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1507 | |
2100 | |
1508 | Example: Call a callback every hour, starting now: |
2101 | Example: Call a callback every hour, starting now: |
1509 | |
2102 | |
1510 | struct ev_periodic hourly_tick; |
2103 | ev_periodic hourly_tick; |
1511 | ev_periodic_init (&hourly_tick, clock_cb, |
2104 | ev_periodic_init (&hourly_tick, clock_cb, |
1512 | fmod (ev_now (loop), 3600.), 3600., 0); |
2105 | fmod (ev_now (loop), 3600.), 3600., 0); |
1513 | ev_periodic_start (loop, &hourly_tick); |
2106 | ev_periodic_start (loop, &hourly_tick); |
1514 | |
2107 | |
1515 | |
2108 | |
… | |
… | |
1518 | Signal watchers will trigger an event when the process receives a specific |
2111 | Signal watchers will trigger an event when the process receives a specific |
1519 | signal one or more times. Even though signals are very asynchronous, libev |
2112 | signal one or more times. Even though signals are very asynchronous, libev |
1520 | will try it's best to deliver signals synchronously, i.e. as part of the |
2113 | will try it's best to deliver signals synchronously, i.e. as part of the |
1521 | normal event processing, like any other event. |
2114 | normal event processing, like any other event. |
1522 | |
2115 | |
|
|
2116 | If you want signals to be delivered truly asynchronously, just use |
|
|
2117 | C<sigaction> as you would do without libev and forget about sharing |
|
|
2118 | the signal. You can even use C<ev_async> from a signal handler to |
|
|
2119 | synchronously wake up an event loop. |
|
|
2120 | |
1523 | You can configure as many watchers as you like per signal. Only when the |
2121 | You can configure as many watchers as you like for the same signal, but |
|
|
2122 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
|
|
2123 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
|
|
2124 | C<SIGINT> in both the default loop and another loop at the same time. At |
|
|
2125 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
|
|
2126 | |
1524 | first watcher gets started will libev actually register a signal watcher |
2127 | When the first watcher gets started will libev actually register something |
1525 | with the kernel (thus it coexists with your own signal handlers as long |
2128 | with the kernel (thus it coexists with your own signal handlers as long as |
1526 | as you don't register any with libev). Similarly, when the last signal |
2129 | you don't register any with libev for the same signal). |
1527 | watcher for a signal is stopped libev will reset the signal handler to |
|
|
1528 | SIG_DFL (regardless of what it was set to before). |
|
|
1529 | |
2130 | |
1530 | If possible and supported, libev will install its handlers with |
2131 | If possible and supported, libev will install its handlers with |
1531 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
2132 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
1532 | interrupted. If you have a problem with system calls getting interrupted by |
2133 | not be unduly interrupted. If you have a problem with system calls getting |
1533 | signals you can block all signals in an C<ev_check> watcher and unblock |
2134 | interrupted by signals you can block all signals in an C<ev_check> watcher |
1534 | them in an C<ev_prepare> watcher. |
2135 | and unblock them in an C<ev_prepare> watcher. |
|
|
2136 | |
|
|
2137 | =head3 The special problem of inheritance over execve |
|
|
2138 | |
|
|
2139 | Both the signal mask (C<sigprocmask>) and the signal disposition |
|
|
2140 | (C<sigaction>) are unspecified after starting a signal watcher (and after |
|
|
2141 | stopping it again), that is, libev might or might not block the signal, |
|
|
2142 | and might or might not set or restore the installed signal handler. |
|
|
2143 | |
|
|
2144 | While this does not matter for the signal disposition (libev never |
|
|
2145 | sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on |
|
|
2146 | C<execve>), this matters for the signal mask: many programs do not expect |
|
|
2147 | certain signals to be blocked. |
|
|
2148 | |
|
|
2149 | This means that before calling C<exec> (from the child) you should reset |
|
|
2150 | the signal mask to whatever "default" you expect (all clear is a good |
|
|
2151 | choice usually). |
|
|
2152 | |
|
|
2153 | The simplest way to ensure that the signal mask is reset in the child is |
|
|
2154 | to install a fork handler with C<pthread_atfork> that resets it. That will |
|
|
2155 | catch fork calls done by libraries (such as the libc) as well. |
|
|
2156 | |
|
|
2157 | In current versions of libev, you can also ensure that the signal mask is |
|
|
2158 | not blocking any signals (except temporarily, so thread users watch out) |
|
|
2159 | by specifying the C<EVFLAG_NOSIGFD> when creating the event loop. This |
|
|
2160 | is not guaranteed for future versions, however. |
1535 | |
2161 | |
1536 | =head3 Watcher-Specific Functions and Data Members |
2162 | =head3 Watcher-Specific Functions and Data Members |
1537 | |
2163 | |
1538 | =over 4 |
2164 | =over 4 |
1539 | |
2165 | |
… | |
… | |
1550 | |
2176 | |
1551 | =back |
2177 | =back |
1552 | |
2178 | |
1553 | =head3 Examples |
2179 | =head3 Examples |
1554 | |
2180 | |
1555 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
2181 | Example: Try to exit cleanly on SIGINT. |
1556 | |
2182 | |
1557 | static void |
2183 | static void |
1558 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
2184 | sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) |
1559 | { |
2185 | { |
1560 | ev_unloop (loop, EVUNLOOP_ALL); |
2186 | ev_unloop (loop, EVUNLOOP_ALL); |
1561 | } |
2187 | } |
1562 | |
2188 | |
1563 | struct ev_signal signal_watcher; |
2189 | ev_signal signal_watcher; |
1564 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
2190 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1565 | ev_signal_start (loop, &sigint_cb); |
2191 | ev_signal_start (loop, &signal_watcher); |
1566 | |
2192 | |
1567 | |
2193 | |
1568 | =head2 C<ev_child> - watch out for process status changes |
2194 | =head2 C<ev_child> - watch out for process status changes |
1569 | |
2195 | |
1570 | Child watchers trigger when your process receives a SIGCHLD in response to |
2196 | Child watchers trigger when your process receives a SIGCHLD in response to |
1571 | some child status changes (most typically when a child of yours dies). It |
2197 | some child status changes (most typically when a child of yours dies or |
1572 | is permissible to install a child watcher I<after> the child has been |
2198 | exits). It is permissible to install a child watcher I<after> the child |
1573 | forked (which implies it might have already exited), as long as the event |
2199 | has been forked (which implies it might have already exited), as long |
1574 | loop isn't entered (or is continued from a watcher). |
2200 | as the event loop isn't entered (or is continued from a watcher), i.e., |
|
|
2201 | forking and then immediately registering a watcher for the child is fine, |
|
|
2202 | but forking and registering a watcher a few event loop iterations later or |
|
|
2203 | in the next callback invocation is not. |
1575 | |
2204 | |
1576 | Only the default event loop is capable of handling signals, and therefore |
2205 | Only the default event loop is capable of handling signals, and therefore |
1577 | you can only register child watchers in the default event loop. |
2206 | you can only register child watchers in the default event loop. |
1578 | |
2207 | |
|
|
2208 | Due to some design glitches inside libev, child watchers will always be |
|
|
2209 | handled at maximum priority (their priority is set to C<EV_MAXPRI> by |
|
|
2210 | libev) |
|
|
2211 | |
1579 | =head3 Process Interaction |
2212 | =head3 Process Interaction |
1580 | |
2213 | |
1581 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2214 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
1582 | initialised. This is necessary to guarantee proper behaviour even if |
2215 | initialised. This is necessary to guarantee proper behaviour even if the |
1583 | the first child watcher is started after the child exits. The occurrence |
2216 | first child watcher is started after the child exits. The occurrence |
1584 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2217 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
1585 | synchronously as part of the event loop processing. Libev always reaps all |
2218 | synchronously as part of the event loop processing. Libev always reaps all |
1586 | children, even ones not watched. |
2219 | children, even ones not watched. |
1587 | |
2220 | |
1588 | =head3 Overriding the Built-In Processing |
2221 | =head3 Overriding the Built-In Processing |
… | |
… | |
1598 | =head3 Stopping the Child Watcher |
2231 | =head3 Stopping the Child Watcher |
1599 | |
2232 | |
1600 | Currently, the child watcher never gets stopped, even when the |
2233 | Currently, the child watcher never gets stopped, even when the |
1601 | child terminates, so normally one needs to stop the watcher in the |
2234 | child terminates, so normally one needs to stop the watcher in the |
1602 | callback. Future versions of libev might stop the watcher automatically |
2235 | callback. Future versions of libev might stop the watcher automatically |
1603 | when a child exit is detected. |
2236 | when a child exit is detected (calling C<ev_child_stop> twice is not a |
|
|
2237 | problem). |
1604 | |
2238 | |
1605 | =head3 Watcher-Specific Functions and Data Members |
2239 | =head3 Watcher-Specific Functions and Data Members |
1606 | |
2240 | |
1607 | =over 4 |
2241 | =over 4 |
1608 | |
2242 | |
… | |
… | |
1640 | its completion. |
2274 | its completion. |
1641 | |
2275 | |
1642 | ev_child cw; |
2276 | ev_child cw; |
1643 | |
2277 | |
1644 | static void |
2278 | static void |
1645 | child_cb (EV_P_ struct ev_child *w, int revents) |
2279 | child_cb (EV_P_ ev_child *w, int revents) |
1646 | { |
2280 | { |
1647 | ev_child_stop (EV_A_ w); |
2281 | ev_child_stop (EV_A_ w); |
1648 | printf ("process %d exited with status %x\n", w->rpid, w->rstatus); |
2282 | printf ("process %d exited with status %x\n", w->rpid, w->rstatus); |
1649 | } |
2283 | } |
1650 | |
2284 | |
… | |
… | |
1665 | |
2299 | |
1666 | |
2300 | |
1667 | =head2 C<ev_stat> - did the file attributes just change? |
2301 | =head2 C<ev_stat> - did the file attributes just change? |
1668 | |
2302 | |
1669 | This watches a file system path for attribute changes. That is, it calls |
2303 | This watches a file system path for attribute changes. That is, it calls |
1670 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
2304 | C<stat> on that path in regular intervals (or when the OS says it changed) |
1671 | compared to the last time, invoking the callback if it did. |
2305 | and sees if it changed compared to the last time, invoking the callback if |
|
|
2306 | it did. |
1672 | |
2307 | |
1673 | The path does not need to exist: changing from "path exists" to "path does |
2308 | The path does not need to exist: changing from "path exists" to "path does |
1674 | not exist" is a status change like any other. The condition "path does |
2309 | not exist" is a status change like any other. The condition "path does not |
1675 | not exist" is signified by the C<st_nlink> field being zero (which is |
2310 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
1676 | otherwise always forced to be at least one) and all the other fields of |
2311 | C<st_nlink> field being zero (which is otherwise always forced to be at |
1677 | the stat buffer having unspecified contents. |
2312 | least one) and all the other fields of the stat buffer having unspecified |
|
|
2313 | contents. |
1678 | |
2314 | |
1679 | The path I<should> be absolute and I<must not> end in a slash. If it is |
2315 | The path I<must not> end in a slash or contain special components such as |
|
|
2316 | C<.> or C<..>. The path I<should> be absolute: If it is relative and |
1680 | relative and your working directory changes, the behaviour is undefined. |
2317 | your working directory changes, then the behaviour is undefined. |
1681 | |
2318 | |
1682 | Since there is no standard to do this, the portable implementation simply |
2319 | Since there is no portable change notification interface available, the |
1683 | calls C<stat (2)> regularly on the path to see if it changed somehow. You |
2320 | portable implementation simply calls C<stat(2)> regularly on the path |
1684 | can specify a recommended polling interval for this case. If you specify |
2321 | to see if it changed somehow. You can specify a recommended polling |
1685 | a polling interval of C<0> (highly recommended!) then a I<suitable, |
2322 | interval for this case. If you specify a polling interval of C<0> (highly |
1686 | unspecified default> value will be used (which you can expect to be around |
2323 | recommended!) then a I<suitable, unspecified default> value will be used |
1687 | five seconds, although this might change dynamically). Libev will also |
2324 | (which you can expect to be around five seconds, although this might |
1688 | impose a minimum interval which is currently around C<0.1>, but thats |
2325 | change dynamically). Libev will also impose a minimum interval which is |
1689 | usually overkill. |
2326 | currently around C<0.1>, but that's usually overkill. |
1690 | |
2327 | |
1691 | This watcher type is not meant for massive numbers of stat watchers, |
2328 | This watcher type is not meant for massive numbers of stat watchers, |
1692 | as even with OS-supported change notifications, this can be |
2329 | as even with OS-supported change notifications, this can be |
1693 | resource-intensive. |
2330 | resource-intensive. |
1694 | |
2331 | |
1695 | At the time of this writing, only the Linux inotify interface is |
2332 | At the time of this writing, the only OS-specific interface implemented |
1696 | implemented (implementing kqueue support is left as an exercise for the |
2333 | is the Linux inotify interface (implementing kqueue support is left as an |
1697 | reader, note, however, that the author sees no way of implementing ev_stat |
2334 | exercise for the reader. Note, however, that the author sees no way of |
1698 | semantics with kqueue). Inotify will be used to give hints only and should |
2335 | implementing C<ev_stat> semantics with kqueue, except as a hint). |
1699 | not change the semantics of C<ev_stat> watchers, which means that libev |
|
|
1700 | sometimes needs to fall back to regular polling again even with inotify, |
|
|
1701 | but changes are usually detected immediately, and if the file exists there |
|
|
1702 | will be no polling. |
|
|
1703 | |
2336 | |
1704 | =head3 ABI Issues (Largefile Support) |
2337 | =head3 ABI Issues (Largefile Support) |
1705 | |
2338 | |
1706 | Libev by default (unless the user overrides this) uses the default |
2339 | Libev by default (unless the user overrides this) uses the default |
1707 | compilation environment, which means that on systems with large file |
2340 | compilation environment, which means that on systems with large file |
1708 | support disabled by default, you get the 32 bit version of the stat |
2341 | support disabled by default, you get the 32 bit version of the stat |
1709 | structure. When using the library from programs that change the ABI to |
2342 | structure. When using the library from programs that change the ABI to |
1710 | use 64 bit file offsets the programs will fail. In that case you have to |
2343 | use 64 bit file offsets the programs will fail. In that case you have to |
1711 | compile libev with the same flags to get binary compatibility. This is |
2344 | compile libev with the same flags to get binary compatibility. This is |
1712 | obviously the case with any flags that change the ABI, but the problem is |
2345 | obviously the case with any flags that change the ABI, but the problem is |
1713 | most noticeably disabled with ev_stat and large file support. |
2346 | most noticeably displayed with ev_stat and large file support. |
1714 | |
2347 | |
1715 | The solution for this is to lobby your distribution maker to make large |
2348 | The solution for this is to lobby your distribution maker to make large |
1716 | file interfaces available by default (as e.g. FreeBSD does) and not |
2349 | file interfaces available by default (as e.g. FreeBSD does) and not |
1717 | optional. Libev cannot simply switch on large file support because it has |
2350 | optional. Libev cannot simply switch on large file support because it has |
1718 | to exchange stat structures with application programs compiled using the |
2351 | to exchange stat structures with application programs compiled using the |
1719 | default compilation environment. |
2352 | default compilation environment. |
1720 | |
2353 | |
1721 | =head3 Inotify |
2354 | =head3 Inotify and Kqueue |
1722 | |
2355 | |
1723 | When C<inotify (7)> support has been compiled into libev (generally only |
2356 | When C<inotify (7)> support has been compiled into libev and present at |
1724 | available on Linux) and present at runtime, it will be used to speed up |
2357 | runtime, it will be used to speed up change detection where possible. The |
1725 | change detection where possible. The inotify descriptor will be created lazily |
2358 | inotify descriptor will be created lazily when the first C<ev_stat> |
1726 | when the first C<ev_stat> watcher is being started. |
2359 | watcher is being started. |
1727 | |
2360 | |
1728 | Inotify presence does not change the semantics of C<ev_stat> watchers |
2361 | Inotify presence does not change the semantics of C<ev_stat> watchers |
1729 | except that changes might be detected earlier, and in some cases, to avoid |
2362 | except that changes might be detected earlier, and in some cases, to avoid |
1730 | making regular C<stat> calls. Even in the presence of inotify support |
2363 | making regular C<stat> calls. Even in the presence of inotify support |
1731 | there are many cases where libev has to resort to regular C<stat> polling. |
2364 | there are many cases where libev has to resort to regular C<stat> polling, |
|
|
2365 | but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too |
|
|
2366 | many bugs), the path exists (i.e. stat succeeds), and the path resides on |
|
|
2367 | a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and |
|
|
2368 | xfs are fully working) libev usually gets away without polling. |
1732 | |
2369 | |
1733 | (There is no support for kqueue, as apparently it cannot be used to |
2370 | There is no support for kqueue, as apparently it cannot be used to |
1734 | implement this functionality, due to the requirement of having a file |
2371 | implement this functionality, due to the requirement of having a file |
1735 | descriptor open on the object at all times). |
2372 | descriptor open on the object at all times, and detecting renames, unlinks |
|
|
2373 | etc. is difficult. |
|
|
2374 | |
|
|
2375 | =head3 C<stat ()> is a synchronous operation |
|
|
2376 | |
|
|
2377 | Libev doesn't normally do any kind of I/O itself, and so is not blocking |
|
|
2378 | the process. The exception are C<ev_stat> watchers - those call C<stat |
|
|
2379 | ()>, which is a synchronous operation. |
|
|
2380 | |
|
|
2381 | For local paths, this usually doesn't matter: unless the system is very |
|
|
2382 | busy or the intervals between stat's are large, a stat call will be fast, |
|
|
2383 | as the path data is usually in memory already (except when starting the |
|
|
2384 | watcher). |
|
|
2385 | |
|
|
2386 | For networked file systems, calling C<stat ()> can block an indefinite |
|
|
2387 | time due to network issues, and even under good conditions, a stat call |
|
|
2388 | often takes multiple milliseconds. |
|
|
2389 | |
|
|
2390 | Therefore, it is best to avoid using C<ev_stat> watchers on networked |
|
|
2391 | paths, although this is fully supported by libev. |
1736 | |
2392 | |
1737 | =head3 The special problem of stat time resolution |
2393 | =head3 The special problem of stat time resolution |
1738 | |
2394 | |
1739 | The C<stat ()> system call only supports full-second resolution portably, and |
2395 | The C<stat ()> system call only supports full-second resolution portably, |
1740 | even on systems where the resolution is higher, many file systems still |
2396 | and even on systems where the resolution is higher, most file systems |
1741 | only support whole seconds. |
2397 | still only support whole seconds. |
1742 | |
2398 | |
1743 | That means that, if the time is the only thing that changes, you can |
2399 | That means that, if the time is the only thing that changes, you can |
1744 | easily miss updates: on the first update, C<ev_stat> detects a change and |
2400 | easily miss updates: on the first update, C<ev_stat> detects a change and |
1745 | calls your callback, which does something. When there is another update |
2401 | calls your callback, which does something. When there is another update |
1746 | within the same second, C<ev_stat> will be unable to detect it as the stat |
2402 | within the same second, C<ev_stat> will be unable to detect unless the |
1747 | data does not change. |
2403 | stat data does change in other ways (e.g. file size). |
1748 | |
2404 | |
1749 | The solution to this is to delay acting on a change for slightly more |
2405 | The solution to this is to delay acting on a change for slightly more |
1750 | than a second (or till slightly after the next full second boundary), using |
2406 | than a second (or till slightly after the next full second boundary), using |
1751 | a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02); |
2407 | a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02); |
1752 | ev_timer_again (loop, w)>). |
2408 | ev_timer_again (loop, w)>). |
… | |
… | |
1772 | C<path>. The C<interval> is a hint on how quickly a change is expected to |
2428 | C<path>. The C<interval> is a hint on how quickly a change is expected to |
1773 | be detected and should normally be specified as C<0> to let libev choose |
2429 | be detected and should normally be specified as C<0> to let libev choose |
1774 | a suitable value. The memory pointed to by C<path> must point to the same |
2430 | a suitable value. The memory pointed to by C<path> must point to the same |
1775 | path for as long as the watcher is active. |
2431 | path for as long as the watcher is active. |
1776 | |
2432 | |
1777 | The callback will receive C<EV_STAT> when a change was detected, relative |
2433 | The callback will receive an C<EV_STAT> event when a change was detected, |
1778 | to the attributes at the time the watcher was started (or the last change |
2434 | relative to the attributes at the time the watcher was started (or the |
1779 | was detected). |
2435 | last change was detected). |
1780 | |
2436 | |
1781 | =item ev_stat_stat (loop, ev_stat *) |
2437 | =item ev_stat_stat (loop, ev_stat *) |
1782 | |
2438 | |
1783 | Updates the stat buffer immediately with new values. If you change the |
2439 | Updates the stat buffer immediately with new values. If you change the |
1784 | watched path in your callback, you could call this function to avoid |
2440 | watched path in your callback, you could call this function to avoid |
… | |
… | |
1867 | |
2523 | |
1868 | |
2524 | |
1869 | =head2 C<ev_idle> - when you've got nothing better to do... |
2525 | =head2 C<ev_idle> - when you've got nothing better to do... |
1870 | |
2526 | |
1871 | Idle watchers trigger events when no other events of the same or higher |
2527 | Idle watchers trigger events when no other events of the same or higher |
1872 | priority are pending (prepare, check and other idle watchers do not |
2528 | priority are pending (prepare, check and other idle watchers do not count |
1873 | count). |
2529 | as receiving "events"). |
1874 | |
2530 | |
1875 | That is, as long as your process is busy handling sockets or timeouts |
2531 | That is, as long as your process is busy handling sockets or timeouts |
1876 | (or even signals, imagine) of the same or higher priority it will not be |
2532 | (or even signals, imagine) of the same or higher priority it will not be |
1877 | triggered. But when your process is idle (or only lower-priority watchers |
2533 | triggered. But when your process is idle (or only lower-priority watchers |
1878 | are pending), the idle watchers are being called once per event loop |
2534 | are pending), the idle watchers are being called once per event loop |
… | |
… | |
1889 | |
2545 | |
1890 | =head3 Watcher-Specific Functions and Data Members |
2546 | =head3 Watcher-Specific Functions and Data Members |
1891 | |
2547 | |
1892 | =over 4 |
2548 | =over 4 |
1893 | |
2549 | |
1894 | =item ev_idle_init (ev_signal *, callback) |
2550 | =item ev_idle_init (ev_idle *, callback) |
1895 | |
2551 | |
1896 | Initialises and configures the idle watcher - it has no parameters of any |
2552 | Initialises and configures the idle watcher - it has no parameters of any |
1897 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
2553 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1898 | believe me. |
2554 | believe me. |
1899 | |
2555 | |
… | |
… | |
1903 | |
2559 | |
1904 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
2560 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1905 | callback, free it. Also, use no error checking, as usual. |
2561 | callback, free it. Also, use no error checking, as usual. |
1906 | |
2562 | |
1907 | static void |
2563 | static void |
1908 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
2564 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
1909 | { |
2565 | { |
1910 | free (w); |
2566 | free (w); |
1911 | // now do something you wanted to do when the program has |
2567 | // now do something you wanted to do when the program has |
1912 | // no longer anything immediate to do. |
2568 | // no longer anything immediate to do. |
1913 | } |
2569 | } |
1914 | |
2570 | |
1915 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
2571 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
1916 | ev_idle_init (idle_watcher, idle_cb); |
2572 | ev_idle_init (idle_watcher, idle_cb); |
1917 | ev_idle_start (loop, idle_cb); |
2573 | ev_idle_start (loop, idle_watcher); |
1918 | |
2574 | |
1919 | |
2575 | |
1920 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2576 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
1921 | |
2577 | |
1922 | Prepare and check watchers are usually (but not always) used in tandem: |
2578 | Prepare and check watchers are usually (but not always) used in pairs: |
1923 | prepare watchers get invoked before the process blocks and check watchers |
2579 | prepare watchers get invoked before the process blocks and check watchers |
1924 | afterwards. |
2580 | afterwards. |
1925 | |
2581 | |
1926 | You I<must not> call C<ev_loop> or similar functions that enter |
2582 | You I<must not> call C<ev_loop> or similar functions that enter |
1927 | the current event loop from either C<ev_prepare> or C<ev_check> |
2583 | the current event loop from either C<ev_prepare> or C<ev_check> |
… | |
… | |
1930 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2586 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
1931 | C<ev_check> so if you have one watcher of each kind they will always be |
2587 | C<ev_check> so if you have one watcher of each kind they will always be |
1932 | called in pairs bracketing the blocking call. |
2588 | called in pairs bracketing the blocking call. |
1933 | |
2589 | |
1934 | Their main purpose is to integrate other event mechanisms into libev and |
2590 | Their main purpose is to integrate other event mechanisms into libev and |
1935 | their use is somewhat advanced. This could be used, for example, to track |
2591 | their use is somewhat advanced. They could be used, for example, to track |
1936 | variable changes, implement your own watchers, integrate net-snmp or a |
2592 | variable changes, implement your own watchers, integrate net-snmp or a |
1937 | coroutine library and lots more. They are also occasionally useful if |
2593 | coroutine library and lots more. They are also occasionally useful if |
1938 | you cache some data and want to flush it before blocking (for example, |
2594 | you cache some data and want to flush it before blocking (for example, |
1939 | in X programs you might want to do an C<XFlush ()> in an C<ev_prepare> |
2595 | in X programs you might want to do an C<XFlush ()> in an C<ev_prepare> |
1940 | watcher). |
2596 | watcher). |
1941 | |
2597 | |
1942 | This is done by examining in each prepare call which file descriptors need |
2598 | This is done by examining in each prepare call which file descriptors |
1943 | to be watched by the other library, registering C<ev_io> watchers for |
2599 | need to be watched by the other library, registering C<ev_io> watchers |
1944 | them and starting an C<ev_timer> watcher for any timeouts (many libraries |
2600 | for them and starting an C<ev_timer> watcher for any timeouts (many |
1945 | provide just this functionality). Then, in the check watcher you check for |
2601 | libraries provide exactly this functionality). Then, in the check watcher, |
1946 | any events that occurred (by checking the pending status of all watchers |
2602 | you check for any events that occurred (by checking the pending status |
1947 | and stopping them) and call back into the library. The I/O and timer |
2603 | of all watchers and stopping them) and call back into the library. The |
1948 | callbacks will never actually be called (but must be valid nevertheless, |
2604 | I/O and timer callbacks will never actually be called (but must be valid |
1949 | because you never know, you know?). |
2605 | nevertheless, because you never know, you know?). |
1950 | |
2606 | |
1951 | As another example, the Perl Coro module uses these hooks to integrate |
2607 | As another example, the Perl Coro module uses these hooks to integrate |
1952 | coroutines into libev programs, by yielding to other active coroutines |
2608 | coroutines into libev programs, by yielding to other active coroutines |
1953 | during each prepare and only letting the process block if no coroutines |
2609 | during each prepare and only letting the process block if no coroutines |
1954 | are ready to run (it's actually more complicated: it only runs coroutines |
2610 | are ready to run (it's actually more complicated: it only runs coroutines |
… | |
… | |
1957 | loop from blocking if lower-priority coroutines are active, thus mapping |
2613 | loop from blocking if lower-priority coroutines are active, thus mapping |
1958 | low-priority coroutines to idle/background tasks). |
2614 | low-priority coroutines to idle/background tasks). |
1959 | |
2615 | |
1960 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
2616 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
1961 | priority, to ensure that they are being run before any other watchers |
2617 | priority, to ensure that they are being run before any other watchers |
|
|
2618 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
|
|
2619 | |
1962 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
2620 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
1963 | too) should not activate ("feed") events into libev. While libev fully |
2621 | activate ("feed") events into libev. While libev fully supports this, they |
1964 | supports this, they might get executed before other C<ev_check> watchers |
2622 | might get executed before other C<ev_check> watchers did their job. As |
1965 | did their job. As C<ev_check> watchers are often used to embed other |
2623 | C<ev_check> watchers are often used to embed other (non-libev) event |
1966 | (non-libev) event loops those other event loops might be in an unusable |
2624 | loops those other event loops might be in an unusable state until their |
1967 | state until their C<ev_check> watcher ran (always remind yourself to |
2625 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
1968 | coexist peacefully with others). |
2626 | others). |
1969 | |
2627 | |
1970 | =head3 Watcher-Specific Functions and Data Members |
2628 | =head3 Watcher-Specific Functions and Data Members |
1971 | |
2629 | |
1972 | =over 4 |
2630 | =over 4 |
1973 | |
2631 | |
… | |
… | |
1975 | |
2633 | |
1976 | =item ev_check_init (ev_check *, callback) |
2634 | =item ev_check_init (ev_check *, callback) |
1977 | |
2635 | |
1978 | Initialises and configures the prepare or check watcher - they have no |
2636 | Initialises and configures the prepare or check watcher - they have no |
1979 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
2637 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1980 | macros, but using them is utterly, utterly and completely pointless. |
2638 | macros, but using them is utterly, utterly, utterly and completely |
|
|
2639 | pointless. |
1981 | |
2640 | |
1982 | =back |
2641 | =back |
1983 | |
2642 | |
1984 | =head3 Examples |
2643 | =head3 Examples |
1985 | |
2644 | |
… | |
… | |
1998 | |
2657 | |
1999 | static ev_io iow [nfd]; |
2658 | static ev_io iow [nfd]; |
2000 | static ev_timer tw; |
2659 | static ev_timer tw; |
2001 | |
2660 | |
2002 | static void |
2661 | static void |
2003 | io_cb (ev_loop *loop, ev_io *w, int revents) |
2662 | io_cb (struct ev_loop *loop, ev_io *w, int revents) |
2004 | { |
2663 | { |
2005 | } |
2664 | } |
2006 | |
2665 | |
2007 | // create io watchers for each fd and a timer before blocking |
2666 | // create io watchers for each fd and a timer before blocking |
2008 | static void |
2667 | static void |
2009 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
2668 | adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents) |
2010 | { |
2669 | { |
2011 | int timeout = 3600000; |
2670 | int timeout = 3600000; |
2012 | struct pollfd fds [nfd]; |
2671 | struct pollfd fds [nfd]; |
2013 | // actual code will need to loop here and realloc etc. |
2672 | // actual code will need to loop here and realloc etc. |
2014 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2673 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2015 | |
2674 | |
2016 | /* the callback is illegal, but won't be called as we stop during check */ |
2675 | /* the callback is illegal, but won't be called as we stop during check */ |
2017 | ev_timer_init (&tw, 0, timeout * 1e-3); |
2676 | ev_timer_init (&tw, 0, timeout * 1e-3, 0.); |
2018 | ev_timer_start (loop, &tw); |
2677 | ev_timer_start (loop, &tw); |
2019 | |
2678 | |
2020 | // create one ev_io per pollfd |
2679 | // create one ev_io per pollfd |
2021 | for (int i = 0; i < nfd; ++i) |
2680 | for (int i = 0; i < nfd; ++i) |
2022 | { |
2681 | { |
… | |
… | |
2029 | } |
2688 | } |
2030 | } |
2689 | } |
2031 | |
2690 | |
2032 | // stop all watchers after blocking |
2691 | // stop all watchers after blocking |
2033 | static void |
2692 | static void |
2034 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
2693 | adns_check_cb (struct ev_loop *loop, ev_check *w, int revents) |
2035 | { |
2694 | { |
2036 | ev_timer_stop (loop, &tw); |
2695 | ev_timer_stop (loop, &tw); |
2037 | |
2696 | |
2038 | for (int i = 0; i < nfd; ++i) |
2697 | for (int i = 0; i < nfd; ++i) |
2039 | { |
2698 | { |
… | |
… | |
2078 | } |
2737 | } |
2079 | |
2738 | |
2080 | // do not ever call adns_afterpoll |
2739 | // do not ever call adns_afterpoll |
2081 | |
2740 | |
2082 | Method 4: Do not use a prepare or check watcher because the module you |
2741 | Method 4: Do not use a prepare or check watcher because the module you |
2083 | want to embed is too inflexible to support it. Instead, you can override |
2742 | want to embed is not flexible enough to support it. Instead, you can |
2084 | their poll function. The drawback with this solution is that the main |
2743 | override their poll function. The drawback with this solution is that the |
2085 | loop is now no longer controllable by EV. The C<Glib::EV> module does |
2744 | main loop is now no longer controllable by EV. The C<Glib::EV> module uses |
2086 | this. |
2745 | this approach, effectively embedding EV as a client into the horrible |
|
|
2746 | libglib event loop. |
2087 | |
2747 | |
2088 | static gint |
2748 | static gint |
2089 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
2749 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
2090 | { |
2750 | { |
2091 | int got_events = 0; |
2751 | int got_events = 0; |
… | |
… | |
2122 | prioritise I/O. |
2782 | prioritise I/O. |
2123 | |
2783 | |
2124 | As an example for a bug workaround, the kqueue backend might only support |
2784 | As an example for a bug workaround, the kqueue backend might only support |
2125 | sockets on some platform, so it is unusable as generic backend, but you |
2785 | sockets on some platform, so it is unusable as generic backend, but you |
2126 | still want to make use of it because you have many sockets and it scales |
2786 | still want to make use of it because you have many sockets and it scales |
2127 | so nicely. In this case, you would create a kqueue-based loop and embed it |
2787 | so nicely. In this case, you would create a kqueue-based loop and embed |
2128 | into your default loop (which might use e.g. poll). Overall operation will |
2788 | it into your default loop (which might use e.g. poll). Overall operation |
2129 | be a bit slower because first libev has to poll and then call kevent, but |
2789 | will be a bit slower because first libev has to call C<poll> and then |
2130 | at least you can use both at what they are best. |
2790 | C<kevent>, but at least you can use both mechanisms for what they are |
|
|
2791 | best: C<kqueue> for scalable sockets and C<poll> if you want it to work :) |
2131 | |
2792 | |
2132 | As for prioritising I/O: rarely you have the case where some fds have |
2793 | As for prioritising I/O: under rare circumstances you have the case where |
2133 | to be watched and handled very quickly (with low latency), and even |
2794 | some fds have to be watched and handled very quickly (with low latency), |
2134 | priorities and idle watchers might have too much overhead. In this case |
2795 | and even priorities and idle watchers might have too much overhead. In |
2135 | you would put all the high priority stuff in one loop and all the rest in |
2796 | this case you would put all the high priority stuff in one loop and all |
2136 | a second one, and embed the second one in the first. |
2797 | the rest in a second one, and embed the second one in the first. |
2137 | |
2798 | |
2138 | As long as the watcher is active, the callback will be invoked every time |
2799 | As long as the watcher is active, the callback will be invoked every |
2139 | there might be events pending in the embedded loop. The callback must then |
2800 | time there might be events pending in the embedded loop. The callback |
2140 | call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke |
2801 | must then call C<ev_embed_sweep (mainloop, watcher)> to make a single |
2141 | their callbacks (you could also start an idle watcher to give the embedded |
2802 | sweep and invoke their callbacks (the callback doesn't need to invoke the |
2142 | loop strictly lower priority for example). You can also set the callback |
2803 | C<ev_embed_sweep> function directly, it could also start an idle watcher |
2143 | to C<0>, in which case the embed watcher will automatically execute the |
2804 | to give the embedded loop strictly lower priority for example). |
2144 | embedded loop sweep. |
|
|
2145 | |
2805 | |
2146 | As long as the watcher is started it will automatically handle events. The |
2806 | You can also set the callback to C<0>, in which case the embed watcher |
2147 | callback will be invoked whenever some events have been handled. You can |
2807 | will automatically execute the embedded loop sweep whenever necessary. |
2148 | set the callback to C<0> to avoid having to specify one if you are not |
|
|
2149 | interested in that. |
|
|
2150 | |
2808 | |
2151 | Also, there have not currently been made special provisions for forking: |
2809 | Fork detection will be handled transparently while the C<ev_embed> watcher |
2152 | when you fork, you not only have to call C<ev_loop_fork> on both loops, |
2810 | is active, i.e., the embedded loop will automatically be forked when the |
2153 | but you will also have to stop and restart any C<ev_embed> watchers |
2811 | embedding loop forks. In other cases, the user is responsible for calling |
2154 | yourself. |
2812 | C<ev_loop_fork> on the embedded loop. |
2155 | |
2813 | |
2156 | Unfortunately, not all backends are embeddable, only the ones returned by |
2814 | Unfortunately, not all backends are embeddable: only the ones returned by |
2157 | C<ev_embeddable_backends> are, which, unfortunately, does not include any |
2815 | C<ev_embeddable_backends> are, which, unfortunately, does not include any |
2158 | portable one. |
2816 | portable one. |
2159 | |
2817 | |
2160 | So when you want to use this feature you will always have to be prepared |
2818 | So when you want to use this feature you will always have to be prepared |
2161 | that you cannot get an embeddable loop. The recommended way to get around |
2819 | that you cannot get an embeddable loop. The recommended way to get around |
2162 | this is to have a separate variables for your embeddable loop, try to |
2820 | this is to have a separate variables for your embeddable loop, try to |
2163 | create it, and if that fails, use the normal loop for everything. |
2821 | create it, and if that fails, use the normal loop for everything. |
|
|
2822 | |
|
|
2823 | =head3 C<ev_embed> and fork |
|
|
2824 | |
|
|
2825 | While the C<ev_embed> watcher is running, forks in the embedding loop will |
|
|
2826 | automatically be applied to the embedded loop as well, so no special |
|
|
2827 | fork handling is required in that case. When the watcher is not running, |
|
|
2828 | however, it is still the task of the libev user to call C<ev_loop_fork ()> |
|
|
2829 | as applicable. |
2164 | |
2830 | |
2165 | =head3 Watcher-Specific Functions and Data Members |
2831 | =head3 Watcher-Specific Functions and Data Members |
2166 | |
2832 | |
2167 | =over 4 |
2833 | =over 4 |
2168 | |
2834 | |
… | |
… | |
2196 | C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be |
2862 | C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be |
2197 | used). |
2863 | used). |
2198 | |
2864 | |
2199 | struct ev_loop *loop_hi = ev_default_init (0); |
2865 | struct ev_loop *loop_hi = ev_default_init (0); |
2200 | struct ev_loop *loop_lo = 0; |
2866 | struct ev_loop *loop_lo = 0; |
2201 | struct ev_embed embed; |
2867 | ev_embed embed; |
2202 | |
2868 | |
2203 | // see if there is a chance of getting one that works |
2869 | // see if there is a chance of getting one that works |
2204 | // (remember that a flags value of 0 means autodetection) |
2870 | // (remember that a flags value of 0 means autodetection) |
2205 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
2871 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
2206 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
2872 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
… | |
… | |
2220 | kqueue implementation). Store the kqueue/socket-only event loop in |
2886 | kqueue implementation). Store the kqueue/socket-only event loop in |
2221 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
2887 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
2222 | |
2888 | |
2223 | struct ev_loop *loop = ev_default_init (0); |
2889 | struct ev_loop *loop = ev_default_init (0); |
2224 | struct ev_loop *loop_socket = 0; |
2890 | struct ev_loop *loop_socket = 0; |
2225 | struct ev_embed embed; |
2891 | ev_embed embed; |
2226 | |
2892 | |
2227 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
2893 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
2228 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
2894 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
2229 | { |
2895 | { |
2230 | ev_embed_init (&embed, 0, loop_socket); |
2896 | ev_embed_init (&embed, 0, loop_socket); |
… | |
… | |
2245 | event loop blocks next and before C<ev_check> watchers are being called, |
2911 | event loop blocks next and before C<ev_check> watchers are being called, |
2246 | and only in the child after the fork. If whoever good citizen calling |
2912 | and only in the child after the fork. If whoever good citizen calling |
2247 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
2913 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
2248 | handlers will be invoked, too, of course. |
2914 | handlers will be invoked, too, of course. |
2249 | |
2915 | |
|
|
2916 | =head3 The special problem of life after fork - how is it possible? |
|
|
2917 | |
|
|
2918 | Most uses of C<fork()> consist of forking, then some simple calls to ste |
|
|
2919 | up/change the process environment, followed by a call to C<exec()>. This |
|
|
2920 | sequence should be handled by libev without any problems. |
|
|
2921 | |
|
|
2922 | This changes when the application actually wants to do event handling |
|
|
2923 | in the child, or both parent in child, in effect "continuing" after the |
|
|
2924 | fork. |
|
|
2925 | |
|
|
2926 | The default mode of operation (for libev, with application help to detect |
|
|
2927 | forks) is to duplicate all the state in the child, as would be expected |
|
|
2928 | when I<either> the parent I<or> the child process continues. |
|
|
2929 | |
|
|
2930 | When both processes want to continue using libev, then this is usually the |
|
|
2931 | wrong result. In that case, usually one process (typically the parent) is |
|
|
2932 | supposed to continue with all watchers in place as before, while the other |
|
|
2933 | process typically wants to start fresh, i.e. without any active watchers. |
|
|
2934 | |
|
|
2935 | The cleanest and most efficient way to achieve that with libev is to |
|
|
2936 | simply create a new event loop, which of course will be "empty", and |
|
|
2937 | use that for new watchers. This has the advantage of not touching more |
|
|
2938 | memory than necessary, and thus avoiding the copy-on-write, and the |
|
|
2939 | disadvantage of having to use multiple event loops (which do not support |
|
|
2940 | signal watchers). |
|
|
2941 | |
|
|
2942 | When this is not possible, or you want to use the default loop for |
|
|
2943 | other reasons, then in the process that wants to start "fresh", call |
|
|
2944 | C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying |
|
|
2945 | the default loop will "orphan" (not stop) all registered watchers, so you |
|
|
2946 | have to be careful not to execute code that modifies those watchers. Note |
|
|
2947 | also that in that case, you have to re-register any signal watchers. |
|
|
2948 | |
2250 | =head3 Watcher-Specific Functions and Data Members |
2949 | =head3 Watcher-Specific Functions and Data Members |
2251 | |
2950 | |
2252 | =over 4 |
2951 | =over 4 |
2253 | |
2952 | |
2254 | =item ev_fork_init (ev_signal *, callback) |
2953 | =item ev_fork_init (ev_signal *, callback) |
… | |
… | |
2283 | =head3 Queueing |
2982 | =head3 Queueing |
2284 | |
2983 | |
2285 | C<ev_async> does not support queueing of data in any way. The reason |
2984 | C<ev_async> does not support queueing of data in any way. The reason |
2286 | is that the author does not know of a simple (or any) algorithm for a |
2985 | is that the author does not know of a simple (or any) algorithm for a |
2287 | multiple-writer-single-reader queue that works in all cases and doesn't |
2986 | multiple-writer-single-reader queue that works in all cases and doesn't |
2288 | need elaborate support such as pthreads. |
2987 | need elaborate support such as pthreads or unportable memory access |
|
|
2988 | semantics. |
2289 | |
2989 | |
2290 | That means that if you want to queue data, you have to provide your own |
2990 | That means that if you want to queue data, you have to provide your own |
2291 | queue. But at least I can tell you would implement locking around your |
2991 | queue. But at least I can tell you how to implement locking around your |
2292 | queue: |
2992 | queue: |
2293 | |
2993 | |
2294 | =over 4 |
2994 | =over 4 |
2295 | |
2995 | |
2296 | =item queueing from a signal handler context |
2996 | =item queueing from a signal handler context |
2297 | |
2997 | |
2298 | To implement race-free queueing, you simply add to the queue in the signal |
2998 | To implement race-free queueing, you simply add to the queue in the signal |
2299 | handler but you block the signal handler in the watcher callback. Here is an example that does that for |
2999 | handler but you block the signal handler in the watcher callback. Here is |
2300 | some fictitious SIGUSR1 handler: |
3000 | an example that does that for some fictitious SIGUSR1 handler: |
2301 | |
3001 | |
2302 | static ev_async mysig; |
3002 | static ev_async mysig; |
2303 | |
3003 | |
2304 | static void |
3004 | static void |
2305 | sigusr1_handler (void) |
3005 | sigusr1_handler (void) |
… | |
… | |
2371 | =over 4 |
3071 | =over 4 |
2372 | |
3072 | |
2373 | =item ev_async_init (ev_async *, callback) |
3073 | =item ev_async_init (ev_async *, callback) |
2374 | |
3074 | |
2375 | Initialises and configures the async watcher - it has no parameters of any |
3075 | Initialises and configures the async watcher - it has no parameters of any |
2376 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
3076 | kind. There is a C<ev_async_set> macro, but using it is utterly pointless, |
2377 | believe me. |
3077 | trust me. |
2378 | |
3078 | |
2379 | =item ev_async_send (loop, ev_async *) |
3079 | =item ev_async_send (loop, ev_async *) |
2380 | |
3080 | |
2381 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
3081 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2382 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
3082 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2383 | C<ev_feed_event>, this call is safe to do in other threads, signal or |
3083 | C<ev_feed_event>, this call is safe to do from other threads, signal or |
2384 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
3084 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2385 | section below on what exactly this means). |
3085 | section below on what exactly this means). |
2386 | |
3086 | |
|
|
3087 | Note that, as with other watchers in libev, multiple events might get |
|
|
3088 | compressed into a single callback invocation (another way to look at this |
|
|
3089 | is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, |
|
|
3090 | reset when the event loop detects that). |
|
|
3091 | |
2387 | This call incurs the overhead of a system call only once per loop iteration, |
3092 | This call incurs the overhead of a system call only once per event loop |
2388 | so while the overhead might be noticeable, it doesn't apply to repeated |
3093 | iteration, so while the overhead might be noticeable, it doesn't apply to |
2389 | calls to C<ev_async_send>. |
3094 | repeated calls to C<ev_async_send> for the same event loop. |
2390 | |
3095 | |
2391 | =item bool = ev_async_pending (ev_async *) |
3096 | =item bool = ev_async_pending (ev_async *) |
2392 | |
3097 | |
2393 | Returns a non-zero value when C<ev_async_send> has been called on the |
3098 | Returns a non-zero value when C<ev_async_send> has been called on the |
2394 | watcher but the event has not yet been processed (or even noted) by the |
3099 | watcher but the event has not yet been processed (or even noted) by the |
… | |
… | |
2397 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
3102 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
2398 | the loop iterates next and checks for the watcher to have become active, |
3103 | the loop iterates next and checks for the watcher to have become active, |
2399 | it will reset the flag again. C<ev_async_pending> can be used to very |
3104 | it will reset the flag again. C<ev_async_pending> can be used to very |
2400 | quickly check whether invoking the loop might be a good idea. |
3105 | quickly check whether invoking the loop might be a good idea. |
2401 | |
3106 | |
2402 | Not that this does I<not> check whether the watcher itself is pending, only |
3107 | Not that this does I<not> check whether the watcher itself is pending, |
2403 | whether it has been requested to make this watcher pending. |
3108 | only whether it has been requested to make this watcher pending: there |
|
|
3109 | is a time window between the event loop checking and resetting the async |
|
|
3110 | notification, and the callback being invoked. |
2404 | |
3111 | |
2405 | =back |
3112 | =back |
2406 | |
3113 | |
2407 | |
3114 | |
2408 | =head1 OTHER FUNCTIONS |
3115 | =head1 OTHER FUNCTIONS |
… | |
… | |
2412 | =over 4 |
3119 | =over 4 |
2413 | |
3120 | |
2414 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
3121 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
2415 | |
3122 | |
2416 | This function combines a simple timer and an I/O watcher, calls your |
3123 | This function combines a simple timer and an I/O watcher, calls your |
2417 | callback on whichever event happens first and automatically stop both |
3124 | callback on whichever event happens first and automatically stops both |
2418 | watchers. This is useful if you want to wait for a single event on an fd |
3125 | watchers. This is useful if you want to wait for a single event on an fd |
2419 | or timeout without having to allocate/configure/start/stop/free one or |
3126 | or timeout without having to allocate/configure/start/stop/free one or |
2420 | more watchers yourself. |
3127 | more watchers yourself. |
2421 | |
3128 | |
2422 | If C<fd> is less than 0, then no I/O watcher will be started and events |
3129 | If C<fd> is less than 0, then no I/O watcher will be started and the |
2423 | is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and |
3130 | C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for |
2424 | C<events> set will be created and started. |
3131 | the given C<fd> and C<events> set will be created and started. |
2425 | |
3132 | |
2426 | If C<timeout> is less than 0, then no timeout watcher will be |
3133 | If C<timeout> is less than 0, then no timeout watcher will be |
2427 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
3134 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2428 | repeat = 0) will be started. While C<0> is a valid timeout, it is of |
3135 | repeat = 0) will be started. C<0> is a valid timeout. |
2429 | dubious value. |
|
|
2430 | |
3136 | |
2431 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
3137 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
2432 | passed an C<revents> set like normal event callbacks (a combination of |
3138 | passed an C<revents> set like normal event callbacks (a combination of |
2433 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
3139 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
2434 | value passed to C<ev_once>: |
3140 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
|
|
3141 | a timeout and an io event at the same time - you probably should give io |
|
|
3142 | events precedence. |
|
|
3143 | |
|
|
3144 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
2435 | |
3145 | |
2436 | static void stdin_ready (int revents, void *arg) |
3146 | static void stdin_ready (int revents, void *arg) |
2437 | { |
3147 | { |
|
|
3148 | if (revents & EV_READ) |
|
|
3149 | /* stdin might have data for us, joy! */; |
2438 | if (revents & EV_TIMEOUT) |
3150 | else if (revents & EV_TIMEOUT) |
2439 | /* doh, nothing entered */; |
3151 | /* doh, nothing entered */; |
2440 | else if (revents & EV_READ) |
|
|
2441 | /* stdin might have data for us, joy! */; |
|
|
2442 | } |
3152 | } |
2443 | |
3153 | |
2444 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3154 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2445 | |
3155 | |
2446 | =item ev_feed_event (ev_loop *, watcher *, int revents) |
|
|
2447 | |
|
|
2448 | Feeds the given event set into the event loop, as if the specified event |
|
|
2449 | had happened for the specified watcher (which must be a pointer to an |
|
|
2450 | initialised but not necessarily started event watcher). |
|
|
2451 | |
|
|
2452 | =item ev_feed_fd_event (ev_loop *, int fd, int revents) |
3156 | =item ev_feed_fd_event (loop, int fd, int revents) |
2453 | |
3157 | |
2454 | Feed an event on the given fd, as if a file descriptor backend detected |
3158 | Feed an event on the given fd, as if a file descriptor backend detected |
2455 | the given events it. |
3159 | the given events it. |
2456 | |
3160 | |
2457 | =item ev_feed_signal_event (ev_loop *loop, int signum) |
3161 | =item ev_feed_signal_event (loop, int signum) |
2458 | |
3162 | |
2459 | Feed an event as if the given signal occurred (C<loop> must be the default |
3163 | Feed an event as if the given signal occurred (C<loop> must be the default |
2460 | loop!). |
3164 | loop!). |
2461 | |
3165 | |
2462 | =back |
3166 | =back |
… | |
… | |
2542 | |
3246 | |
2543 | =over 4 |
3247 | =over 4 |
2544 | |
3248 | |
2545 | =item ev::TYPE::TYPE () |
3249 | =item ev::TYPE::TYPE () |
2546 | |
3250 | |
2547 | =item ev::TYPE::TYPE (struct ev_loop *) |
3251 | =item ev::TYPE::TYPE (loop) |
2548 | |
3252 | |
2549 | =item ev::TYPE::~TYPE |
3253 | =item ev::TYPE::~TYPE |
2550 | |
3254 | |
2551 | The constructor (optionally) takes an event loop to associate the watcher |
3255 | The constructor (optionally) takes an event loop to associate the watcher |
2552 | with. If it is omitted, it will use C<EV_DEFAULT>. |
3256 | with. If it is omitted, it will use C<EV_DEFAULT>. |
… | |
… | |
2584 | |
3288 | |
2585 | myclass obj; |
3289 | myclass obj; |
2586 | ev::io iow; |
3290 | ev::io iow; |
2587 | iow.set <myclass, &myclass::io_cb> (&obj); |
3291 | iow.set <myclass, &myclass::io_cb> (&obj); |
2588 | |
3292 | |
|
|
3293 | =item w->set (object *) |
|
|
3294 | |
|
|
3295 | This is an B<experimental> feature that might go away in a future version. |
|
|
3296 | |
|
|
3297 | This is a variation of a method callback - leaving out the method to call |
|
|
3298 | will default the method to C<operator ()>, which makes it possible to use |
|
|
3299 | functor objects without having to manually specify the C<operator ()> all |
|
|
3300 | the time. Incidentally, you can then also leave out the template argument |
|
|
3301 | list. |
|
|
3302 | |
|
|
3303 | The C<operator ()> method prototype must be C<void operator ()(watcher &w, |
|
|
3304 | int revents)>. |
|
|
3305 | |
|
|
3306 | See the method-C<set> above for more details. |
|
|
3307 | |
|
|
3308 | Example: use a functor object as callback. |
|
|
3309 | |
|
|
3310 | struct myfunctor |
|
|
3311 | { |
|
|
3312 | void operator() (ev::io &w, int revents) |
|
|
3313 | { |
|
|
3314 | ... |
|
|
3315 | } |
|
|
3316 | } |
|
|
3317 | |
|
|
3318 | myfunctor f; |
|
|
3319 | |
|
|
3320 | ev::io w; |
|
|
3321 | w.set (&f); |
|
|
3322 | |
2589 | =item w->set<function> (void *data = 0) |
3323 | =item w->set<function> (void *data = 0) |
2590 | |
3324 | |
2591 | Also sets a callback, but uses a static method or plain function as |
3325 | Also sets a callback, but uses a static method or plain function as |
2592 | callback. The optional C<data> argument will be stored in the watcher's |
3326 | callback. The optional C<data> argument will be stored in the watcher's |
2593 | C<data> member and is free for you to use. |
3327 | C<data> member and is free for you to use. |
2594 | |
3328 | |
2595 | The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>. |
3329 | The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>. |
2596 | |
3330 | |
2597 | See the method-C<set> above for more details. |
3331 | See the method-C<set> above for more details. |
2598 | |
3332 | |
2599 | Example: |
3333 | Example: Use a plain function as callback. |
2600 | |
3334 | |
2601 | static void io_cb (ev::io &w, int revents) { } |
3335 | static void io_cb (ev::io &w, int revents) { } |
2602 | iow.set <io_cb> (); |
3336 | iow.set <io_cb> (); |
2603 | |
3337 | |
2604 | =item w->set (struct ev_loop *) |
3338 | =item w->set (loop) |
2605 | |
3339 | |
2606 | Associates a different C<struct ev_loop> with this watcher. You can only |
3340 | Associates a different C<struct ev_loop> with this watcher. You can only |
2607 | do this when the watcher is inactive (and not pending either). |
3341 | do this when the watcher is inactive (and not pending either). |
2608 | |
3342 | |
2609 | =item w->set ([arguments]) |
3343 | =item w->set ([arguments]) |
… | |
… | |
2642 | Example: Define a class with an IO and idle watcher, start one of them in |
3376 | Example: Define a class with an IO and idle watcher, start one of them in |
2643 | the constructor. |
3377 | the constructor. |
2644 | |
3378 | |
2645 | class myclass |
3379 | class myclass |
2646 | { |
3380 | { |
2647 | ev::io io; void io_cb (ev::io &w, int revents); |
3381 | ev::io io ; void io_cb (ev::io &w, int revents); |
2648 | ev:idle idle void idle_cb (ev::idle &w, int revents); |
3382 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
2649 | |
3383 | |
2650 | myclass (int fd) |
3384 | myclass (int fd) |
2651 | { |
3385 | { |
2652 | io .set <myclass, &myclass::io_cb > (this); |
3386 | io .set <myclass, &myclass::io_cb > (this); |
2653 | idle.set <myclass, &myclass::idle_cb> (this); |
3387 | idle.set <myclass, &myclass::idle_cb> (this); |
… | |
… | |
2669 | =item Perl |
3403 | =item Perl |
2670 | |
3404 | |
2671 | The EV module implements the full libev API and is actually used to test |
3405 | The EV module implements the full libev API and is actually used to test |
2672 | libev. EV is developed together with libev. Apart from the EV core module, |
3406 | libev. EV is developed together with libev. Apart from the EV core module, |
2673 | there are additional modules that implement libev-compatible interfaces |
3407 | there are additional modules that implement libev-compatible interfaces |
2674 | to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the |
3408 | to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays), |
2675 | C<libglib> event core (C<Glib::EV> and C<EV::Glib>). |
3409 | C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV> |
|
|
3410 | and C<EV::Glib>). |
2676 | |
3411 | |
2677 | It can be found and installed via CPAN, its homepage is at |
3412 | It can be found and installed via CPAN, its homepage is at |
2678 | L<http://software.schmorp.de/pkg/EV>. |
3413 | L<http://software.schmorp.de/pkg/EV>. |
2679 | |
3414 | |
2680 | =item Python |
3415 | =item Python |
2681 | |
3416 | |
2682 | Python bindings can be found at L<http://code.google.com/p/pyev/>. It |
3417 | Python bindings can be found at L<http://code.google.com/p/pyev/>. It |
2683 | seems to be quite complete and well-documented. Note, however, that the |
3418 | seems to be quite complete and well-documented. |
2684 | patch they require for libev is outright dangerous as it breaks the ABI |
|
|
2685 | for everybody else, and therefore, should never be applied in an installed |
|
|
2686 | libev (if python requires an incompatible ABI then it needs to embed |
|
|
2687 | libev). |
|
|
2688 | |
3419 | |
2689 | =item Ruby |
3420 | =item Ruby |
2690 | |
3421 | |
2691 | Tony Arcieri has written a ruby extension that offers access to a subset |
3422 | Tony Arcieri has written a ruby extension that offers access to a subset |
2692 | of the libev API and adds file handle abstractions, asynchronous DNS and |
3423 | of the libev API and adds file handle abstractions, asynchronous DNS and |
2693 | more on top of it. It can be found via gem servers. Its homepage is at |
3424 | more on top of it. It can be found via gem servers. Its homepage is at |
2694 | L<http://rev.rubyforge.org/>. |
3425 | L<http://rev.rubyforge.org/>. |
2695 | |
3426 | |
|
|
3427 | Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190> |
|
|
3428 | makes rev work even on mingw. |
|
|
3429 | |
|
|
3430 | =item Haskell |
|
|
3431 | |
|
|
3432 | A haskell binding to libev is available at |
|
|
3433 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
|
|
3434 | |
2696 | =item D |
3435 | =item D |
2697 | |
3436 | |
2698 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
3437 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
2699 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
3438 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
|
|
3439 | |
|
|
3440 | =item Ocaml |
|
|
3441 | |
|
|
3442 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
|
|
3443 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
|
|
3444 | |
|
|
3445 | =item Lua |
|
|
3446 | |
|
|
3447 | Brian Maher has written a partial interface to libev |
|
|
3448 | for lua (only C<ev_io> and C<ev_timer>), to be found at |
|
|
3449 | L<http://github.com/brimworks/lua-ev>. |
2700 | |
3450 | |
2701 | =back |
3451 | =back |
2702 | |
3452 | |
2703 | |
3453 | |
2704 | =head1 MACRO MAGIC |
3454 | =head1 MACRO MAGIC |
… | |
… | |
2805 | |
3555 | |
2806 | #define EV_STANDALONE 1 |
3556 | #define EV_STANDALONE 1 |
2807 | #include "ev.h" |
3557 | #include "ev.h" |
2808 | |
3558 | |
2809 | Both header files and implementation files can be compiled with a C++ |
3559 | Both header files and implementation files can be compiled with a C++ |
2810 | compiler (at least, thats a stated goal, and breakage will be treated |
3560 | compiler (at least, that's a stated goal, and breakage will be treated |
2811 | as a bug). |
3561 | as a bug). |
2812 | |
3562 | |
2813 | You need the following files in your source tree, or in a directory |
3563 | You need the following files in your source tree, or in a directory |
2814 | in your include path (e.g. in libev/ when using -Ilibev): |
3564 | in your include path (e.g. in libev/ when using -Ilibev): |
2815 | |
3565 | |
… | |
… | |
2859 | |
3609 | |
2860 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3610 | =head2 PREPROCESSOR SYMBOLS/MACROS |
2861 | |
3611 | |
2862 | Libev can be configured via a variety of preprocessor symbols you have to |
3612 | Libev can be configured via a variety of preprocessor symbols you have to |
2863 | define before including any of its files. The default in the absence of |
3613 | define before including any of its files. The default in the absence of |
2864 | autoconf is noted for every option. |
3614 | autoconf is documented for every option. |
2865 | |
3615 | |
2866 | =over 4 |
3616 | =over 4 |
2867 | |
3617 | |
2868 | =item EV_STANDALONE |
3618 | =item EV_STANDALONE |
2869 | |
3619 | |
… | |
… | |
2871 | keeps libev from including F<config.h>, and it also defines dummy |
3621 | keeps libev from including F<config.h>, and it also defines dummy |
2872 | implementations for some libevent functions (such as logging, which is not |
3622 | implementations for some libevent functions (such as logging, which is not |
2873 | supported). It will also not define any of the structs usually found in |
3623 | supported). It will also not define any of the structs usually found in |
2874 | F<event.h> that are not directly supported by the libev core alone. |
3624 | F<event.h> that are not directly supported by the libev core alone. |
2875 | |
3625 | |
|
|
3626 | In standalone mode, libev will still try to automatically deduce the |
|
|
3627 | configuration, but has to be more conservative. |
|
|
3628 | |
2876 | =item EV_USE_MONOTONIC |
3629 | =item EV_USE_MONOTONIC |
2877 | |
3630 | |
2878 | If defined to be C<1>, libev will try to detect the availability of the |
3631 | If defined to be C<1>, libev will try to detect the availability of the |
2879 | monotonic clock option at both compile time and runtime. Otherwise no use |
3632 | monotonic clock option at both compile time and runtime. Otherwise no |
2880 | of the monotonic clock option will be attempted. If you enable this, you |
3633 | use of the monotonic clock option will be attempted. If you enable this, |
2881 | usually have to link against librt or something similar. Enabling it when |
3634 | you usually have to link against librt or something similar. Enabling it |
2882 | the functionality isn't available is safe, though, although you have |
3635 | when the functionality isn't available is safe, though, although you have |
2883 | to make sure you link against any libraries where the C<clock_gettime> |
3636 | to make sure you link against any libraries where the C<clock_gettime> |
2884 | function is hiding in (often F<-lrt>). |
3637 | function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>. |
2885 | |
3638 | |
2886 | =item EV_USE_REALTIME |
3639 | =item EV_USE_REALTIME |
2887 | |
3640 | |
2888 | If defined to be C<1>, libev will try to detect the availability of the |
3641 | If defined to be C<1>, libev will try to detect the availability of the |
2889 | real-time clock option at compile time (and assume its availability at |
3642 | real-time clock option at compile time (and assume its availability |
2890 | runtime if successful). Otherwise no use of the real-time clock option will |
3643 | at runtime if successful). Otherwise no use of the real-time clock |
2891 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
3644 | option will be attempted. This effectively replaces C<gettimeofday> |
2892 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See the |
3645 | by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect |
2893 | note about libraries in the description of C<EV_USE_MONOTONIC>, though. |
3646 | correctness. See the note about libraries in the description of |
|
|
3647 | C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of |
|
|
3648 | C<EV_USE_CLOCK_SYSCALL>. |
|
|
3649 | |
|
|
3650 | =item EV_USE_CLOCK_SYSCALL |
|
|
3651 | |
|
|
3652 | If defined to be C<1>, libev will try to use a direct syscall instead |
|
|
3653 | of calling the system-provided C<clock_gettime> function. This option |
|
|
3654 | exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt> |
|
|
3655 | unconditionally pulls in C<libpthread>, slowing down single-threaded |
|
|
3656 | programs needlessly. Using a direct syscall is slightly slower (in |
|
|
3657 | theory), because no optimised vdso implementation can be used, but avoids |
|
|
3658 | the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or |
|
|
3659 | higher, as it simplifies linking (no need for C<-lrt>). |
2894 | |
3660 | |
2895 | =item EV_USE_NANOSLEEP |
3661 | =item EV_USE_NANOSLEEP |
2896 | |
3662 | |
2897 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
3663 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
2898 | and will use it for delays. Otherwise it will use C<select ()>. |
3664 | and will use it for delays. Otherwise it will use C<select ()>. |
… | |
… | |
2914 | |
3680 | |
2915 | =item EV_SELECT_USE_FD_SET |
3681 | =item EV_SELECT_USE_FD_SET |
2916 | |
3682 | |
2917 | If defined to C<1>, then the select backend will use the system C<fd_set> |
3683 | If defined to C<1>, then the select backend will use the system C<fd_set> |
2918 | structure. This is useful if libev doesn't compile due to a missing |
3684 | structure. This is useful if libev doesn't compile due to a missing |
2919 | C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on |
3685 | C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout |
2920 | exotic systems. This usually limits the range of file descriptors to some |
3686 | on exotic systems. This usually limits the range of file descriptors to |
2921 | low limit such as 1024 or might have other limitations (winsocket only |
3687 | some low limit such as 1024 or might have other limitations (winsocket |
2922 | allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might |
3688 | only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, |
2923 | influence the size of the C<fd_set> used. |
3689 | configures the maximum size of the C<fd_set>. |
2924 | |
3690 | |
2925 | =item EV_SELECT_IS_WINSOCKET |
3691 | =item EV_SELECT_IS_WINSOCKET |
2926 | |
3692 | |
2927 | When defined to C<1>, the select backend will assume that |
3693 | When defined to C<1>, the select backend will assume that |
2928 | select/socket/connect etc. don't understand file descriptors but |
3694 | select/socket/connect etc. don't understand file descriptors but |
… | |
… | |
2930 | be used is the winsock select). This means that it will call |
3696 | be used is the winsock select). This means that it will call |
2931 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3697 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2932 | it is assumed that all these functions actually work on fds, even |
3698 | it is assumed that all these functions actually work on fds, even |
2933 | on win32. Should not be defined on non-win32 platforms. |
3699 | on win32. Should not be defined on non-win32 platforms. |
2934 | |
3700 | |
2935 | =item EV_FD_TO_WIN32_HANDLE |
3701 | =item EV_FD_TO_WIN32_HANDLE(fd) |
2936 | |
3702 | |
2937 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3703 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
2938 | file descriptors to socket handles. When not defining this symbol (the |
3704 | file descriptors to socket handles. When not defining this symbol (the |
2939 | default), then libev will call C<_get_osfhandle>, which is usually |
3705 | default), then libev will call C<_get_osfhandle>, which is usually |
2940 | correct. In some cases, programs use their own file descriptor management, |
3706 | correct. In some cases, programs use their own file descriptor management, |
2941 | in which case they can provide this function to map fds to socket handles. |
3707 | in which case they can provide this function to map fds to socket handles. |
|
|
3708 | |
|
|
3709 | =item EV_WIN32_HANDLE_TO_FD(handle) |
|
|
3710 | |
|
|
3711 | If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors |
|
|
3712 | using the standard C<_open_osfhandle> function. For programs implementing |
|
|
3713 | their own fd to handle mapping, overwriting this function makes it easier |
|
|
3714 | to do so. This can be done by defining this macro to an appropriate value. |
|
|
3715 | |
|
|
3716 | =item EV_WIN32_CLOSE_FD(fd) |
|
|
3717 | |
|
|
3718 | If programs implement their own fd to handle mapping on win32, then this |
|
|
3719 | macro can be used to override the C<close> function, useful to unregister |
|
|
3720 | file descriptors again. Note that the replacement function has to close |
|
|
3721 | the underlying OS handle. |
2942 | |
3722 | |
2943 | =item EV_USE_POLL |
3723 | =item EV_USE_POLL |
2944 | |
3724 | |
2945 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3725 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2946 | backend. Otherwise it will be enabled on non-win32 platforms. It |
3726 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
3039 | When doing priority-based operations, libev usually has to linearly search |
3819 | When doing priority-based operations, libev usually has to linearly search |
3040 | all the priorities, so having many of them (hundreds) uses a lot of space |
3820 | all the priorities, so having many of them (hundreds) uses a lot of space |
3041 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
3821 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
3042 | fine. |
3822 | fine. |
3043 | |
3823 | |
3044 | If your embedding application does not need any priorities, defining these both to |
3824 | If your embedding application does not need any priorities, defining these |
3045 | C<0> will save some memory and CPU. |
3825 | both to C<0> will save some memory and CPU. |
3046 | |
3826 | |
3047 | =item EV_PERIODIC_ENABLE |
3827 | =item EV_PERIODIC_ENABLE |
3048 | |
3828 | |
3049 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3829 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3050 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
3830 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
… | |
… | |
3057 | code. |
3837 | code. |
3058 | |
3838 | |
3059 | =item EV_EMBED_ENABLE |
3839 | =item EV_EMBED_ENABLE |
3060 | |
3840 | |
3061 | If undefined or defined to be C<1>, then embed watchers are supported. If |
3841 | If undefined or defined to be C<1>, then embed watchers are supported. If |
3062 | defined to be C<0>, then they are not. |
3842 | defined to be C<0>, then they are not. Embed watchers rely on most other |
|
|
3843 | watcher types, which therefore must not be disabled. |
3063 | |
3844 | |
3064 | =item EV_STAT_ENABLE |
3845 | =item EV_STAT_ENABLE |
3065 | |
3846 | |
3066 | If undefined or defined to be C<1>, then stat watchers are supported. If |
3847 | If undefined or defined to be C<1>, then stat watchers are supported. If |
3067 | defined to be C<0>, then they are not. |
3848 | defined to be C<0>, then they are not. |
… | |
… | |
3077 | defined to be C<0>, then they are not. |
3858 | defined to be C<0>, then they are not. |
3078 | |
3859 | |
3079 | =item EV_MINIMAL |
3860 | =item EV_MINIMAL |
3080 | |
3861 | |
3081 | If you need to shave off some kilobytes of code at the expense of some |
3862 | If you need to shave off some kilobytes of code at the expense of some |
3082 | speed, define this symbol to C<1>. Currently this is used to override some |
3863 | speed (but with the full API), define this symbol to C<1>. Currently this |
3083 | inlining decisions, saves roughly 30% code size on amd64. It also selects a |
3864 | is used to override some inlining decisions, saves roughly 30% code size |
3084 | much smaller 2-heap for timer management over the default 4-heap. |
3865 | on amd64. It also selects a much smaller 2-heap for timer management over |
|
|
3866 | the default 4-heap. |
|
|
3867 | |
|
|
3868 | You can save even more by disabling watcher types you do not need |
|
|
3869 | and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert> |
|
|
3870 | (C<-DNDEBUG>) will usually reduce code size a lot. |
|
|
3871 | |
|
|
3872 | Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to |
|
|
3873 | provide a bare-bones event library. See C<ev.h> for details on what parts |
|
|
3874 | of the API are still available, and do not complain if this subset changes |
|
|
3875 | over time. |
|
|
3876 | |
|
|
3877 | =item EV_NSIG |
|
|
3878 | |
|
|
3879 | The highest supported signal number, +1 (or, the number of |
|
|
3880 | signals): Normally, libev tries to deduce the maximum number of signals |
|
|
3881 | automatically, but sometimes this fails, in which case it can be |
|
|
3882 | specified. Also, using a lower number than detected (C<32> should be |
|
|
3883 | good for about any system in existance) can save some memory, as libev |
|
|
3884 | statically allocates some 12-24 bytes per signal number. |
3085 | |
3885 | |
3086 | =item EV_PID_HASHSIZE |
3886 | =item EV_PID_HASHSIZE |
3087 | |
3887 | |
3088 | C<ev_child> watchers use a small hash table to distribute workload by |
3888 | C<ev_child> watchers use a small hash table to distribute workload by |
3089 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
3889 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
… | |
… | |
3099 | two). |
3899 | two). |
3100 | |
3900 | |
3101 | =item EV_USE_4HEAP |
3901 | =item EV_USE_4HEAP |
3102 | |
3902 | |
3103 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3903 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3104 | timer and periodics heap, libev uses a 4-heap when this symbol is defined |
3904 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
3105 | to C<1>. The 4-heap uses more complicated (longer) code but has |
3905 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
3106 | noticeably faster performance with many (thousands) of watchers. |
3906 | faster performance with many (thousands) of watchers. |
3107 | |
3907 | |
3108 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3908 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3109 | (disabled). |
3909 | (disabled). |
3110 | |
3910 | |
3111 | =item EV_HEAP_CACHE_AT |
3911 | =item EV_HEAP_CACHE_AT |
3112 | |
3912 | |
3113 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3913 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3114 | timer and periodics heap, libev can cache the timestamp (I<at>) within |
3914 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
3115 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3915 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3116 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3916 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3117 | but avoids random read accesses on heap changes. This improves performance |
3917 | but avoids random read accesses on heap changes. This improves performance |
3118 | noticeably with with many (hundreds) of watchers. |
3918 | noticeably with many (hundreds) of watchers. |
3119 | |
3919 | |
3120 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3920 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3121 | (disabled). |
3921 | (disabled). |
3122 | |
3922 | |
3123 | =item EV_VERIFY |
3923 | =item EV_VERIFY |
… | |
… | |
3129 | called once per loop, which can slow down libev. If set to C<3>, then the |
3929 | called once per loop, which can slow down libev. If set to C<3>, then the |
3130 | verification code will be called very frequently, which will slow down |
3930 | verification code will be called very frequently, which will slow down |
3131 | libev considerably. |
3931 | libev considerably. |
3132 | |
3932 | |
3133 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
3933 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
3134 | C<0.> |
3934 | C<0>. |
3135 | |
3935 | |
3136 | =item EV_COMMON |
3936 | =item EV_COMMON |
3137 | |
3937 | |
3138 | By default, all watchers have a C<void *data> member. By redefining |
3938 | By default, all watchers have a C<void *data> member. By redefining |
3139 | this macro to a something else you can include more and other types of |
3939 | this macro to a something else you can include more and other types of |
… | |
… | |
3156 | and the way callbacks are invoked and set. Must expand to a struct member |
3956 | and the way callbacks are invoked and set. Must expand to a struct member |
3157 | definition and a statement, respectively. See the F<ev.h> header file for |
3957 | definition and a statement, respectively. See the F<ev.h> header file for |
3158 | their default definitions. One possible use for overriding these is to |
3958 | their default definitions. One possible use for overriding these is to |
3159 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
3959 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
3160 | method calls instead of plain function calls in C++. |
3960 | method calls instead of plain function calls in C++. |
|
|
3961 | |
|
|
3962 | =back |
3161 | |
3963 | |
3162 | =head2 EXPORTED API SYMBOLS |
3964 | =head2 EXPORTED API SYMBOLS |
3163 | |
3965 | |
3164 | If you need to re-export the API (e.g. via a DLL) and you need a list of |
3966 | If you need to re-export the API (e.g. via a DLL) and you need a list of |
3165 | exported symbols, you can use the provided F<Symbol.*> files which list |
3967 | exported symbols, you can use the provided F<Symbol.*> files which list |
… | |
… | |
3212 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
4014 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3213 | |
4015 | |
3214 | #include "ev_cpp.h" |
4016 | #include "ev_cpp.h" |
3215 | #include "ev.c" |
4017 | #include "ev.c" |
3216 | |
4018 | |
|
|
4019 | =head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES |
3217 | |
4020 | |
3218 | =head1 THREADS AND COROUTINES |
4021 | =head2 THREADS AND COROUTINES |
3219 | |
4022 | |
3220 | =head2 THREADS |
4023 | =head3 THREADS |
3221 | |
4024 | |
3222 | Libev itself is completely thread-safe, but it uses no locking. This |
4025 | All libev functions are reentrant and thread-safe unless explicitly |
|
|
4026 | documented otherwise, but libev implements no locking itself. This means |
3223 | means that you can use as many loops as you want in parallel, as long as |
4027 | that you can use as many loops as you want in parallel, as long as there |
3224 | only one thread ever calls into one libev function with the same loop |
4028 | are no concurrent calls into any libev function with the same loop |
3225 | parameter. |
4029 | parameter (C<ev_default_*> calls have an implicit default loop parameter, |
|
|
4030 | of course): libev guarantees that different event loops share no data |
|
|
4031 | structures that need any locking. |
3226 | |
4032 | |
3227 | Or put differently: calls with different loop parameters can be done in |
4033 | Or to put it differently: calls with different loop parameters can be done |
3228 | parallel from multiple threads, calls with the same loop parameter must be |
4034 | concurrently from multiple threads, calls with the same loop parameter |
3229 | done serially (but can be done from different threads, as long as only one |
4035 | must be done serially (but can be done from different threads, as long as |
3230 | thread ever is inside a call at any point in time, e.g. by using a mutex |
4036 | only one thread ever is inside a call at any point in time, e.g. by using |
3231 | per loop). |
4037 | a mutex per loop). |
|
|
4038 | |
|
|
4039 | Specifically to support threads (and signal handlers), libev implements |
|
|
4040 | so-called C<ev_async> watchers, which allow some limited form of |
|
|
4041 | concurrency on the same event loop, namely waking it up "from the |
|
|
4042 | outside". |
3232 | |
4043 | |
3233 | If you want to know which design (one loop, locking, or multiple loops |
4044 | If you want to know which design (one loop, locking, or multiple loops |
3234 | without or something else still) is best for your problem, then I cannot |
4045 | without or something else still) is best for your problem, then I cannot |
3235 | help you. I can give some generic advice however: |
4046 | help you, but here is some generic advice: |
3236 | |
4047 | |
3237 | =over 4 |
4048 | =over 4 |
3238 | |
4049 | |
3239 | =item * most applications have a main thread: use the default libev loop |
4050 | =item * most applications have a main thread: use the default libev loop |
3240 | in that thread, or create a separate thread running only the default loop. |
4051 | in that thread, or create a separate thread running only the default loop. |
… | |
… | |
3252 | |
4063 | |
3253 | Choosing a model is hard - look around, learn, know that usually you can do |
4064 | Choosing a model is hard - look around, learn, know that usually you can do |
3254 | better than you currently do :-) |
4065 | better than you currently do :-) |
3255 | |
4066 | |
3256 | =item * often you need to talk to some other thread which blocks in the |
4067 | =item * often you need to talk to some other thread which blocks in the |
|
|
4068 | event loop. |
|
|
4069 | |
3257 | event loop - C<ev_async> watchers can be used to wake them up from other |
4070 | C<ev_async> watchers can be used to wake them up from other threads safely |
3258 | threads safely (or from signal contexts...). |
4071 | (or from signal contexts...). |
|
|
4072 | |
|
|
4073 | An example use would be to communicate signals or other events that only |
|
|
4074 | work in the default loop by registering the signal watcher with the |
|
|
4075 | default loop and triggering an C<ev_async> watcher from the default loop |
|
|
4076 | watcher callback into the event loop interested in the signal. |
3259 | |
4077 | |
3260 | =back |
4078 | =back |
3261 | |
4079 | |
|
|
4080 | =head4 THREAD LOCKING EXAMPLE |
|
|
4081 | |
|
|
4082 | Here is a fictitious example of how to run an event loop in a different |
|
|
4083 | thread than where callbacks are being invoked and watchers are |
|
|
4084 | created/added/removed. |
|
|
4085 | |
|
|
4086 | For a real-world example, see the C<EV::Loop::Async> perl module, |
|
|
4087 | which uses exactly this technique (which is suited for many high-level |
|
|
4088 | languages). |
|
|
4089 | |
|
|
4090 | The example uses a pthread mutex to protect the loop data, a condition |
|
|
4091 | variable to wait for callback invocations, an async watcher to notify the |
|
|
4092 | event loop thread and an unspecified mechanism to wake up the main thread. |
|
|
4093 | |
|
|
4094 | First, you need to associate some data with the event loop: |
|
|
4095 | |
|
|
4096 | typedef struct { |
|
|
4097 | mutex_t lock; /* global loop lock */ |
|
|
4098 | ev_async async_w; |
|
|
4099 | thread_t tid; |
|
|
4100 | cond_t invoke_cv; |
|
|
4101 | } userdata; |
|
|
4102 | |
|
|
4103 | void prepare_loop (EV_P) |
|
|
4104 | { |
|
|
4105 | // for simplicity, we use a static userdata struct. |
|
|
4106 | static userdata u; |
|
|
4107 | |
|
|
4108 | ev_async_init (&u->async_w, async_cb); |
|
|
4109 | ev_async_start (EV_A_ &u->async_w); |
|
|
4110 | |
|
|
4111 | pthread_mutex_init (&u->lock, 0); |
|
|
4112 | pthread_cond_init (&u->invoke_cv, 0); |
|
|
4113 | |
|
|
4114 | // now associate this with the loop |
|
|
4115 | ev_set_userdata (EV_A_ u); |
|
|
4116 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
|
|
4117 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
|
|
4118 | |
|
|
4119 | // then create the thread running ev_loop |
|
|
4120 | pthread_create (&u->tid, 0, l_run, EV_A); |
|
|
4121 | } |
|
|
4122 | |
|
|
4123 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
|
|
4124 | solely to wake up the event loop so it takes notice of any new watchers |
|
|
4125 | that might have been added: |
|
|
4126 | |
|
|
4127 | static void |
|
|
4128 | async_cb (EV_P_ ev_async *w, int revents) |
|
|
4129 | { |
|
|
4130 | // just used for the side effects |
|
|
4131 | } |
|
|
4132 | |
|
|
4133 | The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex |
|
|
4134 | protecting the loop data, respectively. |
|
|
4135 | |
|
|
4136 | static void |
|
|
4137 | l_release (EV_P) |
|
|
4138 | { |
|
|
4139 | userdata *u = ev_userdata (EV_A); |
|
|
4140 | pthread_mutex_unlock (&u->lock); |
|
|
4141 | } |
|
|
4142 | |
|
|
4143 | static void |
|
|
4144 | l_acquire (EV_P) |
|
|
4145 | { |
|
|
4146 | userdata *u = ev_userdata (EV_A); |
|
|
4147 | pthread_mutex_lock (&u->lock); |
|
|
4148 | } |
|
|
4149 | |
|
|
4150 | The event loop thread first acquires the mutex, and then jumps straight |
|
|
4151 | into C<ev_loop>: |
|
|
4152 | |
|
|
4153 | void * |
|
|
4154 | l_run (void *thr_arg) |
|
|
4155 | { |
|
|
4156 | struct ev_loop *loop = (struct ev_loop *)thr_arg; |
|
|
4157 | |
|
|
4158 | l_acquire (EV_A); |
|
|
4159 | pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); |
|
|
4160 | ev_loop (EV_A_ 0); |
|
|
4161 | l_release (EV_A); |
|
|
4162 | |
|
|
4163 | return 0; |
|
|
4164 | } |
|
|
4165 | |
|
|
4166 | Instead of invoking all pending watchers, the C<l_invoke> callback will |
|
|
4167 | signal the main thread via some unspecified mechanism (signals? pipe |
|
|
4168 | writes? C<Async::Interrupt>?) and then waits until all pending watchers |
|
|
4169 | have been called (in a while loop because a) spurious wakeups are possible |
|
|
4170 | and b) skipping inter-thread-communication when there are no pending |
|
|
4171 | watchers is very beneficial): |
|
|
4172 | |
|
|
4173 | static void |
|
|
4174 | l_invoke (EV_P) |
|
|
4175 | { |
|
|
4176 | userdata *u = ev_userdata (EV_A); |
|
|
4177 | |
|
|
4178 | while (ev_pending_count (EV_A)) |
|
|
4179 | { |
|
|
4180 | wake_up_other_thread_in_some_magic_or_not_so_magic_way (); |
|
|
4181 | pthread_cond_wait (&u->invoke_cv, &u->lock); |
|
|
4182 | } |
|
|
4183 | } |
|
|
4184 | |
|
|
4185 | Now, whenever the main thread gets told to invoke pending watchers, it |
|
|
4186 | will grab the lock, call C<ev_invoke_pending> and then signal the loop |
|
|
4187 | thread to continue: |
|
|
4188 | |
|
|
4189 | static void |
|
|
4190 | real_invoke_pending (EV_P) |
|
|
4191 | { |
|
|
4192 | userdata *u = ev_userdata (EV_A); |
|
|
4193 | |
|
|
4194 | pthread_mutex_lock (&u->lock); |
|
|
4195 | ev_invoke_pending (EV_A); |
|
|
4196 | pthread_cond_signal (&u->invoke_cv); |
|
|
4197 | pthread_mutex_unlock (&u->lock); |
|
|
4198 | } |
|
|
4199 | |
|
|
4200 | Whenever you want to start/stop a watcher or do other modifications to an |
|
|
4201 | event loop, you will now have to lock: |
|
|
4202 | |
|
|
4203 | ev_timer timeout_watcher; |
|
|
4204 | userdata *u = ev_userdata (EV_A); |
|
|
4205 | |
|
|
4206 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
4207 | |
|
|
4208 | pthread_mutex_lock (&u->lock); |
|
|
4209 | ev_timer_start (EV_A_ &timeout_watcher); |
|
|
4210 | ev_async_send (EV_A_ &u->async_w); |
|
|
4211 | pthread_mutex_unlock (&u->lock); |
|
|
4212 | |
|
|
4213 | Note that sending the C<ev_async> watcher is required because otherwise |
|
|
4214 | an event loop currently blocking in the kernel will have no knowledge |
|
|
4215 | about the newly added timer. By waking up the loop it will pick up any new |
|
|
4216 | watchers in the next event loop iteration. |
|
|
4217 | |
3262 | =head2 COROUTINES |
4218 | =head3 COROUTINES |
3263 | |
4219 | |
3264 | Libev is much more accommodating to coroutines ("cooperative threads"): |
4220 | Libev is very accommodating to coroutines ("cooperative threads"): |
3265 | libev fully supports nesting calls to it's functions from different |
4221 | libev fully supports nesting calls to its functions from different |
3266 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
4222 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3267 | different coroutines and switch freely between both coroutines running the |
4223 | different coroutines, and switch freely between both coroutines running |
3268 | loop, as long as you don't confuse yourself). The only exception is that |
4224 | the loop, as long as you don't confuse yourself). The only exception is |
3269 | you must not do this from C<ev_periodic> reschedule callbacks. |
4225 | that you must not do this from C<ev_periodic> reschedule callbacks. |
3270 | |
4226 | |
3271 | Care has been invested into making sure that libev does not keep local |
4227 | Care has been taken to ensure that libev does not keep local state inside |
3272 | state inside C<ev_loop>, and other calls do not usually allow coroutine |
4228 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3273 | switches. |
4229 | they do not call any callbacks. |
3274 | |
4230 | |
|
|
4231 | =head2 COMPILER WARNINGS |
3275 | |
4232 | |
3276 | =head1 COMPLEXITIES |
4233 | Depending on your compiler and compiler settings, you might get no or a |
|
|
4234 | lot of warnings when compiling libev code. Some people are apparently |
|
|
4235 | scared by this. |
3277 | |
4236 | |
3278 | In this section the complexities of (many of) the algorithms used inside |
4237 | However, these are unavoidable for many reasons. For one, each compiler |
3279 | libev will be explained. For complexity discussions about backends see the |
4238 | has different warnings, and each user has different tastes regarding |
3280 | documentation for C<ev_default_init>. |
4239 | warning options. "Warn-free" code therefore cannot be a goal except when |
|
|
4240 | targeting a specific compiler and compiler-version. |
3281 | |
4241 | |
3282 | All of the following are about amortised time: If an array needs to be |
4242 | Another reason is that some compiler warnings require elaborate |
3283 | extended, libev needs to realloc and move the whole array, but this |
4243 | workarounds, or other changes to the code that make it less clear and less |
3284 | happens asymptotically never with higher number of elements, so O(1) might |
4244 | maintainable. |
3285 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
3286 | it is much faster and asymptotically approaches constant time. |
|
|
3287 | |
4245 | |
3288 | =over 4 |
4246 | And of course, some compiler warnings are just plain stupid, or simply |
|
|
4247 | wrong (because they don't actually warn about the condition their message |
|
|
4248 | seems to warn about). For example, certain older gcc versions had some |
|
|
4249 | warnings that resulted an extreme number of false positives. These have |
|
|
4250 | been fixed, but some people still insist on making code warn-free with |
|
|
4251 | such buggy versions. |
3289 | |
4252 | |
3290 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
4253 | While libev is written to generate as few warnings as possible, |
|
|
4254 | "warn-free" code is not a goal, and it is recommended not to build libev |
|
|
4255 | with any compiler warnings enabled unless you are prepared to cope with |
|
|
4256 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
4257 | warnings, not errors, or proof of bugs. |
3291 | |
4258 | |
3292 | This means that, when you have a watcher that triggers in one hour and |
|
|
3293 | there are 100 watchers that would trigger before that then inserting will |
|
|
3294 | have to skip roughly seven (C<ld 100>) of these watchers. |
|
|
3295 | |
4259 | |
3296 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
4260 | =head2 VALGRIND |
3297 | |
4261 | |
3298 | That means that changing a timer costs less than removing/adding them |
4262 | Valgrind has a special section here because it is a popular tool that is |
3299 | as only the relative motion in the event queue has to be paid for. |
4263 | highly useful. Unfortunately, valgrind reports are very hard to interpret. |
3300 | |
4264 | |
3301 | =item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1) |
4265 | If you think you found a bug (memory leak, uninitialised data access etc.) |
|
|
4266 | in libev, then check twice: If valgrind reports something like: |
3302 | |
4267 | |
3303 | These just add the watcher into an array or at the head of a list. |
4268 | ==2274== definitely lost: 0 bytes in 0 blocks. |
|
|
4269 | ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
4270 | ==2274== still reachable: 256 bytes in 1 blocks. |
3304 | |
4271 | |
3305 | =item Stopping check/prepare/idle/fork/async watchers: O(1) |
4272 | Then there is no memory leak, just as memory accounted to global variables |
|
|
4273 | is not a memleak - the memory is still being referenced, and didn't leak. |
3306 | |
4274 | |
3307 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
4275 | Similarly, under some circumstances, valgrind might report kernel bugs |
|
|
4276 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
|
|
4277 | although an acceptable workaround has been found here), or it might be |
|
|
4278 | confused. |
3308 | |
4279 | |
3309 | These watchers are stored in lists then need to be walked to find the |
4280 | Keep in mind that valgrind is a very good tool, but only a tool. Don't |
3310 | correct watcher to remove. The lists are usually short (you don't usually |
4281 | make it into some kind of religion. |
3311 | have many watchers waiting for the same fd or signal). |
|
|
3312 | |
4282 | |
3313 | =item Finding the next timer in each loop iteration: O(1) |
4283 | If you are unsure about something, feel free to contact the mailing list |
|
|
4284 | with the full valgrind report and an explanation on why you think this |
|
|
4285 | is a bug in libev (best check the archives, too :). However, don't be |
|
|
4286 | annoyed when you get a brisk "this is no bug" answer and take the chance |
|
|
4287 | of learning how to interpret valgrind properly. |
3314 | |
4288 | |
3315 | By virtue of using a binary or 4-heap, the next timer is always found at a |
4289 | If you need, for some reason, empty reports from valgrind for your project |
3316 | fixed position in the storage array. |
4290 | I suggest using suppression lists. |
3317 | |
4291 | |
3318 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
|
|
3319 | |
4292 | |
3320 | A change means an I/O watcher gets started or stopped, which requires |
4293 | =head1 PORTABILITY NOTES |
3321 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
3322 | on backend and whether C<ev_io_set> was used). |
|
|
3323 | |
4294 | |
3324 | =item Activating one watcher (putting it into the pending state): O(1) |
|
|
3325 | |
|
|
3326 | =item Priority handling: O(number_of_priorities) |
|
|
3327 | |
|
|
3328 | Priorities are implemented by allocating some space for each |
|
|
3329 | priority. When doing priority-based operations, libev usually has to |
|
|
3330 | linearly search all the priorities, but starting/stopping and activating |
|
|
3331 | watchers becomes O(1) w.r.t. priority handling. |
|
|
3332 | |
|
|
3333 | =item Sending an ev_async: O(1) |
|
|
3334 | |
|
|
3335 | =item Processing ev_async_send: O(number_of_async_watchers) |
|
|
3336 | |
|
|
3337 | =item Processing signals: O(max_signal_number) |
|
|
3338 | |
|
|
3339 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
|
|
3340 | calls in the current loop iteration. Checking for async and signal events |
|
|
3341 | involves iterating over all running async watchers or all signal numbers. |
|
|
3342 | |
|
|
3343 | =back |
|
|
3344 | |
|
|
3345 | |
|
|
3346 | =head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
4295 | =head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
3347 | |
4296 | |
3348 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
4297 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
3349 | requires, and its I/O model is fundamentally incompatible with the POSIX |
4298 | requires, and its I/O model is fundamentally incompatible with the POSIX |
3350 | model. Libev still offers limited functionality on this platform in |
4299 | model. Libev still offers limited functionality on this platform in |
3351 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
4300 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
… | |
… | |
3358 | way (note also that glib is the slowest event library known to man). |
4307 | way (note also that glib is the slowest event library known to man). |
3359 | |
4308 | |
3360 | There is no supported compilation method available on windows except |
4309 | There is no supported compilation method available on windows except |
3361 | embedding it into other applications. |
4310 | embedding it into other applications. |
3362 | |
4311 | |
|
|
4312 | Sensible signal handling is officially unsupported by Microsoft - libev |
|
|
4313 | tries its best, but under most conditions, signals will simply not work. |
|
|
4314 | |
3363 | Not a libev limitation but worth mentioning: windows apparently doesn't |
4315 | Not a libev limitation but worth mentioning: windows apparently doesn't |
3364 | accept large writes: instead of resulting in a partial write, windows will |
4316 | accept large writes: instead of resulting in a partial write, windows will |
3365 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
4317 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
3366 | so make sure you only write small amounts into your sockets (less than a |
4318 | so make sure you only write small amounts into your sockets (less than a |
3367 | megabyte seems safe, but thsi apparently depends on the amount of memory |
4319 | megabyte seems safe, but this apparently depends on the amount of memory |
3368 | available). |
4320 | available). |
3369 | |
4321 | |
3370 | Due to the many, low, and arbitrary limits on the win32 platform and |
4322 | Due to the many, low, and arbitrary limits on the win32 platform and |
3371 | the abysmal performance of winsockets, using a large number of sockets |
4323 | the abysmal performance of winsockets, using a large number of sockets |
3372 | is not recommended (and not reasonable). If your program needs to use |
4324 | is not recommended (and not reasonable). If your program needs to use |
3373 | more than a hundred or so sockets, then likely it needs to use a totally |
4325 | more than a hundred or so sockets, then likely it needs to use a totally |
3374 | different implementation for windows, as libev offers the POSIX readiness |
4326 | different implementation for windows, as libev offers the POSIX readiness |
3375 | notification model, which cannot be implemented efficiently on windows |
4327 | notification model, which cannot be implemented efficiently on windows |
3376 | (Microsoft monopoly games). |
4328 | (due to Microsoft monopoly games). |
3377 | |
4329 | |
3378 | A typical way to use libev under windows is to embed it (see the embedding |
4330 | A typical way to use libev under windows is to embed it (see the embedding |
3379 | section for details) and use the following F<evwrap.h> header file instead |
4331 | section for details) and use the following F<evwrap.h> header file instead |
3380 | of F<ev.h>: |
4332 | of F<ev.h>: |
3381 | |
4333 | |
… | |
… | |
3383 | #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ |
4335 | #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ |
3384 | |
4336 | |
3385 | #include "ev.h" |
4337 | #include "ev.h" |
3386 | |
4338 | |
3387 | And compile the following F<evwrap.c> file into your project (make sure |
4339 | And compile the following F<evwrap.c> file into your project (make sure |
3388 | you do I<not> compile the F<ev.c> or any other embedded soruce files!): |
4340 | you do I<not> compile the F<ev.c> or any other embedded source files!): |
3389 | |
4341 | |
3390 | #include "evwrap.h" |
4342 | #include "evwrap.h" |
3391 | #include "ev.c" |
4343 | #include "ev.c" |
3392 | |
4344 | |
3393 | =over 4 |
4345 | =over 4 |
… | |
… | |
3417 | |
4369 | |
3418 | Early versions of winsocket's select only supported waiting for a maximum |
4370 | Early versions of winsocket's select only supported waiting for a maximum |
3419 | of C<64> handles (probably owning to the fact that all windows kernels |
4371 | of C<64> handles (probably owning to the fact that all windows kernels |
3420 | can only wait for C<64> things at the same time internally; Microsoft |
4372 | can only wait for C<64> things at the same time internally; Microsoft |
3421 | recommends spawning a chain of threads and wait for 63 handles and the |
4373 | recommends spawning a chain of threads and wait for 63 handles and the |
3422 | previous thread in each. Great). |
4374 | previous thread in each. Sounds great!). |
3423 | |
4375 | |
3424 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
4376 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
3425 | to some high number (e.g. C<2048>) before compiling the winsocket select |
4377 | to some high number (e.g. C<2048>) before compiling the winsocket select |
3426 | call (which might be in libev or elsewhere, for example, perl does its own |
4378 | call (which might be in libev or elsewhere, for example, perl and many |
3427 | select emulation on windows). |
4379 | other interpreters do their own select emulation on windows). |
3428 | |
4380 | |
3429 | Another limit is the number of file descriptors in the Microsoft runtime |
4381 | Another limit is the number of file descriptors in the Microsoft runtime |
3430 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
4382 | libraries, which by default is C<64> (there must be a hidden I<64> |
3431 | or something like this inside Microsoft). You can increase this by calling |
4383 | fetish or something like this inside Microsoft). You can increase this |
3432 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
4384 | by calling C<_setmaxstdio>, which can increase this limit to C<2048> |
3433 | arbitrary limit), but is broken in many versions of the Microsoft runtime |
4385 | (another arbitrary limit), but is broken in many versions of the Microsoft |
3434 | libraries. |
|
|
3435 | |
|
|
3436 | This might get you to about C<512> or C<2048> sockets (depending on |
4386 | runtime libraries. This might get you to about C<512> or C<2048> sockets |
3437 | windows version and/or the phase of the moon). To get more, you need to |
4387 | (depending on windows version and/or the phase of the moon). To get more, |
3438 | wrap all I/O functions and provide your own fd management, but the cost of |
4388 | you need to wrap all I/O functions and provide your own fd management, but |
3439 | calling select (O(n²)) will likely make this unworkable. |
4389 | the cost of calling select (O(n²)) will likely make this unworkable. |
3440 | |
4390 | |
3441 | =back |
4391 | =back |
3442 | |
4392 | |
3443 | |
|
|
3444 | =head1 PORTABILITY REQUIREMENTS |
4393 | =head2 PORTABILITY REQUIREMENTS |
3445 | |
4394 | |
3446 | In addition to a working ISO-C implementation, libev relies on a few |
4395 | In addition to a working ISO-C implementation and of course the |
3447 | additional extensions: |
4396 | backend-specific APIs, libev relies on a few additional extensions: |
3448 | |
4397 | |
3449 | =over 4 |
4398 | =over 4 |
3450 | |
4399 | |
3451 | =item C<void (*)(ev_watcher_type *, int revents)> must have compatible |
4400 | =item C<void (*)(ev_watcher_type *, int revents)> must have compatible |
3452 | calling conventions regardless of C<ev_watcher_type *>. |
4401 | calling conventions regardless of C<ev_watcher_type *>. |
… | |
… | |
3458 | calls them using an C<ev_watcher *> internally. |
4407 | calls them using an C<ev_watcher *> internally. |
3459 | |
4408 | |
3460 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
4409 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
3461 | |
4410 | |
3462 | The type C<sig_atomic_t volatile> (or whatever is defined as |
4411 | The type C<sig_atomic_t volatile> (or whatever is defined as |
3463 | C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different |
4412 | C<EV_ATOMIC_T>) must be atomic with respect to accesses from different |
3464 | threads. This is not part of the specification for C<sig_atomic_t>, but is |
4413 | threads. This is not part of the specification for C<sig_atomic_t>, but is |
3465 | believed to be sufficiently portable. |
4414 | believed to be sufficiently portable. |
3466 | |
4415 | |
3467 | =item C<sigprocmask> must work in a threaded environment |
4416 | =item C<sigprocmask> must work in a threaded environment |
3468 | |
4417 | |
… | |
… | |
3477 | except the initial one, and run the default loop in the initial thread as |
4426 | except the initial one, and run the default loop in the initial thread as |
3478 | well. |
4427 | well. |
3479 | |
4428 | |
3480 | =item C<long> must be large enough for common memory allocation sizes |
4429 | =item C<long> must be large enough for common memory allocation sizes |
3481 | |
4430 | |
3482 | To improve portability and simplify using libev, libev uses C<long> |
4431 | To improve portability and simplify its API, libev uses C<long> internally |
3483 | internally instead of C<size_t> when allocating its data structures. On |
4432 | instead of C<size_t> when allocating its data structures. On non-POSIX |
3484 | non-POSIX systems (Microsoft...) this might be unexpectedly low, but |
4433 | systems (Microsoft...) this might be unexpectedly low, but is still at |
3485 | is still at least 31 bits everywhere, which is enough for hundreds of |
4434 | least 31 bits everywhere, which is enough for hundreds of millions of |
3486 | millions of watchers. |
4435 | watchers. |
3487 | |
4436 | |
3488 | =item C<double> must hold a time value in seconds with enough accuracy |
4437 | =item C<double> must hold a time value in seconds with enough accuracy |
3489 | |
4438 | |
3490 | The type C<double> is used to represent timestamps. It is required to |
4439 | The type C<double> is used to represent timestamps. It is required to |
3491 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
4440 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
3492 | enough for at least into the year 4000. This requirement is fulfilled by |
4441 | enough for at least into the year 4000. This requirement is fulfilled by |
3493 | implementations implementing IEEE 754 (basically all existing ones). |
4442 | implementations implementing IEEE 754, which is basically all existing |
|
|
4443 | ones. With IEEE 754 doubles, you get microsecond accuracy until at least |
|
|
4444 | 2200. |
3494 | |
4445 | |
3495 | =back |
4446 | =back |
3496 | |
4447 | |
3497 | If you know of other additional requirements drop me a note. |
4448 | If you know of other additional requirements drop me a note. |
3498 | |
4449 | |
3499 | |
4450 | |
3500 | =head1 COMPILER WARNINGS |
4451 | =head1 ALGORITHMIC COMPLEXITIES |
3501 | |
4452 | |
3502 | Depending on your compiler and compiler settings, you might get no or a |
4453 | In this section the complexities of (many of) the algorithms used inside |
3503 | lot of warnings when compiling libev code. Some people are apparently |
4454 | libev will be documented. For complexity discussions about backends see |
3504 | scared by this. |
4455 | the documentation for C<ev_default_init>. |
3505 | |
4456 | |
3506 | However, these are unavoidable for many reasons. For one, each compiler |
4457 | All of the following are about amortised time: If an array needs to be |
3507 | has different warnings, and each user has different tastes regarding |
4458 | extended, libev needs to realloc and move the whole array, but this |
3508 | warning options. "Warn-free" code therefore cannot be a goal except when |
4459 | happens asymptotically rarer with higher number of elements, so O(1) might |
3509 | targeting a specific compiler and compiler-version. |
4460 | mean that libev does a lengthy realloc operation in rare cases, but on |
|
|
4461 | average it is much faster and asymptotically approaches constant time. |
3510 | |
4462 | |
3511 | Another reason is that some compiler warnings require elaborate |
4463 | =over 4 |
3512 | workarounds, or other changes to the code that make it less clear and less |
|
|
3513 | maintainable. |
|
|
3514 | |
4464 | |
3515 | And of course, some compiler warnings are just plain stupid, or simply |
4465 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
3516 | wrong (because they don't actually warn about the condition their message |
|
|
3517 | seems to warn about). |
|
|
3518 | |
4466 | |
3519 | While libev is written to generate as few warnings as possible, |
4467 | This means that, when you have a watcher that triggers in one hour and |
3520 | "warn-free" code is not a goal, and it is recommended not to build libev |
4468 | there are 100 watchers that would trigger before that, then inserting will |
3521 | with any compiler warnings enabled unless you are prepared to cope with |
4469 | have to skip roughly seven (C<ld 100>) of these watchers. |
3522 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
3523 | warnings, not errors, or proof of bugs. |
|
|
3524 | |
4470 | |
|
|
4471 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
3525 | |
4472 | |
3526 | =head1 VALGRIND |
4473 | That means that changing a timer costs less than removing/adding them, |
|
|
4474 | as only the relative motion in the event queue has to be paid for. |
3527 | |
4475 | |
3528 | Valgrind has a special section here because it is a popular tool that is |
4476 | =item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1) |
3529 | highly useful, but valgrind reports are very hard to interpret. |
|
|
3530 | |
4477 | |
3531 | If you think you found a bug (memory leak, uninitialised data access etc.) |
4478 | These just add the watcher into an array or at the head of a list. |
3532 | in libev, then check twice: If valgrind reports something like: |
|
|
3533 | |
4479 | |
3534 | ==2274== definitely lost: 0 bytes in 0 blocks. |
4480 | =item Stopping check/prepare/idle/fork/async watchers: O(1) |
3535 | ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
3536 | ==2274== still reachable: 256 bytes in 1 blocks. |
|
|
3537 | |
4481 | |
3538 | Then there is no memory leak. Similarly, under some circumstances, |
4482 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
3539 | valgrind might report kernel bugs as if it were a bug in libev, or it |
|
|
3540 | might be confused (it is a very good tool, but only a tool). |
|
|
3541 | |
4483 | |
3542 | If you are unsure about something, feel free to contact the mailing list |
4484 | These watchers are stored in lists, so they need to be walked to find the |
3543 | with the full valgrind report and an explanation on why you think this is |
4485 | correct watcher to remove. The lists are usually short (you don't usually |
3544 | a bug in libev. However, don't be annoyed when you get a brisk "this is |
4486 | have many watchers waiting for the same fd or signal: one is typical, two |
3545 | no bug" answer and take the chance of learning how to interpret valgrind |
4487 | is rare). |
3546 | properly. |
|
|
3547 | |
4488 | |
3548 | If you need, for some reason, empty reports from valgrind for your project |
4489 | =item Finding the next timer in each loop iteration: O(1) |
3549 | I suggest using suppression lists. |
|
|
3550 | |
4490 | |
|
|
4491 | By virtue of using a binary or 4-heap, the next timer is always found at a |
|
|
4492 | fixed position in the storage array. |
|
|
4493 | |
|
|
4494 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
|
|
4495 | |
|
|
4496 | A change means an I/O watcher gets started or stopped, which requires |
|
|
4497 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
4498 | on backend and whether C<ev_io_set> was used). |
|
|
4499 | |
|
|
4500 | =item Activating one watcher (putting it into the pending state): O(1) |
|
|
4501 | |
|
|
4502 | =item Priority handling: O(number_of_priorities) |
|
|
4503 | |
|
|
4504 | Priorities are implemented by allocating some space for each |
|
|
4505 | priority. When doing priority-based operations, libev usually has to |
|
|
4506 | linearly search all the priorities, but starting/stopping and activating |
|
|
4507 | watchers becomes O(1) with respect to priority handling. |
|
|
4508 | |
|
|
4509 | =item Sending an ev_async: O(1) |
|
|
4510 | |
|
|
4511 | =item Processing ev_async_send: O(number_of_async_watchers) |
|
|
4512 | |
|
|
4513 | =item Processing signals: O(max_signal_number) |
|
|
4514 | |
|
|
4515 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
|
|
4516 | calls in the current loop iteration. Checking for async and signal events |
|
|
4517 | involves iterating over all running async watchers or all signal numbers. |
|
|
4518 | |
|
|
4519 | =back |
|
|
4520 | |
|
|
4521 | |
|
|
4522 | =head1 GLOSSARY |
|
|
4523 | |
|
|
4524 | =over 4 |
|
|
4525 | |
|
|
4526 | =item active |
|
|
4527 | |
|
|
4528 | A watcher is active as long as it has been started (has been attached to |
|
|
4529 | an event loop) but not yet stopped (disassociated from the event loop). |
|
|
4530 | |
|
|
4531 | =item application |
|
|
4532 | |
|
|
4533 | In this document, an application is whatever is using libev. |
|
|
4534 | |
|
|
4535 | =item callback |
|
|
4536 | |
|
|
4537 | The address of a function that is called when some event has been |
|
|
4538 | detected. Callbacks are being passed the event loop, the watcher that |
|
|
4539 | received the event, and the actual event bitset. |
|
|
4540 | |
|
|
4541 | =item callback invocation |
|
|
4542 | |
|
|
4543 | The act of calling the callback associated with a watcher. |
|
|
4544 | |
|
|
4545 | =item event |
|
|
4546 | |
|
|
4547 | A change of state of some external event, such as data now being available |
|
|
4548 | for reading on a file descriptor, time having passed or simply not having |
|
|
4549 | any other events happening anymore. |
|
|
4550 | |
|
|
4551 | In libev, events are represented as single bits (such as C<EV_READ> or |
|
|
4552 | C<EV_TIMEOUT>). |
|
|
4553 | |
|
|
4554 | =item event library |
|
|
4555 | |
|
|
4556 | A software package implementing an event model and loop. |
|
|
4557 | |
|
|
4558 | =item event loop |
|
|
4559 | |
|
|
4560 | An entity that handles and processes external events and converts them |
|
|
4561 | into callback invocations. |
|
|
4562 | |
|
|
4563 | =item event model |
|
|
4564 | |
|
|
4565 | The model used to describe how an event loop handles and processes |
|
|
4566 | watchers and events. |
|
|
4567 | |
|
|
4568 | =item pending |
|
|
4569 | |
|
|
4570 | A watcher is pending as soon as the corresponding event has been detected, |
|
|
4571 | and stops being pending as soon as the watcher will be invoked or its |
|
|
4572 | pending status is explicitly cleared by the application. |
|
|
4573 | |
|
|
4574 | A watcher can be pending, but not active. Stopping a watcher also clears |
|
|
4575 | its pending status. |
|
|
4576 | |
|
|
4577 | =item real time |
|
|
4578 | |
|
|
4579 | The physical time that is observed. It is apparently strictly monotonic :) |
|
|
4580 | |
|
|
4581 | =item wall-clock time |
|
|
4582 | |
|
|
4583 | The time and date as shown on clocks. Unlike real time, it can actually |
|
|
4584 | be wrong and jump forwards and backwards, e.g. when the you adjust your |
|
|
4585 | clock. |
|
|
4586 | |
|
|
4587 | =item watcher |
|
|
4588 | |
|
|
4589 | A data structure that describes interest in certain events. Watchers need |
|
|
4590 | to be started (attached to an event loop) before they can receive events. |
|
|
4591 | |
|
|
4592 | =item watcher invocation |
|
|
4593 | |
|
|
4594 | The act of calling the callback associated with a watcher. |
|
|
4595 | |
|
|
4596 | =back |
3551 | |
4597 | |
3552 | =head1 AUTHOR |
4598 | =head1 AUTHOR |
3553 | |
4599 | |
3554 | Marc Lehmann <libev@schmorp.de>. |
4600 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |
3555 | |
4601 | |