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

Comparing libev/ev.pod (file contents):
Revision 1.439 by root, Tue Mar 1 19:19:25 2016 UTC vs.
Revision 1.462 by root, Wed Jan 22 13:06:53 2020 UTC

105details of the event, and then hand it over to libev by I<starting> the 105details of the event, and then hand it over to libev by I<starting> the
106watcher. 106watcher.
107 107
108=head2 FEATURES 108=head2 FEATURES
109 109
110Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 110Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll>
111BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 111interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port
112for file descriptor events (C<ev_io>), the Linux C<inotify> interface 112mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify>
113(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner 113interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
114inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative 114inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
115timers (C<ev_timer>), absolute timers with customised rescheduling 115timers (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
117change events (C<ev_child>), and event watchers dealing with the event 117change events (C<ev_child>), and event watchers dealing with the event
118loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and 118loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
159When libev detects a usage error such as a negative timer interval, then 159When libev detects a usage error such as a negative timer interval, then
160it will print a diagnostic message and abort (via the C<assert> mechanism, 160it will print a diagnostic message and abort (via the C<assert> mechanism,
161so C<NDEBUG> will disable this checking): these are programming errors in 161so C<NDEBUG> will disable this checking): these are programming errors in
162the libev caller and need to be fixed there. 162the libev caller and need to be fixed there.
163 163
164Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive
165consistency checking code inside libev that can be used to check for
166internal inconsistencies, suually caused by application bugs.
167
164Libev also has a few internal error-checking C<assert>ions, and also has 168Libev also has a few internal error-checking C<assert>ions. These do not
165extensive consistency checking code. These do not trigger under normal
166circumstances, as they indicate either a bug in libev or worse. 169trigger under normal circumstances, as they indicate either a bug in libev
170or worse.
167 171
168 172
169=head1 GLOBAL FUNCTIONS 173=head1 GLOBAL FUNCTIONS
170 174
171These functions can be called anytime, even before initialising the 175These functions can be called anytime, even before initialising the
265 269
266You could override this function in high-availability programs to, say, 270You could override this function in high-availability programs to, say,
267free some memory if it cannot allocate memory, to use a special allocator, 271free some memory if it cannot allocate memory, to use a special allocator,
268or even to sleep a while and retry until some memory is available. 272or even to sleep a while and retry until some memory is available.
269 273
274Example: The following is the C<realloc> function that libev itself uses
275which should work with C<realloc> and C<free> functions of all kinds and
276is 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
270Example: Replace the libev allocator with one that waits a bit and then 288Example: Replace the libev allocator with one that waits a bit and then
271retries (example requires a standards-compliant C<realloc>). 289retries.
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)
411make libev check for a fork in each iteration by enabling this flag. 435make libev check for a fork in each iteration by enabling this flag.
412 436
413This works by calling C<getpid ()> on every iteration of the loop, 437This works by calling C<getpid ()> on every iteration of the loop,
414and thus this might slow down your event loop if you do a lot of loop 438and thus this might slow down your event loop if you do a lot of loop
415iterations and little real work, but is usually not noticeable (on my 439iterations and little real work, but is usually not noticeable (on my
416GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 440GNU/Linux system for example, C<getpid> is actually a simple 5-insn
417without a system call and thus I<very> fast, but my GNU/Linux system also has 441sequence without a system call and thus I<very> fast, but my GNU/Linux
418C<pthread_atfork> which is even faster). 442system also has C<pthread_atfork> which is even faster). (Update: glibc
443versions 2.25 apparently removed the C<getpid> optimisation again).
419 444
420The big advantage of this flag is that you can forget about fork (and 445The big advantage of this flag is that you can forget about fork (and
421forget about forgetting to tell libev about forking, although you still 446forget about forgetting to tell libev about forking, although you still
422have to ignore C<SIGPIPE>) when you use this flag. 447have to ignore C<SIGPIPE>) when you use this flag.
423 448
455unblocking the signals. 480unblocking the signals.
456 481
457It's also required by POSIX in a threaded program, as libev calls 482It's also required by POSIX in a threaded program, as libev calls
458C<sigprocmask>, whose behaviour is officially unspecified. 483C<sigprocmask>, whose behaviour is officially unspecified.
459 484
460This flag's behaviour will become the default in future versions of libev. 485=item C<EVFLAG_NOTIMERFD>
486
487When this flag is specified, the libev will avoid using a C<timerfd> to
488detect time jumps. It will still be able to detect time jumps, but takes
489longer and has a lower accuracy in doing so, but saves a file descriptor
490per loop.
491
492The current implementation only tries to use a C<timerfd> when the first
493C<ev_periodic> watcher is started and falls back on other methods if it
494cannot 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
464This is your standard select(2) backend. Not I<completely> standard, as 498This is your standard select(2) backend. Not I<completely> standard, as
465libev tries to roll its own fd_set with no limits on the number of fds, 499libev tries to roll its own fd_set with no limits on the number of fds,
490This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 524This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
491C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 525C<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
495Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 529Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
496kernels). 530kernels).
497 531
498For few fds, this backend is a bit little slower than poll and select, but 532For few fds, this backend is a bit little slower than poll and select, but
499it scales phenomenally better. While poll and select usually scale like 533it scales phenomenally better. While poll and select usually scale like
500O(total_fds) where total_fds is the total number of fds (or the highest 534O(total_fds) where total_fds is the total number of fds (or the highest
546All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or 580All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
547faster than epoll for maybe up to a hundred file descriptors, depending on 581faster than epoll for maybe up to a hundred file descriptors, depending on
548the usage. So sad. 582the usage. So sad.
549 583
550While nominally embeddable in other event loops, this feature is broken in 584While nominally embeddable in other event loops, this feature is broken in
551all kernel versions tested so far. 585a lot of kernel revisions, but probably(!) works in current versions.
552 586
553This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 587This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
554C<EVBACKEND_POLL>. 588C<EVBACKEND_POLL>.
555 589
590=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
591
592Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
593io_submit(2) >>) event interface available in post-4.18 kernels (but libev
594only tries to use it in 4.19+).
595
596This is another Linux train wreck of an event interface.
597
598If this backend works for you (as of this writing, it was very
599experimental), it is the best event interface available on Linux and might
600be well worth enabling it - if it isn't available in your kernel this will
601be detected and this backend will be skipped.
602
603This backend can batch oneshot requests and supports a user-space ring
604buffer to receive events. It also doesn't suffer from most of the design
605problems of epoll (such as not being able to remove event sources from
606the epoll set), and generally sounds too good to be true. Because, this
607being the Linux kernel, of course it suffers from a whole new set of
608limitations, forcing you to fall back to epoll, inheriting all its design
609issues.
610
611For one, it is not easily embeddable (but probably could be done using
612an event fd at some extra overhead). It also is subject to a system wide
613limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
614requests are left, this backend will be skipped during initialisation, and
615will switch to epoll when the loop is active.
616
617Most problematic in practice, however, is that not all file descriptors
618work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
619files, F</dev/null> and many others are supported, but ttys do not work
620properly (a known bug that the kernel developers don't care about, see
621L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
622(yet?) a generic event polling interface.
623
624Overall, it seems the Linux developers just don't want it to have a
625generic event handling mechanism other than C<select> or C<poll>.
626
627To work around all these problem, the current version of libev uses its
628epoll backend as a fallback for file descriptor types that do not work. Or
629falls back completely to epoll if the kernel acts up.
630
631This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
632C<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
558Kqueue deserves special mention, as at the time of this writing, it 636Kqueue deserves special mention, as at the time this backend was
559was broken on all BSDs except NetBSD (usually it doesn't work reliably 637implemented, it was broken on all BSDs except NetBSD (usually it doesn't
560with anything but sockets and pipes, except on Darwin, where of course 638work reliably with anything but sockets and pipes, except on Darwin,
561it's completely useless). Unlike epoll, however, whose brokenness 639where of course it's completely useless). Unlike epoll, however, whose
562is by design, these kqueue bugs can (and eventually will) be fixed 640brokenness is by design, these kqueue bugs can be (and mostly have been)
563without API changes to existing programs. For this reason it's not being 641fixed 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 642being "auto-detected" on all platforms unless you explicitly specify it
565C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 643in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
566system like NetBSD. 644known-to-be-good (-enough) system like NetBSD.
567 645
568You still can embed kqueue into a normal poll or select backend and use it 646You still can embed kqueue into a normal poll or select backend and use it
569only for sockets (after having made sure that sockets work with kqueue on 647only for sockets (after having made sure that sockets work with kqueue on
570the target platform). See C<ev_embed> watchers for more info. 648the target platform). See C<ev_embed> watchers for more info.
571 649
572It scales in the same way as the epoll backend, but the interface to the 650It scales in the same way as the epoll backend, but the interface to the
573kernel is more efficient (which says nothing about its actual speed, of 651kernel is more efficient (which says nothing about its actual speed, of
574course). While stopping, setting and starting an I/O watcher does never 652course). While stopping, setting and starting an I/O watcher does never
575cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 653cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
576two event changes per incident. Support for C<fork ()> is very bad (you 654two event changes per incident. Support for C<fork ()> is very bad (you
577might have to leak fd's on fork, but it's more sane than epoll) and it 655might have to leak fds on fork, but it's more sane than epoll) and it
578drops fds silently in similarly hard-to-detect cases. 656drops fds silently in similarly hard-to-detect cases.
579 657
580This backend usually performs well under most conditions. 658This backend usually performs well under most conditions.
581 659
582While nominally embeddable in other event loops, this doesn't work 660While nominally embeddable in other event loops, this doesn't work
656 734
657Example: Use whatever libev has to offer, but make sure that kqueue is 735Example: Use whatever libev has to offer, but make sure that kqueue is
658used if available. 736used 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);
739
740Example: Similarly, on linux, you mgiht want to take advantage of the
741linux aio backend if possible, but fall back to something else if that
742isn't available.
743
744 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
661 745
662=item ev_loop_destroy (loop) 746=item ev_loop_destroy (loop)
663 747
664Destroys an event loop object (frees all memory and kernel state 748Destroys an event loop object (frees all memory and kernel state
665etc.). None of the active event watchers will be stopped in the normal 749etc.). None of the active event watchers will be stopped in the normal
1134with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher 1218with 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
1136corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. 1220corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
1137 1221
1138As long as your watcher is active (has been started but not stopped) you 1222As long as your watcher is active (has been started but not stopped) you
1139must not touch the values stored in it. Most specifically you must never 1223must not touch the values stored in it except when explicitly documented
1140reinitialise it or call its C<ev_TYPE_set> macro. 1224otherwise. Most specifically you must never reinitialise it or call its
1225C<ev_TYPE_set> macro.
1141 1226
1142Each and every callback receives the event loop pointer as first, the 1227Each and every callback receives the event loop pointer as first, the
1143registered watcher structure as second, and a bitset of received events as 1228registered watcher structure as second, and a bitset of received events as
1144third argument. 1229third argument.
1145 1230
1460 1545
1461Many event loops support I<watcher priorities>, which are usually small 1546Many event loops support I<watcher priorities>, which are usually small
1462integers that influence the ordering of event callback invocation 1547integers that influence the ordering of event callback invocation
1463between watchers in some way, all else being equal. 1548between watchers in some way, all else being equal.
1464 1549
1465In libev, Watcher priorities can be set using C<ev_set_priority>. See its 1550In libev, watcher priorities can be set using C<ev_set_priority>. See its
1466description for the more technical details such as the actual priority 1551description for the more technical details such as the actual priority
1467range. 1552range.
1468 1553
1469There are two common ways how these these priorities are being interpreted 1554There are two common ways how these these priorities are being interpreted
1470by event loops: 1555by event loops:
1564 1649
1565This section describes each watcher in detail, but will not repeat 1650This section describes each watcher in detail, but will not repeat
1566information given in the last section. Any initialisation/set macros, 1651information given in the last section. Any initialisation/set macros,
1567functions and members specific to the watcher type are explained. 1652functions and members specific to the watcher type are explained.
1568 1653
1569Members are additionally marked with either I<[read-only]>, meaning that, 1654Most members are additionally marked with either I<[read-only]>, meaning
1570while the watcher is active, you can look at the member and expect some 1655that, while the watcher is active, you can look at the member and expect
1571sensible content, but you must not modify it (you can modify it while the 1656some sensible content, but you must not modify it (you can modify it while
1572watcher is stopped to your hearts content), or I<[read-write]>, which 1657the watcher is stopped to your hearts content), or I<[read-write]>, which
1573means you can expect it to have some sensible content while the watcher 1658means you can expect it to have some sensible content while the watcher
1574is active, but you can also modify it. Modifying it may not do something 1659is active, but you can also modify it. Modifying it may not do something
1575sensible or take immediate effect (or do anything at all), but libev will 1660sensible or take immediate effect (or do anything at all), but libev will
1576not crash or malfunction in any way. 1661not crash or malfunction in any way.
1577 1662
1663In any case, the documentation for each member will explain what the
1664effects are, and if there are any additional access restrictions.
1578 1665
1579=head2 C<ev_io> - is this file descriptor readable or writable? 1666=head2 C<ev_io> - is this file descriptor readable or writable?
1580 1667
1581I/O watchers check whether a file descriptor is readable or writable 1668I/O watchers check whether a file descriptor is readable or writable
1582in each iteration of the event loop, or, more precisely, when reading 1669in each iteration of the event loop, or, more precisely, when reading
1609 1696
1610But really, best use non-blocking mode. 1697But really, best use non-blocking mode.
1611 1698
1612=head3 The special problem of disappearing file descriptors 1699=head3 The special problem of disappearing file descriptors
1613 1700
1614Some backends (e.g. kqueue, epoll) need to be told about closing a file 1701Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1615descriptor (either due to calling C<close> explicitly or any other means, 1702a file descriptor (either due to calling C<close> explicitly or any other
1616such as C<dup2>). The reason is that you register interest in some file 1703means, such as C<dup2>). The reason is that you register interest in some
1617descriptor, but when it goes away, the operating system will silently drop 1704file descriptor, but when it goes away, the operating system will silently
1618this interest. If another file descriptor with the same number then is 1705drop this interest. If another file descriptor with the same number then
1619registered with libev, there is no efficient way to see that this is, in 1706is registered with libev, there is no efficient way to see that this is,
1620fact, a different file descriptor. 1707in fact, a different file descriptor.
1621 1708
1622To avoid having to explicitly tell libev about such cases, libev follows 1709To avoid having to explicitly tell libev about such cases, libev follows
1623the following policy: Each time C<ev_io_set> is being called, libev 1710the following policy: Each time C<ev_io_set> is being called, libev
1624will assume that this is potentially a new file descriptor, otherwise 1711will assume that this is potentially a new file descriptor, otherwise
1625it is assumed that the file descriptor stays the same. That means that 1712it is assumed that the file descriptor stays the same. That means that
1674when you rarely read from a file instead of from a socket, and want to 1761when you rarely read from a file instead of from a socket, and want to
1675reuse the same code path. 1762reuse the same code path.
1676 1763
1677=head3 The special problem of fork 1764=head3 The special problem of fork
1678 1765
1679Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1766Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1680useless behaviour. Libev fully supports fork, but needs to be told about 1767at all or exhibit useless behaviour. Libev fully supports fork, but needs
1681it in the child if you want to continue to use it in the child. 1768to be told about it in the child if you want to continue to use it in the
1769child.
1682 1770
1683To support fork in your child processes, you have to call C<ev_loop_fork 1771To 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 1772()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1685C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1773C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1686 1774
1741=item ev_io_init (ev_io *, callback, int fd, int events) 1829=item ev_io_init (ev_io *, callback, int fd, int events)
1742 1830
1743=item ev_io_set (ev_io *, int fd, int events) 1831=item ev_io_set (ev_io *, int fd, int events)
1744 1832
1745Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1833Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1746receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or 1834receive events for and C<events> is either C<EV_READ>, C<EV_WRITE>, both
1747C<EV_READ | EV_WRITE>, to express the desire to receive the given events. 1835C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given
1836events.
1748 1837
1749=item int fd [read-only] 1838Note that setting the C<events> to C<0> and starting the watcher is
1839supported, but not specially optimized - if your program sometimes happens
1840to generate this combination this is fine, but if it is easy to avoid
1841starting an io watcher watching for no events you should do so.
1750 1842
1751The file descriptor being watched. 1843=item ev_io_modify (ev_io *, int events)
1752 1844
1845Similar to C<ev_io_set>, but only changes the event mask. Using this might
1846be faster with some backends, as libev can assume that the C<fd> still
1847refers to the same underlying file description, something it cannot do
1848when using C<ev_io_set>.
1849
1850=item int fd [no-modify]
1851
1852The file descriptor being watched. While it can be read at any time, you
1853must not modify this member even when the watcher is stopped - always use
1854C<ev_io_set> for that.
1855
1753=item int events [read-only] 1856=item int events [no-modify]
1754 1857
1755The events being watched. 1858The set of events the fd is being watched for, among other flags. Remember
1859that this is a bit set - to test for C<EV_READ>, use C<< w->events &
1860EV_READ >>, and similarly for C<EV_WRITE>.
1861
1862As with C<fd>, you must not modify this member even when the watcher is
1863stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1756 1864
1757=back 1865=back
1758 1866
1759=head3 Examples 1867=head3 Examples
1760 1868
2113 2221
2114=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2222=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2115 2223
2116=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2224=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2117 2225
2118Configure the timer to trigger after C<after> seconds. If C<repeat> 2226Configure the timer to trigger after C<after> seconds (fractional and
2119is C<0.>, then it will automatically be stopped once the timeout is 2227negative values are supported). If C<repeat> is C<0.>, then it will
2120reached. If it is positive, then the timer will automatically be 2228automatically be stopped once the timeout is reached. If it is positive,
2121configured to trigger again C<repeat> seconds later, again, and again, 2229then the timer will automatically be configured to trigger again C<repeat>
2122until stopped manually. 2230seconds later, again, and again, until stopped manually.
2123 2231
2124The timer itself will do a best-effort at avoiding drift, that is, if 2232The timer itself will do a best-effort at avoiding drift, that is, if
2125you configure a timer to trigger every 10 seconds, then it will normally 2233you configure a timer to trigger every 10 seconds, then it will normally
2126trigger at exactly 10 second intervals. If, however, your program cannot 2234trigger at exactly 10 second intervals. If, however, your program cannot
2127keep up with the timer (because it takes longer than those 10 seconds to 2235keep up with the timer (because it takes longer than those 10 seconds to
2224C<ev_timer>, which would still trigger roughly 10 seconds after starting 2332C<ev_timer>, which would still trigger roughly 10 seconds after starting
2225it, as it uses a relative timeout). 2333it, as it uses a relative timeout).
2226 2334
2227C<ev_periodic> watchers can also be used to implement vastly more complex 2335C<ev_periodic> watchers can also be used to implement vastly more complex
2228timers, such as triggering an event on each "midnight, local time", or 2336timers, such as triggering an event on each "midnight, local time", or
2229other complicated rules. This cannot be done with C<ev_timer> watchers, as 2337other complicated rules. This cannot easily be done with C<ev_timer>
2230those cannot react to time jumps. 2338watchers, as those cannot react to time jumps.
2231 2339
2232As with timers, the callback is guaranteed to be invoked only when the 2340As with timers, the callback is guaranteed to be invoked only when the
2233point in time where it is supposed to trigger has passed. If multiple 2341point in time where it is supposed to trigger has passed. If multiple
2234timers become ready during the same loop iteration then the ones with 2342timers become ready during the same loop iteration then the ones with
2235earlier time-out values are invoked before ones with later time-out values 2343earlier time-out values are invoked before ones with later time-out values
2321 2429
2322NOTE: I<< This callback must always return a time that is higher than or 2430NOTE: I<< This callback must always return a time that is higher than or
2323equal to the passed C<now> value >>. 2431equal to the passed C<now> value >>.
2324 2432
2325This can be used to create very complex timers, such as a timer that 2433This can be used to create very complex timers, such as a timer that
2326triggers on "next midnight, local time". To do this, you would calculate the 2434triggers on "next midnight, local time". To do this, you would calculate
2327next midnight after C<now> and return the timestamp value for this. How 2435the next midnight after C<now> and return the timestamp value for
2328you do this is, again, up to you (but it is not trivial, which is the main 2436this. Here is a (completely untested, no error checking) example on how to
2329reason I omitted it as an example). 2437do this:
2438
2439 #include <time.h>
2440
2441 static ev_tstamp
2442 my_rescheduler (ev_periodic *w, ev_tstamp now)
2443 {
2444 time_t tnow = (time_t)now;
2445 struct tm tm;
2446 localtime_r (&tnow, &tm);
2447
2448 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2449 ++tm.tm_mday; // midnight next day
2450
2451 return mktime (&tm);
2452 }
2453
2454Note: this code might run into trouble on days that have more then two
2455midnights (beginning and end).
2330 2456
2331=back 2457=back
2332 2458
2333=item ev_periodic_again (loop, ev_periodic *) 2459=item ev_periodic_again (loop, ev_periodic *)
2334 2460
3517 3643
3518There are some other functions of possible interest. Described. Here. Now. 3644There are some other functions of possible interest. Described. Here. Now.
3519 3645
3520=over 4 3646=over 4
3521 3647
3522=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3648=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3523 3649
3524This function combines a simple timer and an I/O watcher, calls your 3650This function combines a simple timer and an I/O watcher, calls your
3525callback on whichever event happens first and automatically stops both 3651callback on whichever event happens first and automatically stops both
3526watchers. This is useful if you want to wait for a single event on an fd 3652watchers. This is useful if you want to wait for a single event on an fd
3527or timeout without having to allocate/configure/start/stop/free one or 3653or timeout without having to allocate/configure/start/stop/free one or
3959The normal C API should work fine when used from C++: both ev.h and the 4085The normal C API should work fine when used from C++: both ev.h and the
3960libev sources can be compiled as C++. Therefore, code that uses the C API 4086libev sources can be compiled as C++. Therefore, code that uses the C API
3961will work fine. 4087will work fine.
3962 4088
3963Proper exception specifications might have to be added to callbacks passed 4089Proper exception specifications might have to be added to callbacks passed
3964to libev: exceptions may be thrown only from watcher callbacks, all 4090to libev: exceptions may be thrown only from watcher callbacks, all other
3965other callbacks (allocator, syserr, loop acquire/release and periodic 4091callbacks (allocator, syserr, loop acquire/release and periodic reschedule
3966reschedule callbacks) must not throw exceptions, and might need a C<throw 4092callbacks) must not throw exceptions, and might need a C<noexcept>
3967()> specification. If you have code that needs to be compiled as both C 4093specification. If you have code that needs to be compiled as both C and
3968and C++ you can use the C<EV_THROW> macro for this: 4094C++ you can use the C<EV_NOEXCEPT> macro for this:
3969 4095
3970 static void 4096 static void
3971 fatal_error (const char *msg) EV_THROW 4097 fatal_error (const char *msg) EV_NOEXCEPT
3972 { 4098 {
3973 perror (msg); 4099 perror (msg);
3974 abort (); 4100 abort ();
3975 } 4101 }
3976 4102
4140method. 4266method.
4141 4267
4142For C<ev::embed> watchers this method is called C<set_embed>, to avoid 4268For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4143clashing with the C<set (loop)> method. 4269clashing with the C<set (loop)> method.
4144 4270
4271For C<ev::io> watchers there is an additional C<set> method that acepts a
4272new event mask only, and internally calls C<ev_io_modfify>.
4273
4145=item w->start () 4274=item w->start ()
4146 4275
4147Starts the watcher. Note that there is no C<loop> argument, as the 4276Starts the watcher. Note that there is no C<loop> argument, as the
4148constructor already stores the event loop. 4277constructor already stores the event loop.
4149 4278
4386 ev_vars.h 4515 ev_vars.h
4387 ev_wrap.h 4516 ev_wrap.h
4388 4517
4389 ev_win32.c required on win32 platforms only 4518 ev_win32.c required on win32 platforms only
4390 4519
4391 ev_select.c only when select backend is enabled (which is enabled by default) 4520 ev_select.c only when select backend is enabled
4392 ev_poll.c only when poll backend is enabled (disabled by default) 4521 ev_poll.c only when poll backend is enabled
4393 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4522 ev_epoll.c only when the epoll backend is enabled
4523 ev_linuxaio.c only when the linux aio backend is enabled
4524 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) 4525 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) 4526 ev_port.c only when the solaris port backend is enabled
4396 4527
4397F<ev.c> includes the backend files directly when enabled, so you only need 4528F<ev.c> includes the backend files directly when enabled, so you only need
4398to compile this single file. 4529to compile this single file.
4399 4530
4400=head3 LIBEVENT COMPATIBILITY API 4531=head3 LIBEVENT COMPATIBILITY API
4519available and will probe for kernel support at runtime. This will improve 4650available and will probe for kernel support at runtime. This will improve
4520C<ev_signal> and C<ev_async> performance and reduce resource consumption. 4651C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4521If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4652If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
45222.7 or newer, otherwise disabled. 46532.7 or newer, otherwise disabled.
4523 4654
4655=item EV_USE_SIGNALFD
4656
4657If defined to be C<1>, then libev will assume that C<signalfd ()> is
4658available and will probe for kernel support at runtime. This enables
4659the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
4660undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46612.7 or newer, otherwise disabled.
4662
4663=item EV_USE_TIMERFD
4664
4665If defined to be C<1>, then libev will assume that C<timerfd ()> is
4666available and will probe for kernel support at runtime. This allows
4667libev to detect time jumps accurately. If undefined, it will be enabled
4668if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4669C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
4670
4671=item EV_USE_EVENTFD
4672
4673If defined to be C<1>, then libev will assume that C<eventfd ()> is
4674available and will probe for kernel support at runtime. This will improve
4675C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4676If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46772.7 or newer, otherwise disabled.
4678
4524=item EV_USE_SELECT 4679=item EV_USE_SELECT
4525 4680
4526If undefined or defined to be C<1>, libev will compile in support for the 4681If undefined or defined to be C<1>, libev will compile in support for the
4527C<select>(2) backend. No attempt at auto-detection will be done: if no 4682C<select>(2) backend. No attempt at auto-detection will be done: if no
4528other method takes over, select will be it. Otherwise the select backend 4683other method takes over, select will be it. Otherwise the select backend
4588If defined to be C<1>, libev will compile in support for the Linux 4743If defined to be C<1>, libev will compile in support for the Linux
4589C<epoll>(7) backend. Its availability will be detected at runtime, 4744C<epoll>(7) backend. Its availability will be detected at runtime,
4590otherwise another method will be used as fallback. This is the preferred 4745otherwise another method will be used as fallback. This is the preferred
4591backend for GNU/Linux systems. If undefined, it will be enabled if the 4746backend for GNU/Linux systems. If undefined, it will be enabled if the
4592headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4747headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4748
4749=item EV_USE_LINUXAIO
4750
4751If defined to be C<1>, libev will compile in support for the Linux aio
4752backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4753enabled on linux, otherwise disabled.
4754
4755=item EV_USE_IOURING
4756
4757If defined to be C<1>, libev will compile in support for the Linux
4758io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4759current limitations it has to be requested explicitly. If undefined, it
4760will be enabled on linux, otherwise disabled.
4593 4761
4594=item EV_USE_KQUEUE 4762=item EV_USE_KQUEUE
4595 4763
4596If defined to be C<1>, libev will compile in support for the BSD style 4764If defined to be C<1>, libev will compile in support for the BSD style
4597C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4765C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4875called. If set to C<2>, then the internal verification code will be 5043called. If set to C<2>, then the internal verification code will be
4876called once per loop, which can slow down libev. If set to C<3>, then the 5044called once per loop, which can slow down libev. If set to C<3>, then the
4877verification code will be called very frequently, which will slow down 5045verification code will be called very frequently, which will slow down
4878libev considerably. 5046libev considerably.
4879 5047
5048Verification errors are reported via C's C<assert> mechanism, so if you
5049disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
5050
4880The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 5051The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4881will be C<0>. 5052will be C<0>.
4882 5053
4883=item EV_COMMON 5054=item EV_COMMON
4884 5055

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines