… | |
… | |
105 | 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 |
106 | watcher. |
106 | watcher. |
107 | |
107 | |
108 | =head2 FEATURES |
108 | =head2 FEATURES |
109 | |
109 | |
110 | 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> |
111 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
111 | interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port |
112 | 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> |
113 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
113 | interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
114 | 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 |
115 | timers (C<ev_timer>), absolute timers with customised rescheduling |
115 | timers (C<ev_timer>), absolute timers with customised rescheduling |
116 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
116 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
117 | 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 |
118 | 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 |
… | |
… | |
159 | 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 |
160 | 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, |
161 | 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 |
162 | the libev caller and need to be fixed there. |
162 | the libev caller and need to be fixed there. |
163 | |
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 | |
164 | 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 |
165 | extensive consistency checking code. These do not trigger under normal |
|
|
166 | 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. |
167 | |
171 | |
168 | |
172 | |
169 | =head1 GLOBAL FUNCTIONS |
173 | =head1 GLOBAL FUNCTIONS |
170 | |
174 | |
171 | These functions can be called anytime, even before initialising the |
175 | These functions can be called anytime, even before initialising the |
… | |
… | |
265 | |
269 | |
266 | You could override this function in high-availability programs to, say, |
270 | You could override this function in high-availability programs to, say, |
267 | 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, |
268 | 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. |
269 | |
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 | |
270 | 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 |
271 | retries (example requires a standards-compliant C<realloc>). |
289 | retries. |
272 | |
290 | |
273 | static void * |
291 | static void * |
274 | persistent_realloc (void *ptr, size_t size) |
292 | persistent_realloc (void *ptr, size_t size) |
275 | { |
293 | { |
|
|
294 | if (!size) |
|
|
295 | { |
|
|
296 | free (ptr); |
|
|
297 | return 0; |
|
|
298 | } |
|
|
299 | |
276 | for (;;) |
300 | for (;;) |
277 | { |
301 | { |
278 | void *newptr = realloc (ptr, size); |
302 | void *newptr = realloc (ptr, size); |
279 | |
303 | |
280 | if (newptr) |
304 | if (newptr) |
… | |
… | |
411 | 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. |
412 | |
436 | |
413 | 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, |
414 | 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 |
415 | 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 |
416 | 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 |
417 | 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 |
418 | 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). |
419 | |
444 | |
420 | 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 |
421 | forget about forgetting to tell libev about forking, although you still |
446 | forget about forgetting to tell libev about forking, although you still |
422 | have to ignore C<SIGPIPE>) when you use this flag. |
447 | have to ignore C<SIGPIPE>) when you use this flag. |
423 | |
448 | |
… | |
… | |
455 | unblocking the signals. |
480 | unblocking the signals. |
456 | |
481 | |
457 | It's also required by POSIX in a threaded program, as libev calls |
482 | It's also required by POSIX in a threaded program, as libev calls |
458 | C<sigprocmask>, whose behaviour is officially unspecified. |
483 | C<sigprocmask>, whose behaviour is officially unspecified. |
459 | |
484 | |
460 | This flag's behaviour will become the default in future versions of libev. |
485 | =item C<EVFLAG_NOTIMERFD> |
|
|
486 | |
|
|
487 | When this flag is specified, the libev will avoid using a C<timerfd> to |
|
|
488 | detect time jumps. It will still be able to detect time jumps, but takes |
|
|
489 | longer and has a lower accuracy in doing so, but saves a file descriptor |
|
|
490 | per loop. |
|
|
491 | |
|
|
492 | The current implementation only tries to use a C<timerfd> when the first |
|
|
493 | C<ev_periodic> watcher is started and falls back on other methods if it |
|
|
494 | cannot be created, but this behaviour might change in the future. |
461 | |
495 | |
462 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
496 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
463 | |
497 | |
464 | This is your standard select(2) backend. Not I<completely> standard, as |
498 | This is your standard select(2) backend. Not I<completely> standard, as |
465 | libev tries to roll its own fd_set with no limits on the number of fds, |
499 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
490 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
524 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
491 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
525 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
492 | |
526 | |
493 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
527 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
494 | |
528 | |
495 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
529 | Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
496 | kernels). |
530 | kernels). |
497 | |
531 | |
498 | For few fds, this backend is a bit little slower than poll and select, but |
532 | For few fds, this backend is a bit little slower than poll and select, but |
499 | it scales phenomenally better. While poll and select usually scale like |
533 | it scales phenomenally better. While poll and select usually scale like |
500 | O(total_fds) where total_fds is the total number of fds (or the highest |
534 | O(total_fds) where total_fds is the total number of fds (or the highest |
… | |
… | |
546 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
580 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
547 | faster than epoll for maybe up to a hundred file descriptors, depending on |
581 | faster than epoll for maybe up to a hundred file descriptors, depending on |
548 | the usage. So sad. |
582 | the usage. So sad. |
549 | |
583 | |
550 | While nominally embeddable in other event loops, this feature is broken in |
584 | While nominally embeddable in other event loops, this feature is broken in |
551 | all kernel versions tested so far. |
585 | a lot of kernel revisions, but probably(!) works in current versions. |
552 | |
586 | |
553 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
587 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
554 | C<EVBACKEND_POLL>. |
588 | C<EVBACKEND_POLL>. |
555 | |
589 | |
|
|
590 | =item C<EVBACKEND_LINUXAIO> (value 64, Linux) |
|
|
591 | |
|
|
592 | Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<< |
|
|
593 | io_submit(2) >>) event interface available in post-4.18 kernels (but libev |
|
|
594 | only tries to use it in 4.19+). |
|
|
595 | |
|
|
596 | This is another Linux train wreck of an event interface. |
|
|
597 | |
|
|
598 | If this backend works for you (as of this writing, it was very |
|
|
599 | experimental), it is the best event interface available on Linux and might |
|
|
600 | be well worth enabling it - if it isn't available in your kernel this will |
|
|
601 | be detected and this backend will be skipped. |
|
|
602 | |
|
|
603 | This backend can batch oneshot requests and supports a user-space ring |
|
|
604 | buffer to receive events. It also doesn't suffer from most of the design |
|
|
605 | problems of epoll (such as not being able to remove event sources from |
|
|
606 | the epoll set), and generally sounds too good to be true. Because, this |
|
|
607 | being the Linux kernel, of course it suffers from a whole new set of |
|
|
608 | limitations, forcing you to fall back to epoll, inheriting all its design |
|
|
609 | issues. |
|
|
610 | |
|
|
611 | For one, it is not easily embeddable (but probably could be done using |
|
|
612 | an event fd at some extra overhead). It also is subject to a system wide |
|
|
613 | limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO |
|
|
614 | requests are left, this backend will be skipped during initialisation, and |
|
|
615 | will switch to epoll when the loop is active. |
|
|
616 | |
|
|
617 | Most problematic in practice, however, is that not all file descriptors |
|
|
618 | work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds, |
|
|
619 | files, F</dev/null> and many others are supported, but ttys do not work |
|
|
620 | properly (a known bug that the kernel developers don't care about, see |
|
|
621 | L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not |
|
|
622 | (yet?) a generic event polling interface. |
|
|
623 | |
|
|
624 | Overall, it seems the Linux developers just don't want it to have a |
|
|
625 | generic event handling mechanism other than C<select> or C<poll>. |
|
|
626 | |
|
|
627 | To work around all these problem, the current version of libev uses its |
|
|
628 | epoll backend as a fallback for file descriptor types that do not work. Or |
|
|
629 | falls back completely to epoll if the kernel acts up. |
|
|
630 | |
|
|
631 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
|
|
632 | C<EVBACKEND_POLL>. |
|
|
633 | |
556 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
634 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
557 | |
635 | |
558 | Kqueue deserves special mention, as at the time of this writing, it |
636 | Kqueue deserves special mention, as at the time this backend was |
559 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
637 | implemented, it was broken on all BSDs except NetBSD (usually it doesn't |
560 | with anything but sockets and pipes, except on Darwin, where of course |
638 | work reliably with anything but sockets and pipes, except on Darwin, |
561 | it's completely useless). Unlike epoll, however, whose brokenness |
639 | where of course it's completely useless). Unlike epoll, however, whose |
562 | is by design, these kqueue bugs can (and eventually will) be fixed |
640 | brokenness is by design, these kqueue bugs can be (and mostly have been) |
563 | without API changes to existing programs. For this reason it's not being |
641 | fixed without API changes to existing programs. For this reason it's not |
564 | "auto-detected" unless you explicitly specify it in the flags (i.e. using |
642 | being "auto-detected" on all platforms unless you explicitly specify it |
565 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
643 | in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a |
566 | system like NetBSD. |
644 | known-to-be-good (-enough) system like NetBSD. |
567 | |
645 | |
568 | You still can embed kqueue into a normal poll or select backend and use it |
646 | You still can embed kqueue into a normal poll or select backend and use it |
569 | only for sockets (after having made sure that sockets work with kqueue on |
647 | only for sockets (after having made sure that sockets work with kqueue on |
570 | the target platform). See C<ev_embed> watchers for more info. |
648 | the target platform). See C<ev_embed> watchers for more info. |
571 | |
649 | |
572 | It scales in the same way as the epoll backend, but the interface to the |
650 | It scales in the same way as the epoll backend, but the interface to the |
573 | kernel is more efficient (which says nothing about its actual speed, of |
651 | kernel is more efficient (which says nothing about its actual speed, of |
574 | course). While stopping, setting and starting an I/O watcher does never |
652 | course). While stopping, setting and starting an I/O watcher does never |
575 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
653 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
576 | two event changes per incident. Support for C<fork ()> is very bad (you |
654 | two event changes per incident. Support for C<fork ()> is very bad (you |
577 | might have to leak fd's on fork, but it's more sane than epoll) and it |
655 | might have to leak fds on fork, but it's more sane than epoll) and it |
578 | drops fds silently in similarly hard-to-detect cases. |
656 | drops fds silently in similarly hard-to-detect cases. |
579 | |
657 | |
580 | This backend usually performs well under most conditions. |
658 | This backend usually performs well under most conditions. |
581 | |
659 | |
582 | While nominally embeddable in other event loops, this doesn't work |
660 | While nominally embeddable in other event loops, this doesn't work |
… | |
… | |
597 | and is not embeddable, which would limit the usefulness of this backend |
675 | and is not embeddable, which would limit the usefulness of this backend |
598 | immensely. |
676 | immensely. |
599 | |
677 | |
600 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
678 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
601 | |
679 | |
602 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
680 | This uses the Solaris 10 event port mechanism. As with everything on |
603 | it's really slow, but it still scales very well (O(active_fds)). |
681 | Solaris, it's really slow, but it still scales very well (O(active_fds)). |
604 | |
682 | |
605 | While this backend scales well, it requires one system call per active |
683 | While this backend scales well, it requires one system call per active |
606 | file descriptor per loop iteration. For small and medium numbers of file |
684 | file descriptor per loop iteration. For small and medium numbers of file |
607 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
685 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
608 | might perform better. |
686 | might perform better. |
… | |
… | |
657 | Example: Use whatever libev has to offer, but make sure that kqueue is |
735 | Example: Use whatever libev has to offer, but make sure that kqueue is |
658 | used if available. |
736 | used if available. |
659 | |
737 | |
660 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
738 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
661 | |
739 | |
|
|
740 | Example: Similarly, on linux, you mgiht want to take advantage of the |
|
|
741 | linux aio backend if possible, but fall back to something else if that |
|
|
742 | isn't available. |
|
|
743 | |
|
|
744 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO); |
|
|
745 | |
662 | =item ev_loop_destroy (loop) |
746 | =item ev_loop_destroy (loop) |
663 | |
747 | |
664 | Destroys an event loop object (frees all memory and kernel state |
748 | Destroys an event loop object (frees all memory and kernel state |
665 | etc.). None of the active event watchers will be stopped in the normal |
749 | etc.). None of the active event watchers will be stopped in the normal |
666 | sense, so e.g. C<ev_is_active> might still return true. It is your |
750 | sense, so e.g. C<ev_is_active> might still return true. It is your |
… | |
… | |
689 | the name, you can call it anytime you are allowed to start or stop |
773 | the name, you can call it anytime you are allowed to start or stop |
690 | watchers (except inside an C<ev_prepare> callback), but it makes most |
774 | watchers (except inside an C<ev_prepare> callback), but it makes most |
691 | sense after forking, in the child process. You I<must> call it (or use |
775 | sense after forking, in the child process. You I<must> call it (or use |
692 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
776 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
693 | |
777 | |
694 | In addition, if you want to reuse a loop (via this function of |
778 | In addition, if you want to reuse a loop (via this function or |
695 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
779 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
696 | |
780 | |
697 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
781 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
698 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
782 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
699 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
783 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
… | |
… | |
875 | - Queue all expired timers. |
959 | - Queue all expired timers. |
876 | - Queue all expired periodics. |
960 | - Queue all expired periodics. |
877 | - Queue all idle watchers with priority higher than that of pending events. |
961 | - Queue all idle watchers with priority higher than that of pending events. |
878 | - Queue all check watchers. |
962 | - Queue all check watchers. |
879 | - Call all queued watchers in reverse order (i.e. check watchers first). |
963 | - Call all queued watchers in reverse order (i.e. check watchers first). |
880 | Signals and child watchers are implemented as I/O watchers, and will |
964 | Signals, async and child watchers are implemented as I/O watchers, and |
881 | be handled here by queueing them when their watcher gets executed. |
965 | will be handled here by queueing them when their watcher gets executed. |
882 | - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT |
966 | - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT |
883 | were used, or there are no active watchers, goto FINISH, otherwise |
967 | were used, or there are no active watchers, goto FINISH, otherwise |
884 | continue with step LOOP. |
968 | continue with step LOOP. |
885 | FINISH: |
969 | FINISH: |
886 | - Reset the ev_break status iff it was EVBREAK_ONE. |
970 | - Reset the ev_break status iff it was EVBREAK_ONE. |
… | |
… | |
1134 | with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher |
1218 | with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher |
1135 | *) >>), and you can stop watching for events at any time by calling the |
1219 | *) >>), and you can stop watching for events at any time by calling the |
1136 | corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. |
1220 | corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. |
1137 | |
1221 | |
1138 | As long as your watcher is active (has been started but not stopped) you |
1222 | As long as your watcher is active (has been started but not stopped) you |
1139 | must not touch the values stored in it. Most specifically you must never |
1223 | must not touch the values stored in it except when explicitly documented |
1140 | reinitialise it or call its C<ev_TYPE_set> macro. |
1224 | otherwise. Most specifically you must never reinitialise it or call its |
|
|
1225 | C<ev_TYPE_set> macro. |
1141 | |
1226 | |
1142 | Each and every callback receives the event loop pointer as first, the |
1227 | Each and every callback receives the event loop pointer as first, the |
1143 | registered watcher structure as second, and a bitset of received events as |
1228 | registered watcher structure as second, and a bitset of received events as |
1144 | third argument. |
1229 | third argument. |
1145 | |
1230 | |
… | |
… | |
1311 | |
1396 | |
1312 | =item bool ev_is_active (ev_TYPE *watcher) |
1397 | =item bool ev_is_active (ev_TYPE *watcher) |
1313 | |
1398 | |
1314 | Returns a true value iff the watcher is active (i.e. it has been started |
1399 | Returns a true value iff the watcher is active (i.e. it has been started |
1315 | and not yet been stopped). As long as a watcher is active you must not modify |
1400 | and not yet been stopped). As long as a watcher is active you must not modify |
1316 | it. |
1401 | it unless documented otherwise. |
|
|
1402 | |
|
|
1403 | Obviously, it is safe to call this on an active watcher, or actually any |
|
|
1404 | watcher that is initialised. |
1317 | |
1405 | |
1318 | =item bool ev_is_pending (ev_TYPE *watcher) |
1406 | =item bool ev_is_pending (ev_TYPE *watcher) |
1319 | |
1407 | |
1320 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
1408 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
1321 | events but its callback has not yet been invoked). As long as a watcher |
1409 | events but its callback has not yet been invoked). As long as a watcher |
1322 | is pending (but not active) you must not call an init function on it (but |
1410 | is pending (but not active) you must not call an init function on it (but |
1323 | C<ev_TYPE_set> is safe), you must not change its priority, and you must |
1411 | C<ev_TYPE_set> is safe), you must not change its priority, and you must |
1324 | make sure the watcher is available to libev (e.g. you cannot C<free ()> |
1412 | make sure the watcher is available to libev (e.g. you cannot C<free ()> |
1325 | it). |
1413 | it). |
1326 | |
1414 | |
|
|
1415 | It is safe to call this on any watcher in any state as long as it is |
|
|
1416 | initialised. |
|
|
1417 | |
1327 | =item callback ev_cb (ev_TYPE *watcher) |
1418 | =item callback ev_cb (ev_TYPE *watcher) |
1328 | |
1419 | |
1329 | Returns the callback currently set on the watcher. |
1420 | Returns the callback currently set on the watcher. |
1330 | |
1421 | |
1331 | =item ev_set_cb (ev_TYPE *watcher, callback) |
1422 | =item ev_set_cb (ev_TYPE *watcher, callback) |
… | |
… | |
1344 | from being executed (except for C<ev_idle> watchers). |
1435 | from being executed (except for C<ev_idle> watchers). |
1345 | |
1436 | |
1346 | If you need to suppress invocation when higher priority events are pending |
1437 | If you need to suppress invocation when higher priority events are pending |
1347 | you need to look at C<ev_idle> watchers, which provide this functionality. |
1438 | you need to look at C<ev_idle> watchers, which provide this functionality. |
1348 | |
1439 | |
1349 | You I<must not> change the priority of a watcher as long as it is active or |
1440 | You I<must not> change the priority of a watcher as long as it is active |
1350 | pending. |
1441 | or pending. Reading the priority with C<ev_priority> is fine in any state. |
1351 | |
1442 | |
1352 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
1443 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
1353 | fine, as long as you do not mind that the priority value you query might |
1444 | fine, as long as you do not mind that the priority value you query might |
1354 | or might not have been clamped to the valid range. |
1445 | or might not have been clamped to the valid range. |
1355 | |
1446 | |
… | |
… | |
1377 | |
1468 | |
1378 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
1469 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
1379 | |
1470 | |
1380 | Feeds the given event set into the event loop, as if the specified event |
1471 | Feeds the given event set into the event loop, as if the specified event |
1381 | had happened for the specified watcher (which must be a pointer to an |
1472 | had happened for the specified watcher (which must be a pointer to an |
1382 | initialised but not necessarily started event watcher). Obviously you must |
1473 | initialised but not necessarily started event watcher, though it can be |
1383 | not free the watcher as long as it has pending events. |
1474 | active). Obviously you must not free the watcher as long as it has pending |
|
|
1475 | events. |
1384 | |
1476 | |
1385 | Stopping the watcher, letting libev invoke it, or calling |
1477 | Stopping the watcher, letting libev invoke it, or calling |
1386 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
1478 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
1387 | not started in the first place. |
1479 | not started in the first place. |
1388 | |
1480 | |
… | |
… | |
1416 | |
1508 | |
1417 | =item started/running/active |
1509 | =item started/running/active |
1418 | |
1510 | |
1419 | Once a watcher has been started with a call to C<ev_TYPE_start> it becomes |
1511 | Once a watcher has been started with a call to C<ev_TYPE_start> it becomes |
1420 | property of the event loop, and is actively waiting for events. While in |
1512 | property of the event loop, and is actively waiting for events. While in |
1421 | this state it cannot be accessed (except in a few documented ways), moved, |
1513 | this state it cannot be accessed (except in a few documented ways, such as |
1422 | freed or anything else - the only legal thing is to keep a pointer to it, |
1514 | stoping it), moved, freed or anything else - the only legal thing is to |
1423 | and call libev functions on it that are documented to work on active watchers. |
1515 | keep a pointer to it, and call libev functions on it that are documented |
|
|
1516 | to work on active watchers. |
|
|
1517 | |
|
|
1518 | As a rule of thumb, before accessing a member or calling any function on |
|
|
1519 | a watcher, it should be stopped (or freshly initialised). If that is not |
|
|
1520 | convenient, you can check the documentation for that function or member to |
|
|
1521 | see if it is safe to use on an active watcher. |
1424 | |
1522 | |
1425 | =item pending |
1523 | =item pending |
1426 | |
1524 | |
1427 | If a watcher is active and libev determines that an event it is interested |
1525 | If a watcher is active and libev determines that an event it is interested |
1428 | in has occurred (such as a timer expiring), it will become pending. It will |
1526 | in has occurred (such as a timer expiring), it will become pending. It |
1429 | stay in this pending state until either it is stopped or its callback is |
1527 | will stay in this pending state until either it is explicitly stopped or |
1430 | about to be invoked, so it is not normally pending inside the watcher |
1528 | its callback is about to be invoked, so it is not normally pending inside |
1431 | callback. |
1529 | the watcher callback. |
1432 | |
1530 | |
1433 | The watcher might or might not be active while it is pending (for example, |
1531 | Generally, the watcher might or might not be active while it is pending |
1434 | an expired non-repeating timer can be pending but no longer active). If it |
1532 | (for example, an expired non-repeating timer can be pending but no longer |
1435 | is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>), |
1533 | active). If it is pending but not active, it can be freely accessed (e.g. |
1436 | but it is still property of the event loop at this time, so cannot be |
1534 | by calling C<ev_TYPE_set>), but it is still property of the event loop at |
1437 | moved, freed or reused. And if it is active the rules described in the |
1535 | this time, so cannot be moved, freed or reused. And if it is active the |
1438 | previous item still apply. |
1536 | rules described in the previous item still apply. |
|
|
1537 | |
|
|
1538 | Explicitly stopping a watcher will also clear the pending state |
|
|
1539 | unconditionally, so it is safe to stop a watcher and then free it. |
1439 | |
1540 | |
1440 | It is also possible to feed an event on a watcher that is not active (e.g. |
1541 | It is also possible to feed an event on a watcher that is not active (e.g. |
1441 | via C<ev_feed_event>), in which case it becomes pending without being |
1542 | via C<ev_feed_event>), in which case it becomes pending without being |
1442 | active. |
1543 | active. |
1443 | |
1544 | |
… | |
… | |
1460 | |
1561 | |
1461 | Many event loops support I<watcher priorities>, which are usually small |
1562 | Many event loops support I<watcher priorities>, which are usually small |
1462 | integers that influence the ordering of event callback invocation |
1563 | integers that influence the ordering of event callback invocation |
1463 | between watchers in some way, all else being equal. |
1564 | between watchers in some way, all else being equal. |
1464 | |
1565 | |
1465 | In libev, Watcher priorities can be set using C<ev_set_priority>. See its |
1566 | In libev, watcher priorities can be set using C<ev_set_priority>. See its |
1466 | description for the more technical details such as the actual priority |
1567 | description for the more technical details such as the actual priority |
1467 | range. |
1568 | range. |
1468 | |
1569 | |
1469 | There are two common ways how these these priorities are being interpreted |
1570 | There are two common ways how these these priorities are being interpreted |
1470 | by event loops: |
1571 | by event loops: |
… | |
… | |
1564 | |
1665 | |
1565 | This section describes each watcher in detail, but will not repeat |
1666 | This section describes each watcher in detail, but will not repeat |
1566 | information given in the last section. Any initialisation/set macros, |
1667 | information given in the last section. Any initialisation/set macros, |
1567 | functions and members specific to the watcher type are explained. |
1668 | functions and members specific to the watcher type are explained. |
1568 | |
1669 | |
1569 | Members are additionally marked with either I<[read-only]>, meaning that, |
1670 | Most members are additionally marked with either I<[read-only]>, meaning |
1570 | while the watcher is active, you can look at the member and expect some |
1671 | that, while the watcher is active, you can look at the member and expect |
1571 | sensible content, but you must not modify it (you can modify it while the |
1672 | some sensible content, but you must not modify it (you can modify it while |
1572 | watcher is stopped to your hearts content), or I<[read-write]>, which |
1673 | the watcher is stopped to your hearts content), or I<[read-write]>, which |
1573 | means you can expect it to have some sensible content while the watcher |
1674 | means you can expect it to have some sensible content while the watcher is |
1574 | is active, but you can also modify it. Modifying it may not do something |
1675 | active, but you can also modify it (within the same thread as the event |
|
|
1676 | loop, i.e. without creating data races). Modifying it may not do something |
1575 | sensible or take immediate effect (or do anything at all), but libev will |
1677 | sensible or take immediate effect (or do anything at all), but libev will |
1576 | not crash or malfunction in any way. |
1678 | not crash or malfunction in any way. |
1577 | |
1679 | |
|
|
1680 | In any case, the documentation for each member will explain what the |
|
|
1681 | effects are, and if there are any additional access restrictions. |
1578 | |
1682 | |
1579 | =head2 C<ev_io> - is this file descriptor readable or writable? |
1683 | =head2 C<ev_io> - is this file descriptor readable or writable? |
1580 | |
1684 | |
1581 | I/O watchers check whether a file descriptor is readable or writable |
1685 | I/O watchers check whether a file descriptor is readable or writable |
1582 | in each iteration of the event loop, or, more precisely, when reading |
1686 | in each iteration of the event loop, or, more precisely, when reading |
… | |
… | |
1609 | |
1713 | |
1610 | But really, best use non-blocking mode. |
1714 | But really, best use non-blocking mode. |
1611 | |
1715 | |
1612 | =head3 The special problem of disappearing file descriptors |
1716 | =head3 The special problem of disappearing file descriptors |
1613 | |
1717 | |
1614 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1718 | Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing |
1615 | descriptor (either due to calling C<close> explicitly or any other means, |
1719 | a file descriptor (either due to calling C<close> explicitly or any other |
1616 | such as C<dup2>). The reason is that you register interest in some file |
1720 | means, such as C<dup2>). The reason is that you register interest in some |
1617 | descriptor, but when it goes away, the operating system will silently drop |
1721 | file descriptor, but when it goes away, the operating system will silently |
1618 | this interest. If another file descriptor with the same number then is |
1722 | drop this interest. If another file descriptor with the same number then |
1619 | registered with libev, there is no efficient way to see that this is, in |
1723 | is registered with libev, there is no efficient way to see that this is, |
1620 | fact, a different file descriptor. |
1724 | in fact, a different file descriptor. |
1621 | |
1725 | |
1622 | To avoid having to explicitly tell libev about such cases, libev follows |
1726 | To avoid having to explicitly tell libev about such cases, libev follows |
1623 | the following policy: Each time C<ev_io_set> is being called, libev |
1727 | the following policy: Each time C<ev_io_set> is being called, libev |
1624 | will assume that this is potentially a new file descriptor, otherwise |
1728 | will assume that this is potentially a new file descriptor, otherwise |
1625 | it is assumed that the file descriptor stays the same. That means that |
1729 | it is assumed that the file descriptor stays the same. That means that |
… | |
… | |
1674 | when you rarely read from a file instead of from a socket, and want to |
1778 | when you rarely read from a file instead of from a socket, and want to |
1675 | reuse the same code path. |
1779 | reuse the same code path. |
1676 | |
1780 | |
1677 | =head3 The special problem of fork |
1781 | =head3 The special problem of fork |
1678 | |
1782 | |
1679 | Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit |
1783 | Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()> |
1680 | useless behaviour. Libev fully supports fork, but needs to be told about |
1784 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1681 | it in the child if you want to continue to use it in the child. |
1785 | to be told about it in the child if you want to continue to use it in the |
|
|
1786 | child. |
1682 | |
1787 | |
1683 | To support fork in your child processes, you have to call C<ev_loop_fork |
1788 | To support fork in your child processes, you have to call C<ev_loop_fork |
1684 | ()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to |
1789 | ()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to |
1685 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1790 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1686 | |
1791 | |
… | |
… | |
1741 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1846 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1742 | |
1847 | |
1743 | =item ev_io_set (ev_io *, int fd, int events) |
1848 | =item ev_io_set (ev_io *, int fd, int events) |
1744 | |
1849 | |
1745 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1850 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1746 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or |
1851 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE>, both |
1747 | C<EV_READ | EV_WRITE>, to express the desire to receive the given events. |
1852 | C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given |
|
|
1853 | events. |
1748 | |
1854 | |
1749 | =item int fd [read-only] |
1855 | Note that setting the C<events> to C<0> and starting the watcher is |
|
|
1856 | supported, but not specially optimized - if your program sometimes happens |
|
|
1857 | to generate this combination this is fine, but if it is easy to avoid |
|
|
1858 | starting an io watcher watching for no events you should do so. |
1750 | |
1859 | |
1751 | The file descriptor being watched. |
1860 | =item ev_io_modify (ev_io *, int events) |
1752 | |
1861 | |
|
|
1862 | Similar to C<ev_io_set>, but only changes the requested events. Using this |
|
|
1863 | might be faster with some backends, as libev can assume that the C<fd> |
|
|
1864 | still refers to the same underlying file description, something it cannot |
|
|
1865 | do when using C<ev_io_set>. |
|
|
1866 | |
|
|
1867 | =item int fd [no-modify] |
|
|
1868 | |
|
|
1869 | The file descriptor being watched. While it can be read at any time, you |
|
|
1870 | must not modify this member even when the watcher is stopped - always use |
|
|
1871 | C<ev_io_set> for that. |
|
|
1872 | |
1753 | =item int events [read-only] |
1873 | =item int events [no-modify] |
1754 | |
1874 | |
1755 | The events being watched. |
1875 | The set of events the fd is being watched for, among other flags. Remember |
|
|
1876 | that this is a bit set - to test for C<EV_READ>, use C<< w->events & |
|
|
1877 | EV_READ >>, and similarly for C<EV_WRITE>. |
|
|
1878 | |
|
|
1879 | As with C<fd>, you must not modify this member even when the watcher is |
|
|
1880 | stopped, always use C<ev_io_set> or C<ev_io_modify> for that. |
1756 | |
1881 | |
1757 | =back |
1882 | =back |
1758 | |
1883 | |
1759 | =head3 Examples |
1884 | =head3 Examples |
1760 | |
1885 | |
… | |
… | |
2113 | |
2238 | |
2114 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2239 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2115 | |
2240 | |
2116 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2241 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2117 | |
2242 | |
2118 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
2243 | Configure the timer to trigger after C<after> seconds (fractional and |
2119 | is C<0.>, then it will automatically be stopped once the timeout is |
2244 | negative values are supported). If C<repeat> is C<0.>, then it will |
2120 | reached. If it is positive, then the timer will automatically be |
2245 | automatically be stopped once the timeout is reached. If it is positive, |
2121 | configured to trigger again C<repeat> seconds later, again, and again, |
2246 | then the timer will automatically be configured to trigger again C<repeat> |
2122 | until stopped manually. |
2247 | seconds later, again, and again, until stopped manually. |
2123 | |
2248 | |
2124 | The timer itself will do a best-effort at avoiding drift, that is, if |
2249 | The timer itself will do a best-effort at avoiding drift, that is, if |
2125 | you configure a timer to trigger every 10 seconds, then it will normally |
2250 | you configure a timer to trigger every 10 seconds, then it will normally |
2126 | trigger at exactly 10 second intervals. If, however, your program cannot |
2251 | trigger at exactly 10 second intervals. If, however, your program cannot |
2127 | keep up with the timer (because it takes longer than those 10 seconds to |
2252 | keep up with the timer (because it takes longer than those 10 seconds to |
… | |
… | |
2209 | Periodic watchers are also timers of a kind, but they are very versatile |
2334 | Periodic watchers are also timers of a kind, but they are very versatile |
2210 | (and unfortunately a bit complex). |
2335 | (and unfortunately a bit complex). |
2211 | |
2336 | |
2212 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2337 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2213 | relative time, the physical time that passes) but on wall clock time |
2338 | relative time, the physical time that passes) but on wall clock time |
2214 | (absolute time, the thing you can read on your calender or clock). The |
2339 | (absolute time, the thing you can read on your calendar or clock). The |
2215 | difference is that wall clock time can run faster or slower than real |
2340 | difference is that wall clock time can run faster or slower than real |
2216 | time, and time jumps are not uncommon (e.g. when you adjust your |
2341 | time, and time jumps are not uncommon (e.g. when you adjust your |
2217 | wrist-watch). |
2342 | wrist-watch). |
2218 | |
2343 | |
2219 | You can tell a periodic watcher to trigger after some specific point |
2344 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
2224 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2349 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2225 | it, as it uses a relative timeout). |
2350 | it, as it uses a relative timeout). |
2226 | |
2351 | |
2227 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2352 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2228 | timers, such as triggering an event on each "midnight, local time", or |
2353 | timers, such as triggering an event on each "midnight, local time", or |
2229 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
2354 | other complicated rules. This cannot easily be done with C<ev_timer> |
2230 | those cannot react to time jumps. |
2355 | watchers, as those cannot react to time jumps. |
2231 | |
2356 | |
2232 | As with timers, the callback is guaranteed to be invoked only when the |
2357 | As with timers, the callback is guaranteed to be invoked only when the |
2233 | point in time where it is supposed to trigger has passed. If multiple |
2358 | point in time where it is supposed to trigger has passed. If multiple |
2234 | timers become ready during the same loop iteration then the ones with |
2359 | timers become ready during the same loop iteration then the ones with |
2235 | earlier time-out values are invoked before ones with later time-out values |
2360 | earlier time-out values are invoked before ones with later time-out values |
… | |
… | |
2321 | |
2446 | |
2322 | NOTE: I<< This callback must always return a time that is higher than or |
2447 | NOTE: I<< This callback must always return a time that is higher than or |
2323 | equal to the passed C<now> value >>. |
2448 | equal to the passed C<now> value >>. |
2324 | |
2449 | |
2325 | This can be used to create very complex timers, such as a timer that |
2450 | This can be used to create very complex timers, such as a timer that |
2326 | triggers on "next midnight, local time". To do this, you would calculate the |
2451 | triggers on "next midnight, local time". To do this, you would calculate |
2327 | next midnight after C<now> and return the timestamp value for this. How |
2452 | the next midnight after C<now> and return the timestamp value for |
2328 | you do this is, again, up to you (but it is not trivial, which is the main |
2453 | this. Here is a (completely untested, no error checking) example on how to |
2329 | reason I omitted it as an example). |
2454 | do this: |
|
|
2455 | |
|
|
2456 | #include <time.h> |
|
|
2457 | |
|
|
2458 | static ev_tstamp |
|
|
2459 | my_rescheduler (ev_periodic *w, ev_tstamp now) |
|
|
2460 | { |
|
|
2461 | time_t tnow = (time_t)now; |
|
|
2462 | struct tm tm; |
|
|
2463 | localtime_r (&tnow, &tm); |
|
|
2464 | |
|
|
2465 | tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day |
|
|
2466 | ++tm.tm_mday; // midnight next day |
|
|
2467 | |
|
|
2468 | return mktime (&tm); |
|
|
2469 | } |
|
|
2470 | |
|
|
2471 | Note: this code might run into trouble on days that have more then two |
|
|
2472 | midnights (beginning and end). |
2330 | |
2473 | |
2331 | =back |
2474 | =back |
2332 | |
2475 | |
2333 | =item ev_periodic_again (loop, ev_periodic *) |
2476 | =item ev_periodic_again (loop, ev_periodic *) |
2334 | |
2477 | |
… | |
… | |
3517 | |
3660 | |
3518 | There are some other functions of possible interest. Described. Here. Now. |
3661 | There are some other functions of possible interest. Described. Here. Now. |
3519 | |
3662 | |
3520 | =over 4 |
3663 | =over 4 |
3521 | |
3664 | |
3522 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
3665 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg) |
3523 | |
3666 | |
3524 | This function combines a simple timer and an I/O watcher, calls your |
3667 | This function combines a simple timer and an I/O watcher, calls your |
3525 | callback on whichever event happens first and automatically stops both |
3668 | callback on whichever event happens first and automatically stops both |
3526 | watchers. This is useful if you want to wait for a single event on an fd |
3669 | watchers. This is useful if you want to wait for a single event on an fd |
3527 | or timeout without having to allocate/configure/start/stop/free one or |
3670 | or timeout without having to allocate/configure/start/stop/free one or |
… | |
… | |
3735 | event loop thread and an unspecified mechanism to wake up the main thread. |
3878 | event loop thread and an unspecified mechanism to wake up the main thread. |
3736 | |
3879 | |
3737 | First, you need to associate some data with the event loop: |
3880 | First, you need to associate some data with the event loop: |
3738 | |
3881 | |
3739 | typedef struct { |
3882 | typedef struct { |
3740 | mutex_t lock; /* global loop lock */ |
3883 | pthread_mutex_t lock; /* global loop lock */ |
|
|
3884 | pthread_t tid; |
|
|
3885 | pthread_cond_t invoke_cv; |
3741 | ev_async async_w; |
3886 | ev_async async_w; |
3742 | thread_t tid; |
|
|
3743 | cond_t invoke_cv; |
|
|
3744 | } userdata; |
3887 | } userdata; |
3745 | |
3888 | |
3746 | void prepare_loop (EV_P) |
3889 | void prepare_loop (EV_P) |
3747 | { |
3890 | { |
3748 | // for simplicity, we use a static userdata struct. |
3891 | // for simplicity, we use a static userdata struct. |
3749 | static userdata u; |
3892 | static userdata u; |
3750 | |
3893 | |
3751 | ev_async_init (&u->async_w, async_cb); |
3894 | ev_async_init (&u.async_w, async_cb); |
3752 | ev_async_start (EV_A_ &u->async_w); |
3895 | ev_async_start (EV_A_ &u.async_w); |
3753 | |
3896 | |
3754 | pthread_mutex_init (&u->lock, 0); |
3897 | pthread_mutex_init (&u.lock, 0); |
3755 | pthread_cond_init (&u->invoke_cv, 0); |
3898 | pthread_cond_init (&u.invoke_cv, 0); |
3756 | |
3899 | |
3757 | // now associate this with the loop |
3900 | // now associate this with the loop |
3758 | ev_set_userdata (EV_A_ u); |
3901 | ev_set_userdata (EV_A_ &u); |
3759 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
3902 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
3760 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
3903 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
3761 | |
3904 | |
3762 | // then create the thread running ev_run |
3905 | // then create the thread running ev_run |
3763 | pthread_create (&u->tid, 0, l_run, EV_A); |
3906 | pthread_create (&u.tid, 0, l_run, EV_A); |
3764 | } |
3907 | } |
3765 | |
3908 | |
3766 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
3909 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
3767 | solely to wake up the event loop so it takes notice of any new watchers |
3910 | solely to wake up the event loop so it takes notice of any new watchers |
3768 | that might have been added: |
3911 | that might have been added: |
… | |
… | |
3959 | The normal C API should work fine when used from C++: both ev.h and the |
4102 | The normal C API should work fine when used from C++: both ev.h and the |
3960 | libev sources can be compiled as C++. Therefore, code that uses the C API |
4103 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3961 | will work fine. |
4104 | will work fine. |
3962 | |
4105 | |
3963 | Proper exception specifications might have to be added to callbacks passed |
4106 | Proper exception specifications might have to be added to callbacks passed |
3964 | to libev: exceptions may be thrown only from watcher callbacks, all |
4107 | to libev: exceptions may be thrown only from watcher callbacks, all other |
3965 | other callbacks (allocator, syserr, loop acquire/release and periodic |
4108 | callbacks (allocator, syserr, loop acquire/release and periodic reschedule |
3966 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
4109 | callbacks) must not throw exceptions, and might need a C<noexcept> |
3967 | ()> specification. If you have code that needs to be compiled as both C |
4110 | specification. If you have code that needs to be compiled as both C and |
3968 | and C++ you can use the C<EV_THROW> macro for this: |
4111 | C++ you can use the C<EV_NOEXCEPT> macro for this: |
3969 | |
4112 | |
3970 | static void |
4113 | static void |
3971 | fatal_error (const char *msg) EV_THROW |
4114 | fatal_error (const char *msg) EV_NOEXCEPT |
3972 | { |
4115 | { |
3973 | perror (msg); |
4116 | perror (msg); |
3974 | abort (); |
4117 | abort (); |
3975 | } |
4118 | } |
3976 | |
4119 | |
… | |
… | |
4140 | method. |
4283 | method. |
4141 | |
4284 | |
4142 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
4285 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
4143 | clashing with the C<set (loop)> method. |
4286 | clashing with the C<set (loop)> method. |
4144 | |
4287 | |
|
|
4288 | For C<ev::io> watchers there is an additional C<set> method that acepts a |
|
|
4289 | new event mask only, and internally calls C<ev_io_modify>. |
|
|
4290 | |
4145 | =item w->start () |
4291 | =item w->start () |
4146 | |
4292 | |
4147 | Starts the watcher. Note that there is no C<loop> argument, as the |
4293 | Starts the watcher. Note that there is no C<loop> argument, as the |
4148 | constructor already stores the event loop. |
4294 | constructor already stores the event loop. |
4149 | |
4295 | |
… | |
… | |
4386 | ev_vars.h |
4532 | ev_vars.h |
4387 | ev_wrap.h |
4533 | ev_wrap.h |
4388 | |
4534 | |
4389 | ev_win32.c required on win32 platforms only |
4535 | ev_win32.c required on win32 platforms only |
4390 | |
4536 | |
4391 | ev_select.c only when select backend is enabled (which is enabled by default) |
4537 | ev_select.c only when select backend is enabled |
4392 | ev_poll.c only when poll backend is enabled (disabled by default) |
4538 | ev_poll.c only when poll backend is enabled |
4393 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4539 | ev_epoll.c only when the epoll backend is enabled |
|
|
4540 | ev_linuxaio.c only when the linux aio backend is enabled |
|
|
4541 | ev_iouring.c only when the linux io_uring backend is enabled |
4394 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4542 | ev_kqueue.c only when the kqueue backend is enabled |
4395 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
4543 | ev_port.c only when the solaris port backend is enabled |
4396 | |
4544 | |
4397 | F<ev.c> includes the backend files directly when enabled, so you only need |
4545 | F<ev.c> includes the backend files directly when enabled, so you only need |
4398 | to compile this single file. |
4546 | to compile this single file. |
4399 | |
4547 | |
4400 | =head3 LIBEVENT COMPATIBILITY API |
4548 | =head3 LIBEVENT COMPATIBILITY API |
… | |
… | |
4519 | available and will probe for kernel support at runtime. This will improve |
4667 | available and will probe for kernel support at runtime. This will improve |
4520 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
4668 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
4521 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
4669 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
4522 | 2.7 or newer, otherwise disabled. |
4670 | 2.7 or newer, otherwise disabled. |
4523 | |
4671 | |
|
|
4672 | =item EV_USE_SIGNALFD |
|
|
4673 | |
|
|
4674 | If defined to be C<1>, then libev will assume that C<signalfd ()> is |
|
|
4675 | available and will probe for kernel support at runtime. This enables |
|
|
4676 | the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If |
|
|
4677 | undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4678 | 2.7 or newer, otherwise disabled. |
|
|
4679 | |
|
|
4680 | =item EV_USE_TIMERFD |
|
|
4681 | |
|
|
4682 | If defined to be C<1>, then libev will assume that C<timerfd ()> is |
|
|
4683 | available and will probe for kernel support at runtime. This allows |
|
|
4684 | libev to detect time jumps accurately. If undefined, it will be enabled |
|
|
4685 | if the headers indicate GNU/Linux + Glibc 2.8 or newer and define |
|
|
4686 | C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled. |
|
|
4687 | |
|
|
4688 | =item EV_USE_EVENTFD |
|
|
4689 | |
|
|
4690 | If defined to be C<1>, then libev will assume that C<eventfd ()> is |
|
|
4691 | available and will probe for kernel support at runtime. This will improve |
|
|
4692 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
|
|
4693 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4694 | 2.7 or newer, otherwise disabled. |
|
|
4695 | |
4524 | =item EV_USE_SELECT |
4696 | =item EV_USE_SELECT |
4525 | |
4697 | |
4526 | If undefined or defined to be C<1>, libev will compile in support for the |
4698 | If undefined or defined to be C<1>, libev will compile in support for the |
4527 | C<select>(2) backend. No attempt at auto-detection will be done: if no |
4699 | C<select>(2) backend. No attempt at auto-detection will be done: if no |
4528 | other method takes over, select will be it. Otherwise the select backend |
4700 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
4588 | If defined to be C<1>, libev will compile in support for the Linux |
4760 | If defined to be C<1>, libev will compile in support for the Linux |
4589 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4761 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4590 | otherwise another method will be used as fallback. This is the preferred |
4762 | otherwise another method will be used as fallback. This is the preferred |
4591 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4763 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4592 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4764 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
|
|
4765 | |
|
|
4766 | =item EV_USE_LINUXAIO |
|
|
4767 | |
|
|
4768 | If defined to be C<1>, libev will compile in support for the Linux aio |
|
|
4769 | backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be |
|
|
4770 | enabled on linux, otherwise disabled. |
|
|
4771 | |
|
|
4772 | =item EV_USE_IOURING |
|
|
4773 | |
|
|
4774 | If defined to be C<1>, libev will compile in support for the Linux |
|
|
4775 | io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's |
|
|
4776 | current limitations it has to be requested explicitly. If undefined, it |
|
|
4777 | will be enabled on linux, otherwise disabled. |
4593 | |
4778 | |
4594 | =item EV_USE_KQUEUE |
4779 | =item EV_USE_KQUEUE |
4595 | |
4780 | |
4596 | If defined to be C<1>, libev will compile in support for the BSD style |
4781 | If defined to be C<1>, libev will compile in support for the BSD style |
4597 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
4782 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
… | |
… | |
4875 | called. If set to C<2>, then the internal verification code will be |
5060 | called. If set to C<2>, then the internal verification code will be |
4876 | called once per loop, which can slow down libev. If set to C<3>, then the |
5061 | called once per loop, which can slow down libev. If set to C<3>, then the |
4877 | verification code will be called very frequently, which will slow down |
5062 | verification code will be called very frequently, which will slow down |
4878 | libev considerably. |
5063 | libev considerably. |
4879 | |
5064 | |
|
|
5065 | Verification errors are reported via C's C<assert> mechanism, so if you |
|
|
5066 | disable that (e.g. by defining C<NDEBUG>) then no errors will be reported. |
|
|
5067 | |
4880 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
5068 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
4881 | will be C<0>. |
5069 | will be C<0>. |
4882 | |
5070 | |
4883 | =item EV_COMMON |
5071 | =item EV_COMMON |
4884 | |
5072 | |
… | |
… | |
5300 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5488 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5301 | assumes that the same (machine) code can be used to call any watcher |
5489 | assumes that the same (machine) code can be used to call any watcher |
5302 | callback: The watcher callbacks have different type signatures, but libev |
5490 | callback: The watcher callbacks have different type signatures, but libev |
5303 | calls them using an C<ev_watcher *> internally. |
5491 | calls them using an C<ev_watcher *> internally. |
5304 | |
5492 | |
|
|
5493 | =item null pointers and integer zero are represented by 0 bytes |
|
|
5494 | |
|
|
5495 | Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and |
|
|
5496 | relies on this setting pointers and integers to null. |
|
|
5497 | |
5305 | =item pointer accesses must be thread-atomic |
5498 | =item pointer accesses must be thread-atomic |
5306 | |
5499 | |
5307 | Accessing a pointer value must be atomic, it must both be readable and |
5500 | Accessing a pointer value must be atomic, it must both be readable and |
5308 | writable in one piece - this is the case on all current architectures. |
5501 | writable in one piece - this is the case on all current architectures. |
5309 | |
5502 | |