|
|
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> |
… | |
… | |
486 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
515 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
487 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
516 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
488 | |
517 | |
489 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
518 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
490 | |
519 | |
491 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
520 | Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
492 | kernels). |
521 | kernels). |
493 | |
522 | |
494 | For few fds, this backend is a bit little slower than poll and select, but |
523 | 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 |
524 | 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 |
525 | 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 |
571 | 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 |
572 | faster than epoll for maybe up to a hundred file descriptors, depending on |
544 | the usage. So sad. |
573 | the usage. So sad. |
545 | |
574 | |
546 | While nominally embeddable in other event loops, this feature is broken in |
575 | While nominally embeddable in other event loops, this feature is broken in |
547 | all kernel versions tested so far. |
576 | a lot of kernel revisions, but probably(!) works in current versions. |
548 | |
577 | |
549 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
578 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
550 | C<EVBACKEND_POLL>. |
579 | C<EVBACKEND_POLL>. |
551 | |
580 | |
|
|
581 | =item C<EVBACKEND_LINUXAIO> (value 64, Linux) |
|
|
582 | |
|
|
583 | Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<< |
|
|
584 | io_submit(2) >>) event interface available in post-4.18 kernels (but libev |
|
|
585 | only tries to use it in 4.19+). |
|
|
586 | |
|
|
587 | This is another Linux train wreck of an event interface. |
|
|
588 | |
|
|
589 | If this backend works for you (as of this writing, it was very |
|
|
590 | experimental), it is the best event interface available on Linux and might |
|
|
591 | be well worth enabling it - if it isn't available in your kernel this will |
|
|
592 | be detected and this backend will be skipped. |
|
|
593 | |
|
|
594 | This backend can batch oneshot requests and supports a user-space ring |
|
|
595 | buffer to receive events. It also doesn't suffer from most of the design |
|
|
596 | problems of epoll (such as not being able to remove event sources from |
|
|
597 | the epoll set), and generally sounds too good to be true. Because, this |
|
|
598 | being the Linux kernel, of course it suffers from a whole new set of |
|
|
599 | limitations, forcing you to fall back to epoll, inheriting all its design |
|
|
600 | issues. |
|
|
601 | |
|
|
602 | For one, it is not easily embeddable (but probably could be done using |
|
|
603 | an event fd at some extra overhead). It also is subject to a system wide |
|
|
604 | limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO |
|
|
605 | requests are left, this backend will be skipped during initialisation, and |
|
|
606 | will switch to epoll when the loop is active. |
|
|
607 | |
|
|
608 | Most problematic in practice, however, is that not all file descriptors |
|
|
609 | work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds, |
|
|
610 | files, F</dev/null> and many others are supported, but ttys do not work |
|
|
611 | properly (a known bug that the kernel developers don't care about, see |
|
|
612 | L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not |
|
|
613 | (yet?) a generic event polling interface. |
|
|
614 | |
|
|
615 | Overall, it seems the Linux developers just don't want it to have a |
|
|
616 | generic event handling mechanism other than C<select> or C<poll>. |
|
|
617 | |
|
|
618 | To work around all these problem, the current version of libev uses its |
|
|
619 | epoll backend as a fallback for file descriptor types that do not work. Or |
|
|
620 | falls back completely to epoll if the kernel acts up. |
|
|
621 | |
|
|
622 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
|
|
623 | C<EVBACKEND_POLL>. |
|
|
624 | |
552 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
625 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
553 | |
626 | |
554 | Kqueue deserves special mention, as at the time of this writing, it |
627 | 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 |
628 | 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 |
629 | work reliably with anything but sockets and pipes, except on Darwin, |
557 | it's completely useless). Unlike epoll, however, whose brokenness |
630 | where of course it's completely useless). Unlike epoll, however, whose |
558 | is by design, these kqueue bugs can (and eventually will) be fixed |
631 | 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 |
632 | 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 |
633 | 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) |
634 | in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a |
562 | system like NetBSD. |
635 | known-to-be-good (-enough) system like NetBSD. |
563 | |
636 | |
564 | You still can embed kqueue into a normal poll or select backend and use it |
637 | 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 |
638 | 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. |
639 | the target platform). See C<ev_embed> watchers for more info. |
567 | |
640 | |
568 | It scales in the same way as the epoll backend, but the interface to the |
641 | 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 |
642 | 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 |
643 | 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 |
644 | 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 |
645 | 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 |
646 | might have to leak fds on fork, but it's more sane than epoll) and it |
574 | cases |
647 | drops fds silently in similarly hard-to-detect cases. |
575 | |
648 | |
576 | This backend usually performs well under most conditions. |
649 | This backend usually performs well under most conditions. |
577 | |
650 | |
578 | While nominally embeddable in other event loops, this doesn't work |
651 | 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 |
652 | 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 |
726 | Example: Use whatever libev has to offer, but make sure that kqueue is |
654 | used if available. |
727 | used if available. |
655 | |
728 | |
656 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
729 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
657 | |
730 | |
|
|
731 | Example: Similarly, on linux, you mgiht want to take advantage of the |
|
|
732 | linux aio backend if possible, but fall back to something else if that |
|
|
733 | isn't available. |
|
|
734 | |
|
|
735 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO); |
|
|
736 | |
658 | =item ev_loop_destroy (loop) |
737 | =item ev_loop_destroy (loop) |
659 | |
738 | |
660 | Destroys an event loop object (frees all memory and kernel state |
739 | 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 |
740 | 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 |
741 | 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> |
757 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
679 | and C<ev_loop_destroy>. |
758 | and C<ev_loop_destroy>. |
680 | |
759 | |
681 | =item ev_loop_fork (loop) |
760 | =item ev_loop_fork (loop) |
682 | |
761 | |
683 | This function sets a flag that causes subsequent C<ev_run> iterations to |
762 | This function sets a flag that causes subsequent C<ev_run> iterations |
684 | reinitialise the kernel state for backends that have one. Despite the |
763 | 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 |
764 | 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 |
765 | watchers (except inside an C<ev_prepare> callback), but it makes most |
|
|
766 | sense after forking, in the child process. You I<must> call it (or use |
687 | child before resuming or calling C<ev_run>. |
767 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
688 | |
768 | |
|
|
769 | In addition, if you want to reuse a loop (via this function or |
|
|
770 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
|
|
771 | |
689 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
772 | 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 |
773 | 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 |
774 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
692 | during fork. |
775 | during fork. |
693 | |
776 | |
694 | On the other hand, you only need to call this function in the child |
777 | On the other hand, you only need to call this function in the child |
… | |
… | |
764 | |
847 | |
765 | This function is rarely useful, but when some event callback runs for a |
848 | 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 |
849 | very long time without entering the event loop, updating libev's idea of |
767 | the current time is a good idea. |
850 | the current time is a good idea. |
768 | |
851 | |
769 | See also L<The special problem of time updates> in the C<ev_timer> section. |
852 | See also L</The special problem of time updates> in the C<ev_timer> section. |
770 | |
853 | |
771 | =item ev_suspend (loop) |
854 | =item ev_suspend (loop) |
772 | |
855 | |
773 | =item ev_resume (loop) |
856 | =item ev_resume (loop) |
774 | |
857 | |
… | |
… | |
792 | without a previous call to C<ev_suspend>. |
875 | without a previous call to C<ev_suspend>. |
793 | |
876 | |
794 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
877 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
795 | event loop time (see C<ev_now_update>). |
878 | event loop time (see C<ev_now_update>). |
796 | |
879 | |
797 | =item ev_run (loop, int flags) |
880 | =item bool ev_run (loop, int flags) |
798 | |
881 | |
799 | Finally, this is it, the event handler. This function usually is called |
882 | 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 |
883 | 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 |
884 | 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 |
885 | the watcher callbacks, and then repeat the whole process indefinitely: This |
803 | is why event loops are called I<loops>. |
886 | is why event loops are called I<loops>. |
804 | |
887 | |
805 | If the flags argument is specified as C<0>, it will keep handling events |
888 | 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 |
889 | until either no event watchers are active anymore or C<ev_break> was |
807 | called. |
890 | called. |
|
|
891 | |
|
|
892 | The return value is false if there are no more active watchers (which |
|
|
893 | usually means "all jobs done" or "deadlock"), and true in all other cases |
|
|
894 | (which usually means " you should call C<ev_run> again"). |
808 | |
895 | |
809 | Please note that an explicit C<ev_break> is usually better than |
896 | 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 |
897 | relying on all watchers to be stopped when deciding when a program has |
811 | finished (especially in interactive programs), but having a program |
898 | finished (especially in interactive programs), but having a program |
812 | that automatically loops as long as it has to and no longer by virtue |
899 | 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 |
900 | of relying on its watchers stopping correctly, that is truly a thing of |
814 | beauty. |
901 | beauty. |
815 | |
902 | |
816 | This function is also I<mostly> exception-safe - you can break out of |
903 | 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++ |
904 | 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 |
905 | exception and so on. This does not decrement the C<ev_depth> value, nor |
819 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
906 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
820 | |
907 | |
821 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
908 | 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 |
909 | those events and any already outstanding ones, but will not wait and |
… | |
… | |
1012 | invoke the actual watchers inside another context (another thread etc.). |
1099 | invoke the actual watchers inside another context (another thread etc.). |
1013 | |
1100 | |
1014 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1101 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1015 | callback. |
1102 | callback. |
1016 | |
1103 | |
1017 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
1104 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ()) |
1018 | |
1105 | |
1019 | Sometimes you want to share the same loop between multiple threads. This |
1106 | 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 |
1107 | can be done relatively simply by putting mutex_lock/unlock calls around |
1021 | each call to a libev function. |
1108 | each call to a libev function. |
1022 | |
1109 | |
1023 | However, C<ev_run> can run an indefinite time, so it is not feasible |
1110 | 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 |
1111 | 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 |
1112 | 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. |
1113 | I<release> and I<acquire> callbacks on the loop. |
1027 | |
1114 | |
1028 | When set, then C<release> will be called just before the thread is |
1115 | 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 |
1116 | suspended waiting for new events, and C<acquire> is called just |
1030 | afterwards. |
1117 | afterwards. |
… | |
… | |
1170 | |
1257 | |
1171 | =item C<EV_PREPARE> |
1258 | =item C<EV_PREPARE> |
1172 | |
1259 | |
1173 | =item C<EV_CHECK> |
1260 | =item C<EV_CHECK> |
1174 | |
1261 | |
1175 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts |
1262 | 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 |
1263 | 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 |
1264 | just after C<ev_run> has gathered them, but before it queues any callbacks |
|
|
1265 | for any received events. That means C<ev_prepare> watchers are the last |
|
|
1266 | watchers invoked before the event loop sleeps or polls for new events, and |
|
|
1267 | C<ev_check> watchers will be invoked before any other watchers of the same |
|
|
1268 | or lower priority within an event loop iteration. |
|
|
1269 | |
1178 | received events. Callbacks of both watcher types can start and stop as |
1270 | 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 |
1271 | 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 |
1272 | C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from |
1181 | C<ev_run> from blocking). |
1273 | blocking). |
1182 | |
1274 | |
1183 | =item C<EV_EMBED> |
1275 | =item C<EV_EMBED> |
1184 | |
1276 | |
1185 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1277 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1186 | |
1278 | |
… | |
… | |
1309 | |
1401 | |
1310 | =item callback ev_cb (ev_TYPE *watcher) |
1402 | =item callback ev_cb (ev_TYPE *watcher) |
1311 | |
1403 | |
1312 | Returns the callback currently set on the watcher. |
1404 | Returns the callback currently set on the watcher. |
1313 | |
1405 | |
1314 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1406 | =item ev_set_cb (ev_TYPE *watcher, callback) |
1315 | |
1407 | |
1316 | Change the callback. You can change the callback at virtually any time |
1408 | Change the callback. You can change the callback at virtually any time |
1317 | (modulo threads). |
1409 | (modulo threads). |
1318 | |
1410 | |
1319 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1411 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
… | |
… | |
1337 | or might not have been clamped to the valid range. |
1429 | or might not have been clamped to the valid range. |
1338 | |
1430 | |
1339 | The default priority used by watchers when no priority has been set is |
1431 | 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 :). |
1432 | always C<0>, which is supposed to not be too high and not be too low :). |
1341 | |
1433 | |
1342 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1434 | See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1343 | priorities. |
1435 | priorities. |
1344 | |
1436 | |
1345 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1437 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1346 | |
1438 | |
1347 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1439 | 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 |
1464 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1373 | functions that do not need a watcher. |
1465 | functions that do not need a watcher. |
1374 | |
1466 | |
1375 | =back |
1467 | =back |
1376 | |
1468 | |
1377 | See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR |
1469 | See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR |
1378 | OWN COMPOSITE WATCHERS> idioms. |
1470 | OWN COMPOSITE WATCHERS> idioms. |
1379 | |
1471 | |
1380 | =head2 WATCHER STATES |
1472 | =head2 WATCHER STATES |
1381 | |
1473 | |
1382 | There are various watcher states mentioned throughout this manual - |
1474 | There are various watcher states mentioned throughout this manual - |
… | |
… | |
1384 | transition between them will be described in more detail - and while these |
1476 | transition between them will be described in more detail - and while these |
1385 | rules might look complicated, they usually do "the right thing". |
1477 | rules might look complicated, they usually do "the right thing". |
1386 | |
1478 | |
1387 | =over 4 |
1479 | =over 4 |
1388 | |
1480 | |
1389 | =item initialiased |
1481 | =item initialised |
1390 | |
1482 | |
1391 | Before a watcher can be registered with the event loop it has to be |
1483 | 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 |
1484 | 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. |
1485 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1394 | |
1486 | |
… | |
… | |
1443 | |
1535 | |
1444 | Many event loops support I<watcher priorities>, which are usually small |
1536 | Many event loops support I<watcher priorities>, which are usually small |
1445 | integers that influence the ordering of event callback invocation |
1537 | integers that influence the ordering of event callback invocation |
1446 | between watchers in some way, all else being equal. |
1538 | between watchers in some way, all else being equal. |
1447 | |
1539 | |
1448 | In libev, Watcher priorities can be set using C<ev_set_priority>. See its |
1540 | 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 |
1541 | description for the more technical details such as the actual priority |
1450 | range. |
1542 | range. |
1451 | |
1543 | |
1452 | There are two common ways how these these priorities are being interpreted |
1544 | There are two common ways how these these priorities are being interpreted |
1453 | by event loops: |
1545 | by event loops: |
… | |
… | |
1592 | |
1684 | |
1593 | But really, best use non-blocking mode. |
1685 | But really, best use non-blocking mode. |
1594 | |
1686 | |
1595 | =head3 The special problem of disappearing file descriptors |
1687 | =head3 The special problem of disappearing file descriptors |
1596 | |
1688 | |
1597 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1689 | 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, |
1690 | 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 |
1691 | 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 |
1692 | 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 |
1693 | 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 |
1694 | is registered with libev, there is no efficient way to see that this is, |
1603 | fact, a different file descriptor. |
1695 | in fact, a different file descriptor. |
1604 | |
1696 | |
1605 | To avoid having to explicitly tell libev about such cases, libev follows |
1697 | 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 |
1698 | 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 |
1699 | 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 |
1700 | 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 |
1749 | when you rarely read from a file instead of from a socket, and want to |
1658 | reuse the same code path. |
1750 | reuse the same code path. |
1659 | |
1751 | |
1660 | =head3 The special problem of fork |
1752 | =head3 The special problem of fork |
1661 | |
1753 | |
1662 | Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit |
1754 | Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()> |
1663 | useless behaviour. Libev fully supports fork, but needs to be told about |
1755 | 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. |
1756 | to be told about it in the child if you want to continue to use it in the |
|
|
1757 | child. |
1665 | |
1758 | |
1666 | To support fork in your child processes, you have to call C<ev_loop_fork |
1759 | 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 |
1760 | ()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to |
1668 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1761 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1669 | |
1762 | |
… | |
… | |
1860 | |
1953 | |
1861 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1954 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1862 | but remember the time of last activity, and check for a real timeout only |
1955 | but remember the time of last activity, and check for a real timeout only |
1863 | within the callback: |
1956 | within the callback: |
1864 | |
1957 | |
|
|
1958 | ev_tstamp timeout = 60.; |
1865 | ev_tstamp last_activity; // time of last activity |
1959 | ev_tstamp last_activity; // time of last activity |
|
|
1960 | ev_timer timer; |
1866 | |
1961 | |
1867 | static void |
1962 | static void |
1868 | callback (EV_P_ ev_timer *w, int revents) |
1963 | callback (EV_P_ ev_timer *w, int revents) |
1869 | { |
1964 | { |
1870 | ev_tstamp now = ev_now (EV_A); |
1965 | // calculate when the timeout would happen |
1871 | ev_tstamp timeout = last_activity + 60.; |
1966 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1872 | |
1967 | |
1873 | // if last_activity + 60. is older than now, we did time out |
1968 | // if negative, it means we the timeout already occurred |
1874 | if (timeout < now) |
1969 | if (after < 0.) |
1875 | { |
1970 | { |
1876 | // timeout occurred, take action |
1971 | // timeout occurred, take action |
1877 | } |
1972 | } |
1878 | else |
1973 | else |
1879 | { |
1974 | { |
1880 | // callback was invoked, but there was some activity, re-arm |
1975 | // callback was invoked, but there was some recent |
1881 | // the watcher to fire in last_activity + 60, which is |
1976 | // activity. simply restart the timer to time out |
1882 | // guaranteed to be in the future, so "again" is positive: |
1977 | // after "after" seconds, which is the earliest time |
1883 | w->repeat = timeout - now; |
1978 | // the timeout can occur. |
|
|
1979 | ev_timer_set (w, after, 0.); |
1884 | ev_timer_again (EV_A_ w); |
1980 | ev_timer_start (EV_A_ w); |
1885 | } |
1981 | } |
1886 | } |
1982 | } |
1887 | |
1983 | |
1888 | To summarise the callback: first calculate the real timeout (defined |
1984 | To summarise the callback: first calculate in how many seconds the |
1889 | as "60 seconds after the last activity"), then check if that time has |
1985 | timeout will occur (by calculating the absolute time when it would occur, |
1890 | been reached, which means something I<did>, in fact, time out. Otherwise |
1986 | C<last_activity + timeout>, and subtracting the current time, C<ev_now |
1891 | the callback was invoked too early (C<timeout> is in the future), so |
1987 | (EV_A)> from that). |
1892 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1893 | a timeout then. |
|
|
1894 | |
1988 | |
1895 | Note how C<ev_timer_again> is used, taking advantage of the |
1989 | If this value is negative, then we are already past the timeout, i.e. we |
1896 | C<ev_timer_again> optimisation when the timer is already running. |
1990 | timed out, and need to do whatever is needed in this case. |
|
|
1991 | |
|
|
1992 | Otherwise, we now the earliest time at which the timeout would trigger, |
|
|
1993 | and simply start the timer with this timeout value. |
|
|
1994 | |
|
|
1995 | In other words, each time the callback is invoked it will check whether |
|
|
1996 | the timeout occurred. If not, it will simply reschedule itself to check |
|
|
1997 | again at the earliest time it could time out. Rinse. Repeat. |
1897 | |
1998 | |
1898 | This scheme causes more callback invocations (about one every 60 seconds |
1999 | This scheme causes more callback invocations (about one every 60 seconds |
1899 | minus half the average time between activity), but virtually no calls to |
2000 | minus half the average time between activity), but virtually no calls to |
1900 | libev to change the timeout. |
2001 | libev to change the timeout. |
1901 | |
2002 | |
1902 | To start the timer, simply initialise the watcher and set C<last_activity> |
2003 | To start the machinery, simply initialise the watcher and set |
1903 | to the current time (meaning we just have some activity :), then call the |
2004 | C<last_activity> to the current time (meaning there was some activity just |
1904 | callback, which will "do the right thing" and start the timer: |
2005 | now), then call the callback, which will "do the right thing" and start |
|
|
2006 | the timer: |
1905 | |
2007 | |
|
|
2008 | last_activity = ev_now (EV_A); |
1906 | ev_init (timer, callback); |
2009 | ev_init (&timer, callback); |
1907 | last_activity = ev_now (loop); |
2010 | callback (EV_A_ &timer, 0); |
1908 | callback (loop, timer, EV_TIMER); |
|
|
1909 | |
2011 | |
1910 | And when there is some activity, simply store the current time in |
2012 | When there is some activity, simply store the current time in |
1911 | C<last_activity>, no libev calls at all: |
2013 | C<last_activity>, no libev calls at all: |
1912 | |
2014 | |
|
|
2015 | if (activity detected) |
1913 | last_activity = ev_now (loop); |
2016 | last_activity = ev_now (EV_A); |
|
|
2017 | |
|
|
2018 | When your timeout value changes, then the timeout can be changed by simply |
|
|
2019 | providing a new value, stopping the timer and calling the callback, which |
|
|
2020 | will again do the right thing (for example, time out immediately :). |
|
|
2021 | |
|
|
2022 | timeout = new_value; |
|
|
2023 | ev_timer_stop (EV_A_ &timer); |
|
|
2024 | callback (EV_A_ &timer, 0); |
1914 | |
2025 | |
1915 | This technique is slightly more complex, but in most cases where the |
2026 | This technique is slightly more complex, but in most cases where the |
1916 | time-out is unlikely to be triggered, much more efficient. |
2027 | time-out is unlikely to be triggered, much more efficient. |
1917 | |
|
|
1918 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1919 | callback :) - just change the timeout and invoke the callback, which will |
|
|
1920 | fix things for you. |
|
|
1921 | |
2028 | |
1922 | =item 4. Wee, just use a double-linked list for your timeouts. |
2029 | =item 4. Wee, just use a double-linked list for your timeouts. |
1923 | |
2030 | |
1924 | If there is not one request, but many thousands (millions...), all |
2031 | If there is not one request, but many thousands (millions...), all |
1925 | employing some kind of timeout with the same timeout value, then one can |
2032 | employing some kind of timeout with the same timeout value, then one can |
… | |
… | |
1958 | |
2065 | |
1959 | If you ask a timer to call your callback after three seconds, then |
2066 | If you ask a timer to call your callback after three seconds, then |
1960 | you expect it to be invoked after three seconds - but of course, this |
2067 | you expect it to be invoked after three seconds - but of course, this |
1961 | cannot be guaranteed to infinite precision. Less obviously, it cannot be |
2068 | cannot be guaranteed to infinite precision. Less obviously, it cannot be |
1962 | guaranteed to any precision by libev - imagine somebody suspending the |
2069 | guaranteed to any precision by libev - imagine somebody suspending the |
1963 | process a STOP signal for a few hours for example. |
2070 | process with a STOP signal for a few hours for example. |
1964 | |
2071 | |
1965 | So, libev tries to invoke your callback as soon as possible I<after> the |
2072 | So, libev tries to invoke your callback as soon as possible I<after> the |
1966 | delay has occured, but cannot guarantee this. |
2073 | delay has occurred, but cannot guarantee this. |
1967 | |
2074 | |
1968 | A less obvious failure mode is calling your callback too early: many event |
2075 | A less obvious failure mode is calling your callback too early: many event |
1969 | loops compare timestamps with a "elapsed delay >= requested delay", but |
2076 | loops compare timestamps with a "elapsed delay >= requested delay", but |
1970 | this can cause your callback to be invoked much earlier than you would |
2077 | this can cause your callback to be invoked much earlier than you would |
1971 | expect. |
2078 | expect. |
… | |
… | |
1991 | delay has actually elapsed, or in other words, it always errs on the "too |
2098 | delay has actually elapsed, or in other words, it always errs on the "too |
1992 | late" side of things. |
2099 | late" side of things. |
1993 | |
2100 | |
1994 | =head3 The special problem of time updates |
2101 | =head3 The special problem of time updates |
1995 | |
2102 | |
1996 | Establishing the current time is a costly operation (it usually takes at |
2103 | Establishing the current time is a costly operation (it usually takes |
1997 | least two system calls): EV therefore updates its idea of the current |
2104 | at least one system call): EV therefore updates its idea of the current |
1998 | time only before and after C<ev_run> collects new events, which causes a |
2105 | time only before and after C<ev_run> collects new events, which causes a |
1999 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
2106 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
2000 | lots of events in one iteration. |
2107 | lots of events in one iteration. |
2001 | |
2108 | |
2002 | The relative timeouts are calculated relative to the C<ev_now ()> |
2109 | The relative timeouts are calculated relative to the C<ev_now ()> |
2003 | time. This is usually the right thing as this timestamp refers to the time |
2110 | time. This is usually the right thing as this timestamp refers to the time |
2004 | of the event triggering whatever timeout you are modifying/starting. If |
2111 | of the event triggering whatever timeout you are modifying/starting. If |
2005 | you suspect event processing to be delayed and you I<need> to base the |
2112 | you suspect event processing to be delayed and you I<need> to base the |
2006 | timeout on the current time, use something like this to adjust for this: |
2113 | timeout on the current time, use something like the following to adjust |
|
|
2114 | for it: |
2007 | |
2115 | |
2008 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2116 | ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.); |
2009 | |
2117 | |
2010 | If the event loop is suspended for a long time, you can also force an |
2118 | If the event loop is suspended for a long time, you can also force an |
2011 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2119 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2012 | ()>. |
2120 | ()>, although that will push the event time of all outstanding events |
|
|
2121 | further into the future. |
2013 | |
2122 | |
2014 | =head3 The special problem of unsychronised clocks |
2123 | =head3 The special problem of unsynchronised clocks |
2015 | |
2124 | |
2016 | Modern systems have a variety of clocks - libev itself uses the normal |
2125 | Modern systems have a variety of clocks - libev itself uses the normal |
2017 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
2126 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
2018 | jumps). |
2127 | jumps). |
2019 | |
2128 | |
… | |
… | |
2023 | a call to C<gettimeofday> might return a second count that is one higher |
2132 | a call to C<gettimeofday> might return a second count that is one higher |
2024 | than a directly following call to C<time>. |
2133 | than a directly following call to C<time>. |
2025 | |
2134 | |
2026 | The moral of this is to only compare libev-related timestamps with |
2135 | The moral of this is to only compare libev-related timestamps with |
2027 | C<ev_time ()> and C<ev_now ()>, at least if you want better precision than |
2136 | C<ev_time ()> and C<ev_now ()>, at least if you want better precision than |
2028 | a seocnd or so. |
2137 | a second or so. |
2029 | |
2138 | |
2030 | One more problem arises due to this lack of synchronisation: if libev uses |
2139 | One more problem arises due to this lack of synchronisation: if libev uses |
2031 | the system monotonic clock and you compare timestamps from C<ev_time> |
2140 | the system monotonic clock and you compare timestamps from C<ev_time> |
2032 | or C<ev_now> from when you started your timer and when your callback is |
2141 | or C<ev_now> from when you started your timer and when your callback is |
2033 | invoked, you will find that sometimes the callback is a bit "early". |
2142 | invoked, you will find that sometimes the callback is a bit "early". |
… | |
… | |
2080 | |
2189 | |
2081 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2190 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2082 | |
2191 | |
2083 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2192 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2084 | |
2193 | |
2085 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
2194 | Configure the timer to trigger after C<after> seconds (fractional and |
2086 | is C<0.>, then it will automatically be stopped once the timeout is |
2195 | negative values are supported). If C<repeat> is C<0.>, then it will |
2087 | reached. If it is positive, then the timer will automatically be |
2196 | automatically be stopped once the timeout is reached. If it is positive, |
2088 | configured to trigger again C<repeat> seconds later, again, and again, |
2197 | then the timer will automatically be configured to trigger again C<repeat> |
2089 | until stopped manually. |
2198 | seconds later, again, and again, until stopped manually. |
2090 | |
2199 | |
2091 | The timer itself will do a best-effort at avoiding drift, that is, if |
2200 | The timer itself will do a best-effort at avoiding drift, that is, if |
2092 | you configure a timer to trigger every 10 seconds, then it will normally |
2201 | you configure a timer to trigger every 10 seconds, then it will normally |
2093 | trigger at exactly 10 second intervals. If, however, your program cannot |
2202 | trigger at exactly 10 second intervals. If, however, your program cannot |
2094 | keep up with the timer (because it takes longer than those 10 seconds to |
2203 | keep up with the timer (because it takes longer than those 10 seconds to |
2095 | do stuff) the timer will not fire more than once per event loop iteration. |
2204 | do stuff) the timer will not fire more than once per event loop iteration. |
2096 | |
2205 | |
2097 | =item ev_timer_again (loop, ev_timer *) |
2206 | =item ev_timer_again (loop, ev_timer *) |
2098 | |
2207 | |
2099 | This will act as if the timer timed out and restarts it again if it is |
2208 | This will act as if the timer timed out, and restarts it again if it is |
2100 | repeating. The exact semantics are: |
2209 | repeating. It basically works like calling C<ev_timer_stop>, updating the |
|
|
2210 | timeout to the C<repeat> value and calling C<ev_timer_start>. |
2101 | |
2211 | |
|
|
2212 | The exact semantics are as in the following rules, all of which will be |
|
|
2213 | applied to the watcher: |
|
|
2214 | |
|
|
2215 | =over 4 |
|
|
2216 | |
2102 | If the timer is pending, its pending status is cleared. |
2217 | =item If the timer is pending, the pending status is always cleared. |
2103 | |
2218 | |
2104 | If the timer is started but non-repeating, stop it (as if it timed out). |
2219 | =item If the timer is started but non-repeating, stop it (as if it timed |
|
|
2220 | out, without invoking it). |
2105 | |
2221 | |
2106 | If the timer is repeating, either start it if necessary (with the |
2222 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2107 | C<repeat> value), or reset the running timer to the C<repeat> value. |
2223 | and start the timer, if necessary. |
2108 | |
2224 | |
|
|
2225 | =back |
|
|
2226 | |
2109 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2227 | This sounds a bit complicated, see L</Be smart about timeouts>, above, for a |
2110 | usage example. |
2228 | usage example. |
2111 | |
2229 | |
2112 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2230 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2113 | |
2231 | |
2114 | Returns the remaining time until a timer fires. If the timer is active, |
2232 | Returns the remaining time until a timer fires. If the timer is active, |
… | |
… | |
2167 | Periodic watchers are also timers of a kind, but they are very versatile |
2285 | Periodic watchers are also timers of a kind, but they are very versatile |
2168 | (and unfortunately a bit complex). |
2286 | (and unfortunately a bit complex). |
2169 | |
2287 | |
2170 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2288 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2171 | relative time, the physical time that passes) but on wall clock time |
2289 | relative time, the physical time that passes) but on wall clock time |
2172 | (absolute time, the thing you can read on your calender or clock). The |
2290 | (absolute time, the thing you can read on your calendar or clock). The |
2173 | difference is that wall clock time can run faster or slower than real |
2291 | difference is that wall clock time can run faster or slower than real |
2174 | time, and time jumps are not uncommon (e.g. when you adjust your |
2292 | time, and time jumps are not uncommon (e.g. when you adjust your |
2175 | wrist-watch). |
2293 | wrist-watch). |
2176 | |
2294 | |
2177 | You can tell a periodic watcher to trigger after some specific point |
2295 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
2182 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2300 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2183 | it, as it uses a relative timeout). |
2301 | it, as it uses a relative timeout). |
2184 | |
2302 | |
2185 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2303 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2186 | timers, such as triggering an event on each "midnight, local time", or |
2304 | timers, such as triggering an event on each "midnight, local time", or |
2187 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
2305 | other complicated rules. This cannot easily be done with C<ev_timer> |
2188 | those cannot react to time jumps. |
2306 | watchers, as those cannot react to time jumps. |
2189 | |
2307 | |
2190 | As with timers, the callback is guaranteed to be invoked only when the |
2308 | As with timers, the callback is guaranteed to be invoked only when the |
2191 | point in time where it is supposed to trigger has passed. If multiple |
2309 | point in time where it is supposed to trigger has passed. If multiple |
2192 | timers become ready during the same loop iteration then the ones with |
2310 | timers become ready during the same loop iteration then the ones with |
2193 | earlier time-out values are invoked before ones with later time-out values |
2311 | earlier time-out values are invoked before ones with later time-out values |
… | |
… | |
2279 | |
2397 | |
2280 | NOTE: I<< This callback must always return a time that is higher than or |
2398 | NOTE: I<< This callback must always return a time that is higher than or |
2281 | equal to the passed C<now> value >>. |
2399 | equal to the passed C<now> value >>. |
2282 | |
2400 | |
2283 | This can be used to create very complex timers, such as a timer that |
2401 | This can be used to create very complex timers, such as a timer that |
2284 | triggers on "next midnight, local time". To do this, you would calculate the |
2402 | triggers on "next midnight, local time". To do this, you would calculate |
2285 | next midnight after C<now> and return the timestamp value for this. How |
2403 | the next midnight after C<now> and return the timestamp value for |
2286 | you do this is, again, up to you (but it is not trivial, which is the main |
2404 | this. Here is a (completely untested, no error checking) example on how to |
2287 | reason I omitted it as an example). |
2405 | do this: |
|
|
2406 | |
|
|
2407 | #include <time.h> |
|
|
2408 | |
|
|
2409 | static ev_tstamp |
|
|
2410 | my_rescheduler (ev_periodic *w, ev_tstamp now) |
|
|
2411 | { |
|
|
2412 | time_t tnow = (time_t)now; |
|
|
2413 | struct tm tm; |
|
|
2414 | localtime_r (&tnow, &tm); |
|
|
2415 | |
|
|
2416 | tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day |
|
|
2417 | ++tm.tm_mday; // midnight next day |
|
|
2418 | |
|
|
2419 | return mktime (&tm); |
|
|
2420 | } |
|
|
2421 | |
|
|
2422 | Note: this code might run into trouble on days that have more then two |
|
|
2423 | midnights (beginning and end). |
2288 | |
2424 | |
2289 | =back |
2425 | =back |
2290 | |
2426 | |
2291 | =item ev_periodic_again (loop, ev_periodic *) |
2427 | =item ev_periodic_again (loop, ev_periodic *) |
2292 | |
2428 | |
… | |
… | |
2357 | |
2493 | |
2358 | ev_periodic hourly_tick; |
2494 | ev_periodic hourly_tick; |
2359 | ev_periodic_init (&hourly_tick, clock_cb, |
2495 | ev_periodic_init (&hourly_tick, clock_cb, |
2360 | fmod (ev_now (loop), 3600.), 3600., 0); |
2496 | fmod (ev_now (loop), 3600.), 3600., 0); |
2361 | ev_periodic_start (loop, &hourly_tick); |
2497 | ev_periodic_start (loop, &hourly_tick); |
2362 | |
2498 | |
2363 | |
2499 | |
2364 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2500 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2365 | |
2501 | |
2366 | Signal watchers will trigger an event when the process receives a specific |
2502 | Signal watchers will trigger an event when the process receives a specific |
2367 | signal one or more times. Even though signals are very asynchronous, libev |
2503 | signal one or more times. Even though signals are very asynchronous, libev |
… | |
… | |
2377 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2513 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2378 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2514 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2379 | C<SIGINT> in both the default loop and another loop at the same time. At |
2515 | C<SIGINT> in both the default loop and another loop at the same time. At |
2380 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2516 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2381 | |
2517 | |
2382 | When the first watcher gets started will libev actually register something |
2518 | Only after the first watcher for a signal is started will libev actually |
2383 | with the kernel (thus it coexists with your own signal handlers as long as |
2519 | register something with the kernel. It thus coexists with your own signal |
2384 | you don't register any with libev for the same signal). |
2520 | handlers as long as you don't register any with libev for the same signal. |
2385 | |
2521 | |
2386 | If possible and supported, libev will install its handlers with |
2522 | If possible and supported, libev will install its handlers with |
2387 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2523 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2388 | not be unduly interrupted. If you have a problem with system calls getting |
2524 | not be unduly interrupted. If you have a problem with system calls getting |
2389 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2525 | interrupted by signals you can block all signals in an C<ev_check> watcher |
… | |
… | |
2574 | |
2710 | |
2575 | =head2 C<ev_stat> - did the file attributes just change? |
2711 | =head2 C<ev_stat> - did the file attributes just change? |
2576 | |
2712 | |
2577 | This watches a file system path for attribute changes. That is, it calls |
2713 | This watches a file system path for attribute changes. That is, it calls |
2578 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2714 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2579 | and sees if it changed compared to the last time, invoking the callback if |
2715 | and sees if it changed compared to the last time, invoking the callback |
2580 | it did. |
2716 | if it did. Starting the watcher C<stat>'s the file, so only changes that |
|
|
2717 | happen after the watcher has been started will be reported. |
2581 | |
2718 | |
2582 | The path does not need to exist: changing from "path exists" to "path does |
2719 | The path does not need to exist: changing from "path exists" to "path does |
2583 | not exist" is a status change like any other. The condition "path does not |
2720 | not exist" is a status change like any other. The condition "path does not |
2584 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2721 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2585 | C<st_nlink> field being zero (which is otherwise always forced to be at |
2722 | C<st_nlink> field being zero (which is otherwise always forced to be at |
… | |
… | |
2815 | Apart from keeping your process non-blocking (which is a useful |
2952 | Apart from keeping your process non-blocking (which is a useful |
2816 | effect on its own sometimes), idle watchers are a good place to do |
2953 | effect on its own sometimes), idle watchers are a good place to do |
2817 | "pseudo-background processing", or delay processing stuff to after the |
2954 | "pseudo-background processing", or delay processing stuff to after the |
2818 | event loop has handled all outstanding events. |
2955 | event loop has handled all outstanding events. |
2819 | |
2956 | |
|
|
2957 | =head3 Abusing an C<ev_idle> watcher for its side-effect |
|
|
2958 | |
|
|
2959 | As long as there is at least one active idle watcher, libev will never |
|
|
2960 | sleep unnecessarily. Or in other words, it will loop as fast as possible. |
|
|
2961 | For this to work, the idle watcher doesn't need to be invoked at all - the |
|
|
2962 | lowest priority will do. |
|
|
2963 | |
|
|
2964 | This mode of operation can be useful together with an C<ev_check> watcher, |
|
|
2965 | to do something on each event loop iteration - for example to balance load |
|
|
2966 | between different connections. |
|
|
2967 | |
|
|
2968 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
|
|
2969 | example. |
|
|
2970 | |
2820 | =head3 Watcher-Specific Functions and Data Members |
2971 | =head3 Watcher-Specific Functions and Data Members |
2821 | |
2972 | |
2822 | =over 4 |
2973 | =over 4 |
2823 | |
2974 | |
2824 | =item ev_idle_init (ev_idle *, callback) |
2975 | =item ev_idle_init (ev_idle *, callback) |
… | |
… | |
2835 | callback, free it. Also, use no error checking, as usual. |
2986 | callback, free it. Also, use no error checking, as usual. |
2836 | |
2987 | |
2837 | static void |
2988 | static void |
2838 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2989 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2839 | { |
2990 | { |
|
|
2991 | // stop the watcher |
|
|
2992 | ev_idle_stop (loop, w); |
|
|
2993 | |
|
|
2994 | // now we can free it |
2840 | free (w); |
2995 | free (w); |
|
|
2996 | |
2841 | // now do something you wanted to do when the program has |
2997 | // now do something you wanted to do when the program has |
2842 | // no longer anything immediate to do. |
2998 | // no longer anything immediate to do. |
2843 | } |
2999 | } |
2844 | |
3000 | |
2845 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
3001 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
… | |
… | |
2847 | ev_idle_start (loop, idle_watcher); |
3003 | ev_idle_start (loop, idle_watcher); |
2848 | |
3004 | |
2849 | |
3005 | |
2850 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
3006 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2851 | |
3007 | |
2852 | Prepare and check watchers are usually (but not always) used in pairs: |
3008 | Prepare and check watchers are often (but not always) used in pairs: |
2853 | prepare watchers get invoked before the process blocks and check watchers |
3009 | prepare watchers get invoked before the process blocks and check watchers |
2854 | afterwards. |
3010 | afterwards. |
2855 | |
3011 | |
2856 | You I<must not> call C<ev_run> or similar functions that enter |
3012 | You I<must not> call C<ev_run> (or similar functions that enter the |
2857 | the current event loop from either C<ev_prepare> or C<ev_check> |
3013 | current event loop) or C<ev_loop_fork> from either C<ev_prepare> or |
2858 | watchers. Other loops than the current one are fine, however. The |
3014 | C<ev_check> watchers. Other loops than the current one are fine, |
2859 | rationale behind this is that you do not need to check for recursion in |
3015 | however. The rationale behind this is that you do not need to check |
2860 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
3016 | for recursion in those watchers, i.e. the sequence will always be |
2861 | C<ev_check> so if you have one watcher of each kind they will always be |
3017 | C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each |
2862 | called in pairs bracketing the blocking call. |
3018 | kind they will always be called in pairs bracketing the blocking call. |
2863 | |
3019 | |
2864 | Their main purpose is to integrate other event mechanisms into libev and |
3020 | Their main purpose is to integrate other event mechanisms into libev and |
2865 | their use is somewhat advanced. They could be used, for example, to track |
3021 | their use is somewhat advanced. They could be used, for example, to track |
2866 | variable changes, implement your own watchers, integrate net-snmp or a |
3022 | variable changes, implement your own watchers, integrate net-snmp or a |
2867 | coroutine library and lots more. They are also occasionally useful if |
3023 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
2885 | with priority higher than or equal to the event loop and one coroutine |
3041 | with priority higher than or equal to the event loop and one coroutine |
2886 | of lower priority, but only once, using idle watchers to keep the event |
3042 | of lower priority, but only once, using idle watchers to keep the event |
2887 | loop from blocking if lower-priority coroutines are active, thus mapping |
3043 | loop from blocking if lower-priority coroutines are active, thus mapping |
2888 | low-priority coroutines to idle/background tasks). |
3044 | low-priority coroutines to idle/background tasks). |
2889 | |
3045 | |
2890 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
3046 | When used for this purpose, it is recommended to give C<ev_check> watchers |
2891 | priority, to ensure that they are being run before any other watchers |
3047 | highest (C<EV_MAXPRI>) priority, to ensure that they are being run before |
2892 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
3048 | any other watchers after the poll (this doesn't matter for C<ev_prepare> |
|
|
3049 | watchers). |
2893 | |
3050 | |
2894 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
3051 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2895 | activate ("feed") events into libev. While libev fully supports this, they |
3052 | activate ("feed") events into libev. While libev fully supports this, they |
2896 | might get executed before other C<ev_check> watchers did their job. As |
3053 | might get executed before other C<ev_check> watchers did their job. As |
2897 | C<ev_check> watchers are often used to embed other (non-libev) event |
3054 | C<ev_check> watchers are often used to embed other (non-libev) event |
2898 | loops those other event loops might be in an unusable state until their |
3055 | loops those other event loops might be in an unusable state until their |
2899 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
3056 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2900 | others). |
3057 | others). |
|
|
3058 | |
|
|
3059 | =head3 Abusing an C<ev_check> watcher for its side-effect |
|
|
3060 | |
|
|
3061 | C<ev_check> (and less often also C<ev_prepare>) watchers can also be |
|
|
3062 | useful because they are called once per event loop iteration. For |
|
|
3063 | example, if you want to handle a large number of connections fairly, you |
|
|
3064 | normally only do a bit of work for each active connection, and if there |
|
|
3065 | is more work to do, you wait for the next event loop iteration, so other |
|
|
3066 | connections have a chance of making progress. |
|
|
3067 | |
|
|
3068 | Using an C<ev_check> watcher is almost enough: it will be called on the |
|
|
3069 | next event loop iteration. However, that isn't as soon as possible - |
|
|
3070 | without external events, your C<ev_check> watcher will not be invoked. |
|
|
3071 | |
|
|
3072 | This is where C<ev_idle> watchers come in handy - all you need is a |
|
|
3073 | single global idle watcher that is active as long as you have one active |
|
|
3074 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
|
|
3075 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
|
|
3076 | invoked. Neither watcher alone can do that. |
2901 | |
3077 | |
2902 | =head3 Watcher-Specific Functions and Data Members |
3078 | =head3 Watcher-Specific Functions and Data Members |
2903 | |
3079 | |
2904 | =over 4 |
3080 | =over 4 |
2905 | |
3081 | |
… | |
… | |
3106 | |
3282 | |
3107 | =over 4 |
3283 | =over 4 |
3108 | |
3284 | |
3109 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3285 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3110 | |
3286 | |
3111 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3287 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3112 | |
3288 | |
3113 | Configures the watcher to embed the given loop, which must be |
3289 | Configures the watcher to embed the given loop, which must be |
3114 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3290 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3115 | invoked automatically, otherwise it is the responsibility of the callback |
3291 | invoked automatically, otherwise it is the responsibility of the callback |
3116 | to invoke it (it will continue to be called until the sweep has been done, |
3292 | to invoke it (it will continue to be called until the sweep has been done, |
… | |
… | |
3137 | used). |
3313 | used). |
3138 | |
3314 | |
3139 | struct ev_loop *loop_hi = ev_default_init (0); |
3315 | struct ev_loop *loop_hi = ev_default_init (0); |
3140 | struct ev_loop *loop_lo = 0; |
3316 | struct ev_loop *loop_lo = 0; |
3141 | ev_embed embed; |
3317 | ev_embed embed; |
3142 | |
3318 | |
3143 | // see if there is a chance of getting one that works |
3319 | // see if there is a chance of getting one that works |
3144 | // (remember that a flags value of 0 means autodetection) |
3320 | // (remember that a flags value of 0 means autodetection) |
3145 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3321 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3146 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3322 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3147 | : 0; |
3323 | : 0; |
… | |
… | |
3161 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3337 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3162 | |
3338 | |
3163 | struct ev_loop *loop = ev_default_init (0); |
3339 | struct ev_loop *loop = ev_default_init (0); |
3164 | struct ev_loop *loop_socket = 0; |
3340 | struct ev_loop *loop_socket = 0; |
3165 | ev_embed embed; |
3341 | ev_embed embed; |
3166 | |
3342 | |
3167 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3343 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3168 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3344 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3169 | { |
3345 | { |
3170 | ev_embed_init (&embed, 0, loop_socket); |
3346 | ev_embed_init (&embed, 0, loop_socket); |
3171 | ev_embed_start (loop, &embed); |
3347 | ev_embed_start (loop, &embed); |
… | |
… | |
3179 | |
3355 | |
3180 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3356 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3181 | |
3357 | |
3182 | Fork watchers are called when a C<fork ()> was detected (usually because |
3358 | Fork watchers are called when a C<fork ()> was detected (usually because |
3183 | whoever is a good citizen cared to tell libev about it by calling |
3359 | whoever is a good citizen cared to tell libev about it by calling |
3184 | C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the |
3360 | C<ev_loop_fork>). The invocation is done before the event loop blocks next |
3185 | event loop blocks next and before C<ev_check> watchers are being called, |
3361 | and before C<ev_check> watchers are being called, and only in the child |
3186 | and only in the child after the fork. If whoever good citizen calling |
3362 | after the fork. If whoever good citizen calling C<ev_default_fork> cheats |
3187 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3363 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3188 | handlers will be invoked, too, of course. |
3364 | of course. |
3189 | |
3365 | |
3190 | =head3 The special problem of life after fork - how is it possible? |
3366 | =head3 The special problem of life after fork - how is it possible? |
3191 | |
3367 | |
3192 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3368 | Most uses of C<fork ()> consist of forking, then some simple calls to set |
3193 | up/change the process environment, followed by a call to C<exec()>. This |
3369 | up/change the process environment, followed by a call to C<exec()>. This |
3194 | sequence should be handled by libev without any problems. |
3370 | sequence should be handled by libev without any problems. |
3195 | |
3371 | |
3196 | This changes when the application actually wants to do event handling |
3372 | This changes when the application actually wants to do event handling |
3197 | in the child, or both parent in child, in effect "continuing" after the |
3373 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
3286 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3462 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3287 | |
3463 | |
3288 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3464 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3289 | too, are asynchronous in nature, and signals, too, will be compressed |
3465 | too, are asynchronous in nature, and signals, too, will be compressed |
3290 | (i.e. the number of callback invocations may be less than the number of |
3466 | (i.e. the number of callback invocations may be less than the number of |
3291 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3467 | C<ev_async_send> calls). In fact, you could use signal watchers as a kind |
3292 | of "global async watchers" by using a watcher on an otherwise unused |
3468 | of "global async watchers" by using a watcher on an otherwise unused |
3293 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3469 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3294 | even without knowing which loop owns the signal. |
3470 | even without knowing which loop owns the signal. |
3295 | |
3471 | |
3296 | =head3 Queueing |
3472 | =head3 Queueing |
… | |
… | |
3435 | |
3611 | |
3436 | There are some other functions of possible interest. Described. Here. Now. |
3612 | There are some other functions of possible interest. Described. Here. Now. |
3437 | |
3613 | |
3438 | =over 4 |
3614 | =over 4 |
3439 | |
3615 | |
3440 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
3616 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg) |
3441 | |
3617 | |
3442 | This function combines a simple timer and an I/O watcher, calls your |
3618 | This function combines a simple timer and an I/O watcher, calls your |
3443 | callback on whichever event happens first and automatically stops both |
3619 | callback on whichever event happens first and automatically stops both |
3444 | watchers. This is useful if you want to wait for a single event on an fd |
3620 | watchers. This is useful if you want to wait for a single event on an fd |
3445 | or timeout without having to allocate/configure/start/stop/free one or |
3621 | or timeout without having to allocate/configure/start/stop/free one or |
… | |
… | |
3473 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3649 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3474 | |
3650 | |
3475 | =item ev_feed_fd_event (loop, int fd, int revents) |
3651 | =item ev_feed_fd_event (loop, int fd, int revents) |
3476 | |
3652 | |
3477 | Feed an event on the given fd, as if a file descriptor backend detected |
3653 | Feed an event on the given fd, as if a file descriptor backend detected |
3478 | the given events it. |
3654 | the given events. |
3479 | |
3655 | |
3480 | =item ev_feed_signal_event (loop, int signum) |
3656 | =item ev_feed_signal_event (loop, int signum) |
3481 | |
3657 | |
3482 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3658 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3483 | which is async-safe. |
3659 | which is async-safe. |
… | |
… | |
3557 | { |
3733 | { |
3558 | struct my_biggy big = (struct my_biggy *) |
3734 | struct my_biggy big = (struct my_biggy *) |
3559 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3735 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3560 | } |
3736 | } |
3561 | |
3737 | |
|
|
3738 | =head2 AVOIDING FINISHING BEFORE RETURNING |
|
|
3739 | |
|
|
3740 | Often you have structures like this in event-based programs: |
|
|
3741 | |
|
|
3742 | callback () |
|
|
3743 | { |
|
|
3744 | free (request); |
|
|
3745 | } |
|
|
3746 | |
|
|
3747 | request = start_new_request (..., callback); |
|
|
3748 | |
|
|
3749 | The intent is to start some "lengthy" operation. The C<request> could be |
|
|
3750 | used to cancel the operation, or do other things with it. |
|
|
3751 | |
|
|
3752 | It's not uncommon to have code paths in C<start_new_request> that |
|
|
3753 | immediately invoke the callback, for example, to report errors. Or you add |
|
|
3754 | some caching layer that finds that it can skip the lengthy aspects of the |
|
|
3755 | operation and simply invoke the callback with the result. |
|
|
3756 | |
|
|
3757 | The problem here is that this will happen I<before> C<start_new_request> |
|
|
3758 | has returned, so C<request> is not set. |
|
|
3759 | |
|
|
3760 | Even if you pass the request by some safer means to the callback, you |
|
|
3761 | might want to do something to the request after starting it, such as |
|
|
3762 | canceling it, which probably isn't working so well when the callback has |
|
|
3763 | already been invoked. |
|
|
3764 | |
|
|
3765 | A common way around all these issues is to make sure that |
|
|
3766 | C<start_new_request> I<always> returns before the callback is invoked. If |
|
|
3767 | C<start_new_request> immediately knows the result, it can artificially |
|
|
3768 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
|
|
3769 | example, or more sneakily, by reusing an existing (stopped) watcher and |
|
|
3770 | pushing it into the pending queue: |
|
|
3771 | |
|
|
3772 | ev_set_cb (watcher, callback); |
|
|
3773 | ev_feed_event (EV_A_ watcher, 0); |
|
|
3774 | |
|
|
3775 | This way, C<start_new_request> can safely return before the callback is |
|
|
3776 | invoked, while not delaying callback invocation too much. |
|
|
3777 | |
3562 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3778 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3563 | |
3779 | |
3564 | Often (especially in GUI toolkits) there are places where you have |
3780 | Often (especially in GUI toolkits) there are places where you have |
3565 | I<modal> interaction, which is most easily implemented by recursively |
3781 | I<modal> interaction, which is most easily implemented by recursively |
3566 | invoking C<ev_run>. |
3782 | invoking C<ev_run>. |
3567 | |
3783 | |
3568 | This brings the problem of exiting - a callback might want to finish the |
3784 | This brings the problem of exiting - a callback might want to finish the |
3569 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3785 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3570 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3786 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3571 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3787 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3572 | other combination: In these cases, C<ev_break> will not work alone. |
3788 | other combination: In these cases, a simple C<ev_break> will not work. |
3573 | |
3789 | |
3574 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3790 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3575 | invocation, and use a loop around C<ev_run> until the condition is |
3791 | invocation, and use a loop around C<ev_run> until the condition is |
3576 | triggered, using C<EVRUN_ONCE>: |
3792 | triggered, using C<EVRUN_ONCE>: |
3577 | |
3793 | |
… | |
… | |
3579 | int exit_main_loop = 0; |
3795 | int exit_main_loop = 0; |
3580 | |
3796 | |
3581 | while (!exit_main_loop) |
3797 | while (!exit_main_loop) |
3582 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3798 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3583 | |
3799 | |
3584 | // in a model watcher |
3800 | // in a modal watcher |
3585 | int exit_nested_loop = 0; |
3801 | int exit_nested_loop = 0; |
3586 | |
3802 | |
3587 | while (!exit_nested_loop) |
3803 | while (!exit_nested_loop) |
3588 | ev_run (EV_A_ EVRUN_ONCE); |
3804 | ev_run (EV_A_ EVRUN_ONCE); |
3589 | |
3805 | |
… | |
… | |
3763 | called): |
3979 | called): |
3764 | |
3980 | |
3765 | void |
3981 | void |
3766 | wait_for_event (ev_watcher *w) |
3982 | wait_for_event (ev_watcher *w) |
3767 | { |
3983 | { |
3768 | ev_cb_set (w) = current_coro; |
3984 | ev_set_cb (w, current_coro); |
3769 | switch_to (libev_coro); |
3985 | switch_to (libev_coro); |
3770 | } |
3986 | } |
3771 | |
3987 | |
3772 | That basically suspends the coroutine inside C<wait_for_event> and |
3988 | That basically suspends the coroutine inside C<wait_for_event> and |
3773 | continues the libev coroutine, which, when appropriate, switches back to |
3989 | continues the libev coroutine, which, when appropriate, switches back to |
3774 | this or any other coroutine. I am sure if you sue this your own :) |
3990 | this or any other coroutine. |
3775 | |
3991 | |
3776 | You can do similar tricks if you have, say, threads with an event queue - |
3992 | You can do similar tricks if you have, say, threads with an event queue - |
3777 | instead of storing a coroutine, you store the queue object and instead of |
3993 | instead of storing a coroutine, you store the queue object and instead of |
3778 | switching to a coroutine, you push the watcher onto the queue and notify |
3994 | switching to a coroutine, you push the watcher onto the queue and notify |
3779 | any waiters. |
3995 | any waiters. |
3780 | |
3996 | |
3781 | To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two |
3997 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3782 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3998 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3783 | |
3999 | |
3784 | // my_ev.h |
4000 | // my_ev.h |
3785 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
4001 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3786 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
4002 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb) |
3787 | #include "../libev/ev.h" |
4003 | #include "../libev/ev.h" |
3788 | |
4004 | |
3789 | // my_ev.c |
4005 | // my_ev.c |
3790 | #define EV_H "my_ev.h" |
4006 | #define EV_H "my_ev.h" |
3791 | #include "../libev/ev.c" |
4007 | #include "../libev/ev.c" |
… | |
… | |
3830 | |
4046 | |
3831 | =back |
4047 | =back |
3832 | |
4048 | |
3833 | =head1 C++ SUPPORT |
4049 | =head1 C++ SUPPORT |
3834 | |
4050 | |
|
|
4051 | =head2 C API |
|
|
4052 | |
|
|
4053 | The normal C API should work fine when used from C++: both ev.h and the |
|
|
4054 | libev sources can be compiled as C++. Therefore, code that uses the C API |
|
|
4055 | will work fine. |
|
|
4056 | |
|
|
4057 | Proper exception specifications might have to be added to callbacks passed |
|
|
4058 | to libev: exceptions may be thrown only from watcher callbacks, all other |
|
|
4059 | callbacks (allocator, syserr, loop acquire/release and periodic reschedule |
|
|
4060 | callbacks) must not throw exceptions, and might need a C<noexcept> |
|
|
4061 | specification. If you have code that needs to be compiled as both C and |
|
|
4062 | C++ you can use the C<EV_NOEXCEPT> macro for this: |
|
|
4063 | |
|
|
4064 | static void |
|
|
4065 | fatal_error (const char *msg) EV_NOEXCEPT |
|
|
4066 | { |
|
|
4067 | perror (msg); |
|
|
4068 | abort (); |
|
|
4069 | } |
|
|
4070 | |
|
|
4071 | ... |
|
|
4072 | ev_set_syserr_cb (fatal_error); |
|
|
4073 | |
|
|
4074 | The only API functions that can currently throw exceptions are C<ev_run>, |
|
|
4075 | C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter |
|
|
4076 | because it runs cleanup watchers). |
|
|
4077 | |
|
|
4078 | Throwing exceptions in watcher callbacks is only supported if libev itself |
|
|
4079 | is compiled with a C++ compiler or your C and C++ environments allow |
|
|
4080 | throwing exceptions through C libraries (most do). |
|
|
4081 | |
|
|
4082 | =head2 C++ API |
|
|
4083 | |
3835 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
4084 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3836 | you to use some convenience methods to start/stop watchers and also change |
4085 | you to use some convenience methods to start/stop watchers and also change |
3837 | the callback model to a model using method callbacks on objects. |
4086 | the callback model to a model using method callbacks on objects. |
3838 | |
4087 | |
3839 | To use it, |
4088 | To use it, |
3840 | |
4089 | |
3841 | #include <ev++.h> |
4090 | #include <ev++.h> |
3842 | |
4091 | |
3843 | This automatically includes F<ev.h> and puts all of its definitions (many |
4092 | This automatically includes F<ev.h> and puts all of its definitions (many |
3844 | of them macros) into the global namespace. All C++ specific things are |
4093 | of them macros) into the global namespace. All C++ specific things are |
3845 | put into the C<ev> namespace. It should support all the same embedding |
4094 | put into the C<ev> namespace. It should support all the same embedding |
… | |
… | |
3854 | with C<operator ()> can be used as callbacks. Other types should be easy |
4103 | with C<operator ()> can be used as callbacks. Other types should be easy |
3855 | to add as long as they only need one additional pointer for context. If |
4104 | to add as long as they only need one additional pointer for context. If |
3856 | you need support for other types of functors please contact the author |
4105 | you need support for other types of functors please contact the author |
3857 | (preferably after implementing it). |
4106 | (preferably after implementing it). |
3858 | |
4107 | |
|
|
4108 | For all this to work, your C++ compiler either has to use the same calling |
|
|
4109 | conventions as your C compiler (for static member functions), or you have |
|
|
4110 | to embed libev and compile libev itself as C++. |
|
|
4111 | |
3859 | Here is a list of things available in the C<ev> namespace: |
4112 | Here is a list of things available in the C<ev> namespace: |
3860 | |
4113 | |
3861 | =over 4 |
4114 | =over 4 |
3862 | |
4115 | |
3863 | =item C<ev::READ>, C<ev::WRITE> etc. |
4116 | =item C<ev::READ>, C<ev::WRITE> etc. |
… | |
… | |
3872 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
4125 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
3873 | |
4126 | |
3874 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
4127 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
3875 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
4128 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
3876 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
4129 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
3877 | defines by many implementations. |
4130 | defined by many implementations. |
3878 | |
4131 | |
3879 | All of those classes have these methods: |
4132 | All of those classes have these methods: |
3880 | |
4133 | |
3881 | =over 4 |
4134 | =over 4 |
3882 | |
4135 | |
… | |
… | |
3944 | void operator() (ev::io &w, int revents) |
4197 | void operator() (ev::io &w, int revents) |
3945 | { |
4198 | { |
3946 | ... |
4199 | ... |
3947 | } |
4200 | } |
3948 | } |
4201 | } |
3949 | |
4202 | |
3950 | myfunctor f; |
4203 | myfunctor f; |
3951 | |
4204 | |
3952 | ev::io w; |
4205 | ev::io w; |
3953 | w.set (&f); |
4206 | w.set (&f); |
3954 | |
4207 | |
… | |
… | |
3972 | Associates a different C<struct ev_loop> with this watcher. You can only |
4225 | Associates a different C<struct ev_loop> with this watcher. You can only |
3973 | do this when the watcher is inactive (and not pending either). |
4226 | do this when the watcher is inactive (and not pending either). |
3974 | |
4227 | |
3975 | =item w->set ([arguments]) |
4228 | =item w->set ([arguments]) |
3976 | |
4229 | |
3977 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4230 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
3978 | method or a suitable start method must be called at least once. Unlike the |
4231 | with the same arguments. Either this method or a suitable start method |
3979 | C counterpart, an active watcher gets automatically stopped and restarted |
4232 | must be called at least once. Unlike the C counterpart, an active watcher |
3980 | when reconfiguring it with this method. |
4233 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4234 | method. |
|
|
4235 | |
|
|
4236 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4237 | clashing with the C<set (loop)> method. |
3981 | |
4238 | |
3982 | =item w->start () |
4239 | =item w->start () |
3983 | |
4240 | |
3984 | Starts the watcher. Note that there is no C<loop> argument, as the |
4241 | Starts the watcher. Note that there is no C<loop> argument, as the |
3985 | constructor already stores the event loop. |
4242 | constructor already stores the event loop. |
… | |
… | |
4089 | |
4346 | |
4090 | Brian Maher has written a partial interface to libev for lua (at the |
4347 | Brian Maher has written a partial interface to libev for lua (at the |
4091 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4348 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4092 | L<http://github.com/brimworks/lua-ev>. |
4349 | L<http://github.com/brimworks/lua-ev>. |
4093 | |
4350 | |
|
|
4351 | =item Javascript |
|
|
4352 | |
|
|
4353 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4354 | |
|
|
4355 | =item Others |
|
|
4356 | |
|
|
4357 | There are others, and I stopped counting. |
|
|
4358 | |
4094 | =back |
4359 | =back |
4095 | |
4360 | |
4096 | |
4361 | |
4097 | =head1 MACRO MAGIC |
4362 | =head1 MACRO MAGIC |
4098 | |
4363 | |
… | |
… | |
4215 | ev_vars.h |
4480 | ev_vars.h |
4216 | ev_wrap.h |
4481 | ev_wrap.h |
4217 | |
4482 | |
4218 | ev_win32.c required on win32 platforms only |
4483 | ev_win32.c required on win32 platforms only |
4219 | |
4484 | |
4220 | ev_select.c only when select backend is enabled (which is enabled by default) |
4485 | ev_select.c only when select backend is enabled |
4221 | ev_poll.c only when poll backend is enabled (disabled by default) |
4486 | ev_poll.c only when poll backend is enabled |
4222 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4487 | ev_epoll.c only when the epoll backend is enabled |
|
|
4488 | ev_linuxaio.c only when the linux aio backend is enabled |
|
|
4489 | ev_iouring.c only when the linux io_uring backend is enabled |
4223 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4490 | ev_kqueue.c only when the kqueue backend is enabled |
4224 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
4491 | ev_port.c only when the solaris port backend is enabled |
4225 | |
4492 | |
4226 | F<ev.c> includes the backend files directly when enabled, so you only need |
4493 | F<ev.c> includes the backend files directly when enabled, so you only need |
4227 | to compile this single file. |
4494 | to compile this single file. |
4228 | |
4495 | |
4229 | =head3 LIBEVENT COMPATIBILITY API |
4496 | =head3 LIBEVENT COMPATIBILITY API |
… | |
… | |
4397 | If programs implement their own fd to handle mapping on win32, then this |
4664 | If programs implement their own fd to handle mapping on win32, then this |
4398 | macro can be used to override the C<close> function, useful to unregister |
4665 | macro can be used to override the C<close> function, useful to unregister |
4399 | file descriptors again. Note that the replacement function has to close |
4666 | file descriptors again. Note that the replacement function has to close |
4400 | the underlying OS handle. |
4667 | the underlying OS handle. |
4401 | |
4668 | |
|
|
4669 | =item EV_USE_WSASOCKET |
|
|
4670 | |
|
|
4671 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4672 | communication socket, which works better in some environments. Otherwise, |
|
|
4673 | the normal C<socket> function will be used, which works better in other |
|
|
4674 | environments. |
|
|
4675 | |
4402 | =item EV_USE_POLL |
4676 | =item EV_USE_POLL |
4403 | |
4677 | |
4404 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4678 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4405 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4679 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4406 | takes precedence over select. |
4680 | takes precedence over select. |
… | |
… | |
4410 | If defined to be C<1>, libev will compile in support for the Linux |
4684 | If defined to be C<1>, libev will compile in support for the Linux |
4411 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4685 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4412 | otherwise another method will be used as fallback. This is the preferred |
4686 | otherwise another method will be used as fallback. This is the preferred |
4413 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4687 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4414 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4688 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
|
|
4689 | |
|
|
4690 | =item EV_USE_LINUXAIO |
|
|
4691 | |
|
|
4692 | If defined to be C<1>, libev will compile in support for the Linux aio |
|
|
4693 | backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be |
|
|
4694 | enabled on linux, otherwise disabled. |
|
|
4695 | |
|
|
4696 | =item EV_USE_IOURING |
|
|
4697 | |
|
|
4698 | If defined to be C<1>, libev will compile in support for the Linux |
|
|
4699 | io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's |
|
|
4700 | current limitations it has to be requested explicitly. If undefined, it |
|
|
4701 | will be enabled on linux, otherwise disabled. |
4415 | |
4702 | |
4416 | =item EV_USE_KQUEUE |
4703 | =item EV_USE_KQUEUE |
4417 | |
4704 | |
4418 | If defined to be C<1>, libev will compile in support for the BSD style |
4705 | If defined to be C<1>, libev will compile in support for the BSD style |
4419 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
4706 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
… | |
… | |
4441 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4728 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4442 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4729 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4443 | be detected at runtime. If undefined, it will be enabled if the headers |
4730 | be detected at runtime. If undefined, it will be enabled if the headers |
4444 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4731 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4445 | |
4732 | |
|
|
4733 | =item EV_NO_SMP |
|
|
4734 | |
|
|
4735 | If defined to be C<1>, libev will assume that memory is always coherent |
|
|
4736 | between threads, that is, threads can be used, but threads never run on |
|
|
4737 | different cpus (or different cpu cores). This reduces dependencies |
|
|
4738 | and makes libev faster. |
|
|
4739 | |
|
|
4740 | =item EV_NO_THREADS |
|
|
4741 | |
|
|
4742 | If defined to be C<1>, libev will assume that it will never be called from |
|
|
4743 | different threads (that includes signal handlers), which is a stronger |
|
|
4744 | assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes |
|
|
4745 | libev faster. |
|
|
4746 | |
4446 | =item EV_ATOMIC_T |
4747 | =item EV_ATOMIC_T |
4447 | |
4748 | |
4448 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4749 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4449 | access is atomic and serialised with respect to other threads or signal |
4750 | access is atomic with respect to other threads or signal contexts. No |
4450 | contexts. No such type is easily found in the C language, so you can |
4751 | such type is easily found in the C language, so you can provide your own |
4451 | provide your own type that you know is safe for your purposes. It is used |
4752 | type that you know is safe for your purposes. It is used both for signal |
4452 | both for signal handler "locking" as well as for signal and thread safety |
4753 | handler "locking" as well as for signal and thread safety in C<ev_async> |
4453 | in C<ev_async> watchers. |
4754 | watchers. |
4454 | |
4755 | |
4455 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4756 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4456 | (from F<signal.h>), which is usually good enough on most platforms, |
4757 | (from F<signal.h>), which is usually good enough on most platforms. |
4457 | although strictly speaking using a type that also implies a memory fence |
|
|
4458 | is required. |
|
|
4459 | |
4758 | |
4460 | =item EV_H (h) |
4759 | =item EV_H (h) |
4461 | |
4760 | |
4462 | The name of the F<ev.h> header file used to include it. The default if |
4761 | The name of the F<ev.h> header file used to include it. The default if |
4463 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
4762 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
… | |
… | |
4536 | #define EV_USE_POLL 1 |
4835 | #define EV_USE_POLL 1 |
4537 | #define EV_CHILD_ENABLE 1 |
4836 | #define EV_CHILD_ENABLE 1 |
4538 | #define EV_ASYNC_ENABLE 1 |
4837 | #define EV_ASYNC_ENABLE 1 |
4539 | |
4838 | |
4540 | The actual value is a bitset, it can be a combination of the following |
4839 | The actual value is a bitset, it can be a combination of the following |
4541 | values: |
4840 | values (by default, all of these are enabled): |
4542 | |
4841 | |
4543 | =over 4 |
4842 | =over 4 |
4544 | |
4843 | |
4545 | =item C<1> - faster/larger code |
4844 | =item C<1> - faster/larger code |
4546 | |
4845 | |
… | |
… | |
4550 | code size by roughly 30% on amd64). |
4849 | code size by roughly 30% on amd64). |
4551 | |
4850 | |
4552 | When optimising for size, use of compiler flags such as C<-Os> with |
4851 | When optimising for size, use of compiler flags such as C<-Os> with |
4553 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4852 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4554 | assertions. |
4853 | assertions. |
|
|
4854 | |
|
|
4855 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4856 | (e.g. gcc with C<-Os>). |
4555 | |
4857 | |
4556 | =item C<2> - faster/larger data structures |
4858 | =item C<2> - faster/larger data structures |
4557 | |
4859 | |
4558 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4860 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4559 | hash table sizes and so on. This will usually further increase code size |
4861 | hash table sizes and so on. This will usually further increase code size |
4560 | and can additionally have an effect on the size of data structures at |
4862 | and can additionally have an effect on the size of data structures at |
4561 | runtime. |
4863 | runtime. |
4562 | |
4864 | |
|
|
4865 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4866 | (e.g. gcc with C<-Os>). |
|
|
4867 | |
4563 | =item C<4> - full API configuration |
4868 | =item C<4> - full API configuration |
4564 | |
4869 | |
4565 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4870 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4566 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4871 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4567 | |
4872 | |
… | |
… | |
4597 | |
4902 | |
4598 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4903 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4599 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4904 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4600 | your program might be left out as well - a binary starting a timer and an |
4905 | your program might be left out as well - a binary starting a timer and an |
4601 | I/O watcher then might come out at only 5Kb. |
4906 | I/O watcher then might come out at only 5Kb. |
|
|
4907 | |
|
|
4908 | =item EV_API_STATIC |
|
|
4909 | |
|
|
4910 | If this symbol is defined (by default it is not), then all identifiers |
|
|
4911 | will have static linkage. This means that libev will not export any |
|
|
4912 | identifiers, and you cannot link against libev anymore. This can be useful |
|
|
4913 | when you embed libev, only want to use libev functions in a single file, |
|
|
4914 | and do not want its identifiers to be visible. |
|
|
4915 | |
|
|
4916 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
|
|
4917 | wants to use libev. |
|
|
4918 | |
|
|
4919 | This option only works when libev is compiled with a C compiler, as C++ |
|
|
4920 | doesn't support the required declaration syntax. |
4602 | |
4921 | |
4603 | =item EV_AVOID_STDIO |
4922 | =item EV_AVOID_STDIO |
4604 | |
4923 | |
4605 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4924 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4606 | functions (printf, scanf, perror etc.). This will increase the code size |
4925 | functions (printf, scanf, perror etc.). This will increase the code size |
… | |
… | |
4664 | in. If set to C<1>, then verification code will be compiled in, but not |
4983 | in. If set to C<1>, then verification code will be compiled in, but not |
4665 | called. If set to C<2>, then the internal verification code will be |
4984 | called. If set to C<2>, then the internal verification code will be |
4666 | called once per loop, which can slow down libev. If set to C<3>, then the |
4985 | called once per loop, which can slow down libev. If set to C<3>, then the |
4667 | verification code will be called very frequently, which will slow down |
4986 | verification code will be called very frequently, which will slow down |
4668 | libev considerably. |
4987 | libev considerably. |
|
|
4988 | |
|
|
4989 | Verification errors are reported via C's C<assert> mechanism, so if you |
|
|
4990 | disable that (e.g. by defining C<NDEBUG>) then no errors will be reported. |
4669 | |
4991 | |
4670 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
4992 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
4671 | will be C<0>. |
4993 | will be C<0>. |
4672 | |
4994 | |
4673 | =item EV_COMMON |
4995 | =item EV_COMMON |
… | |
… | |
4811 | default loop and triggering an C<ev_async> watcher from the default loop |
5133 | default loop and triggering an C<ev_async> watcher from the default loop |
4812 | watcher callback into the event loop interested in the signal. |
5134 | watcher callback into the event loop interested in the signal. |
4813 | |
5135 | |
4814 | =back |
5136 | =back |
4815 | |
5137 | |
4816 | See also L<THREAD LOCKING EXAMPLE>. |
5138 | See also L</THREAD LOCKING EXAMPLE>. |
4817 | |
5139 | |
4818 | =head3 COROUTINES |
5140 | =head3 COROUTINES |
4819 | |
5141 | |
4820 | Libev is very accommodating to coroutines ("cooperative threads"): |
5142 | Libev is very accommodating to coroutines ("cooperative threads"): |
4821 | libev fully supports nesting calls to its functions from different |
5143 | libev fully supports nesting calls to its functions from different |
… | |
… | |
5090 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5412 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5091 | assumes that the same (machine) code can be used to call any watcher |
5413 | assumes that the same (machine) code can be used to call any watcher |
5092 | callback: The watcher callbacks have different type signatures, but libev |
5414 | callback: The watcher callbacks have different type signatures, but libev |
5093 | calls them using an C<ev_watcher *> internally. |
5415 | calls them using an C<ev_watcher *> internally. |
5094 | |
5416 | |
|
|
5417 | =item null pointers and integer zero are represented by 0 bytes |
|
|
5418 | |
|
|
5419 | Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and |
|
|
5420 | relies on this setting pointers and integers to null. |
|
|
5421 | |
5095 | =item pointer accesses must be thread-atomic |
5422 | =item pointer accesses must be thread-atomic |
5096 | |
5423 | |
5097 | Accessing a pointer value must be atomic, it must both be readable and |
5424 | Accessing a pointer value must be atomic, it must both be readable and |
5098 | writable in one piece - this is the case on all current architectures. |
5425 | writable in one piece - this is the case on all current architectures. |
5099 | |
5426 | |
… | |
… | |
5112 | thread" or will block signals process-wide, both behaviours would |
5439 | thread" or will block signals process-wide, both behaviours would |
5113 | be compatible with libev. Interaction between C<sigprocmask> and |
5440 | be compatible with libev. Interaction between C<sigprocmask> and |
5114 | C<pthread_sigmask> could complicate things, however. |
5441 | C<pthread_sigmask> could complicate things, however. |
5115 | |
5442 | |
5116 | The most portable way to handle signals is to block signals in all threads |
5443 | The most portable way to handle signals is to block signals in all threads |
5117 | except the initial one, and run the default loop in the initial thread as |
5444 | except the initial one, and run the signal handling loop in the initial |
5118 | well. |
5445 | thread as well. |
5119 | |
5446 | |
5120 | =item C<long> must be large enough for common memory allocation sizes |
5447 | =item C<long> must be large enough for common memory allocation sizes |
5121 | |
5448 | |
5122 | To improve portability and simplify its API, libev uses C<long> internally |
5449 | To improve portability and simplify its API, libev uses C<long> internally |
5123 | instead of C<size_t> when allocating its data structures. On non-POSIX |
5450 | instead of C<size_t> when allocating its data structures. On non-POSIX |
… | |
… | |
5132 | good enough for at least into the year 4000 with millisecond accuracy |
5459 | good enough for at least into the year 4000 with millisecond accuracy |
5133 | (the design goal for libev). This requirement is overfulfilled by |
5460 | (the design goal for libev). This requirement is overfulfilled by |
5134 | implementations using IEEE 754, which is basically all existing ones. |
5461 | implementations using IEEE 754, which is basically all existing ones. |
5135 | |
5462 | |
5136 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
5463 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
5137 | year 2255 (and millisecond accuray till the year 287396 - by then, libev |
5464 | year 2255 (and millisecond accuracy till the year 287396 - by then, libev |
5138 | is either obsolete or somebody patched it to use C<long double> or |
5465 | is either obsolete or somebody patched it to use C<long double> or |
5139 | something like that, just kidding). |
5466 | something like that, just kidding). |
5140 | |
5467 | |
5141 | =back |
5468 | =back |
5142 | |
5469 | |
… | |
… | |
5227 | =over 4 |
5554 | =over 4 |
5228 | |
5555 | |
5229 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5556 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5230 | |
5557 | |
5231 | The backward compatibility mechanism can be controlled by |
5558 | The backward compatibility mechanism can be controlled by |
5232 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
5559 | C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING> |
5233 | section. |
5560 | section. |
5234 | |
5561 | |
5235 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5562 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5236 | |
5563 | |
5237 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5564 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
… | |
… | |
5280 | =over 4 |
5607 | =over 4 |
5281 | |
5608 | |
5282 | =item active |
5609 | =item active |
5283 | |
5610 | |
5284 | A watcher is active as long as it has been started and not yet stopped. |
5611 | A watcher is active as long as it has been started and not yet stopped. |
5285 | See L<WATCHER STATES> for details. |
5612 | See L</WATCHER STATES> for details. |
5286 | |
5613 | |
5287 | =item application |
5614 | =item application |
5288 | |
5615 | |
5289 | In this document, an application is whatever is using libev. |
5616 | In this document, an application is whatever is using libev. |
5290 | |
5617 | |
… | |
… | |
5326 | watchers and events. |
5653 | watchers and events. |
5327 | |
5654 | |
5328 | =item pending |
5655 | =item pending |
5329 | |
5656 | |
5330 | A watcher is pending as soon as the corresponding event has been |
5657 | A watcher is pending as soon as the corresponding event has been |
5331 | detected. See L<WATCHER STATES> for details. |
5658 | detected. See L</WATCHER STATES> for details. |
5332 | |
5659 | |
5333 | =item real time |
5660 | =item real time |
5334 | |
5661 | |
5335 | The physical time that is observed. It is apparently strictly monotonic :) |
5662 | The physical time that is observed. It is apparently strictly monotonic :) |
5336 | |
5663 | |