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

Comparing libev/ev.pod (file contents):
Revision 1.434 by root, Tue May 6 13:24:39 2014 UTC vs.
Revision 1.461 by root, Wed Jan 22 12:15:52 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) when you use this 446forget about forgetting to tell libev about forking, although you still
422flag. 447have to ignore C<SIGPIPE>) when you use this flag.
423 448
424This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 449This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
425environment variable. 450environment variable.
426 451
427=item C<EVFLAG_NOINOTIFY> 452=item C<EVFLAG_NOINOTIFY>
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
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);
661 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);
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
666sense, so e.g. C<ev_is_active> might still return true. It is your 750sense, so e.g. C<ev_is_active> might still return true. It is your
688to reinitialise the kernel state for backends that have one. Despite 772to reinitialise the kernel state for backends that have one. Despite
689the name, you can call it anytime you are allowed to start or stop 773the name, you can call it anytime you are allowed to start or stop
690watchers (except inside an C<ev_prepare> callback), but it makes most 774watchers (except inside an C<ev_prepare> callback), but it makes most
691sense after forking, in the child process. You I<must> call it (or use 775sense after forking, in the child process. You I<must> call it (or use
692C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. 776C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
777
778In addition, if you want to reuse a loop (via this function or
779C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
693 780
694Again, you I<have> to call it on I<any> loop that you want to re-use after 781Again, you I<have> to call it on I<any> loop that you want to re-use after
695a fork, I<even if you do not plan to use the loop in the parent>. This is 782a fork, I<even if you do not plan to use the loop in the parent>. This is
696because some kernel interfaces *cough* I<kqueue> *cough* do funny things 783because some kernel interfaces *cough* I<kqueue> *cough* do funny things
697during fork. 784during fork.
1131with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher 1218with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
1132*) >>), 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
1133corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. 1220corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
1134 1221
1135As 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
1136must not touch the values stored in it. Most specifically you must never 1223must not touch the values stored in it except when explicitly documented
1137reinitialise 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.
1138 1226
1139Each and every callback receives the event loop pointer as first, the 1227Each and every callback receives the event loop pointer as first, the
1140registered watcher structure as second, and a bitset of received events as 1228registered watcher structure as second, and a bitset of received events as
1141third argument. 1229third argument.
1142 1230
1457 1545
1458Many event loops support I<watcher priorities>, which are usually small 1546Many event loops support I<watcher priorities>, which are usually small
1459integers that influence the ordering of event callback invocation 1547integers that influence the ordering of event callback invocation
1460between watchers in some way, all else being equal. 1548between watchers in some way, all else being equal.
1461 1549
1462In 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
1463description for the more technical details such as the actual priority 1551description for the more technical details such as the actual priority
1464range. 1552range.
1465 1553
1466There are two common ways how these these priorities are being interpreted 1554There are two common ways how these these priorities are being interpreted
1467by event loops: 1555by event loops:
1561 1649
1562This section describes each watcher in detail, but will not repeat 1650This section describes each watcher in detail, but will not repeat
1563information given in the last section. Any initialisation/set macros, 1651information given in the last section. Any initialisation/set macros,
1564functions and members specific to the watcher type are explained. 1652functions and members specific to the watcher type are explained.
1565 1653
1566Members are additionally marked with either I<[read-only]>, meaning that, 1654Most members are additionally marked with either I<[read-only]>, meaning
1567while 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
1568sensible 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
1569watcher is stopped to your hearts content), or I<[read-write]>, which 1657the watcher is stopped to your hearts content), or I<[read-write]>, which
1570means 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
1571is 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
1572sensible 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
1573not crash or malfunction in any way. 1661not crash or malfunction in any way.
1574 1662
1663In any case, the documentation for each member will explain what the
1664effects are, and if there are any additional access restrictions.
1575 1665
1576=head2 C<ev_io> - is this file descriptor readable or writable? 1666=head2 C<ev_io> - is this file descriptor readable or writable?
1577 1667
1578I/O watchers check whether a file descriptor is readable or writable 1668I/O watchers check whether a file descriptor is readable or writable
1579in each iteration of the event loop, or, more precisely, when reading 1669in each iteration of the event loop, or, more precisely, when reading
1606 1696
1607But really, best use non-blocking mode. 1697But really, best use non-blocking mode.
1608 1698
1609=head3 The special problem of disappearing file descriptors 1699=head3 The special problem of disappearing file descriptors
1610 1700
1611Some 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
1612descriptor (either due to calling C<close> explicitly or any other means, 1702a file descriptor (either due to calling C<close> explicitly or any other
1613such 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
1614descriptor, but when it goes away, the operating system will silently drop 1704file descriptor, but when it goes away, the operating system will silently
1615this interest. If another file descriptor with the same number then is 1705drop this interest. If another file descriptor with the same number then
1616registered 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,
1617fact, a different file descriptor. 1707in fact, a different file descriptor.
1618 1708
1619To avoid having to explicitly tell libev about such cases, libev follows 1709To avoid having to explicitly tell libev about such cases, libev follows
1620the 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
1621will assume that this is potentially a new file descriptor, otherwise 1711will assume that this is potentially a new file descriptor, otherwise
1622it 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
1671when 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
1672reuse the same code path. 1762reuse the same code path.
1673 1763
1674=head3 The special problem of fork 1764=head3 The special problem of fork
1675 1765
1676Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1766Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1677useless behaviour. Libev fully supports fork, but needs to be told about 1767at all or exhibit useless behaviour. Libev fully supports fork, but needs
1678it 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.
1679 1770
1680To 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
1681()> 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
1682C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1773C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1683 1774
1741 1832
1742Configures 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
1743receive 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> or
1744C<EV_READ | EV_WRITE>, to express the desire to receive the given events. 1835C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1745 1836
1746=item int fd [read-only] 1837=item ev_io_modify (ev_io *, int events)
1747 1838
1748The file descriptor being watched. 1839Similar to C<ev_io_set>, but only changes the event mask. Using this might
1840be faster with some backends, as libev can assume that the C<fd> still
1841refers to the same underlying file description, something it cannot do
1842when using C<ev_io_set>.
1749 1843
1844=item int fd [no-modify]
1845
1846The file descriptor being watched. While it can be read at any time, you
1847must not modify this member even when the watcher is stopped - always use
1848C<ev_io_set> for that.
1849
1750=item int events [read-only] 1850=item int events [no-modify]
1751 1851
1752The events being watched. 1852The set of events the fd is being watched for, among other flags. Remember
1853that this is a bit set - to test for C<EV_READ>, use C<< w->events &
1854EV_READ >>, and similarly for C<EV_WRITE>.
1855
1856As with C<fd>, you must not modify this member even when the watcher is
1857stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1753 1858
1754=back 1859=back
1755 1860
1756=head3 Examples 1861=head3 Examples
1757 1862
2110 2215
2111=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2216=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2112 2217
2113=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2218=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2114 2219
2115Configure the timer to trigger after C<after> seconds. If C<repeat> 2220Configure the timer to trigger after C<after> seconds (fractional and
2116is C<0.>, then it will automatically be stopped once the timeout is 2221negative values are supported). If C<repeat> is C<0.>, then it will
2117reached. If it is positive, then the timer will automatically be 2222automatically be stopped once the timeout is reached. If it is positive,
2118configured to trigger again C<repeat> seconds later, again, and again, 2223then the timer will automatically be configured to trigger again C<repeat>
2119until stopped manually. 2224seconds later, again, and again, until stopped manually.
2120 2225
2121The timer itself will do a best-effort at avoiding drift, that is, if 2226The timer itself will do a best-effort at avoiding drift, that is, if
2122you configure a timer to trigger every 10 seconds, then it will normally 2227you configure a timer to trigger every 10 seconds, then it will normally
2123trigger at exactly 10 second intervals. If, however, your program cannot 2228trigger at exactly 10 second intervals. If, however, your program cannot
2124keep up with the timer (because it takes longer than those 10 seconds to 2229keep up with the timer (because it takes longer than those 10 seconds to
2206Periodic watchers are also timers of a kind, but they are very versatile 2311Periodic watchers are also timers of a kind, but they are very versatile
2207(and unfortunately a bit complex). 2312(and unfortunately a bit complex).
2208 2313
2209Unlike C<ev_timer>, periodic watchers are not based on real time (or 2314Unlike C<ev_timer>, periodic watchers are not based on real time (or
2210relative time, the physical time that passes) but on wall clock time 2315relative time, the physical time that passes) but on wall clock time
2211(absolute time, the thing you can read on your calender or clock). The 2316(absolute time, the thing you can read on your calendar or clock). The
2212difference is that wall clock time can run faster or slower than real 2317difference is that wall clock time can run faster or slower than real
2213time, and time jumps are not uncommon (e.g. when you adjust your 2318time, and time jumps are not uncommon (e.g. when you adjust your
2214wrist-watch). 2319wrist-watch).
2215 2320
2216You can tell a periodic watcher to trigger after some specific point 2321You can tell a periodic watcher to trigger after some specific point
2221C<ev_timer>, which would still trigger roughly 10 seconds after starting 2326C<ev_timer>, which would still trigger roughly 10 seconds after starting
2222it, as it uses a relative timeout). 2327it, as it uses a relative timeout).
2223 2328
2224C<ev_periodic> watchers can also be used to implement vastly more complex 2329C<ev_periodic> watchers can also be used to implement vastly more complex
2225timers, such as triggering an event on each "midnight, local time", or 2330timers, such as triggering an event on each "midnight, local time", or
2226other complicated rules. This cannot be done with C<ev_timer> watchers, as 2331other complicated rules. This cannot easily be done with C<ev_timer>
2227those cannot react to time jumps. 2332watchers, as those cannot react to time jumps.
2228 2333
2229As with timers, the callback is guaranteed to be invoked only when the 2334As with timers, the callback is guaranteed to be invoked only when the
2230point in time where it is supposed to trigger has passed. If multiple 2335point in time where it is supposed to trigger has passed. If multiple
2231timers become ready during the same loop iteration then the ones with 2336timers become ready during the same loop iteration then the ones with
2232earlier time-out values are invoked before ones with later time-out values 2337earlier time-out values are invoked before ones with later time-out values
2318 2423
2319NOTE: I<< This callback must always return a time that is higher than or 2424NOTE: I<< This callback must always return a time that is higher than or
2320equal to the passed C<now> value >>. 2425equal to the passed C<now> value >>.
2321 2426
2322This can be used to create very complex timers, such as a timer that 2427This can be used to create very complex timers, such as a timer that
2323triggers on "next midnight, local time". To do this, you would calculate the 2428triggers on "next midnight, local time". To do this, you would calculate
2324next midnight after C<now> and return the timestamp value for this. How 2429the next midnight after C<now> and return the timestamp value for
2325you do this is, again, up to you (but it is not trivial, which is the main 2430this. Here is a (completely untested, no error checking) example on how to
2326reason I omitted it as an example). 2431do this:
2432
2433 #include <time.h>
2434
2435 static ev_tstamp
2436 my_rescheduler (ev_periodic *w, ev_tstamp now)
2437 {
2438 time_t tnow = (time_t)now;
2439 struct tm tm;
2440 localtime_r (&tnow, &tm);
2441
2442 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2443 ++tm.tm_mday; // midnight next day
2444
2445 return mktime (&tm);
2446 }
2447
2448Note: this code might run into trouble on days that have more then two
2449midnights (beginning and end).
2327 2450
2328=back 2451=back
2329 2452
2330=item ev_periodic_again (loop, ev_periodic *) 2453=item ev_periodic_again (loop, ev_periodic *)
2331 2454
3514 3637
3515There are some other functions of possible interest. Described. Here. Now. 3638There are some other functions of possible interest. Described. Here. Now.
3516 3639
3517=over 4 3640=over 4
3518 3641
3519=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3642=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3520 3643
3521This function combines a simple timer and an I/O watcher, calls your 3644This function combines a simple timer and an I/O watcher, calls your
3522callback on whichever event happens first and automatically stops both 3645callback on whichever event happens first and automatically stops both
3523watchers. This is useful if you want to wait for a single event on an fd 3646watchers. This is useful if you want to wait for a single event on an fd
3524or timeout without having to allocate/configure/start/stop/free one or 3647or timeout without having to allocate/configure/start/stop/free one or
3900To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two 4023To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3901files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 4024files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3902 4025
3903 // my_ev.h 4026 // my_ev.h
3904 #define EV_CB_DECLARE(type) struct my_coro *cb; 4027 #define EV_CB_DECLARE(type) struct my_coro *cb;
3905 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 4028 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3906 #include "../libev/ev.h" 4029 #include "../libev/ev.h"
3907 4030
3908 // my_ev.c 4031 // my_ev.c
3909 #define EV_H "my_ev.h" 4032 #define EV_H "my_ev.h"
3910 #include "../libev/ev.c" 4033 #include "../libev/ev.c"
3956The normal C API should work fine when used from C++: both ev.h and the 4079The normal C API should work fine when used from C++: both ev.h and the
3957libev sources can be compiled as C++. Therefore, code that uses the C API 4080libev sources can be compiled as C++. Therefore, code that uses the C API
3958will work fine. 4081will work fine.
3959 4082
3960Proper exception specifications might have to be added to callbacks passed 4083Proper exception specifications might have to be added to callbacks passed
3961to libev: exceptions may be thrown only from watcher callbacks, all 4084to libev: exceptions may be thrown only from watcher callbacks, all other
3962other callbacks (allocator, syserr, loop acquire/release and periodic 4085callbacks (allocator, syserr, loop acquire/release and periodic reschedule
3963reschedule callbacks) must not throw exceptions, and might need a C<throw 4086callbacks) must not throw exceptions, and might need a C<noexcept>
3964()> specification. If you have code that needs to be compiled as both C 4087specification. If you have code that needs to be compiled as both C and
3965and C++ you can use the C<EV_THROW> macro for this: 4088C++ you can use the C<EV_NOEXCEPT> macro for this:
3966 4089
3967 static void 4090 static void
3968 fatal_error (const char *msg) EV_THROW 4091 fatal_error (const char *msg) EV_NOEXCEPT
3969 { 4092 {
3970 perror (msg); 4093 perror (msg);
3971 abort (); 4094 abort ();
3972 } 4095 }
3973 4096
4137method. 4260method.
4138 4261
4139For C<ev::embed> watchers this method is called C<set_embed>, to avoid 4262For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4140clashing with the C<set (loop)> method. 4263clashing with the C<set (loop)> method.
4141 4264
4265For C<ev::io> watchers there is an additional C<set> method that acepts a
4266new event mask only, and internally calls C<ev_io_modfify>.
4267
4142=item w->start () 4268=item w->start ()
4143 4269
4144Starts the watcher. Note that there is no C<loop> argument, as the 4270Starts the watcher. Note that there is no C<loop> argument, as the
4145constructor already stores the event loop. 4271constructor already stores the event loop.
4146 4272
4383 ev_vars.h 4509 ev_vars.h
4384 ev_wrap.h 4510 ev_wrap.h
4385 4511
4386 ev_win32.c required on win32 platforms only 4512 ev_win32.c required on win32 platforms only
4387 4513
4388 ev_select.c only when select backend is enabled (which is enabled by default) 4514 ev_select.c only when select backend is enabled
4389 ev_poll.c only when poll backend is enabled (disabled by default) 4515 ev_poll.c only when poll backend is enabled
4390 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4516 ev_epoll.c only when the epoll backend is enabled
4517 ev_linuxaio.c only when the linux aio backend is enabled
4518 ev_iouring.c only when the linux io_uring backend is enabled
4391 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4519 ev_kqueue.c only when the kqueue backend is enabled
4392 ev_port.c only when the solaris port backend is enabled (disabled by default) 4520 ev_port.c only when the solaris port backend is enabled
4393 4521
4394F<ev.c> includes the backend files directly when enabled, so you only need 4522F<ev.c> includes the backend files directly when enabled, so you only need
4395to compile this single file. 4523to compile this single file.
4396 4524
4397=head3 LIBEVENT COMPATIBILITY API 4525=head3 LIBEVENT COMPATIBILITY API
4516available and will probe for kernel support at runtime. This will improve 4644available and will probe for kernel support at runtime. This will improve
4517C<ev_signal> and C<ev_async> performance and reduce resource consumption. 4645C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4518If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4646If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
45192.7 or newer, otherwise disabled. 46472.7 or newer, otherwise disabled.
4520 4648
4649=item EV_USE_SIGNALFD
4650
4651If defined to be C<1>, then libev will assume that C<signalfd ()> is
4652available and will probe for kernel support at runtime. This enables
4653the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
4654undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46552.7 or newer, otherwise disabled.
4656
4657=item EV_USE_TIMERFD
4658
4659If defined to be C<1>, then libev will assume that C<timerfd ()> is
4660available and will probe for kernel support at runtime. This allows
4661libev to detect time jumps accurately. If undefined, it will be enabled
4662if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4663C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
4664
4665=item EV_USE_EVENTFD
4666
4667If defined to be C<1>, then libev will assume that C<eventfd ()> is
4668available and will probe for kernel support at runtime. This will improve
4669C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4670If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46712.7 or newer, otherwise disabled.
4672
4521=item EV_USE_SELECT 4673=item EV_USE_SELECT
4522 4674
4523If undefined or defined to be C<1>, libev will compile in support for the 4675If undefined or defined to be C<1>, libev will compile in support for the
4524C<select>(2) backend. No attempt at auto-detection will be done: if no 4676C<select>(2) backend. No attempt at auto-detection will be done: if no
4525other method takes over, select will be it. Otherwise the select backend 4677other method takes over, select will be it. Otherwise the select backend
4585If defined to be C<1>, libev will compile in support for the Linux 4737If defined to be C<1>, libev will compile in support for the Linux
4586C<epoll>(7) backend. Its availability will be detected at runtime, 4738C<epoll>(7) backend. Its availability will be detected at runtime,
4587otherwise another method will be used as fallback. This is the preferred 4739otherwise another method will be used as fallback. This is the preferred
4588backend for GNU/Linux systems. If undefined, it will be enabled if the 4740backend for GNU/Linux systems. If undefined, it will be enabled if the
4589headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4741headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4742
4743=item EV_USE_LINUXAIO
4744
4745If defined to be C<1>, libev will compile in support for the Linux aio
4746backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4747enabled on linux, otherwise disabled.
4748
4749=item EV_USE_IOURING
4750
4751If defined to be C<1>, libev will compile in support for the Linux
4752io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4753current limitations it has to be requested explicitly. If undefined, it
4754will be enabled on linux, otherwise disabled.
4590 4755
4591=item EV_USE_KQUEUE 4756=item EV_USE_KQUEUE
4592 4757
4593If defined to be C<1>, libev will compile in support for the BSD style 4758If defined to be C<1>, libev will compile in support for the BSD style
4594C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4759C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4872called. If set to C<2>, then the internal verification code will be 5037called. If set to C<2>, then the internal verification code will be
4873called once per loop, which can slow down libev. If set to C<3>, then the 5038called once per loop, which can slow down libev. If set to C<3>, then the
4874verification code will be called very frequently, which will slow down 5039verification code will be called very frequently, which will slow down
4875libev considerably. 5040libev considerably.
4876 5041
5042Verification errors are reported via C's C<assert> mechanism, so if you
5043disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
5044
4877The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 5045The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4878will be C<0>. 5046will be C<0>.
4879 5047
4880=item EV_COMMON 5048=item EV_COMMON
4881 5049
5297structure (guaranteed by POSIX but not by ISO C for example), but it also 5465structure (guaranteed by POSIX but not by ISO C for example), but it also
5298assumes that the same (machine) code can be used to call any watcher 5466assumes that the same (machine) code can be used to call any watcher
5299callback: The watcher callbacks have different type signatures, but libev 5467callback: The watcher callbacks have different type signatures, but libev
5300calls them using an C<ev_watcher *> internally. 5468calls them using an C<ev_watcher *> internally.
5301 5469
5470=item null pointers and integer zero are represented by 0 bytes
5471
5472Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5473relies on this setting pointers and integers to null.
5474
5302=item pointer accesses must be thread-atomic 5475=item pointer accesses must be thread-atomic
5303 5476
5304Accessing a pointer value must be atomic, it must both be readable and 5477Accessing a pointer value must be atomic, it must both be readable and
5305writable in one piece - this is the case on all current architectures. 5478writable in one piece - this is the case on all current architectures.
5306 5479

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines