ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.3
(Generate patch)

Comparing libev/ev.3 (file contents):
Revision 1.105 by root, Thu Feb 18 04:48:05 2016 UTC vs.
Revision 1.119 by root, Wed Jan 22 02:00:13 2020 UTC

1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30) 1.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
… …
44.\" 44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
47.el .ds Aq ' 47.el .ds Aq '
48.\" 48.\"
49.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is >0, we'll generate index entries on stderr for
50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
52.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
53.\" 53.\"
54.\" Avoid warning from groff about undefined register 'F'. 54.\" Avoid warning from groff about undefined register 'F'.
55.de IX 55.de IX
56.. 56..
57.nr rF 0 57.nr rF 0
58.if \n(.g .if rF .nr rF 1 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{ 59.if (\n(rF:(\n(.g==0)) \{\
60. if \nF \{ 60. if \nF \{\
61. de IX 61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2" 62. tm Index:\\$1\t\\n%\t"\\$2"
63.. 63..
64. if !\nF==2 \{ 64. if !\nF==2 \{\
65. nr % 0 65. nr % 0
66. nr F 2 66. nr F 2
67. \} 67. \}
68. \} 68. \}
69.\} 69.\}
… …
131.\} 131.\}
132.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
133.\" ======================================================================== 133.\" ========================================================================
134.\" 134.\"
135.IX Title "LIBEV 3" 135.IX Title "LIBEV 3"
136.TH LIBEV 3 "2016-02-18" "libev-4.22" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2020-01-22" "libev-4.31" "libev - high performance full featured event loop"
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
139.if n .ad l 139.if n .ad l
140.nh 140.nh
141.SH "NAME" 141.SH "NAME"
… …
240watchers\fR, which are relatively small C structures you initialise with the 240watchers\fR, which are relatively small C structures you initialise with the
241details of the event, and then hand it over to libev by \fIstarting\fR the 241details of the event, and then hand it over to libev by \fIstarting\fR the
242watcher. 242watcher.
243.SS "\s-1FEATURES\s0" 243.SS "\s-1FEATURES\s0"
244.IX Subsection "FEATURES" 244.IX Subsection "FEATURES"
245Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 245Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific aio and \f(CW\*(C`epoll\*(C'\fR
246BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 246interfaces, the BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port
247for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 247mechanisms for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR
248(for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner 248interface (for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner
249inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative 249inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative
250timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling 250timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling
251(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status 251(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status
252change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event 252change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event
253loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and 253loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and
… …
291When libev detects a usage error such as a negative timer interval, then 291When libev detects a usage error such as a negative timer interval, then
292it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism, 292it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism,
293so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in 293so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in
294the libev caller and need to be fixed there. 294the libev caller and need to be fixed there.
295.PP 295.PP
296Via the \f(CW\*(C`EV_FREQUENT\*(C'\fR macro you can compile in and/or enable extensive
297consistency checking code inside libev that can be used to check for
298internal inconsistencies, suually caused by application bugs.
299.PP
296Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has 300Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions. These do not
297extensive consistency checking code. These do not trigger under normal
298circumstances, as they indicate either a bug in libev or worse. 301trigger under normal circumstances, as they indicate either a bug in libev
302or worse.
299.SH "GLOBAL FUNCTIONS" 303.SH "GLOBAL FUNCTIONS"
300.IX Header "GLOBAL FUNCTIONS" 304.IX Header "GLOBAL FUNCTIONS"
301These functions can be called anytime, even before initialising the 305These functions can be called anytime, even before initialising the
302library in any way. 306library in any way.
303.IP "ev_tstamp ev_time ()" 4 307.IP "ev_tstamp ev_time ()" 4
… …
392.Sp 396.Sp
393You could override this function in high-availability programs to, say, 397You could override this function in high-availability programs to, say,
394free some memory if it cannot allocate memory, to use a special allocator, 398free some memory if it cannot allocate memory, to use a special allocator,
395or even to sleep a while and retry until some memory is available. 399or even to sleep a while and retry until some memory is available.
396.Sp 400.Sp
401Example: The following is the \f(CW\*(C`realloc\*(C'\fR function that libev itself uses
402which should work with \f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions of all kinds and
403is probably a good basis for your own implementation.
404.Sp
405.Vb 5
406\& static void *
407\& ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
408\& {
409\& if (size)
410\& return realloc (ptr, size);
411\&
412\& free (ptr);
413\& return 0;
414\& }
415.Ve
416.Sp
397Example: Replace the libev allocator with one that waits a bit and then 417Example: Replace the libev allocator with one that waits a bit and then
398retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). 418retries.
399.Sp 419.Sp
400.Vb 6 420.Vb 8
401\& static void * 421\& static void *
402\& persistent_realloc (void *ptr, size_t size) 422\& persistent_realloc (void *ptr, size_t size)
403\& { 423\& {
424\& if (!size)
425\& {
426\& free (ptr);
427\& return 0;
428\& }
429\&
404\& for (;;) 430\& for (;;)
405\& { 431\& {
406\& void *newptr = realloc (ptr, size); 432\& void *newptr = realloc (ptr, size);
407\& 433\&
408\& if (newptr) 434\& if (newptr)
… …
536make libev check for a fork in each iteration by enabling this flag. 562make libev check for a fork in each iteration by enabling this flag.
537.Sp 563.Sp
538This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 564This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
539and thus this might slow down your event loop if you do a lot of loop 565and thus this might slow down your event loop if you do a lot of loop
540iterations and little real work, but is usually not noticeable (on my 566iterations and little real work, but is usually not noticeable (on my
541GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 567GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn
542without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has 568sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux
543\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 569system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc
570versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again).
544.Sp 571.Sp
545The big advantage of this flag is that you can forget about fork (and 572The big advantage of this flag is that you can forget about fork (and
546forget about forgetting to tell libev about forking, although you still 573forget about forgetting to tell libev about forking, although you still
547have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag. 574have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
548.Sp 575.Sp
… …
579want to handle signals only in specific threads and want to avoid libev 606want to handle signals only in specific threads and want to avoid libev
580unblocking the signals. 607unblocking the signals.
581.Sp 608.Sp
582It's also required by \s-1POSIX\s0 in a threaded program, as libev calls 609It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
583\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified. 610\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
611.ie n .IP """EVFLAG_NOTIMERFD""" 4
612.el .IP "\f(CWEVFLAG_NOTIMERFD\fR" 4
613.IX Item "EVFLAG_NOTIMERFD"
614When this flag is specified, the libev will avoid using a \f(CW\*(C`timerfd\*(C'\fR to
615detect time jumps. It will still be able to detect time jumps, but takes
616longer and has a lower accuracy in doing so, but saves a file descriptor
617per loop.
584.Sp 618.Sp
585This flag's behaviour will become the default in future versions of libev. 619The current implementation only tries to use a \f(CW\*(C`timerfd\*(C'\fR when the first
620\&\f(CW\*(C`ev_periodic\*(C'\fR watcher is started and falls back on other methods if it
621cannot be created, but this behaviour might change in the future.
586.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 622.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
587.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 623.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
588.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 624.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
589This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 625This is your standard \fBselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
590libev tries to roll its own fd_set with no limits on the number of fds, 626libev tries to roll its own fd_set with no limits on the number of fds,
591but if that fails, expect a fairly low limit on the number of fds when 627but if that fails, expect a fairly low limit on the number of fds when
592using this backend. It doesn't scale too well (O(highest_fd)), but its 628using this backend. It doesn't scale too well (O(highest_fd)), but its
593usually the fastest backend for a low number of (low-numbered :) fds. 629usually the fastest backend for a low number of (low-numbered :) fds.
594.Sp 630.Sp
… …
603\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the 639\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
604\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). 640\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
605.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 641.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
606.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 642.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
607.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 643.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
608And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 644And this is your standard \fBpoll\fR\|(2) backend. It's more complicated
609than select, but handles sparse fds better and has no artificial 645than select, but handles sparse fds better and has no artificial
610limit on the number of fds you can use (except it will slow down 646limit on the number of fds you can use (except it will slow down
611considerably with a lot of inactive fds). It scales similarly to select, 647considerably with a lot of inactive fds). It scales similarly to select,
612i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for 648i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
613performance tips. 649performance tips.
… …
615This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 651This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
616\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 652\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
617.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 653.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
618.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 654.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
619.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 655.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
620Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 656Use the Linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
621kernels). 657kernels).
622.Sp 658.Sp
623For few fds, this backend is a bit little slower than poll and select, but 659For few fds, this backend is a bit little slower than poll and select, but
624it scales phenomenally better. While poll and select usually scale like 660it scales phenomenally better. While poll and select usually scale like
625O(total_fds) where total_fds is the total number of fds (or the highest 661O(total_fds) where total_fds is the total number of fds (or the highest
… …
671All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or 707All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
672faster than epoll for maybe up to a hundred file descriptors, depending on 708faster than epoll for maybe up to a hundred file descriptors, depending on
673the usage. So sad. 709the usage. So sad.
674.Sp 710.Sp
675While nominally embeddable in other event loops, this feature is broken in 711While nominally embeddable in other event loops, this feature is broken in
676all kernel versions tested so far. 712a lot of kernel revisions, but probably(!) works in current versions.
713.Sp
714This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
715\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
716.ie n .IP """EVBACKEND_LINUXAIO"" (value 64, Linux)" 4
717.el .IP "\f(CWEVBACKEND_LINUXAIO\fR (value 64, Linux)" 4
718.IX Item "EVBACKEND_LINUXAIO (value 64, Linux)"
719Use the Linux-specific Linux \s-1AIO\s0 (\fInot\fR \f(CWaio(7)\fR but \f(CWio_submit(2)\fR) event interface available in post\-4.18 kernels (but libev
720only tries to use it in 4.19+).
721.Sp
722This is another Linux train wreck of an event interface.
723.Sp
724If this backend works for you (as of this writing, it was very
725experimental), it is the best event interface available on Linux and might
726be well worth enabling it \- if it isn't available in your kernel this will
727be detected and this backend will be skipped.
728.Sp
729This backend can batch oneshot requests and supports a user-space ring
730buffer to receive events. It also doesn't suffer from most of the design
731problems of epoll (such as not being able to remove event sources from
732the epoll set), and generally sounds too good to be true. Because, this
733being the Linux kernel, of course it suffers from a whole new set of
734limitations, forcing you to fall back to epoll, inheriting all its design
735issues.
736.Sp
737For one, it is not easily embeddable (but probably could be done using
738an event fd at some extra overhead). It also is subject to a system wide
739limit that can be configured in \fI/proc/sys/fs/aio\-max\-nr\fR. If no \s-1AIO\s0
740requests are left, this backend will be skipped during initialisation, and
741will switch to epoll when the loop is active.
742.Sp
743Most problematic in practice, however, is that not all file descriptors
744work with it. For example, in Linux 5.1, \s-1TCP\s0 sockets, pipes, event fds,
745files, \fI/dev/null\fR and many others are supported, but ttys do not work
746properly (a known bug that the kernel developers don't care about, see
747<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
748(yet?) a generic event polling interface.
749.Sp
750Overall, it seems the Linux developers just don't want it to have a
751generic event handling mechanism other than \f(CW\*(C`select\*(C'\fR or \f(CW\*(C`poll\*(C'\fR.
752.Sp
753To work around all these problem, the current version of libev uses its
754epoll backend as a fallback for file descriptor types that do not work. Or
755falls back completely to epoll if the kernel acts up.
677.Sp 756.Sp
678This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 757This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
679\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 758\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
680.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 759.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
681.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 760.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
682.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 761.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
683Kqueue deserves special mention, as at the time of this writing, it 762Kqueue deserves special mention, as at the time this backend was
684was broken on all BSDs except NetBSD (usually it doesn't work reliably 763implemented, it was broken on all BSDs except NetBSD (usually it doesn't
685with anything but sockets and pipes, except on Darwin, where of course 764work reliably with anything but sockets and pipes, except on Darwin,
686it's completely useless). Unlike epoll, however, whose brokenness 765where of course it's completely useless). Unlike epoll, however, whose
687is by design, these kqueue bugs can (and eventually will) be fixed 766brokenness is by design, these kqueue bugs can be (and mostly have been)
688without \s-1API\s0 changes to existing programs. For this reason it's not being 767fixed without \s-1API\s0 changes to existing programs. For this reason it's not
689\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using 768being \*(L"auto-detected\*(R" on all platforms unless you explicitly specify it
690\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) 769in the flags (i.e. using \f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a
691system like NetBSD. 770known-to-be-good (\-enough) system like NetBSD.
692.Sp 771.Sp
693You still can embed kqueue into a normal poll or select backend and use it 772You still can embed kqueue into a normal poll or select backend and use it
694only for sockets (after having made sure that sockets work with kqueue on 773only for sockets (after having made sure that sockets work with kqueue on
695the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 774the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
696.Sp 775.Sp
697It scales in the same way as the epoll backend, but the interface to the 776It scales in the same way as the epoll backend, but the interface to the
698kernel is more efficient (which says nothing about its actual speed, of 777kernel is more efficient (which says nothing about its actual speed, of
699course). While stopping, setting and starting an I/O watcher does never 778course). While stopping, setting and starting an I/O watcher does never
700cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 779cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
701two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you 780two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
702might have to leak fd's on fork, but it's more sane than epoll) and it 781might have to leak fds on fork, but it's more sane than epoll) and it
703drops fds silently in similarly hard-to-detect cases. 782drops fds silently in similarly hard-to-detect cases.
704.Sp 783.Sp
705This backend usually performs well under most conditions. 784This backend usually performs well under most conditions.
706.Sp 785.Sp
707While nominally embeddable in other event loops, this doesn't work 786While nominally embeddable in other event loops, this doesn't work
… …
784Example: Use whatever libev has to offer, but make sure that kqueue is 863Example: Use whatever libev has to offer, but make sure that kqueue is
785used if available. 864used if available.
786.Sp 865.Sp
787.Vb 1 866.Vb 1
788\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 867\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
868.Ve
869.Sp
870Example: Similarly, on linux, you mgiht want to take advantage of the
871linux aio backend if possible, but fall back to something else if that
872isn't available.
873.Sp
874.Vb 1
875\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
789.Ve 876.Ve
790.RE 877.RE
791.IP "ev_loop_destroy (loop)" 4 878.IP "ev_loop_destroy (loop)" 4
792.IX Item "ev_loop_destroy (loop)" 879.IX Item "ev_loop_destroy (loop)"
793Destroys an event loop object (frees all memory and kernel state 880Destroys an event loop object (frees all memory and kernel state
… …
1364bug in your program. 1451bug in your program.
1365.Sp 1452.Sp
1366Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1453Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
1367example it might indicate that a fd is readable or writable, and if your 1454example it might indicate that a fd is readable or writable, and if your
1368callbacks is well-written it can just attempt the operation and cope with 1455callbacks is well-written it can just attempt the operation and cope with
1369the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1456the error from \fBread()\fR or \fBwrite()\fR. This will not work in multi-threaded
1370programs, though, as the fd could already be closed and reused for another 1457programs, though, as the fd could already be closed and reused for another
1371thing, so beware. 1458thing, so beware.
1372.SS "\s-1GENERIC WATCHER FUNCTIONS\s0" 1459.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1373.IX Subsection "GENERIC WATCHER FUNCTIONS" 1460.IX Subsection "GENERIC WATCHER FUNCTIONS"
1374.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1461.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
… …
1576.IX Subsection "WATCHER PRIORITY MODELS" 1663.IX Subsection "WATCHER PRIORITY MODELS"
1577Many event loops support \fIwatcher priorities\fR, which are usually small 1664Many event loops support \fIwatcher priorities\fR, which are usually small
1578integers that influence the ordering of event callback invocation 1665integers that influence the ordering of event callback invocation
1579between watchers in some way, all else being equal. 1666between watchers in some way, all else being equal.
1580.PP 1667.PP
1581In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its 1668In libev, watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1582description for the more technical details such as the actual priority 1669description for the more technical details such as the actual priority
1583range. 1670range.
1584.PP 1671.PP
1585There are two common ways how these these priorities are being interpreted 1672There are two common ways how these these priorities are being interpreted
1586by event loops: 1673by event loops:
… …
1680.IX Header "WATCHER TYPES" 1767.IX Header "WATCHER TYPES"
1681This section describes each watcher in detail, but will not repeat 1768This section describes each watcher in detail, but will not repeat
1682information given in the last section. Any initialisation/set macros, 1769information given in the last section. Any initialisation/set macros,
1683functions and members specific to the watcher type are explained. 1770functions and members specific to the watcher type are explained.
1684.PP 1771.PP
1685Members are additionally marked with either \fI[read\-only]\fR, meaning that, 1772Most members are additionally marked with either \fI[read\-only]\fR, meaning
1686while the watcher is active, you can look at the member and expect some 1773that, while the watcher is active, you can look at the member and expect
1687sensible content, but you must not modify it (you can modify it while the 1774some sensible content, but you must not modify it (you can modify it while
1688watcher is stopped to your hearts content), or \fI[read\-write]\fR, which 1775the watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1689means you can expect it to have some sensible content while the watcher 1776means you can expect it to have some sensible content while the watcher
1690is active, but you can also modify it. Modifying it may not do something 1777is active, but you can also modify it. Modifying it may not do something
1691sensible or take immediate effect (or do anything at all), but libev will 1778sensible or take immediate effect (or do anything at all), but libev will
1692not crash or malfunction in any way. 1779not crash or malfunction in any way.
1780.PP
1781In any case, the documentation for each member will explain what the
1782effects are, and if there are any additional access restrictions.
1693.ie n .SS """ev_io"" \- is this file descriptor readable or writable?" 1783.ie n .SS """ev_io"" \- is this file descriptor readable or writable?"
1694.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?" 1784.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?"
1695.IX Subsection "ev_io - is this file descriptor readable or writable?" 1785.IX Subsection "ev_io - is this file descriptor readable or writable?"
1696I/O watchers check whether a file descriptor is readable or writable 1786I/O watchers check whether a file descriptor is readable or writable
1697in each iteration of the event loop, or, more precisely, when reading 1787in each iteration of the event loop, or, more precisely, when reading
… …
1725But really, best use non-blocking mode. 1815But really, best use non-blocking mode.
1726.PP 1816.PP
1727\fIThe special problem of disappearing file descriptors\fR 1817\fIThe special problem of disappearing file descriptors\fR
1728.IX Subsection "The special problem of disappearing file descriptors" 1818.IX Subsection "The special problem of disappearing file descriptors"
1729.PP 1819.PP
1730Some backends (e.g. kqueue, epoll) need to be told about closing a file 1820Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1731descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means, 1821a file descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other
1732such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file 1822means, such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some
1733descriptor, but when it goes away, the operating system will silently drop 1823file descriptor, but when it goes away, the operating system will silently
1734this interest. If another file descriptor with the same number then is 1824drop this interest. If another file descriptor with the same number then
1735registered with libev, there is no efficient way to see that this is, in 1825is registered with libev, there is no efficient way to see that this is,
1736fact, a different file descriptor. 1826in fact, a different file descriptor.
1737.PP 1827.PP
1738To avoid having to explicitly tell libev about such cases, libev follows 1828To avoid having to explicitly tell libev about such cases, libev follows
1739the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev 1829the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1740will assume that this is potentially a new file descriptor, otherwise 1830will assume that this is potentially a new file descriptor, otherwise
1741it is assumed that the file descriptor stays the same. That means that 1831it is assumed that the file descriptor stays the same. That means that
… …
1793reuse the same code path. 1883reuse the same code path.
1794.PP 1884.PP
1795\fIThe special problem of fork\fR 1885\fIThe special problem of fork\fR
1796.IX Subsection "The special problem of fork" 1886.IX Subsection "The special problem of fork"
1797.PP 1887.PP
1798Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1888Some backends (epoll, kqueue, linuxaio, iouring) do not support \f(CW\*(C`fork ()\*(C'\fR
1799useless behaviour. Libev fully supports fork, but needs to be told about 1889at all or exhibit useless behaviour. Libev fully supports fork, but needs
1800it in the child if you want to continue to use it in the child. 1890to be told about it in the child if you want to continue to use it in the
1891child.
1801.PP 1892.PP
1802To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork 1893To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1803()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to 1894()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1804\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1895\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1805.PP 1896.PP
… …
1810when writing to a pipe whose other end has been closed, your program gets 1901when writing to a pipe whose other end has been closed, your program gets
1811sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs 1902sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1812this is sensible behaviour, for daemons, this is usually undesirable. 1903this is sensible behaviour, for daemons, this is usually undesirable.
1813.PP 1904.PP
1814So when you encounter spurious, unexplained daemon exits, make sure you 1905So when you encounter spurious, unexplained daemon exits, make sure you
1815ignore \s-1SIGPIPE \s0(and maybe make sure you log the exit status of your daemon 1906ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1816somewhere, as that would have given you a big clue). 1907somewhere, as that would have given you a big clue).
1817.PP 1908.PP
1818\fIThe special problem of \fIaccept()\fIing when you can't\fR 1909\fIThe special problem of \f(BIaccept()\fIing when you can't\fR
1819.IX Subsection "The special problem of accept()ing when you can't" 1910.IX Subsection "The special problem of accept()ing when you can't"
1820.PP 1911.PP
1821Many implementations of the \s-1POSIX \s0\f(CW\*(C`accept\*(C'\fR function (for example, 1912Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
1822found in post\-2004 Linux) have the peculiar behaviour of not removing a 1913found in post\-2004 Linux) have the peculiar behaviour of not removing a
1823connection from the pending queue in all error cases. 1914connection from the pending queue in all error cases.
1824.PP 1915.PP
1825For example, larger servers often run out of file descriptors (because 1916For example, larger servers often run out of file descriptors (because
1826of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not 1917of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not
… …
1864.IX Item "ev_io_set (ev_io *, int fd, int events)" 1955.IX Item "ev_io_set (ev_io *, int fd, int events)"
1865.PD 1956.PD
1866Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1957Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
1867receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or 1958receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
1868\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events. 1959\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events.
1960.IP "ev_io_modify (ev_io *, int events)" 4
1961.IX Item "ev_io_modify (ev_io *, int events)"
1962Similar to \f(CW\*(C`ev_io_set\*(C'\fR, but only changes the event mask. Using this might
1963be faster with some backends, as libev can assume that the \f(CW\*(C`fd\*(C'\fR still
1964refers to the same underlying file description, something it cannot do
1965when using \f(CW\*(C`ev_io_set\*(C'\fR.
1869.IP "int fd [read\-only]" 4 1966.IP "int fd [no\-modify]" 4
1870.IX Item "int fd [read-only]" 1967.IX Item "int fd [no-modify]"
1871The file descriptor being watched. 1968The file descriptor being watched. While it can be read at any time, you
1969must not modify this member even when the watcher is stopped \- always use
1970\&\f(CW\*(C`ev_io_set\*(C'\fR for that.
1872.IP "int events [read\-only]" 4 1971.IP "int events [no\-modify]" 4
1873.IX Item "int events [read-only]" 1972.IX Item "int events [no-modify]"
1874The events being watched. 1973The set of events being watched, among other flags. This field is a
1974bit set \- to test for \f(CW\*(C`EV_READ\*(C'\fR, use \f(CW\*(C`w\->events & EV_READ\*(C'\fR, and
1975similarly for \f(CW\*(C`EV_WRITE\*(C'\fR.
1976.Sp
1977As with \f(CW\*(C`fd\*(C'\fR, you must not modify this member even when the watcher is
1978stopped, always use \f(CW\*(C`ev_io_set\*(C'\fR or \f(CW\*(C`ev_io_modify\*(C'\fR for that.
1875.PP 1979.PP
1876\fIExamples\fR 1980\fIExamples\fR
1877.IX Subsection "Examples" 1981.IX Subsection "Examples"
1878.PP 1982.PP
1879Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1983Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
… …
2250.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2354.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
2251.PD 0 2355.PD 0
2252.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2356.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
2253.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 2357.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
2254.PD 2358.PD
2255Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR 2359Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds (fractional and
2256is \f(CW0.\fR, then it will automatically be stopped once the timeout is 2360negative values are supported). If \f(CW\*(C`repeat\*(C'\fR is \f(CW0.\fR, then it will
2257reached. If it is positive, then the timer will automatically be 2361automatically be stopped once the timeout is reached. If it is positive,
2258configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, 2362then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
2259until stopped manually. 2363seconds later, again, and again, until stopped manually.
2260.Sp 2364.Sp
2261The timer itself will do a best-effort at avoiding drift, that is, if 2365The timer itself will do a best-effort at avoiding drift, that is, if
2262you configure a timer to trigger every 10 seconds, then it will normally 2366you configure a timer to trigger every 10 seconds, then it will normally
2263trigger at exactly 10 second intervals. If, however, your program cannot 2367trigger at exactly 10 second intervals. If, however, your program cannot
2264keep up with the timer (because it takes longer than those 10 seconds to 2368keep up with the timer (because it takes longer than those 10 seconds to
… …
2361\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting 2465\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2362it, as it uses a relative timeout). 2466it, as it uses a relative timeout).
2363.PP 2467.PP
2364\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex 2468\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
2365timers, such as triggering an event on each \*(L"midnight, local time\*(R", or 2469timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
2366other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as 2470other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2367those cannot react to time jumps. 2471watchers, as those cannot react to time jumps.
2368.PP 2472.PP
2369As with timers, the callback is guaranteed to be invoked only when the 2473As with timers, the callback is guaranteed to be invoked only when the
2370point in time where it is supposed to trigger has passed. If multiple 2474point in time where it is supposed to trigger has passed. If multiple
2371timers become ready during the same loop iteration then the ones with 2475timers become ready during the same loop iteration then the ones with
2372earlier time-out values are invoked before ones with later time-out values 2476earlier time-out values are invoked before ones with later time-out values
… …
2433In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being 2537In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
2434ignored. Instead, each time the periodic watcher gets scheduled, the 2538ignored. Instead, each time the periodic watcher gets scheduled, the
2435reschedule callback will be called with the watcher as first, and the 2539reschedule callback will be called with the watcher as first, and the
2436current time as second argument. 2540current time as second argument.
2437.Sp 2541.Sp
2438\&\s-1NOTE: \s0\fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever, 2542\&\s-1NOTE:\s0 \fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
2439or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly 2543or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2440allowed by documentation here\fR. 2544allowed by documentation here\fR.
2441.Sp 2545.Sp
2442If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2546If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2443it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2547it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
… …
2457It must return the next time to trigger, based on the passed time value 2561It must return the next time to trigger, based on the passed time value
2458(that is, the lowest time value larger than to the second argument). It 2562(that is, the lowest time value larger than to the second argument). It
2459will usually be called just before the callback will be triggered, but 2563will usually be called just before the callback will be triggered, but
2460might be called at other times, too. 2564might be called at other times, too.
2461.Sp 2565.Sp
2462\&\s-1NOTE: \s0\fIThis callback must always return a time that is higher than or 2566\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
2463equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. 2567equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2464.Sp 2568.Sp
2465This can be used to create very complex timers, such as a timer that 2569This can be used to create very complex timers, such as a timer that
2466triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the 2570triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate
2467next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2571the next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for
2468you do this is, again, up to you (but it is not trivial, which is the main 2572this. Here is a (completely untested, no error checking) example on how to
2469reason I omitted it as an example). 2573do this:
2574.Sp
2575.Vb 1
2576\& #include <time.h>
2577\&
2578\& static ev_tstamp
2579\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2580\& {
2581\& time_t tnow = (time_t)now;
2582\& struct tm tm;
2583\& localtime_r (&tnow, &tm);
2584\&
2585\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2586\& ++tm.tm_mday; // midnight next day
2587\&
2588\& return mktime (&tm);
2589\& }
2590.Ve
2591.Sp
2592Note: this code might run into trouble on days that have more then two
2593midnights (beginning and end).
2470.RE 2594.RE
2471.RS 4 2595.RS 4
2472.RE 2596.RE
2473.IP "ev_periodic_again (loop, ev_periodic *)" 4 2597.IP "ev_periodic_again (loop, ev_periodic *)" 4
2474.IX Item "ev_periodic_again (loop, ev_periodic *)" 2598.IX Item "ev_periodic_again (loop, ev_periodic *)"
… …
2592The simplest way to ensure that the signal mask is reset in the child is 2716The simplest way to ensure that the signal mask is reset in the child is
2593to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will 2717to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will
2594catch fork calls done by libraries (such as the libc) as well. 2718catch fork calls done by libraries (such as the libc) as well.
2595.PP 2719.PP
2596In current versions of libev, the signal will not be blocked indefinitely 2720In current versions of libev, the signal will not be blocked indefinitely
2597unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API \s0(\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces 2721unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API\s0 (\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
2598the window of opportunity for problems, it will not go away, as libev 2722the window of opportunity for problems, it will not go away, as libev
2599\&\fIhas\fR to modify the signal mask, at least temporarily. 2723\&\fIhas\fR to modify the signal mask, at least temporarily.
2600.PP 2724.PP
2601So I can't stress this enough: \fIIf you do not reset your signal mask when 2725So I can't stress this enough: \fIIf you do not reset your signal mask when
2602you expect it to be empty, you have a race condition in your code\fR. This 2726you expect it to be empty, you have a race condition in your code\fR. This
… …
3644is a time window between the event loop checking and resetting the async 3768is a time window between the event loop checking and resetting the async
3645notification, and the callback being invoked. 3769notification, and the callback being invoked.
3646.SH "OTHER FUNCTIONS" 3770.SH "OTHER FUNCTIONS"
3647.IX Header "OTHER FUNCTIONS" 3771.IX Header "OTHER FUNCTIONS"
3648There are some other functions of possible interest. Described. Here. Now. 3772There are some other functions of possible interest. Described. Here. Now.
3649.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3773.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" 4
3650.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3774.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)"
3651This function combines a simple timer and an I/O watcher, calls your 3775This function combines a simple timer and an I/O watcher, calls your
3652callback on whichever event happens first and automatically stops both 3776callback on whichever event happens first and automatically stops both
3653watchers. This is useful if you want to wait for a single event on an fd 3777watchers. This is useful if you want to wait for a single event on an fd
3654or timeout without having to allocate/configure/start/stop/free one or 3778or timeout without having to allocate/configure/start/stop/free one or
3655more watchers yourself. 3779more watchers yourself.
… …
4105The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the 4229The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4106libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0 4230libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4107will work fine. 4231will work fine.
4108.PP 4232.PP
4109Proper exception specifications might have to be added to callbacks passed 4233Proper exception specifications might have to be added to callbacks passed
4110to libev: exceptions may be thrown only from watcher callbacks, all 4234to libev: exceptions may be thrown only from watcher callbacks, all other
4111other callbacks (allocator, syserr, loop acquire/release and periodic 4235callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4112reschedule callbacks) must not throw exceptions, and might need a \f(CW\*(C`throw 4236callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4113()\*(C'\fR specification. If you have code that needs to be compiled as both C 4237specification. If you have code that needs to be compiled as both C and
4114and \*(C+ you can use the \f(CW\*(C`EV_THROW\*(C'\fR macro for this: 4238\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4115.PP 4239.PP
4116.Vb 6 4240.Vb 6
4117\& static void 4241\& static void
4118\& fatal_error (const char *msg) EV_THROW 4242\& fatal_error (const char *msg) EV_NOEXCEPT
4119\& { 4243\& {
4120\& perror (msg); 4244\& perror (msg);
4121\& abort (); 4245\& abort ();
4122\& } 4246\& }
4123\& 4247\&
… …
4497\& #include "ev.c" 4621\& #include "ev.c"
4498.Ve 4622.Ve
4499.PP 4623.PP
4500This will automatically include \fIev.h\fR, too, and should be done in a 4624This will automatically include \fIev.h\fR, too, and should be done in a
4501single C source file only to provide the function implementations. To use 4625single C source file only to provide the function implementations. To use
4502it, do the same for \fIev.h\fR in all files wishing to use this \s-1API \s0(best 4626it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
4503done by writing a wrapper around \fIev.h\fR that you can include instead and 4627done by writing a wrapper around \fIev.h\fR that you can include instead and
4504where you can put other configuration options): 4628where you can put other configuration options):
4505.PP 4629.PP
4506.Vb 2 4630.Vb 2
4507\& #define EV_STANDALONE 1 4631\& #define EV_STANDALONE 1
… …
4521\& ev_vars.h 4645\& ev_vars.h
4522\& ev_wrap.h 4646\& ev_wrap.h
4523\& 4647\&
4524\& ev_win32.c required on win32 platforms only 4648\& ev_win32.c required on win32 platforms only
4525\& 4649\&
4526\& ev_select.c only when select backend is enabled (which is enabled by default) 4650\& ev_select.c only when select backend is enabled
4527\& ev_poll.c only when poll backend is enabled (disabled by default) 4651\& ev_poll.c only when poll backend is enabled
4528\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4652\& ev_epoll.c only when the epoll backend is enabled
4653\& ev_linuxaio.c only when the linux aio backend is enabled
4654\& ev_iouring.c only when the linux io_uring backend is enabled
4529\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4655\& ev_kqueue.c only when the kqueue backend is enabled
4530\& ev_port.c only when the solaris port backend is enabled (disabled by default) 4656\& ev_port.c only when the solaris port backend is enabled
4531.Ve 4657.Ve
4532.PP 4658.PP
4533\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4659\&\fIev.c\fR includes the backend files directly when enabled, so you only need
4534to compile this single file. 4660to compile this single file.
4535.PP 4661.PP
… …
4580values when compiling libev vs. including \fIev.h\fR, so it is permissible 4706values when compiling libev vs. including \fIev.h\fR, so it is permissible
4581to redefine them before including \fIev.h\fR without breaking compatibility 4707to redefine them before including \fIev.h\fR without breaking compatibility
4582to a compiled library. All other symbols change the \s-1ABI,\s0 which means all 4708to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4583users of libev and the libev code itself must be compiled with compatible 4709users of libev and the libev code itself must be compiled with compatible
4584settings. 4710settings.
4585.IP "\s-1EV_COMPAT3 \s0(h)" 4 4711.IP "\s-1EV_COMPAT3\s0 (h)" 4
4586.IX Item "EV_COMPAT3 (h)" 4712.IX Item "EV_COMPAT3 (h)"
4587Backwards compatibility is a major concern for libev. This is why this 4713Backwards compatibility is a major concern for libev. This is why this
4588release of libev comes with wrappers for the functions and symbols that 4714release of libev comes with wrappers for the functions and symbols that
4589have been renamed between libev version 3 and 4. 4715have been renamed between libev version 3 and 4.
4590.Sp 4716.Sp
… …
4595typedef in that case. 4721typedef in that case.
4596.Sp 4722.Sp
4597In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR, 4723In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR,
4598and in some even more future version the compatibility code will be 4724and in some even more future version the compatibility code will be
4599removed completely. 4725removed completely.
4600.IP "\s-1EV_STANDALONE \s0(h)" 4 4726.IP "\s-1EV_STANDALONE\s0 (h)" 4
4601.IX Item "EV_STANDALONE (h)" 4727.IX Item "EV_STANDALONE (h)"
4602Must always be \f(CW1\fR if you do not use autoconf configuration, which 4728Must always be \f(CW1\fR if you do not use autoconf configuration, which
4603keeps libev from including \fIconfig.h\fR, and it also defines dummy 4729keeps libev from including \fIconfig.h\fR, and it also defines dummy
4604implementations for some libevent functions (such as logging, which is not 4730implementations for some libevent functions (such as logging, which is not
4605supported). It will also not define any of the structs usually found in 4731supported). It will also not define any of the structs usually found in
… …
4646higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). 4772higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR).
4647.IP "\s-1EV_USE_NANOSLEEP\s0" 4 4773.IP "\s-1EV_USE_NANOSLEEP\s0" 4
4648.IX Item "EV_USE_NANOSLEEP" 4774.IX Item "EV_USE_NANOSLEEP"
4649If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available 4775If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
4650and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. 4776and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
4777.IP "\s-1EV_USE_EVENTFD\s0" 4
4778.IX Item "EV_USE_EVENTFD"
4779If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4780available and will probe for kernel support at runtime. This will improve
4781\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4782If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
47832.7 or newer, otherwise disabled.
4784.IP "\s-1EV_USE_SIGNALFD\s0" 4
4785.IX Item "EV_USE_SIGNALFD"
4786If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`signalfd ()\*(C'\fR is
4787available and will probe for kernel support at runtime. This enables
4788the use of \s-1EVFLAG_SIGNALFD\s0 for faster and simpler signal handling. If
4789undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
47902.7 or newer, otherwise disabled.
4791.IP "\s-1EV_USE_TIMERFD\s0" 4
4792.IX Item "EV_USE_TIMERFD"
4793If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`timerfd ()\*(C'\fR is
4794available and will probe for kernel support at runtime. This allows
4795libev to detect time jumps accurately. If undefined, it will be enabled
4796if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4797\&\f(CW\*(C`TFD_TIMER_CANCEL_ON_SET\*(C'\fR, otherwise disabled.
4651.IP "\s-1EV_USE_EVENTFD\s0" 4 4798.IP "\s-1EV_USE_EVENTFD\s0" 4
4652.IX Item "EV_USE_EVENTFD" 4799.IX Item "EV_USE_EVENTFD"
4653If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is 4800If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4654available and will probe for kernel support at runtime. This will improve 4801available and will probe for kernel support at runtime. This will improve
4655\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. 4802\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
… …
4714If defined to be \f(CW1\fR, libev will compile in support for the Linux 4861If defined to be \f(CW1\fR, libev will compile in support for the Linux
4715\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 4862\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
4716otherwise another method will be used as fallback. This is the preferred 4863otherwise another method will be used as fallback. This is the preferred
4717backend for GNU/Linux systems. If undefined, it will be enabled if the 4864backend for GNU/Linux systems. If undefined, it will be enabled if the
4718headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4865headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4866.IP "\s-1EV_USE_LINUXAIO\s0" 4
4867.IX Item "EV_USE_LINUXAIO"
4868If defined to be \f(CW1\fR, libev will compile in support for the Linux aio
4869backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). If undefined, it will be
4870enabled on linux, otherwise disabled.
4871.IP "\s-1EV_USE_IOURING\s0" 4
4872.IX Item "EV_USE_IOURING"
4873If defined to be \f(CW1\fR, libev will compile in support for the Linux
4874io_uring backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). Due to it's
4875current limitations it has to be requested explicitly. If undefined, it
4876will be enabled on linux, otherwise disabled.
4719.IP "\s-1EV_USE_KQUEUE\s0" 4 4877.IP "\s-1EV_USE_KQUEUE\s0" 4
4720.IX Item "EV_USE_KQUEUE" 4878.IX Item "EV_USE_KQUEUE"
4721If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4879If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
4722\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 4880\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
4723otherwise another method will be used as fallback. This is the preferred 4881otherwise another method will be used as fallback. This is the preferred
… …
4763handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR 4921handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4764watchers. 4922watchers.
4765.Sp 4923.Sp
4766In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4924In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4767(from \fIsignal.h\fR), which is usually good enough on most platforms. 4925(from \fIsignal.h\fR), which is usually good enough on most platforms.
4768.IP "\s-1EV_H \s0(h)" 4 4926.IP "\s-1EV_H\s0 (h)" 4
4769.IX Item "EV_H (h)" 4927.IX Item "EV_H (h)"
4770The name of the \fIev.h\fR header file used to include it. The default if 4928The name of the \fIev.h\fR header file used to include it. The default if
4771undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 4929undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
4772used to virtually rename the \fIev.h\fR header file in case of conflicts. 4930used to virtually rename the \fIev.h\fR header file in case of conflicts.
4773.IP "\s-1EV_CONFIG_H \s0(h)" 4 4931.IP "\s-1EV_CONFIG_H\s0 (h)" 4
4774.IX Item "EV_CONFIG_H (h)" 4932.IX Item "EV_CONFIG_H (h)"
4775If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 4933If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
4776\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 4934\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
4777\&\f(CW\*(C`EV_H\*(C'\fR, above. 4935\&\f(CW\*(C`EV_H\*(C'\fR, above.
4778.IP "\s-1EV_EVENT_H \s0(h)" 4 4936.IP "\s-1EV_EVENT_H\s0 (h)" 4
4779.IX Item "EV_EVENT_H (h)" 4937.IX Item "EV_EVENT_H (h)"
4780Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 4938Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
4781of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR. 4939of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
4782.IP "\s-1EV_PROTOTYPES \s0(h)" 4 4940.IP "\s-1EV_PROTOTYPES\s0 (h)" 4
4783.IX Item "EV_PROTOTYPES (h)" 4941.IX Item "EV_PROTOTYPES (h)"
4784If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 4942If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
4785prototypes, but still define all the structs and other symbols. This is 4943prototypes, but still define all the structs and other symbols. This is
4786occasionally useful if you want to provide your own wrapper functions 4944occasionally useful if you want to provide your own wrapper functions
4787around libev functions. 4945around libev functions.
… …
4980called. If set to \f(CW2\fR, then the internal verification code will be 5138called. If set to \f(CW2\fR, then the internal verification code will be
4981called once per loop, which can slow down libev. If set to \f(CW3\fR, then the 5139called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
4982verification code will be called very frequently, which will slow down 5140verification code will be called very frequently, which will slow down
4983libev considerably. 5141libev considerably.
4984.Sp 5142.Sp
5143Verification errors are reported via C's \f(CW\*(C`assert\*(C'\fR mechanism, so if you
5144disable that (e.g. by defining \f(CW\*(C`NDEBUG\*(C'\fR) then no errors will be reported.
5145.Sp
4985The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it 5146The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4986will be \f(CW0\fR. 5147will be \f(CW0\fR.
4987.IP "\s-1EV_COMMON\s0" 4 5148.IP "\s-1EV_COMMON\s0" 4
4988.IX Item "EV_COMMON" 5149.IX Item "EV_COMMON"
4989By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 5150By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
… …
4996.Vb 3 5157.Vb 3
4997\& #define EV_COMMON \e 5158\& #define EV_COMMON \e
4998\& SV *self; /* contains this struct */ \e 5159\& SV *self; /* contains this struct */ \e
4999\& SV *cb_sv, *fh /* note no trailing ";" */ 5160\& SV *cb_sv, *fh /* note no trailing ";" */
5000.Ve 5161.Ve
5001.IP "\s-1EV_CB_DECLARE \s0(type)" 4 5162.IP "\s-1EV_CB_DECLARE\s0 (type)" 4
5002.IX Item "EV_CB_DECLARE (type)" 5163.IX Item "EV_CB_DECLARE (type)"
5003.PD 0 5164.PD 0
5004.IP "\s-1EV_CB_INVOKE \s0(watcher, revents)" 4 5165.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4
5005.IX Item "EV_CB_INVOKE (watcher, revents)" 5166.IX Item "EV_CB_INVOKE (watcher, revents)"
5006.IP "ev_set_cb (ev, cb)" 4 5167.IP "ev_set_cb (ev, cb)" 4
5007.IX Item "ev_set_cb (ev, cb)" 5168.IX Item "ev_set_cb (ev, cb)"
5008.PD 5169.PD
5009Can be used to change the callback member declaration in each watcher, 5170Can be used to change the callback member declaration in each watcher,
… …
5012their default definitions. One possible use for overriding these is to 5173their default definitions. One possible use for overriding these is to
5013avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5174avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
5014method calls instead of plain function calls in \*(C+. 5175method calls instead of plain function calls in \*(C+.
5015.SS "\s-1EXPORTED API SYMBOLS\s0" 5176.SS "\s-1EXPORTED API SYMBOLS\s0"
5016.IX Subsection "EXPORTED API SYMBOLS" 5177.IX Subsection "EXPORTED API SYMBOLS"
5017If you need to re-export the \s-1API \s0(e.g. via a \s-1DLL\s0) and you need a list of 5178If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
5018exported symbols, you can use the provided \fISymbol.*\fR files which list 5179exported symbols, you can use the provided \fISymbol.*\fR files which list
5019all public symbols, one per line: 5180all public symbols, one per line:
5020.PP 5181.PP
5021.Vb 2 5182.Vb 2
5022\& Symbols.ev for libev proper 5183\& Symbols.ev for libev proper
… …
5254.PP 5415.PP
5255\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5416\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
5256.IX Subsection "select is buggy" 5417.IX Subsection "select is buggy"
5257.PP 5418.PP
5258All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5419All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
5259one up as well: On \s-1OS/X, \s0\f(CW\*(C`select\*(C'\fR actively limits the number of file 5420one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file
5260descriptors you can pass in to 1024 \- your program suddenly crashes when 5421descriptors you can pass in to 1024 \- your program suddenly crashes when
5261you use more. 5422you use more.
5262.PP 5423.PP
5263There is an undocumented \*(L"workaround\*(R" for this \- defining 5424There is an undocumented \*(L"workaround\*(R" for this \- defining
5264\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR 5425\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
… …
5412Libev assumes not only that all watcher pointers have the same internal 5573Libev assumes not only that all watcher pointers have the same internal
5413structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also 5574structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5414assumes that the same (machine) code can be used to call any watcher 5575assumes that the same (machine) code can be used to call any watcher
5415callback: The watcher callbacks have different type signatures, but libev 5576callback: The watcher callbacks have different type signatures, but libev
5416calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5577calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5578.IP "null pointers and integer zero are represented by 0 bytes" 4
5579.IX Item "null pointers and integer zero are represented by 0 bytes"
5580Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5581relies on this setting pointers and integers to null.
5417.IP "pointer accesses must be thread-atomic" 4 5582.IP "pointer accesses must be thread-atomic" 4
5418.IX Item "pointer accesses must be thread-atomic" 5583.IX Item "pointer accesses must be thread-atomic"
5419Accessing a pointer value must be atomic, it must both be readable and 5584Accessing a pointer value must be atomic, it must both be readable and
5420writable in one piece \- this is the case on all current architectures. 5585writable in one piece \- this is the case on all current architectures.
5421.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5586.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines