|
|
1 | =encoding utf-8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | libev - a high performance full-featured event loop written in C |
5 | libev - a high performance full-featured event loop written in C |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
… | |
… | |
82 | |
84 | |
83 | =head1 WHAT TO READ WHEN IN A HURRY |
85 | =head1 WHAT TO READ WHEN IN A HURRY |
84 | |
86 | |
85 | This manual tries to be very detailed, but unfortunately, this also makes |
87 | This manual tries to be very detailed, but unfortunately, this also makes |
86 | it very long. If you just want to know the basics of libev, I suggest |
88 | it very long. If you just want to know the basics of libev, I suggest |
87 | reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and |
89 | reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and |
88 | look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and |
90 | look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and |
89 | C<ev_timer> sections in L<WATCHER TYPES>. |
91 | C<ev_timer> sections in L</WATCHER TYPES>. |
90 | |
92 | |
91 | =head1 ABOUT LIBEV |
93 | =head1 ABOUT LIBEV |
92 | |
94 | |
93 | Libev is an event loop: you register interest in certain events (such as a |
95 | Libev is an event loop: you register interest in certain events (such as a |
94 | file descriptor being readable or a timeout occurring), and it will manage |
96 | file descriptor being readable or a timeout occurring), and it will manage |
… | |
… | |
103 | details of the event, and then hand it over to libev by I<starting> the |
105 | details of the event, and then hand it over to libev by I<starting> the |
104 | watcher. |
106 | watcher. |
105 | |
107 | |
106 | =head2 FEATURES |
108 | =head2 FEATURES |
107 | |
109 | |
108 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
110 | Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll> |
109 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
111 | interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port |
110 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
112 | mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify> |
111 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
113 | interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
112 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
114 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
113 | timers (C<ev_timer>), absolute timers with customised rescheduling |
115 | timers (C<ev_timer>), absolute timers with customised rescheduling |
114 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
116 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
115 | change events (C<ev_child>), and event watchers dealing with the event |
117 | change events (C<ev_child>), and event watchers dealing with the event |
116 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
118 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
… | |
… | |
157 | When libev detects a usage error such as a negative timer interval, then |
159 | When libev detects a usage error such as a negative timer interval, then |
158 | it will print a diagnostic message and abort (via the C<assert> mechanism, |
160 | it will print a diagnostic message and abort (via the C<assert> mechanism, |
159 | so C<NDEBUG> will disable this checking): these are programming errors in |
161 | so C<NDEBUG> will disable this checking): these are programming errors in |
160 | the libev caller and need to be fixed there. |
162 | the libev caller and need to be fixed there. |
161 | |
163 | |
|
|
164 | Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive |
|
|
165 | consistency checking code inside libev that can be used to check for |
|
|
166 | internal inconsistencies, suually caused by application bugs. |
|
|
167 | |
162 | Libev also has a few internal error-checking C<assert>ions, and also has |
168 | Libev also has a few internal error-checking C<assert>ions. These do not |
163 | extensive consistency checking code. These do not trigger under normal |
|
|
164 | circumstances, as they indicate either a bug in libev or worse. |
169 | trigger under normal circumstances, as they indicate either a bug in libev |
|
|
170 | or worse. |
165 | |
171 | |
166 | |
172 | |
167 | =head1 GLOBAL FUNCTIONS |
173 | =head1 GLOBAL FUNCTIONS |
168 | |
174 | |
169 | These functions can be called anytime, even before initialising the |
175 | These functions can be called anytime, even before initialising the |
… | |
… | |
174 | =item ev_tstamp ev_time () |
180 | =item ev_tstamp ev_time () |
175 | |
181 | |
176 | Returns the current time as libev would use it. Please note that the |
182 | Returns the current time as libev would use it. Please note that the |
177 | C<ev_now> function is usually faster and also often returns the timestamp |
183 | C<ev_now> function is usually faster and also often returns the timestamp |
178 | you actually want to know. Also interesting is the combination of |
184 | you actually want to know. Also interesting is the combination of |
179 | C<ev_update_now> and C<ev_now>. |
185 | C<ev_now_update> and C<ev_now>. |
180 | |
186 | |
181 | =item ev_sleep (ev_tstamp interval) |
187 | =item ev_sleep (ev_tstamp interval) |
182 | |
188 | |
183 | Sleep for the given interval: The current thread will be blocked |
189 | Sleep for the given interval: The current thread will be blocked |
184 | until either it is interrupted or the given time interval has |
190 | until either it is interrupted or the given time interval has |
… | |
… | |
247 | the current system, you would need to look at C<ev_embeddable_backends () |
253 | the current system, you would need to look at C<ev_embeddable_backends () |
248 | & ev_supported_backends ()>, likewise for recommended ones. |
254 | & ev_supported_backends ()>, likewise for recommended ones. |
249 | |
255 | |
250 | See the description of C<ev_embed> watchers for more info. |
256 | See the description of C<ev_embed> watchers for more info. |
251 | |
257 | |
252 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
258 | =item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ()) |
253 | |
259 | |
254 | Sets the allocation function to use (the prototype is similar - the |
260 | Sets the allocation function to use (the prototype is similar - the |
255 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
261 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
256 | used to allocate and free memory (no surprises here). If it returns zero |
262 | used to allocate and free memory (no surprises here). If it returns zero |
257 | when memory needs to be allocated (C<size != 0>), the library might abort |
263 | when memory needs to be allocated (C<size != 0>), the library might abort |
… | |
… | |
263 | |
269 | |
264 | You could override this function in high-availability programs to, say, |
270 | You could override this function in high-availability programs to, say, |
265 | free some memory if it cannot allocate memory, to use a special allocator, |
271 | free some memory if it cannot allocate memory, to use a special allocator, |
266 | or even to sleep a while and retry until some memory is available. |
272 | or even to sleep a while and retry until some memory is available. |
267 | |
273 | |
|
|
274 | Example: The following is the C<realloc> function that libev itself uses |
|
|
275 | which should work with C<realloc> and C<free> functions of all kinds and |
|
|
276 | is probably a good basis for your own implementation. |
|
|
277 | |
|
|
278 | static void * |
|
|
279 | ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT |
|
|
280 | { |
|
|
281 | if (size) |
|
|
282 | return realloc (ptr, size); |
|
|
283 | |
|
|
284 | free (ptr); |
|
|
285 | return 0; |
|
|
286 | } |
|
|
287 | |
268 | Example: Replace the libev allocator with one that waits a bit and then |
288 | Example: Replace the libev allocator with one that waits a bit and then |
269 | retries (example requires a standards-compliant C<realloc>). |
289 | retries. |
270 | |
290 | |
271 | static void * |
291 | static void * |
272 | persistent_realloc (void *ptr, size_t size) |
292 | persistent_realloc (void *ptr, size_t size) |
273 | { |
293 | { |
|
|
294 | if (!size) |
|
|
295 | { |
|
|
296 | free (ptr); |
|
|
297 | return 0; |
|
|
298 | } |
|
|
299 | |
274 | for (;;) |
300 | for (;;) |
275 | { |
301 | { |
276 | void *newptr = realloc (ptr, size); |
302 | void *newptr = realloc (ptr, size); |
277 | |
303 | |
278 | if (newptr) |
304 | if (newptr) |
… | |
… | |
283 | } |
309 | } |
284 | |
310 | |
285 | ... |
311 | ... |
286 | ev_set_allocator (persistent_realloc); |
312 | ev_set_allocator (persistent_realloc); |
287 | |
313 | |
288 | =item ev_set_syserr_cb (void (*cb)(const char *msg)) |
314 | =item ev_set_syserr_cb (void (*cb)(const char *msg) throw ()) |
289 | |
315 | |
290 | Set the callback function to call on a retryable system call error (such |
316 | Set the callback function to call on a retryable system call error (such |
291 | as failed select, poll, epoll_wait). The message is a printable string |
317 | as failed select, poll, epoll_wait). The message is a printable string |
292 | indicating the system call or subsystem causing the problem. If this |
318 | indicating the system call or subsystem causing the problem. If this |
293 | callback is set, then libev will expect it to remedy the situation, no |
319 | callback is set, then libev will expect it to remedy the situation, no |
… | |
… | |
396 | |
422 | |
397 | If this flag bit is or'ed into the flag value (or the program runs setuid |
423 | If this flag bit is or'ed into the flag value (or the program runs setuid |
398 | or setgid) then libev will I<not> look at the environment variable |
424 | or setgid) then libev will I<not> look at the environment variable |
399 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
425 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
400 | override the flags completely if it is found in the environment. This is |
426 | override the flags completely if it is found in the environment. This is |
401 | useful to try out specific backends to test their performance, or to work |
427 | useful to try out specific backends to test their performance, to work |
402 | around bugs. |
428 | around bugs, or to make libev threadsafe (accessing environment variables |
|
|
429 | cannot be done in a threadsafe way, but usually it works if no other |
|
|
430 | thread modifies them). |
403 | |
431 | |
404 | =item C<EVFLAG_FORKCHECK> |
432 | =item C<EVFLAG_FORKCHECK> |
405 | |
433 | |
406 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
434 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
407 | make libev check for a fork in each iteration by enabling this flag. |
435 | make libev check for a fork in each iteration by enabling this flag. |
408 | |
436 | |
409 | This works by calling C<getpid ()> on every iteration of the loop, |
437 | This works by calling C<getpid ()> on every iteration of the loop, |
410 | and thus this might slow down your event loop if you do a lot of loop |
438 | and thus this might slow down your event loop if you do a lot of loop |
411 | iterations and little real work, but is usually not noticeable (on my |
439 | iterations and little real work, but is usually not noticeable (on my |
412 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
440 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn |
413 | without a system call and thus I<very> fast, but my GNU/Linux system also has |
441 | sequence without a system call and thus I<very> fast, but my GNU/Linux |
414 | C<pthread_atfork> which is even faster). |
442 | system also has C<pthread_atfork> which is even faster). (Update: glibc |
|
|
443 | versions 2.25 apparently removed the C<getpid> optimisation again). |
415 | |
444 | |
416 | The big advantage of this flag is that you can forget about fork (and |
445 | The big advantage of this flag is that you can forget about fork (and |
417 | forget about forgetting to tell libev about forking) when you use this |
446 | forget about forgetting to tell libev about forking, although you still |
418 | flag. |
447 | have to ignore C<SIGPIPE>) when you use this flag. |
419 | |
448 | |
420 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
449 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
421 | environment variable. |
450 | environment variable. |
422 | |
451 | |
423 | =item C<EVFLAG_NOINOTIFY> |
452 | =item C<EVFLAG_NOINOTIFY> |
… | |
… | |
451 | unblocking the signals. |
480 | unblocking the signals. |
452 | |
481 | |
453 | It's also required by POSIX in a threaded program, as libev calls |
482 | It's also required by POSIX in a threaded program, as libev calls |
454 | C<sigprocmask>, whose behaviour is officially unspecified. |
483 | C<sigprocmask>, whose behaviour is officially unspecified. |
455 | |
484 | |
456 | This flag's behaviour will become the default in future versions of libev. |
485 | =item C<EVFLAG_NOTIMERFD> |
|
|
486 | |
|
|
487 | When this flag is specified, the libev will avoid using a C<timerfd> to |
|
|
488 | detect time jumps. It will still be able to detect time jumps, but takes |
|
|
489 | longer and has a lower accuracy in doing so, but saves a file descriptor |
|
|
490 | per loop. |
|
|
491 | |
|
|
492 | The current implementation only tries to use a C<timerfd> when the first |
|
|
493 | C<ev_periodic> watcher is started and falls back on other methods if it |
|
|
494 | cannot be created, but this behaviour might change in the future. |
457 | |
495 | |
458 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
496 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
459 | |
497 | |
460 | This is your standard select(2) backend. Not I<completely> standard, as |
498 | This is your standard select(2) backend. Not I<completely> standard, as |
461 | libev tries to roll its own fd_set with no limits on the number of fds, |
499 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
486 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
524 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
487 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
525 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
488 | |
526 | |
489 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
527 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
490 | |
528 | |
491 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
529 | Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
492 | kernels). |
530 | kernels). |
493 | |
531 | |
494 | For few fds, this backend is a bit little slower than poll and select, but |
532 | For few fds, this backend is a bit little slower than poll and select, but |
495 | it scales phenomenally better. While poll and select usually scale like |
533 | it scales phenomenally better. While poll and select usually scale like |
496 | O(total_fds) where total_fds is the total number of fds (or the highest |
534 | O(total_fds) where total_fds is the total number of fds (or the highest |
… | |
… | |
542 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
580 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
543 | faster than epoll for maybe up to a hundred file descriptors, depending on |
581 | faster than epoll for maybe up to a hundred file descriptors, depending on |
544 | the usage. So sad. |
582 | the usage. So sad. |
545 | |
583 | |
546 | While nominally embeddable in other event loops, this feature is broken in |
584 | While nominally embeddable in other event loops, this feature is broken in |
547 | all kernel versions tested so far. |
585 | a lot of kernel revisions, but probably(!) works in current versions. |
548 | |
586 | |
549 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
587 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
550 | C<EVBACKEND_POLL>. |
588 | C<EVBACKEND_POLL>. |
551 | |
589 | |
|
|
590 | =item C<EVBACKEND_LINUXAIO> (value 64, Linux) |
|
|
591 | |
|
|
592 | Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<< |
|
|
593 | io_submit(2) >>) event interface available in post-4.18 kernels (but libev |
|
|
594 | only tries to use it in 4.19+). |
|
|
595 | |
|
|
596 | This is another Linux train wreck of an event interface. |
|
|
597 | |
|
|
598 | If this backend works for you (as of this writing, it was very |
|
|
599 | experimental), it is the best event interface available on Linux and might |
|
|
600 | be well worth enabling it - if it isn't available in your kernel this will |
|
|
601 | be detected and this backend will be skipped. |
|
|
602 | |
|
|
603 | This backend can batch oneshot requests and supports a user-space ring |
|
|
604 | buffer to receive events. It also doesn't suffer from most of the design |
|
|
605 | problems of epoll (such as not being able to remove event sources from |
|
|
606 | the epoll set), and generally sounds too good to be true. Because, this |
|
|
607 | being the Linux kernel, of course it suffers from a whole new set of |
|
|
608 | limitations, forcing you to fall back to epoll, inheriting all its design |
|
|
609 | issues. |
|
|
610 | |
|
|
611 | For one, it is not easily embeddable (but probably could be done using |
|
|
612 | an event fd at some extra overhead). It also is subject to a system wide |
|
|
613 | limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO |
|
|
614 | requests are left, this backend will be skipped during initialisation, and |
|
|
615 | will switch to epoll when the loop is active. |
|
|
616 | |
|
|
617 | Most problematic in practice, however, is that not all file descriptors |
|
|
618 | work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds, |
|
|
619 | files, F</dev/null> and many others are supported, but ttys do not work |
|
|
620 | properly (a known bug that the kernel developers don't care about, see |
|
|
621 | L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not |
|
|
622 | (yet?) a generic event polling interface. |
|
|
623 | |
|
|
624 | Overall, it seems the Linux developers just don't want it to have a |
|
|
625 | generic event handling mechanism other than C<select> or C<poll>. |
|
|
626 | |
|
|
627 | To work around all these problem, the current version of libev uses its |
|
|
628 | epoll backend as a fallback for file descriptor types that do not work. Or |
|
|
629 | falls back completely to epoll if the kernel acts up. |
|
|
630 | |
|
|
631 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
|
|
632 | C<EVBACKEND_POLL>. |
|
|
633 | |
552 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
634 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
553 | |
635 | |
554 | Kqueue deserves special mention, as at the time of this writing, it |
636 | Kqueue deserves special mention, as at the time this backend was |
555 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
637 | implemented, it was broken on all BSDs except NetBSD (usually it doesn't |
556 | with anything but sockets and pipes, except on Darwin, where of course |
638 | work reliably with anything but sockets and pipes, except on Darwin, |
557 | it's completely useless). Unlike epoll, however, whose brokenness |
639 | where of course it's completely useless). Unlike epoll, however, whose |
558 | is by design, these kqueue bugs can (and eventually will) be fixed |
640 | brokenness is by design, these kqueue bugs can be (and mostly have been) |
559 | without API changes to existing programs. For this reason it's not being |
641 | fixed without API changes to existing programs. For this reason it's not |
560 | "auto-detected" unless you explicitly specify it in the flags (i.e. using |
642 | being "auto-detected" on all platforms unless you explicitly specify it |
561 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
643 | in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a |
562 | system like NetBSD. |
644 | known-to-be-good (-enough) system like NetBSD. |
563 | |
645 | |
564 | You still can embed kqueue into a normal poll or select backend and use it |
646 | You still can embed kqueue into a normal poll or select backend and use it |
565 | only for sockets (after having made sure that sockets work with kqueue on |
647 | only for sockets (after having made sure that sockets work with kqueue on |
566 | the target platform). See C<ev_embed> watchers for more info. |
648 | the target platform). See C<ev_embed> watchers for more info. |
567 | |
649 | |
568 | It scales in the same way as the epoll backend, but the interface to the |
650 | It scales in the same way as the epoll backend, but the interface to the |
569 | kernel is more efficient (which says nothing about its actual speed, of |
651 | kernel is more efficient (which says nothing about its actual speed, of |
570 | course). While stopping, setting and starting an I/O watcher does never |
652 | course). While stopping, setting and starting an I/O watcher does never |
571 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
653 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
572 | two event changes per incident. Support for C<fork ()> is very bad (but |
654 | two event changes per incident. Support for C<fork ()> is very bad (you |
573 | sane, unlike epoll) and it drops fds silently in similarly hard-to-detect |
655 | might have to leak fds on fork, but it's more sane than epoll) and it |
574 | cases |
656 | drops fds silently in similarly hard-to-detect cases. |
575 | |
657 | |
576 | This backend usually performs well under most conditions. |
658 | This backend usually performs well under most conditions. |
577 | |
659 | |
578 | While nominally embeddable in other event loops, this doesn't work |
660 | While nominally embeddable in other event loops, this doesn't work |
579 | everywhere, so you might need to test for this. And since it is broken |
661 | everywhere, so you might need to test for this. And since it is broken |
… | |
… | |
653 | Example: Use whatever libev has to offer, but make sure that kqueue is |
735 | Example: Use whatever libev has to offer, but make sure that kqueue is |
654 | used if available. |
736 | used if available. |
655 | |
737 | |
656 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
738 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
657 | |
739 | |
|
|
740 | Example: Similarly, on linux, you mgiht want to take advantage of the |
|
|
741 | linux aio backend if possible, but fall back to something else if that |
|
|
742 | isn't available. |
|
|
743 | |
|
|
744 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO); |
|
|
745 | |
658 | =item ev_loop_destroy (loop) |
746 | =item ev_loop_destroy (loop) |
659 | |
747 | |
660 | Destroys an event loop object (frees all memory and kernel state |
748 | Destroys an event loop object (frees all memory and kernel state |
661 | etc.). None of the active event watchers will be stopped in the normal |
749 | etc.). None of the active event watchers will be stopped in the normal |
662 | sense, so e.g. C<ev_is_active> might still return true. It is your |
750 | sense, so e.g. C<ev_is_active> might still return true. It is your |
… | |
… | |
678 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
766 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
679 | and C<ev_loop_destroy>. |
767 | and C<ev_loop_destroy>. |
680 | |
768 | |
681 | =item ev_loop_fork (loop) |
769 | =item ev_loop_fork (loop) |
682 | |
770 | |
683 | This function sets a flag that causes subsequent C<ev_run> iterations to |
771 | This function sets a flag that causes subsequent C<ev_run> iterations |
684 | reinitialise the kernel state for backends that have one. Despite the |
772 | to reinitialise the kernel state for backends that have one. Despite |
685 | name, you can call it anytime, but it makes most sense after forking, in |
773 | the name, you can call it anytime you are allowed to start or stop |
686 | the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the |
774 | watchers (except inside an C<ev_prepare> callback), but it makes most |
|
|
775 | sense after forking, in the child process. You I<must> call it (or use |
687 | child before resuming or calling C<ev_run>. |
776 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
688 | |
777 | |
|
|
778 | In addition, if you want to reuse a loop (via this function or |
|
|
779 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
|
|
780 | |
689 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
781 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
690 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
782 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
691 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
783 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
692 | during fork. |
784 | during fork. |
693 | |
785 | |
694 | On the other hand, you only need to call this function in the child |
786 | On the other hand, you only need to call this function in the child |
… | |
… | |
764 | |
856 | |
765 | This function is rarely useful, but when some event callback runs for a |
857 | This function is rarely useful, but when some event callback runs for a |
766 | very long time without entering the event loop, updating libev's idea of |
858 | very long time without entering the event loop, updating libev's idea of |
767 | the current time is a good idea. |
859 | the current time is a good idea. |
768 | |
860 | |
769 | See also L<The special problem of time updates> in the C<ev_timer> section. |
861 | See also L</The special problem of time updates> in the C<ev_timer> section. |
770 | |
862 | |
771 | =item ev_suspend (loop) |
863 | =item ev_suspend (loop) |
772 | |
864 | |
773 | =item ev_resume (loop) |
865 | =item ev_resume (loop) |
774 | |
866 | |
… | |
… | |
792 | without a previous call to C<ev_suspend>. |
884 | without a previous call to C<ev_suspend>. |
793 | |
885 | |
794 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
886 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
795 | event loop time (see C<ev_now_update>). |
887 | event loop time (see C<ev_now_update>). |
796 | |
888 | |
797 | =item ev_run (loop, int flags) |
889 | =item bool ev_run (loop, int flags) |
798 | |
890 | |
799 | Finally, this is it, the event handler. This function usually is called |
891 | Finally, this is it, the event handler. This function usually is called |
800 | after you have initialised all your watchers and you want to start |
892 | after you have initialised all your watchers and you want to start |
801 | handling events. It will ask the operating system for any new events, call |
893 | handling events. It will ask the operating system for any new events, call |
802 | the watcher callbacks, an then repeat the whole process indefinitely: This |
894 | the watcher callbacks, and then repeat the whole process indefinitely: This |
803 | is why event loops are called I<loops>. |
895 | is why event loops are called I<loops>. |
804 | |
896 | |
805 | If the flags argument is specified as C<0>, it will keep handling events |
897 | If the flags argument is specified as C<0>, it will keep handling events |
806 | until either no event watchers are active anymore or C<ev_break> was |
898 | until either no event watchers are active anymore or C<ev_break> was |
807 | called. |
899 | called. |
|
|
900 | |
|
|
901 | The return value is false if there are no more active watchers (which |
|
|
902 | usually means "all jobs done" or "deadlock"), and true in all other cases |
|
|
903 | (which usually means " you should call C<ev_run> again"). |
808 | |
904 | |
809 | Please note that an explicit C<ev_break> is usually better than |
905 | Please note that an explicit C<ev_break> is usually better than |
810 | relying on all watchers to be stopped when deciding when a program has |
906 | relying on all watchers to be stopped when deciding when a program has |
811 | finished (especially in interactive programs), but having a program |
907 | finished (especially in interactive programs), but having a program |
812 | that automatically loops as long as it has to and no longer by virtue |
908 | that automatically loops as long as it has to and no longer by virtue |
813 | of relying on its watchers stopping correctly, that is truly a thing of |
909 | of relying on its watchers stopping correctly, that is truly a thing of |
814 | beauty. |
910 | beauty. |
815 | |
911 | |
816 | This function is also I<mostly> exception-safe - you can break out of |
912 | This function is I<mostly> exception-safe - you can break out of a |
817 | a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ |
913 | C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ |
818 | exception and so on. This does not decrement the C<ev_depth> value, nor |
914 | exception and so on. This does not decrement the C<ev_depth> value, nor |
819 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
915 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
820 | |
916 | |
821 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
917 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
822 | those events and any already outstanding ones, but will not wait and |
918 | those events and any already outstanding ones, but will not wait and |
… | |
… | |
1012 | invoke the actual watchers inside another context (another thread etc.). |
1108 | invoke the actual watchers inside another context (another thread etc.). |
1013 | |
1109 | |
1014 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1110 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1015 | callback. |
1111 | callback. |
1016 | |
1112 | |
1017 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
1113 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ()) |
1018 | |
1114 | |
1019 | Sometimes you want to share the same loop between multiple threads. This |
1115 | Sometimes you want to share the same loop between multiple threads. This |
1020 | can be done relatively simply by putting mutex_lock/unlock calls around |
1116 | can be done relatively simply by putting mutex_lock/unlock calls around |
1021 | each call to a libev function. |
1117 | each call to a libev function. |
1022 | |
1118 | |
1023 | However, C<ev_run> can run an indefinite time, so it is not feasible |
1119 | However, C<ev_run> can run an indefinite time, so it is not feasible |
1024 | to wait for it to return. One way around this is to wake up the event |
1120 | to wait for it to return. One way around this is to wake up the event |
1025 | loop via C<ev_break> and C<av_async_send>, another way is to set these |
1121 | loop via C<ev_break> and C<ev_async_send>, another way is to set these |
1026 | I<release> and I<acquire> callbacks on the loop. |
1122 | I<release> and I<acquire> callbacks on the loop. |
1027 | |
1123 | |
1028 | When set, then C<release> will be called just before the thread is |
1124 | When set, then C<release> will be called just before the thread is |
1029 | suspended waiting for new events, and C<acquire> is called just |
1125 | suspended waiting for new events, and C<acquire> is called just |
1030 | afterwards. |
1126 | afterwards. |
… | |
… | |
1170 | |
1266 | |
1171 | =item C<EV_PREPARE> |
1267 | =item C<EV_PREPARE> |
1172 | |
1268 | |
1173 | =item C<EV_CHECK> |
1269 | =item C<EV_CHECK> |
1174 | |
1270 | |
1175 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts |
1271 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to |
1176 | to gather new events, and all C<ev_check> watchers are invoked just after |
1272 | gather new events, and all C<ev_check> watchers are queued (not invoked) |
1177 | C<ev_run> has gathered them, but before it invokes any callbacks for any |
1273 | just after C<ev_run> has gathered them, but before it queues any callbacks |
|
|
1274 | for any received events. That means C<ev_prepare> watchers are the last |
|
|
1275 | watchers invoked before the event loop sleeps or polls for new events, and |
|
|
1276 | C<ev_check> watchers will be invoked before any other watchers of the same |
|
|
1277 | or lower priority within an event loop iteration. |
|
|
1278 | |
1178 | received events. Callbacks of both watcher types can start and stop as |
1279 | Callbacks of both watcher types can start and stop as many watchers as |
1179 | many watchers as they want, and all of them will be taken into account |
1280 | they want, and all of them will be taken into account (for example, a |
1180 | (for example, a C<ev_prepare> watcher might start an idle watcher to keep |
1281 | C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from |
1181 | C<ev_run> from blocking). |
1282 | blocking). |
1182 | |
1283 | |
1183 | =item C<EV_EMBED> |
1284 | =item C<EV_EMBED> |
1184 | |
1285 | |
1185 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1286 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1186 | |
1287 | |
… | |
… | |
1309 | |
1410 | |
1310 | =item callback ev_cb (ev_TYPE *watcher) |
1411 | =item callback ev_cb (ev_TYPE *watcher) |
1311 | |
1412 | |
1312 | Returns the callback currently set on the watcher. |
1413 | Returns the callback currently set on the watcher. |
1313 | |
1414 | |
1314 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1415 | =item ev_set_cb (ev_TYPE *watcher, callback) |
1315 | |
1416 | |
1316 | Change the callback. You can change the callback at virtually any time |
1417 | Change the callback. You can change the callback at virtually any time |
1317 | (modulo threads). |
1418 | (modulo threads). |
1318 | |
1419 | |
1319 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1420 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
… | |
… | |
1337 | or might not have been clamped to the valid range. |
1438 | or might not have been clamped to the valid range. |
1338 | |
1439 | |
1339 | The default priority used by watchers when no priority has been set is |
1440 | The default priority used by watchers when no priority has been set is |
1340 | always C<0>, which is supposed to not be too high and not be too low :). |
1441 | always C<0>, which is supposed to not be too high and not be too low :). |
1341 | |
1442 | |
1342 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1443 | See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1343 | priorities. |
1444 | priorities. |
1344 | |
1445 | |
1345 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1446 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1346 | |
1447 | |
1347 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1448 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
… | |
… | |
1372 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1473 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1373 | functions that do not need a watcher. |
1474 | functions that do not need a watcher. |
1374 | |
1475 | |
1375 | =back |
1476 | =back |
1376 | |
1477 | |
1377 | See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR |
1478 | See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR |
1378 | OWN COMPOSITE WATCHERS> idioms. |
1479 | OWN COMPOSITE WATCHERS> idioms. |
1379 | |
1480 | |
1380 | =head2 WATCHER STATES |
1481 | =head2 WATCHER STATES |
1381 | |
1482 | |
1382 | There are various watcher states mentioned throughout this manual - |
1483 | There are various watcher states mentioned throughout this manual - |
… | |
… | |
1384 | transition between them will be described in more detail - and while these |
1485 | transition between them will be described in more detail - and while these |
1385 | rules might look complicated, they usually do "the right thing". |
1486 | rules might look complicated, they usually do "the right thing". |
1386 | |
1487 | |
1387 | =over 4 |
1488 | =over 4 |
1388 | |
1489 | |
1389 | =item initialiased |
1490 | =item initialised |
1390 | |
1491 | |
1391 | Before a watcher can be registered with the event loop it has to be |
1492 | Before a watcher can be registered with the event loop it has to be |
1392 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1493 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1393 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1494 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1394 | |
1495 | |
… | |
… | |
1443 | |
1544 | |
1444 | Many event loops support I<watcher priorities>, which are usually small |
1545 | Many event loops support I<watcher priorities>, which are usually small |
1445 | integers that influence the ordering of event callback invocation |
1546 | integers that influence the ordering of event callback invocation |
1446 | between watchers in some way, all else being equal. |
1547 | between watchers in some way, all else being equal. |
1447 | |
1548 | |
1448 | In libev, Watcher priorities can be set using C<ev_set_priority>. See its |
1549 | In libev, watcher priorities can be set using C<ev_set_priority>. See its |
1449 | description for the more technical details such as the actual priority |
1550 | description for the more technical details such as the actual priority |
1450 | range. |
1551 | range. |
1451 | |
1552 | |
1452 | There are two common ways how these these priorities are being interpreted |
1553 | There are two common ways how these these priorities are being interpreted |
1453 | by event loops: |
1554 | by event loops: |
… | |
… | |
1592 | |
1693 | |
1593 | But really, best use non-blocking mode. |
1694 | But really, best use non-blocking mode. |
1594 | |
1695 | |
1595 | =head3 The special problem of disappearing file descriptors |
1696 | =head3 The special problem of disappearing file descriptors |
1596 | |
1697 | |
1597 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1698 | Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing |
1598 | descriptor (either due to calling C<close> explicitly or any other means, |
1699 | a file descriptor (either due to calling C<close> explicitly or any other |
1599 | such as C<dup2>). The reason is that you register interest in some file |
1700 | means, such as C<dup2>). The reason is that you register interest in some |
1600 | descriptor, but when it goes away, the operating system will silently drop |
1701 | file descriptor, but when it goes away, the operating system will silently |
1601 | this interest. If another file descriptor with the same number then is |
1702 | drop this interest. If another file descriptor with the same number then |
1602 | registered with libev, there is no efficient way to see that this is, in |
1703 | is registered with libev, there is no efficient way to see that this is, |
1603 | fact, a different file descriptor. |
1704 | in fact, a different file descriptor. |
1604 | |
1705 | |
1605 | To avoid having to explicitly tell libev about such cases, libev follows |
1706 | To avoid having to explicitly tell libev about such cases, libev follows |
1606 | the following policy: Each time C<ev_io_set> is being called, libev |
1707 | the following policy: Each time C<ev_io_set> is being called, libev |
1607 | will assume that this is potentially a new file descriptor, otherwise |
1708 | will assume that this is potentially a new file descriptor, otherwise |
1608 | it is assumed that the file descriptor stays the same. That means that |
1709 | it is assumed that the file descriptor stays the same. That means that |
… | |
… | |
1657 | when you rarely read from a file instead of from a socket, and want to |
1758 | when you rarely read from a file instead of from a socket, and want to |
1658 | reuse the same code path. |
1759 | reuse the same code path. |
1659 | |
1760 | |
1660 | =head3 The special problem of fork |
1761 | =head3 The special problem of fork |
1661 | |
1762 | |
1662 | Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit |
1763 | Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()> |
1663 | useless behaviour. Libev fully supports fork, but needs to be told about |
1764 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1664 | it in the child if you want to continue to use it in the child. |
1765 | to be told about it in the child if you want to continue to use it in the |
|
|
1766 | child. |
1665 | |
1767 | |
1666 | To support fork in your child processes, you have to call C<ev_loop_fork |
1768 | To support fork in your child processes, you have to call C<ev_loop_fork |
1667 | ()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to |
1769 | ()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to |
1668 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1770 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1669 | |
1771 | |
… | |
… | |
1771 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1873 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1772 | monotonic clock option helps a lot here). |
1874 | monotonic clock option helps a lot here). |
1773 | |
1875 | |
1774 | The callback is guaranteed to be invoked only I<after> its timeout has |
1876 | The callback is guaranteed to be invoked only I<after> its timeout has |
1775 | passed (not I<at>, so on systems with very low-resolution clocks this |
1877 | passed (not I<at>, so on systems with very low-resolution clocks this |
1776 | might introduce a small delay). If multiple timers become ready during the |
1878 | might introduce a small delay, see "the special problem of being too |
|
|
1879 | early", below). If multiple timers become ready during the same loop |
1777 | same loop iteration then the ones with earlier time-out values are invoked |
1880 | iteration then the ones with earlier time-out values are invoked before |
1778 | before ones of the same priority with later time-out values (but this is |
1881 | ones of the same priority with later time-out values (but this is no |
1779 | no longer true when a callback calls C<ev_run> recursively). |
1882 | longer true when a callback calls C<ev_run> recursively). |
1780 | |
1883 | |
1781 | =head3 Be smart about timeouts |
1884 | =head3 Be smart about timeouts |
1782 | |
1885 | |
1783 | Many real-world problems involve some kind of timeout, usually for error |
1886 | Many real-world problems involve some kind of timeout, usually for error |
1784 | recovery. A typical example is an HTTP request - if the other side hangs, |
1887 | recovery. A typical example is an HTTP request - if the other side hangs, |
… | |
… | |
1859 | |
1962 | |
1860 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1963 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1861 | but remember the time of last activity, and check for a real timeout only |
1964 | but remember the time of last activity, and check for a real timeout only |
1862 | within the callback: |
1965 | within the callback: |
1863 | |
1966 | |
|
|
1967 | ev_tstamp timeout = 60.; |
1864 | ev_tstamp last_activity; // time of last activity |
1968 | ev_tstamp last_activity; // time of last activity |
|
|
1969 | ev_timer timer; |
1865 | |
1970 | |
1866 | static void |
1971 | static void |
1867 | callback (EV_P_ ev_timer *w, int revents) |
1972 | callback (EV_P_ ev_timer *w, int revents) |
1868 | { |
1973 | { |
1869 | ev_tstamp now = ev_now (EV_A); |
1974 | // calculate when the timeout would happen |
1870 | ev_tstamp timeout = last_activity + 60.; |
1975 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1871 | |
1976 | |
1872 | // if last_activity + 60. is older than now, we did time out |
1977 | // if negative, it means we the timeout already occurred |
1873 | if (timeout < now) |
1978 | if (after < 0.) |
1874 | { |
1979 | { |
1875 | // timeout occurred, take action |
1980 | // timeout occurred, take action |
1876 | } |
1981 | } |
1877 | else |
1982 | else |
1878 | { |
1983 | { |
1879 | // callback was invoked, but there was some activity, re-arm |
1984 | // callback was invoked, but there was some recent |
1880 | // the watcher to fire in last_activity + 60, which is |
1985 | // activity. simply restart the timer to time out |
1881 | // guaranteed to be in the future, so "again" is positive: |
1986 | // after "after" seconds, which is the earliest time |
1882 | w->repeat = timeout - now; |
1987 | // the timeout can occur. |
|
|
1988 | ev_timer_set (w, after, 0.); |
1883 | ev_timer_again (EV_A_ w); |
1989 | ev_timer_start (EV_A_ w); |
1884 | } |
1990 | } |
1885 | } |
1991 | } |
1886 | |
1992 | |
1887 | To summarise the callback: first calculate the real timeout (defined |
1993 | To summarise the callback: first calculate in how many seconds the |
1888 | as "60 seconds after the last activity"), then check if that time has |
1994 | timeout will occur (by calculating the absolute time when it would occur, |
1889 | been reached, which means something I<did>, in fact, time out. Otherwise |
1995 | C<last_activity + timeout>, and subtracting the current time, C<ev_now |
1890 | the callback was invoked too early (C<timeout> is in the future), so |
1996 | (EV_A)> from that). |
1891 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1892 | a timeout then. |
|
|
1893 | |
1997 | |
1894 | Note how C<ev_timer_again> is used, taking advantage of the |
1998 | If this value is negative, then we are already past the timeout, i.e. we |
1895 | C<ev_timer_again> optimisation when the timer is already running. |
1999 | timed out, and need to do whatever is needed in this case. |
|
|
2000 | |
|
|
2001 | Otherwise, we now the earliest time at which the timeout would trigger, |
|
|
2002 | and simply start the timer with this timeout value. |
|
|
2003 | |
|
|
2004 | In other words, each time the callback is invoked it will check whether |
|
|
2005 | the timeout occurred. If not, it will simply reschedule itself to check |
|
|
2006 | again at the earliest time it could time out. Rinse. Repeat. |
1896 | |
2007 | |
1897 | This scheme causes more callback invocations (about one every 60 seconds |
2008 | This scheme causes more callback invocations (about one every 60 seconds |
1898 | minus half the average time between activity), but virtually no calls to |
2009 | minus half the average time between activity), but virtually no calls to |
1899 | libev to change the timeout. |
2010 | libev to change the timeout. |
1900 | |
2011 | |
1901 | To start the timer, simply initialise the watcher and set C<last_activity> |
2012 | To start the machinery, simply initialise the watcher and set |
1902 | to the current time (meaning we just have some activity :), then call the |
2013 | C<last_activity> to the current time (meaning there was some activity just |
1903 | callback, which will "do the right thing" and start the timer: |
2014 | now), then call the callback, which will "do the right thing" and start |
|
|
2015 | the timer: |
1904 | |
2016 | |
|
|
2017 | last_activity = ev_now (EV_A); |
1905 | ev_init (timer, callback); |
2018 | ev_init (&timer, callback); |
1906 | last_activity = ev_now (loop); |
2019 | callback (EV_A_ &timer, 0); |
1907 | callback (loop, timer, EV_TIMER); |
|
|
1908 | |
2020 | |
1909 | And when there is some activity, simply store the current time in |
2021 | When there is some activity, simply store the current time in |
1910 | C<last_activity>, no libev calls at all: |
2022 | C<last_activity>, no libev calls at all: |
1911 | |
2023 | |
|
|
2024 | if (activity detected) |
1912 | last_activity = ev_now (loop); |
2025 | last_activity = ev_now (EV_A); |
|
|
2026 | |
|
|
2027 | When your timeout value changes, then the timeout can be changed by simply |
|
|
2028 | providing a new value, stopping the timer and calling the callback, which |
|
|
2029 | will again do the right thing (for example, time out immediately :). |
|
|
2030 | |
|
|
2031 | timeout = new_value; |
|
|
2032 | ev_timer_stop (EV_A_ &timer); |
|
|
2033 | callback (EV_A_ &timer, 0); |
1913 | |
2034 | |
1914 | This technique is slightly more complex, but in most cases where the |
2035 | This technique is slightly more complex, but in most cases where the |
1915 | time-out is unlikely to be triggered, much more efficient. |
2036 | time-out is unlikely to be triggered, much more efficient. |
1916 | |
|
|
1917 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1918 | callback :) - just change the timeout and invoke the callback, which will |
|
|
1919 | fix things for you. |
|
|
1920 | |
2037 | |
1921 | =item 4. Wee, just use a double-linked list for your timeouts. |
2038 | =item 4. Wee, just use a double-linked list for your timeouts. |
1922 | |
2039 | |
1923 | If there is not one request, but many thousands (millions...), all |
2040 | If there is not one request, but many thousands (millions...), all |
1924 | employing some kind of timeout with the same timeout value, then one can |
2041 | employing some kind of timeout with the same timeout value, then one can |
… | |
… | |
1951 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
2068 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
1952 | rather complicated, but extremely efficient, something that really pays |
2069 | rather complicated, but extremely efficient, something that really pays |
1953 | off after the first million or so of active timers, i.e. it's usually |
2070 | off after the first million or so of active timers, i.e. it's usually |
1954 | overkill :) |
2071 | overkill :) |
1955 | |
2072 | |
|
|
2073 | =head3 The special problem of being too early |
|
|
2074 | |
|
|
2075 | If you ask a timer to call your callback after three seconds, then |
|
|
2076 | you expect it to be invoked after three seconds - but of course, this |
|
|
2077 | cannot be guaranteed to infinite precision. Less obviously, it cannot be |
|
|
2078 | guaranteed to any precision by libev - imagine somebody suspending the |
|
|
2079 | process with a STOP signal for a few hours for example. |
|
|
2080 | |
|
|
2081 | So, libev tries to invoke your callback as soon as possible I<after> the |
|
|
2082 | delay has occurred, but cannot guarantee this. |
|
|
2083 | |
|
|
2084 | A less obvious failure mode is calling your callback too early: many event |
|
|
2085 | loops compare timestamps with a "elapsed delay >= requested delay", but |
|
|
2086 | this can cause your callback to be invoked much earlier than you would |
|
|
2087 | expect. |
|
|
2088 | |
|
|
2089 | To see why, imagine a system with a clock that only offers full second |
|
|
2090 | resolution (think windows if you can't come up with a broken enough OS |
|
|
2091 | yourself). If you schedule a one-second timer at the time 500.9, then the |
|
|
2092 | event loop will schedule your timeout to elapse at a system time of 500 |
|
|
2093 | (500.9 truncated to the resolution) + 1, or 501. |
|
|
2094 | |
|
|
2095 | If an event library looks at the timeout 0.1s later, it will see "501 >= |
|
|
2096 | 501" and invoke the callback 0.1s after it was started, even though a |
|
|
2097 | one-second delay was requested - this is being "too early", despite best |
|
|
2098 | intentions. |
|
|
2099 | |
|
|
2100 | This is the reason why libev will never invoke the callback if the elapsed |
|
|
2101 | delay equals the requested delay, but only when the elapsed delay is |
|
|
2102 | larger than the requested delay. In the example above, libev would only invoke |
|
|
2103 | the callback at system time 502, or 1.1s after the timer was started. |
|
|
2104 | |
|
|
2105 | So, while libev cannot guarantee that your callback will be invoked |
|
|
2106 | exactly when requested, it I<can> and I<does> guarantee that the requested |
|
|
2107 | delay has actually elapsed, or in other words, it always errs on the "too |
|
|
2108 | late" side of things. |
|
|
2109 | |
1956 | =head3 The special problem of time updates |
2110 | =head3 The special problem of time updates |
1957 | |
2111 | |
1958 | Establishing the current time is a costly operation (it usually takes at |
2112 | Establishing the current time is a costly operation (it usually takes |
1959 | least two system calls): EV therefore updates its idea of the current |
2113 | at least one system call): EV therefore updates its idea of the current |
1960 | time only before and after C<ev_run> collects new events, which causes a |
2114 | time only before and after C<ev_run> collects new events, which causes a |
1961 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
2115 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1962 | lots of events in one iteration. |
2116 | lots of events in one iteration. |
1963 | |
2117 | |
1964 | The relative timeouts are calculated relative to the C<ev_now ()> |
2118 | The relative timeouts are calculated relative to the C<ev_now ()> |
1965 | time. This is usually the right thing as this timestamp refers to the time |
2119 | time. This is usually the right thing as this timestamp refers to the time |
1966 | of the event triggering whatever timeout you are modifying/starting. If |
2120 | of the event triggering whatever timeout you are modifying/starting. If |
1967 | you suspect event processing to be delayed and you I<need> to base the |
2121 | you suspect event processing to be delayed and you I<need> to base the |
1968 | timeout on the current time, use something like this to adjust for this: |
2122 | timeout on the current time, use something like the following to adjust |
|
|
2123 | for it: |
1969 | |
2124 | |
1970 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2125 | ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.); |
1971 | |
2126 | |
1972 | If the event loop is suspended for a long time, you can also force an |
2127 | If the event loop is suspended for a long time, you can also force an |
1973 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2128 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1974 | ()>. |
2129 | ()>, although that will push the event time of all outstanding events |
|
|
2130 | further into the future. |
|
|
2131 | |
|
|
2132 | =head3 The special problem of unsynchronised clocks |
|
|
2133 | |
|
|
2134 | Modern systems have a variety of clocks - libev itself uses the normal |
|
|
2135 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
|
|
2136 | jumps). |
|
|
2137 | |
|
|
2138 | Neither of these clocks is synchronised with each other or any other clock |
|
|
2139 | on the system, so C<ev_time ()> might return a considerably different time |
|
|
2140 | than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example, |
|
|
2141 | a call to C<gettimeofday> might return a second count that is one higher |
|
|
2142 | than a directly following call to C<time>. |
|
|
2143 | |
|
|
2144 | The moral of this is to only compare libev-related timestamps with |
|
|
2145 | C<ev_time ()> and C<ev_now ()>, at least if you want better precision than |
|
|
2146 | a second or so. |
|
|
2147 | |
|
|
2148 | One more problem arises due to this lack of synchronisation: if libev uses |
|
|
2149 | the system monotonic clock and you compare timestamps from C<ev_time> |
|
|
2150 | or C<ev_now> from when you started your timer and when your callback is |
|
|
2151 | invoked, you will find that sometimes the callback is a bit "early". |
|
|
2152 | |
|
|
2153 | This is because C<ev_timer>s work in real time, not wall clock time, so |
|
|
2154 | libev makes sure your callback is not invoked before the delay happened, |
|
|
2155 | I<measured according to the real time>, not the system clock. |
|
|
2156 | |
|
|
2157 | If your timeouts are based on a physical timescale (e.g. "time out this |
|
|
2158 | connection after 100 seconds") then this shouldn't bother you as it is |
|
|
2159 | exactly the right behaviour. |
|
|
2160 | |
|
|
2161 | If you want to compare wall clock/system timestamps to your timers, then |
|
|
2162 | you need to use C<ev_periodic>s, as these are based on the wall clock |
|
|
2163 | time, where your comparisons will always generate correct results. |
1975 | |
2164 | |
1976 | =head3 The special problems of suspended animation |
2165 | =head3 The special problems of suspended animation |
1977 | |
2166 | |
1978 | When you leave the server world it is quite customary to hit machines that |
2167 | When you leave the server world it is quite customary to hit machines that |
1979 | can suspend/hibernate - what happens to the clocks during such a suspend? |
2168 | can suspend/hibernate - what happens to the clocks during such a suspend? |
… | |
… | |
2009 | |
2198 | |
2010 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2199 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2011 | |
2200 | |
2012 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2201 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2013 | |
2202 | |
2014 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
2203 | Configure the timer to trigger after C<after> seconds (fractional and |
2015 | is C<0.>, then it will automatically be stopped once the timeout is |
2204 | negative values are supported). If C<repeat> is C<0.>, then it will |
2016 | reached. If it is positive, then the timer will automatically be |
2205 | automatically be stopped once the timeout is reached. If it is positive, |
2017 | configured to trigger again C<repeat> seconds later, again, and again, |
2206 | then the timer will automatically be configured to trigger again C<repeat> |
2018 | until stopped manually. |
2207 | seconds later, again, and again, until stopped manually. |
2019 | |
2208 | |
2020 | The timer itself will do a best-effort at avoiding drift, that is, if |
2209 | The timer itself will do a best-effort at avoiding drift, that is, if |
2021 | you configure a timer to trigger every 10 seconds, then it will normally |
2210 | you configure a timer to trigger every 10 seconds, then it will normally |
2022 | trigger at exactly 10 second intervals. If, however, your program cannot |
2211 | trigger at exactly 10 second intervals. If, however, your program cannot |
2023 | keep up with the timer (because it takes longer than those 10 seconds to |
2212 | keep up with the timer (because it takes longer than those 10 seconds to |
2024 | do stuff) the timer will not fire more than once per event loop iteration. |
2213 | do stuff) the timer will not fire more than once per event loop iteration. |
2025 | |
2214 | |
2026 | =item ev_timer_again (loop, ev_timer *) |
2215 | =item ev_timer_again (loop, ev_timer *) |
2027 | |
2216 | |
2028 | This will act as if the timer timed out and restarts it again if it is |
2217 | This will act as if the timer timed out, and restarts it again if it is |
2029 | repeating. The exact semantics are: |
2218 | repeating. It basically works like calling C<ev_timer_stop>, updating the |
|
|
2219 | timeout to the C<repeat> value and calling C<ev_timer_start>. |
2030 | |
2220 | |
|
|
2221 | The exact semantics are as in the following rules, all of which will be |
|
|
2222 | applied to the watcher: |
|
|
2223 | |
|
|
2224 | =over 4 |
|
|
2225 | |
2031 | If the timer is pending, its pending status is cleared. |
2226 | =item If the timer is pending, the pending status is always cleared. |
2032 | |
2227 | |
2033 | If the timer is started but non-repeating, stop it (as if it timed out). |
2228 | =item If the timer is started but non-repeating, stop it (as if it timed |
|
|
2229 | out, without invoking it). |
2034 | |
2230 | |
2035 | If the timer is repeating, either start it if necessary (with the |
2231 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2036 | C<repeat> value), or reset the running timer to the C<repeat> value. |
2232 | and start the timer, if necessary. |
2037 | |
2233 | |
|
|
2234 | =back |
|
|
2235 | |
2038 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2236 | This sounds a bit complicated, see L</Be smart about timeouts>, above, for a |
2039 | usage example. |
2237 | usage example. |
2040 | |
2238 | |
2041 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2239 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2042 | |
2240 | |
2043 | Returns the remaining time until a timer fires. If the timer is active, |
2241 | Returns the remaining time until a timer fires. If the timer is active, |
… | |
… | |
2096 | Periodic watchers are also timers of a kind, but they are very versatile |
2294 | Periodic watchers are also timers of a kind, but they are very versatile |
2097 | (and unfortunately a bit complex). |
2295 | (and unfortunately a bit complex). |
2098 | |
2296 | |
2099 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2297 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2100 | relative time, the physical time that passes) but on wall clock time |
2298 | relative time, the physical time that passes) but on wall clock time |
2101 | (absolute time, the thing you can read on your calender or clock). The |
2299 | (absolute time, the thing you can read on your calendar or clock). The |
2102 | difference is that wall clock time can run faster or slower than real |
2300 | difference is that wall clock time can run faster or slower than real |
2103 | time, and time jumps are not uncommon (e.g. when you adjust your |
2301 | time, and time jumps are not uncommon (e.g. when you adjust your |
2104 | wrist-watch). |
2302 | wrist-watch). |
2105 | |
2303 | |
2106 | You can tell a periodic watcher to trigger after some specific point |
2304 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
2111 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2309 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2112 | it, as it uses a relative timeout). |
2310 | it, as it uses a relative timeout). |
2113 | |
2311 | |
2114 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2312 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2115 | timers, such as triggering an event on each "midnight, local time", or |
2313 | timers, such as triggering an event on each "midnight, local time", or |
2116 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
2314 | other complicated rules. This cannot easily be done with C<ev_timer> |
2117 | those cannot react to time jumps. |
2315 | watchers, as those cannot react to time jumps. |
2118 | |
2316 | |
2119 | As with timers, the callback is guaranteed to be invoked only when the |
2317 | As with timers, the callback is guaranteed to be invoked only when the |
2120 | point in time where it is supposed to trigger has passed. If multiple |
2318 | point in time where it is supposed to trigger has passed. If multiple |
2121 | timers become ready during the same loop iteration then the ones with |
2319 | timers become ready during the same loop iteration then the ones with |
2122 | earlier time-out values are invoked before ones with later time-out values |
2320 | earlier time-out values are invoked before ones with later time-out values |
… | |
… | |
2208 | |
2406 | |
2209 | NOTE: I<< This callback must always return a time that is higher than or |
2407 | NOTE: I<< This callback must always return a time that is higher than or |
2210 | equal to the passed C<now> value >>. |
2408 | equal to the passed C<now> value >>. |
2211 | |
2409 | |
2212 | This can be used to create very complex timers, such as a timer that |
2410 | This can be used to create very complex timers, such as a timer that |
2213 | triggers on "next midnight, local time". To do this, you would calculate the |
2411 | triggers on "next midnight, local time". To do this, you would calculate |
2214 | next midnight after C<now> and return the timestamp value for this. How |
2412 | the next midnight after C<now> and return the timestamp value for |
2215 | you do this is, again, up to you (but it is not trivial, which is the main |
2413 | this. Here is a (completely untested, no error checking) example on how to |
2216 | reason I omitted it as an example). |
2414 | do this: |
|
|
2415 | |
|
|
2416 | #include <time.h> |
|
|
2417 | |
|
|
2418 | static ev_tstamp |
|
|
2419 | my_rescheduler (ev_periodic *w, ev_tstamp now) |
|
|
2420 | { |
|
|
2421 | time_t tnow = (time_t)now; |
|
|
2422 | struct tm tm; |
|
|
2423 | localtime_r (&tnow, &tm); |
|
|
2424 | |
|
|
2425 | tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day |
|
|
2426 | ++tm.tm_mday; // midnight next day |
|
|
2427 | |
|
|
2428 | return mktime (&tm); |
|
|
2429 | } |
|
|
2430 | |
|
|
2431 | Note: this code might run into trouble on days that have more then two |
|
|
2432 | midnights (beginning and end). |
2217 | |
2433 | |
2218 | =back |
2434 | =back |
2219 | |
2435 | |
2220 | =item ev_periodic_again (loop, ev_periodic *) |
2436 | =item ev_periodic_again (loop, ev_periodic *) |
2221 | |
2437 | |
… | |
… | |
2286 | |
2502 | |
2287 | ev_periodic hourly_tick; |
2503 | ev_periodic hourly_tick; |
2288 | ev_periodic_init (&hourly_tick, clock_cb, |
2504 | ev_periodic_init (&hourly_tick, clock_cb, |
2289 | fmod (ev_now (loop), 3600.), 3600., 0); |
2505 | fmod (ev_now (loop), 3600.), 3600., 0); |
2290 | ev_periodic_start (loop, &hourly_tick); |
2506 | ev_periodic_start (loop, &hourly_tick); |
2291 | |
2507 | |
2292 | |
2508 | |
2293 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2509 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2294 | |
2510 | |
2295 | Signal watchers will trigger an event when the process receives a specific |
2511 | Signal watchers will trigger an event when the process receives a specific |
2296 | signal one or more times. Even though signals are very asynchronous, libev |
2512 | signal one or more times. Even though signals are very asynchronous, libev |
… | |
… | |
2306 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2522 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2307 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2523 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2308 | C<SIGINT> in both the default loop and another loop at the same time. At |
2524 | C<SIGINT> in both the default loop and another loop at the same time. At |
2309 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2525 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2310 | |
2526 | |
2311 | When the first watcher gets started will libev actually register something |
2527 | Only after the first watcher for a signal is started will libev actually |
2312 | with the kernel (thus it coexists with your own signal handlers as long as |
2528 | register something with the kernel. It thus coexists with your own signal |
2313 | you don't register any with libev for the same signal). |
2529 | handlers as long as you don't register any with libev for the same signal. |
2314 | |
2530 | |
2315 | If possible and supported, libev will install its handlers with |
2531 | If possible and supported, libev will install its handlers with |
2316 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2532 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2317 | not be unduly interrupted. If you have a problem with system calls getting |
2533 | not be unduly interrupted. If you have a problem with system calls getting |
2318 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2534 | interrupted by signals you can block all signals in an C<ev_check> watcher |
… | |
… | |
2503 | |
2719 | |
2504 | =head2 C<ev_stat> - did the file attributes just change? |
2720 | =head2 C<ev_stat> - did the file attributes just change? |
2505 | |
2721 | |
2506 | This watches a file system path for attribute changes. That is, it calls |
2722 | This watches a file system path for attribute changes. That is, it calls |
2507 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2723 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2508 | and sees if it changed compared to the last time, invoking the callback if |
2724 | and sees if it changed compared to the last time, invoking the callback |
2509 | it did. |
2725 | if it did. Starting the watcher C<stat>'s the file, so only changes that |
|
|
2726 | happen after the watcher has been started will be reported. |
2510 | |
2727 | |
2511 | The path does not need to exist: changing from "path exists" to "path does |
2728 | The path does not need to exist: changing from "path exists" to "path does |
2512 | not exist" is a status change like any other. The condition "path does not |
2729 | not exist" is a status change like any other. The condition "path does not |
2513 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2730 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2514 | C<st_nlink> field being zero (which is otherwise always forced to be at |
2731 | C<st_nlink> field being zero (which is otherwise always forced to be at |
… | |
… | |
2744 | Apart from keeping your process non-blocking (which is a useful |
2961 | Apart from keeping your process non-blocking (which is a useful |
2745 | effect on its own sometimes), idle watchers are a good place to do |
2962 | effect on its own sometimes), idle watchers are a good place to do |
2746 | "pseudo-background processing", or delay processing stuff to after the |
2963 | "pseudo-background processing", or delay processing stuff to after the |
2747 | event loop has handled all outstanding events. |
2964 | event loop has handled all outstanding events. |
2748 | |
2965 | |
|
|
2966 | =head3 Abusing an C<ev_idle> watcher for its side-effect |
|
|
2967 | |
|
|
2968 | As long as there is at least one active idle watcher, libev will never |
|
|
2969 | sleep unnecessarily. Or in other words, it will loop as fast as possible. |
|
|
2970 | For this to work, the idle watcher doesn't need to be invoked at all - the |
|
|
2971 | lowest priority will do. |
|
|
2972 | |
|
|
2973 | This mode of operation can be useful together with an C<ev_check> watcher, |
|
|
2974 | to do something on each event loop iteration - for example to balance load |
|
|
2975 | between different connections. |
|
|
2976 | |
|
|
2977 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
|
|
2978 | example. |
|
|
2979 | |
2749 | =head3 Watcher-Specific Functions and Data Members |
2980 | =head3 Watcher-Specific Functions and Data Members |
2750 | |
2981 | |
2751 | =over 4 |
2982 | =over 4 |
2752 | |
2983 | |
2753 | =item ev_idle_init (ev_idle *, callback) |
2984 | =item ev_idle_init (ev_idle *, callback) |
… | |
… | |
2764 | callback, free it. Also, use no error checking, as usual. |
2995 | callback, free it. Also, use no error checking, as usual. |
2765 | |
2996 | |
2766 | static void |
2997 | static void |
2767 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2998 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2768 | { |
2999 | { |
|
|
3000 | // stop the watcher |
|
|
3001 | ev_idle_stop (loop, w); |
|
|
3002 | |
|
|
3003 | // now we can free it |
2769 | free (w); |
3004 | free (w); |
|
|
3005 | |
2770 | // now do something you wanted to do when the program has |
3006 | // now do something you wanted to do when the program has |
2771 | // no longer anything immediate to do. |
3007 | // no longer anything immediate to do. |
2772 | } |
3008 | } |
2773 | |
3009 | |
2774 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
3010 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
… | |
… | |
2776 | ev_idle_start (loop, idle_watcher); |
3012 | ev_idle_start (loop, idle_watcher); |
2777 | |
3013 | |
2778 | |
3014 | |
2779 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
3015 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2780 | |
3016 | |
2781 | Prepare and check watchers are usually (but not always) used in pairs: |
3017 | Prepare and check watchers are often (but not always) used in pairs: |
2782 | prepare watchers get invoked before the process blocks and check watchers |
3018 | prepare watchers get invoked before the process blocks and check watchers |
2783 | afterwards. |
3019 | afterwards. |
2784 | |
3020 | |
2785 | You I<must not> call C<ev_run> or similar functions that enter |
3021 | You I<must not> call C<ev_run> (or similar functions that enter the |
2786 | the current event loop from either C<ev_prepare> or C<ev_check> |
3022 | current event loop) or C<ev_loop_fork> from either C<ev_prepare> or |
2787 | watchers. Other loops than the current one are fine, however. The |
3023 | C<ev_check> watchers. Other loops than the current one are fine, |
2788 | rationale behind this is that you do not need to check for recursion in |
3024 | however. The rationale behind this is that you do not need to check |
2789 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
3025 | for recursion in those watchers, i.e. the sequence will always be |
2790 | C<ev_check> so if you have one watcher of each kind they will always be |
3026 | C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each |
2791 | called in pairs bracketing the blocking call. |
3027 | kind they will always be called in pairs bracketing the blocking call. |
2792 | |
3028 | |
2793 | Their main purpose is to integrate other event mechanisms into libev and |
3029 | Their main purpose is to integrate other event mechanisms into libev and |
2794 | their use is somewhat advanced. They could be used, for example, to track |
3030 | their use is somewhat advanced. They could be used, for example, to track |
2795 | variable changes, implement your own watchers, integrate net-snmp or a |
3031 | variable changes, implement your own watchers, integrate net-snmp or a |
2796 | coroutine library and lots more. They are also occasionally useful if |
3032 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
2814 | with priority higher than or equal to the event loop and one coroutine |
3050 | with priority higher than or equal to the event loop and one coroutine |
2815 | of lower priority, but only once, using idle watchers to keep the event |
3051 | of lower priority, but only once, using idle watchers to keep the event |
2816 | loop from blocking if lower-priority coroutines are active, thus mapping |
3052 | loop from blocking if lower-priority coroutines are active, thus mapping |
2817 | low-priority coroutines to idle/background tasks). |
3053 | low-priority coroutines to idle/background tasks). |
2818 | |
3054 | |
2819 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
3055 | When used for this purpose, it is recommended to give C<ev_check> watchers |
2820 | priority, to ensure that they are being run before any other watchers |
3056 | highest (C<EV_MAXPRI>) priority, to ensure that they are being run before |
2821 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
3057 | any other watchers after the poll (this doesn't matter for C<ev_prepare> |
|
|
3058 | watchers). |
2822 | |
3059 | |
2823 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
3060 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2824 | activate ("feed") events into libev. While libev fully supports this, they |
3061 | activate ("feed") events into libev. While libev fully supports this, they |
2825 | might get executed before other C<ev_check> watchers did their job. As |
3062 | might get executed before other C<ev_check> watchers did their job. As |
2826 | C<ev_check> watchers are often used to embed other (non-libev) event |
3063 | C<ev_check> watchers are often used to embed other (non-libev) event |
2827 | loops those other event loops might be in an unusable state until their |
3064 | loops those other event loops might be in an unusable state until their |
2828 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
3065 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2829 | others). |
3066 | others). |
|
|
3067 | |
|
|
3068 | =head3 Abusing an C<ev_check> watcher for its side-effect |
|
|
3069 | |
|
|
3070 | C<ev_check> (and less often also C<ev_prepare>) watchers can also be |
|
|
3071 | useful because they are called once per event loop iteration. For |
|
|
3072 | example, if you want to handle a large number of connections fairly, you |
|
|
3073 | normally only do a bit of work for each active connection, and if there |
|
|
3074 | is more work to do, you wait for the next event loop iteration, so other |
|
|
3075 | connections have a chance of making progress. |
|
|
3076 | |
|
|
3077 | Using an C<ev_check> watcher is almost enough: it will be called on the |
|
|
3078 | next event loop iteration. However, that isn't as soon as possible - |
|
|
3079 | without external events, your C<ev_check> watcher will not be invoked. |
|
|
3080 | |
|
|
3081 | This is where C<ev_idle> watchers come in handy - all you need is a |
|
|
3082 | single global idle watcher that is active as long as you have one active |
|
|
3083 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
|
|
3084 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
|
|
3085 | invoked. Neither watcher alone can do that. |
2830 | |
3086 | |
2831 | =head3 Watcher-Specific Functions and Data Members |
3087 | =head3 Watcher-Specific Functions and Data Members |
2832 | |
3088 | |
2833 | =over 4 |
3089 | =over 4 |
2834 | |
3090 | |
… | |
… | |
3035 | |
3291 | |
3036 | =over 4 |
3292 | =over 4 |
3037 | |
3293 | |
3038 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3294 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3039 | |
3295 | |
3040 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3296 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3041 | |
3297 | |
3042 | Configures the watcher to embed the given loop, which must be |
3298 | Configures the watcher to embed the given loop, which must be |
3043 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3299 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3044 | invoked automatically, otherwise it is the responsibility of the callback |
3300 | invoked automatically, otherwise it is the responsibility of the callback |
3045 | to invoke it (it will continue to be called until the sweep has been done, |
3301 | to invoke it (it will continue to be called until the sweep has been done, |
… | |
… | |
3066 | used). |
3322 | used). |
3067 | |
3323 | |
3068 | struct ev_loop *loop_hi = ev_default_init (0); |
3324 | struct ev_loop *loop_hi = ev_default_init (0); |
3069 | struct ev_loop *loop_lo = 0; |
3325 | struct ev_loop *loop_lo = 0; |
3070 | ev_embed embed; |
3326 | ev_embed embed; |
3071 | |
3327 | |
3072 | // see if there is a chance of getting one that works |
3328 | // see if there is a chance of getting one that works |
3073 | // (remember that a flags value of 0 means autodetection) |
3329 | // (remember that a flags value of 0 means autodetection) |
3074 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3330 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3075 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3331 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3076 | : 0; |
3332 | : 0; |
… | |
… | |
3090 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3346 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3091 | |
3347 | |
3092 | struct ev_loop *loop = ev_default_init (0); |
3348 | struct ev_loop *loop = ev_default_init (0); |
3093 | struct ev_loop *loop_socket = 0; |
3349 | struct ev_loop *loop_socket = 0; |
3094 | ev_embed embed; |
3350 | ev_embed embed; |
3095 | |
3351 | |
3096 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3352 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3097 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3353 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3098 | { |
3354 | { |
3099 | ev_embed_init (&embed, 0, loop_socket); |
3355 | ev_embed_init (&embed, 0, loop_socket); |
3100 | ev_embed_start (loop, &embed); |
3356 | ev_embed_start (loop, &embed); |
… | |
… | |
3108 | |
3364 | |
3109 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3365 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3110 | |
3366 | |
3111 | Fork watchers are called when a C<fork ()> was detected (usually because |
3367 | Fork watchers are called when a C<fork ()> was detected (usually because |
3112 | whoever is a good citizen cared to tell libev about it by calling |
3368 | whoever is a good citizen cared to tell libev about it by calling |
3113 | C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the |
3369 | C<ev_loop_fork>). The invocation is done before the event loop blocks next |
3114 | event loop blocks next and before C<ev_check> watchers are being called, |
3370 | and before C<ev_check> watchers are being called, and only in the child |
3115 | and only in the child after the fork. If whoever good citizen calling |
3371 | after the fork. If whoever good citizen calling C<ev_default_fork> cheats |
3116 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3372 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3117 | handlers will be invoked, too, of course. |
3373 | of course. |
3118 | |
3374 | |
3119 | =head3 The special problem of life after fork - how is it possible? |
3375 | =head3 The special problem of life after fork - how is it possible? |
3120 | |
3376 | |
3121 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3377 | Most uses of C<fork ()> consist of forking, then some simple calls to set |
3122 | up/change the process environment, followed by a call to C<exec()>. This |
3378 | up/change the process environment, followed by a call to C<exec()>. This |
3123 | sequence should be handled by libev without any problems. |
3379 | sequence should be handled by libev without any problems. |
3124 | |
3380 | |
3125 | This changes when the application actually wants to do event handling |
3381 | This changes when the application actually wants to do event handling |
3126 | in the child, or both parent in child, in effect "continuing" after the |
3382 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
3215 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3471 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3216 | |
3472 | |
3217 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3473 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3218 | too, are asynchronous in nature, and signals, too, will be compressed |
3474 | too, are asynchronous in nature, and signals, too, will be compressed |
3219 | (i.e. the number of callback invocations may be less than the number of |
3475 | (i.e. the number of callback invocations may be less than the number of |
3220 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3476 | C<ev_async_send> calls). In fact, you could use signal watchers as a kind |
3221 | of "global async watchers" by using a watcher on an otherwise unused |
3477 | of "global async watchers" by using a watcher on an otherwise unused |
3222 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3478 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3223 | even without knowing which loop owns the signal. |
3479 | even without knowing which loop owns the signal. |
3224 | |
3480 | |
3225 | =head3 Queueing |
3481 | =head3 Queueing |
… | |
… | |
3364 | |
3620 | |
3365 | There are some other functions of possible interest. Described. Here. Now. |
3621 | There are some other functions of possible interest. Described. Here. Now. |
3366 | |
3622 | |
3367 | =over 4 |
3623 | =over 4 |
3368 | |
3624 | |
3369 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
3625 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg) |
3370 | |
3626 | |
3371 | This function combines a simple timer and an I/O watcher, calls your |
3627 | This function combines a simple timer and an I/O watcher, calls your |
3372 | callback on whichever event happens first and automatically stops both |
3628 | callback on whichever event happens first and automatically stops both |
3373 | watchers. This is useful if you want to wait for a single event on an fd |
3629 | watchers. This is useful if you want to wait for a single event on an fd |
3374 | or timeout without having to allocate/configure/start/stop/free one or |
3630 | or timeout without having to allocate/configure/start/stop/free one or |
… | |
… | |
3402 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3658 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3403 | |
3659 | |
3404 | =item ev_feed_fd_event (loop, int fd, int revents) |
3660 | =item ev_feed_fd_event (loop, int fd, int revents) |
3405 | |
3661 | |
3406 | Feed an event on the given fd, as if a file descriptor backend detected |
3662 | Feed an event on the given fd, as if a file descriptor backend detected |
3407 | the given events it. |
3663 | the given events. |
3408 | |
3664 | |
3409 | =item ev_feed_signal_event (loop, int signum) |
3665 | =item ev_feed_signal_event (loop, int signum) |
3410 | |
3666 | |
3411 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3667 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3412 | which is async-safe. |
3668 | which is async-safe. |
… | |
… | |
3486 | { |
3742 | { |
3487 | struct my_biggy big = (struct my_biggy *) |
3743 | struct my_biggy big = (struct my_biggy *) |
3488 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3744 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3489 | } |
3745 | } |
3490 | |
3746 | |
|
|
3747 | =head2 AVOIDING FINISHING BEFORE RETURNING |
|
|
3748 | |
|
|
3749 | Often you have structures like this in event-based programs: |
|
|
3750 | |
|
|
3751 | callback () |
|
|
3752 | { |
|
|
3753 | free (request); |
|
|
3754 | } |
|
|
3755 | |
|
|
3756 | request = start_new_request (..., callback); |
|
|
3757 | |
|
|
3758 | The intent is to start some "lengthy" operation. The C<request> could be |
|
|
3759 | used to cancel the operation, or do other things with it. |
|
|
3760 | |
|
|
3761 | It's not uncommon to have code paths in C<start_new_request> that |
|
|
3762 | immediately invoke the callback, for example, to report errors. Or you add |
|
|
3763 | some caching layer that finds that it can skip the lengthy aspects of the |
|
|
3764 | operation and simply invoke the callback with the result. |
|
|
3765 | |
|
|
3766 | The problem here is that this will happen I<before> C<start_new_request> |
|
|
3767 | has returned, so C<request> is not set. |
|
|
3768 | |
|
|
3769 | Even if you pass the request by some safer means to the callback, you |
|
|
3770 | might want to do something to the request after starting it, such as |
|
|
3771 | canceling it, which probably isn't working so well when the callback has |
|
|
3772 | already been invoked. |
|
|
3773 | |
|
|
3774 | A common way around all these issues is to make sure that |
|
|
3775 | C<start_new_request> I<always> returns before the callback is invoked. If |
|
|
3776 | C<start_new_request> immediately knows the result, it can artificially |
|
|
3777 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
|
|
3778 | example, or more sneakily, by reusing an existing (stopped) watcher and |
|
|
3779 | pushing it into the pending queue: |
|
|
3780 | |
|
|
3781 | ev_set_cb (watcher, callback); |
|
|
3782 | ev_feed_event (EV_A_ watcher, 0); |
|
|
3783 | |
|
|
3784 | This way, C<start_new_request> can safely return before the callback is |
|
|
3785 | invoked, while not delaying callback invocation too much. |
|
|
3786 | |
3491 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3787 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3492 | |
3788 | |
3493 | Often (especially in GUI toolkits) there are places where you have |
3789 | Often (especially in GUI toolkits) there are places where you have |
3494 | I<modal> interaction, which is most easily implemented by recursively |
3790 | I<modal> interaction, which is most easily implemented by recursively |
3495 | invoking C<ev_run>. |
3791 | invoking C<ev_run>. |
3496 | |
3792 | |
3497 | This brings the problem of exiting - a callback might want to finish the |
3793 | This brings the problem of exiting - a callback might want to finish the |
3498 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3794 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3499 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3795 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3500 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3796 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3501 | other combination: In these cases, C<ev_break> will not work alone. |
3797 | other combination: In these cases, a simple C<ev_break> will not work. |
3502 | |
3798 | |
3503 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3799 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3504 | invocation, and use a loop around C<ev_run> until the condition is |
3800 | invocation, and use a loop around C<ev_run> until the condition is |
3505 | triggered, using C<EVRUN_ONCE>: |
3801 | triggered, using C<EVRUN_ONCE>: |
3506 | |
3802 | |
… | |
… | |
3508 | int exit_main_loop = 0; |
3804 | int exit_main_loop = 0; |
3509 | |
3805 | |
3510 | while (!exit_main_loop) |
3806 | while (!exit_main_loop) |
3511 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3807 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3512 | |
3808 | |
3513 | // in a model watcher |
3809 | // in a modal watcher |
3514 | int exit_nested_loop = 0; |
3810 | int exit_nested_loop = 0; |
3515 | |
3811 | |
3516 | while (!exit_nested_loop) |
3812 | while (!exit_nested_loop) |
3517 | ev_run (EV_A_ EVRUN_ONCE); |
3813 | ev_run (EV_A_ EVRUN_ONCE); |
3518 | |
3814 | |
… | |
… | |
3692 | called): |
3988 | called): |
3693 | |
3989 | |
3694 | void |
3990 | void |
3695 | wait_for_event (ev_watcher *w) |
3991 | wait_for_event (ev_watcher *w) |
3696 | { |
3992 | { |
3697 | ev_cb_set (w) = current_coro; |
3993 | ev_set_cb (w, current_coro); |
3698 | switch_to (libev_coro); |
3994 | switch_to (libev_coro); |
3699 | } |
3995 | } |
3700 | |
3996 | |
3701 | That basically suspends the coroutine inside C<wait_for_event> and |
3997 | That basically suspends the coroutine inside C<wait_for_event> and |
3702 | continues the libev coroutine, which, when appropriate, switches back to |
3998 | continues the libev coroutine, which, when appropriate, switches back to |
3703 | this or any other coroutine. I am sure if you sue this your own :) |
3999 | this or any other coroutine. |
3704 | |
4000 | |
3705 | You can do similar tricks if you have, say, threads with an event queue - |
4001 | You can do similar tricks if you have, say, threads with an event queue - |
3706 | instead of storing a coroutine, you store the queue object and instead of |
4002 | instead of storing a coroutine, you store the queue object and instead of |
3707 | switching to a coroutine, you push the watcher onto the queue and notify |
4003 | switching to a coroutine, you push the watcher onto the queue and notify |
3708 | any waiters. |
4004 | any waiters. |
3709 | |
4005 | |
3710 | To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two |
4006 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3711 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
4007 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3712 | |
4008 | |
3713 | // my_ev.h |
4009 | // my_ev.h |
3714 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
4010 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3715 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
4011 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb) |
3716 | #include "../libev/ev.h" |
4012 | #include "../libev/ev.h" |
3717 | |
4013 | |
3718 | // my_ev.c |
4014 | // my_ev.c |
3719 | #define EV_H "my_ev.h" |
4015 | #define EV_H "my_ev.h" |
3720 | #include "../libev/ev.c" |
4016 | #include "../libev/ev.c" |
… | |
… | |
3759 | |
4055 | |
3760 | =back |
4056 | =back |
3761 | |
4057 | |
3762 | =head1 C++ SUPPORT |
4058 | =head1 C++ SUPPORT |
3763 | |
4059 | |
|
|
4060 | =head2 C API |
|
|
4061 | |
|
|
4062 | The normal C API should work fine when used from C++: both ev.h and the |
|
|
4063 | libev sources can be compiled as C++. Therefore, code that uses the C API |
|
|
4064 | will work fine. |
|
|
4065 | |
|
|
4066 | Proper exception specifications might have to be added to callbacks passed |
|
|
4067 | to libev: exceptions may be thrown only from watcher callbacks, all other |
|
|
4068 | callbacks (allocator, syserr, loop acquire/release and periodic reschedule |
|
|
4069 | callbacks) must not throw exceptions, and might need a C<noexcept> |
|
|
4070 | specification. If you have code that needs to be compiled as both C and |
|
|
4071 | C++ you can use the C<EV_NOEXCEPT> macro for this: |
|
|
4072 | |
|
|
4073 | static void |
|
|
4074 | fatal_error (const char *msg) EV_NOEXCEPT |
|
|
4075 | { |
|
|
4076 | perror (msg); |
|
|
4077 | abort (); |
|
|
4078 | } |
|
|
4079 | |
|
|
4080 | ... |
|
|
4081 | ev_set_syserr_cb (fatal_error); |
|
|
4082 | |
|
|
4083 | The only API functions that can currently throw exceptions are C<ev_run>, |
|
|
4084 | C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter |
|
|
4085 | because it runs cleanup watchers). |
|
|
4086 | |
|
|
4087 | Throwing exceptions in watcher callbacks is only supported if libev itself |
|
|
4088 | is compiled with a C++ compiler or your C and C++ environments allow |
|
|
4089 | throwing exceptions through C libraries (most do). |
|
|
4090 | |
|
|
4091 | =head2 C++ API |
|
|
4092 | |
3764 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
4093 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3765 | you to use some convenience methods to start/stop watchers and also change |
4094 | you to use some convenience methods to start/stop watchers and also change |
3766 | the callback model to a model using method callbacks on objects. |
4095 | the callback model to a model using method callbacks on objects. |
3767 | |
4096 | |
3768 | To use it, |
4097 | To use it, |
3769 | |
4098 | |
3770 | #include <ev++.h> |
4099 | #include <ev++.h> |
3771 | |
4100 | |
3772 | This automatically includes F<ev.h> and puts all of its definitions (many |
4101 | This automatically includes F<ev.h> and puts all of its definitions (many |
3773 | of them macros) into the global namespace. All C++ specific things are |
4102 | of them macros) into the global namespace. All C++ specific things are |
3774 | put into the C<ev> namespace. It should support all the same embedding |
4103 | put into the C<ev> namespace. It should support all the same embedding |
… | |
… | |
3783 | with C<operator ()> can be used as callbacks. Other types should be easy |
4112 | with C<operator ()> can be used as callbacks. Other types should be easy |
3784 | to add as long as they only need one additional pointer for context. If |
4113 | to add as long as they only need one additional pointer for context. If |
3785 | you need support for other types of functors please contact the author |
4114 | you need support for other types of functors please contact the author |
3786 | (preferably after implementing it). |
4115 | (preferably after implementing it). |
3787 | |
4116 | |
|
|
4117 | For all this to work, your C++ compiler either has to use the same calling |
|
|
4118 | conventions as your C compiler (for static member functions), or you have |
|
|
4119 | to embed libev and compile libev itself as C++. |
|
|
4120 | |
3788 | Here is a list of things available in the C<ev> namespace: |
4121 | Here is a list of things available in the C<ev> namespace: |
3789 | |
4122 | |
3790 | =over 4 |
4123 | =over 4 |
3791 | |
4124 | |
3792 | =item C<ev::READ>, C<ev::WRITE> etc. |
4125 | =item C<ev::READ>, C<ev::WRITE> etc. |
… | |
… | |
3801 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
4134 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
3802 | |
4135 | |
3803 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
4136 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
3804 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
4137 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
3805 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
4138 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
3806 | defines by many implementations. |
4139 | defined by many implementations. |
3807 | |
4140 | |
3808 | All of those classes have these methods: |
4141 | All of those classes have these methods: |
3809 | |
4142 | |
3810 | =over 4 |
4143 | =over 4 |
3811 | |
4144 | |
… | |
… | |
3873 | void operator() (ev::io &w, int revents) |
4206 | void operator() (ev::io &w, int revents) |
3874 | { |
4207 | { |
3875 | ... |
4208 | ... |
3876 | } |
4209 | } |
3877 | } |
4210 | } |
3878 | |
4211 | |
3879 | myfunctor f; |
4212 | myfunctor f; |
3880 | |
4213 | |
3881 | ev::io w; |
4214 | ev::io w; |
3882 | w.set (&f); |
4215 | w.set (&f); |
3883 | |
4216 | |
… | |
… | |
3901 | Associates a different C<struct ev_loop> with this watcher. You can only |
4234 | Associates a different C<struct ev_loop> with this watcher. You can only |
3902 | do this when the watcher is inactive (and not pending either). |
4235 | do this when the watcher is inactive (and not pending either). |
3903 | |
4236 | |
3904 | =item w->set ([arguments]) |
4237 | =item w->set ([arguments]) |
3905 | |
4238 | |
3906 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4239 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
3907 | method or a suitable start method must be called at least once. Unlike the |
4240 | with the same arguments. Either this method or a suitable start method |
3908 | C counterpart, an active watcher gets automatically stopped and restarted |
4241 | must be called at least once. Unlike the C counterpart, an active watcher |
3909 | when reconfiguring it with this method. |
4242 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4243 | method. |
|
|
4244 | |
|
|
4245 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4246 | clashing with the C<set (loop)> method. |
3910 | |
4247 | |
3911 | =item w->start () |
4248 | =item w->start () |
3912 | |
4249 | |
3913 | Starts the watcher. Note that there is no C<loop> argument, as the |
4250 | Starts the watcher. Note that there is no C<loop> argument, as the |
3914 | constructor already stores the event loop. |
4251 | constructor already stores the event loop. |
… | |
… | |
3944 | watchers in the constructor. |
4281 | watchers in the constructor. |
3945 | |
4282 | |
3946 | class myclass |
4283 | class myclass |
3947 | { |
4284 | { |
3948 | ev::io io ; void io_cb (ev::io &w, int revents); |
4285 | ev::io io ; void io_cb (ev::io &w, int revents); |
3949 | ev::io2 io2 ; void io2_cb (ev::io &w, int revents); |
4286 | ev::io io2 ; void io2_cb (ev::io &w, int revents); |
3950 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
4287 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
3951 | |
4288 | |
3952 | myclass (int fd) |
4289 | myclass (int fd) |
3953 | { |
4290 | { |
3954 | io .set <myclass, &myclass::io_cb > (this); |
4291 | io .set <myclass, &myclass::io_cb > (this); |
… | |
… | |
4005 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
4342 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
4006 | |
4343 | |
4007 | =item D |
4344 | =item D |
4008 | |
4345 | |
4009 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4346 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4010 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
4347 | be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>. |
4011 | |
4348 | |
4012 | =item Ocaml |
4349 | =item Ocaml |
4013 | |
4350 | |
4014 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4351 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4015 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
4352 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
… | |
… | |
4018 | |
4355 | |
4019 | Brian Maher has written a partial interface to libev for lua (at the |
4356 | Brian Maher has written a partial interface to libev for lua (at the |
4020 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4357 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4021 | L<http://github.com/brimworks/lua-ev>. |
4358 | L<http://github.com/brimworks/lua-ev>. |
4022 | |
4359 | |
|
|
4360 | =item Javascript |
|
|
4361 | |
|
|
4362 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4363 | |
|
|
4364 | =item Others |
|
|
4365 | |
|
|
4366 | There are others, and I stopped counting. |
|
|
4367 | |
4023 | =back |
4368 | =back |
4024 | |
4369 | |
4025 | |
4370 | |
4026 | =head1 MACRO MAGIC |
4371 | =head1 MACRO MAGIC |
4027 | |
4372 | |
… | |
… | |
4063 | suitable for use with C<EV_A>. |
4408 | suitable for use with C<EV_A>. |
4064 | |
4409 | |
4065 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
4410 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
4066 | |
4411 | |
4067 | Similar to the other two macros, this gives you the value of the default |
4412 | Similar to the other two macros, this gives you the value of the default |
4068 | loop, if multiple loops are supported ("ev loop default"). |
4413 | loop, if multiple loops are supported ("ev loop default"). The default loop |
|
|
4414 | will be initialised if it isn't already initialised. |
|
|
4415 | |
|
|
4416 | For non-multiplicity builds, these macros do nothing, so you always have |
|
|
4417 | to initialise the loop somewhere. |
4069 | |
4418 | |
4070 | =item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> |
4419 | =item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> |
4071 | |
4420 | |
4072 | Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the |
4421 | Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the |
4073 | default loop has been initialised (C<UC> == unchecked). Their behaviour |
4422 | default loop has been initialised (C<UC> == unchecked). Their behaviour |
… | |
… | |
4140 | ev_vars.h |
4489 | ev_vars.h |
4141 | ev_wrap.h |
4490 | ev_wrap.h |
4142 | |
4491 | |
4143 | ev_win32.c required on win32 platforms only |
4492 | ev_win32.c required on win32 platforms only |
4144 | |
4493 | |
4145 | ev_select.c only when select backend is enabled (which is enabled by default) |
4494 | ev_select.c only when select backend is enabled |
4146 | ev_poll.c only when poll backend is enabled (disabled by default) |
4495 | ev_poll.c only when poll backend is enabled |
4147 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4496 | ev_epoll.c only when the epoll backend is enabled |
|
|
4497 | ev_linuxaio.c only when the linux aio backend is enabled |
|
|
4498 | ev_iouring.c only when the linux io_uring backend is enabled |
4148 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4499 | ev_kqueue.c only when the kqueue backend is enabled |
4149 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
4500 | ev_port.c only when the solaris port backend is enabled |
4150 | |
4501 | |
4151 | F<ev.c> includes the backend files directly when enabled, so you only need |
4502 | F<ev.c> includes the backend files directly when enabled, so you only need |
4152 | to compile this single file. |
4503 | to compile this single file. |
4153 | |
4504 | |
4154 | =head3 LIBEVENT COMPATIBILITY API |
4505 | =head3 LIBEVENT COMPATIBILITY API |
… | |
… | |
4273 | available and will probe for kernel support at runtime. This will improve |
4624 | available and will probe for kernel support at runtime. This will improve |
4274 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
4625 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
4275 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
4626 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
4276 | 2.7 or newer, otherwise disabled. |
4627 | 2.7 or newer, otherwise disabled. |
4277 | |
4628 | |
|
|
4629 | =item EV_USE_SIGNALFD |
|
|
4630 | |
|
|
4631 | If defined to be C<1>, then libev will assume that C<signalfd ()> is |
|
|
4632 | available and will probe for kernel support at runtime. This enables |
|
|
4633 | the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If |
|
|
4634 | undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4635 | 2.7 or newer, otherwise disabled. |
|
|
4636 | |
|
|
4637 | =item EV_USE_TIMERFD |
|
|
4638 | |
|
|
4639 | If defined to be C<1>, then libev will assume that C<timerfd ()> is |
|
|
4640 | available and will probe for kernel support at runtime. This allows |
|
|
4641 | libev to detect time jumps accurately. If undefined, it will be enabled |
|
|
4642 | if the headers indicate GNU/Linux + Glibc 2.8 or newer and define |
|
|
4643 | C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled. |
|
|
4644 | |
|
|
4645 | =item EV_USE_EVENTFD |
|
|
4646 | |
|
|
4647 | If defined to be C<1>, then libev will assume that C<eventfd ()> is |
|
|
4648 | available and will probe for kernel support at runtime. This will improve |
|
|
4649 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
|
|
4650 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4651 | 2.7 or newer, otherwise disabled. |
|
|
4652 | |
4278 | =item EV_USE_SELECT |
4653 | =item EV_USE_SELECT |
4279 | |
4654 | |
4280 | If undefined or defined to be C<1>, libev will compile in support for the |
4655 | If undefined or defined to be C<1>, libev will compile in support for the |
4281 | C<select>(2) backend. No attempt at auto-detection will be done: if no |
4656 | C<select>(2) backend. No attempt at auto-detection will be done: if no |
4282 | other method takes over, select will be it. Otherwise the select backend |
4657 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
4322 | If programs implement their own fd to handle mapping on win32, then this |
4697 | If programs implement their own fd to handle mapping on win32, then this |
4323 | macro can be used to override the C<close> function, useful to unregister |
4698 | macro can be used to override the C<close> function, useful to unregister |
4324 | file descriptors again. Note that the replacement function has to close |
4699 | file descriptors again. Note that the replacement function has to close |
4325 | the underlying OS handle. |
4700 | the underlying OS handle. |
4326 | |
4701 | |
|
|
4702 | =item EV_USE_WSASOCKET |
|
|
4703 | |
|
|
4704 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4705 | communication socket, which works better in some environments. Otherwise, |
|
|
4706 | the normal C<socket> function will be used, which works better in other |
|
|
4707 | environments. |
|
|
4708 | |
4327 | =item EV_USE_POLL |
4709 | =item EV_USE_POLL |
4328 | |
4710 | |
4329 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4711 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4330 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4712 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4331 | takes precedence over select. |
4713 | takes precedence over select. |
… | |
… | |
4335 | If defined to be C<1>, libev will compile in support for the Linux |
4717 | If defined to be C<1>, libev will compile in support for the Linux |
4336 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4718 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4337 | otherwise another method will be used as fallback. This is the preferred |
4719 | otherwise another method will be used as fallback. This is the preferred |
4338 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4720 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4339 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4721 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
|
|
4722 | |
|
|
4723 | =item EV_USE_LINUXAIO |
|
|
4724 | |
|
|
4725 | If defined to be C<1>, libev will compile in support for the Linux aio |
|
|
4726 | backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be |
|
|
4727 | enabled on linux, otherwise disabled. |
|
|
4728 | |
|
|
4729 | =item EV_USE_IOURING |
|
|
4730 | |
|
|
4731 | If defined to be C<1>, libev will compile in support for the Linux |
|
|
4732 | io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's |
|
|
4733 | current limitations it has to be requested explicitly. If undefined, it |
|
|
4734 | will be enabled on linux, otherwise disabled. |
4340 | |
4735 | |
4341 | =item EV_USE_KQUEUE |
4736 | =item EV_USE_KQUEUE |
4342 | |
4737 | |
4343 | If defined to be C<1>, libev will compile in support for the BSD style |
4738 | If defined to be C<1>, libev will compile in support for the BSD style |
4344 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
4739 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
… | |
… | |
4366 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4761 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4367 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4762 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4368 | be detected at runtime. If undefined, it will be enabled if the headers |
4763 | be detected at runtime. If undefined, it will be enabled if the headers |
4369 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4764 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4370 | |
4765 | |
|
|
4766 | =item EV_NO_SMP |
|
|
4767 | |
|
|
4768 | If defined to be C<1>, libev will assume that memory is always coherent |
|
|
4769 | between threads, that is, threads can be used, but threads never run on |
|
|
4770 | different cpus (or different cpu cores). This reduces dependencies |
|
|
4771 | and makes libev faster. |
|
|
4772 | |
|
|
4773 | =item EV_NO_THREADS |
|
|
4774 | |
|
|
4775 | If defined to be C<1>, libev will assume that it will never be called from |
|
|
4776 | different threads (that includes signal handlers), which is a stronger |
|
|
4777 | assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes |
|
|
4778 | libev faster. |
|
|
4779 | |
4371 | =item EV_ATOMIC_T |
4780 | =item EV_ATOMIC_T |
4372 | |
4781 | |
4373 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4782 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4374 | access is atomic and serialised with respect to other threads or signal |
4783 | access is atomic with respect to other threads or signal contexts. No |
4375 | contexts. No such type is easily found in the C language, so you can |
4784 | such type is easily found in the C language, so you can provide your own |
4376 | provide your own type that you know is safe for your purposes. It is used |
4785 | type that you know is safe for your purposes. It is used both for signal |
4377 | both for signal handler "locking" as well as for signal and thread safety |
4786 | handler "locking" as well as for signal and thread safety in C<ev_async> |
4378 | in C<ev_async> watchers. |
4787 | watchers. |
4379 | |
4788 | |
4380 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4789 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4381 | (from F<signal.h>), which is usually good enough on most platforms. |
4790 | (from F<signal.h>), which is usually good enough on most platforms. |
4382 | |
4791 | |
4383 | =item EV_H (h) |
4792 | =item EV_H (h) |
… | |
… | |
4410 | will have the C<struct ev_loop *> as first argument, and you can create |
4819 | will have the C<struct ev_loop *> as first argument, and you can create |
4411 | additional independent event loops. Otherwise there will be no support |
4820 | additional independent event loops. Otherwise there will be no support |
4412 | for multiple event loops and there is no first event loop pointer |
4821 | for multiple event loops and there is no first event loop pointer |
4413 | argument. Instead, all functions act on the single default loop. |
4822 | argument. Instead, all functions act on the single default loop. |
4414 | |
4823 | |
|
|
4824 | Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a |
|
|
4825 | default loop when multiplicity is switched off - you always have to |
|
|
4826 | initialise the loop manually in this case. |
|
|
4827 | |
4415 | =item EV_MINPRI |
4828 | =item EV_MINPRI |
4416 | |
4829 | |
4417 | =item EV_MAXPRI |
4830 | =item EV_MAXPRI |
4418 | |
4831 | |
4419 | The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to |
4832 | The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to |
… | |
… | |
4455 | #define EV_USE_POLL 1 |
4868 | #define EV_USE_POLL 1 |
4456 | #define EV_CHILD_ENABLE 1 |
4869 | #define EV_CHILD_ENABLE 1 |
4457 | #define EV_ASYNC_ENABLE 1 |
4870 | #define EV_ASYNC_ENABLE 1 |
4458 | |
4871 | |
4459 | The actual value is a bitset, it can be a combination of the following |
4872 | The actual value is a bitset, it can be a combination of the following |
4460 | values: |
4873 | values (by default, all of these are enabled): |
4461 | |
4874 | |
4462 | =over 4 |
4875 | =over 4 |
4463 | |
4876 | |
4464 | =item C<1> - faster/larger code |
4877 | =item C<1> - faster/larger code |
4465 | |
4878 | |
… | |
… | |
4469 | code size by roughly 30% on amd64). |
4882 | code size by roughly 30% on amd64). |
4470 | |
4883 | |
4471 | When optimising for size, use of compiler flags such as C<-Os> with |
4884 | When optimising for size, use of compiler flags such as C<-Os> with |
4472 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4885 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4473 | assertions. |
4886 | assertions. |
|
|
4887 | |
|
|
4888 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4889 | (e.g. gcc with C<-Os>). |
4474 | |
4890 | |
4475 | =item C<2> - faster/larger data structures |
4891 | =item C<2> - faster/larger data structures |
4476 | |
4892 | |
4477 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4893 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4478 | hash table sizes and so on. This will usually further increase code size |
4894 | hash table sizes and so on. This will usually further increase code size |
4479 | and can additionally have an effect on the size of data structures at |
4895 | and can additionally have an effect on the size of data structures at |
4480 | runtime. |
4896 | runtime. |
4481 | |
4897 | |
|
|
4898 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4899 | (e.g. gcc with C<-Os>). |
|
|
4900 | |
4482 | =item C<4> - full API configuration |
4901 | =item C<4> - full API configuration |
4483 | |
4902 | |
4484 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4903 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4485 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4904 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4486 | |
4905 | |
… | |
… | |
4516 | |
4935 | |
4517 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4936 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4518 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4937 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4519 | your program might be left out as well - a binary starting a timer and an |
4938 | your program might be left out as well - a binary starting a timer and an |
4520 | I/O watcher then might come out at only 5Kb. |
4939 | I/O watcher then might come out at only 5Kb. |
|
|
4940 | |
|
|
4941 | =item EV_API_STATIC |
|
|
4942 | |
|
|
4943 | If this symbol is defined (by default it is not), then all identifiers |
|
|
4944 | will have static linkage. This means that libev will not export any |
|
|
4945 | identifiers, and you cannot link against libev anymore. This can be useful |
|
|
4946 | when you embed libev, only want to use libev functions in a single file, |
|
|
4947 | and do not want its identifiers to be visible. |
|
|
4948 | |
|
|
4949 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
|
|
4950 | wants to use libev. |
|
|
4951 | |
|
|
4952 | This option only works when libev is compiled with a C compiler, as C++ |
|
|
4953 | doesn't support the required declaration syntax. |
4521 | |
4954 | |
4522 | =item EV_AVOID_STDIO |
4955 | =item EV_AVOID_STDIO |
4523 | |
4956 | |
4524 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4957 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4525 | functions (printf, scanf, perror etc.). This will increase the code size |
4958 | functions (printf, scanf, perror etc.). This will increase the code size |
… | |
… | |
4583 | in. If set to C<1>, then verification code will be compiled in, but not |
5016 | in. If set to C<1>, then verification code will be compiled in, but not |
4584 | called. If set to C<2>, then the internal verification code will be |
5017 | called. If set to C<2>, then the internal verification code will be |
4585 | called once per loop, which can slow down libev. If set to C<3>, then the |
5018 | called once per loop, which can slow down libev. If set to C<3>, then the |
4586 | verification code will be called very frequently, which will slow down |
5019 | verification code will be called very frequently, which will slow down |
4587 | libev considerably. |
5020 | libev considerably. |
|
|
5021 | |
|
|
5022 | Verification errors are reported via C's C<assert> mechanism, so if you |
|
|
5023 | disable that (e.g. by defining C<NDEBUG>) then no errors will be reported. |
4588 | |
5024 | |
4589 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
5025 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
4590 | will be C<0>. |
5026 | will be C<0>. |
4591 | |
5027 | |
4592 | =item EV_COMMON |
5028 | =item EV_COMMON |
… | |
… | |
4730 | default loop and triggering an C<ev_async> watcher from the default loop |
5166 | default loop and triggering an C<ev_async> watcher from the default loop |
4731 | watcher callback into the event loop interested in the signal. |
5167 | watcher callback into the event loop interested in the signal. |
4732 | |
5168 | |
4733 | =back |
5169 | =back |
4734 | |
5170 | |
4735 | See also L<THREAD LOCKING EXAMPLE>. |
5171 | See also L</THREAD LOCKING EXAMPLE>. |
4736 | |
5172 | |
4737 | =head3 COROUTINES |
5173 | =head3 COROUTINES |
4738 | |
5174 | |
4739 | Libev is very accommodating to coroutines ("cooperative threads"): |
5175 | Libev is very accommodating to coroutines ("cooperative threads"): |
4740 | libev fully supports nesting calls to its functions from different |
5176 | libev fully supports nesting calls to its functions from different |
… | |
… | |
5009 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5445 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5010 | assumes that the same (machine) code can be used to call any watcher |
5446 | assumes that the same (machine) code can be used to call any watcher |
5011 | callback: The watcher callbacks have different type signatures, but libev |
5447 | callback: The watcher callbacks have different type signatures, but libev |
5012 | calls them using an C<ev_watcher *> internally. |
5448 | calls them using an C<ev_watcher *> internally. |
5013 | |
5449 | |
|
|
5450 | =item null pointers and integer zero are represented by 0 bytes |
|
|
5451 | |
|
|
5452 | Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and |
|
|
5453 | relies on this setting pointers and integers to null. |
|
|
5454 | |
5014 | =item pointer accesses must be thread-atomic |
5455 | =item pointer accesses must be thread-atomic |
5015 | |
5456 | |
5016 | Accessing a pointer value must be atomic, it must both be readable and |
5457 | Accessing a pointer value must be atomic, it must both be readable and |
5017 | writable in one piece - this is the case on all current architectures. |
5458 | writable in one piece - this is the case on all current architectures. |
5018 | |
5459 | |
… | |
… | |
5031 | thread" or will block signals process-wide, both behaviours would |
5472 | thread" or will block signals process-wide, both behaviours would |
5032 | be compatible with libev. Interaction between C<sigprocmask> and |
5473 | be compatible with libev. Interaction between C<sigprocmask> and |
5033 | C<pthread_sigmask> could complicate things, however. |
5474 | C<pthread_sigmask> could complicate things, however. |
5034 | |
5475 | |
5035 | The most portable way to handle signals is to block signals in all threads |
5476 | The most portable way to handle signals is to block signals in all threads |
5036 | except the initial one, and run the default loop in the initial thread as |
5477 | except the initial one, and run the signal handling loop in the initial |
5037 | well. |
5478 | thread as well. |
5038 | |
5479 | |
5039 | =item C<long> must be large enough for common memory allocation sizes |
5480 | =item C<long> must be large enough for common memory allocation sizes |
5040 | |
5481 | |
5041 | To improve portability and simplify its API, libev uses C<long> internally |
5482 | To improve portability and simplify its API, libev uses C<long> internally |
5042 | instead of C<size_t> when allocating its data structures. On non-POSIX |
5483 | instead of C<size_t> when allocating its data structures. On non-POSIX |
… | |
… | |
5051 | good enough for at least into the year 4000 with millisecond accuracy |
5492 | good enough for at least into the year 4000 with millisecond accuracy |
5052 | (the design goal for libev). This requirement is overfulfilled by |
5493 | (the design goal for libev). This requirement is overfulfilled by |
5053 | implementations using IEEE 754, which is basically all existing ones. |
5494 | implementations using IEEE 754, which is basically all existing ones. |
5054 | |
5495 | |
5055 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
5496 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
5056 | year 2255 (and millisecond accuray till the year 287396 - by then, libev |
5497 | year 2255 (and millisecond accuracy till the year 287396 - by then, libev |
5057 | is either obsolete or somebody patched it to use C<long double> or |
5498 | is either obsolete or somebody patched it to use C<long double> or |
5058 | something like that, just kidding). |
5499 | something like that, just kidding). |
5059 | |
5500 | |
5060 | =back |
5501 | =back |
5061 | |
5502 | |
… | |
… | |
5146 | =over 4 |
5587 | =over 4 |
5147 | |
5588 | |
5148 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5589 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5149 | |
5590 | |
5150 | The backward compatibility mechanism can be controlled by |
5591 | The backward compatibility mechanism can be controlled by |
5151 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
5592 | C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING> |
5152 | section. |
5593 | section. |
5153 | |
5594 | |
5154 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5595 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5155 | |
5596 | |
5156 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5597 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
… | |
… | |
5199 | =over 4 |
5640 | =over 4 |
5200 | |
5641 | |
5201 | =item active |
5642 | =item active |
5202 | |
5643 | |
5203 | A watcher is active as long as it has been started and not yet stopped. |
5644 | A watcher is active as long as it has been started and not yet stopped. |
5204 | See L<WATCHER STATES> for details. |
5645 | See L</WATCHER STATES> for details. |
5205 | |
5646 | |
5206 | =item application |
5647 | =item application |
5207 | |
5648 | |
5208 | In this document, an application is whatever is using libev. |
5649 | In this document, an application is whatever is using libev. |
5209 | |
5650 | |
… | |
… | |
5245 | watchers and events. |
5686 | watchers and events. |
5246 | |
5687 | |
5247 | =item pending |
5688 | =item pending |
5248 | |
5689 | |
5249 | A watcher is pending as soon as the corresponding event has been |
5690 | A watcher is pending as soon as the corresponding event has been |
5250 | detected. See L<WATCHER STATES> for details. |
5691 | detected. See L</WATCHER STATES> for details. |
5251 | |
5692 | |
5252 | =item real time |
5693 | =item real time |
5253 | |
5694 | |
5254 | The physical time that is observed. It is apparently strictly monotonic :) |
5695 | The physical time that is observed. It is apparently strictly monotonic :) |
5255 | |
5696 | |