… | |
… | |
159 | When libev detects a usage error such as a negative timer interval, then |
159 | When libev detects a usage error such as a negative timer interval, then |
160 | it will print a diagnostic message and abort (via the C<assert> mechanism, |
160 | it will print a diagnostic message and abort (via the C<assert> mechanism, |
161 | so C<NDEBUG> will disable this checking): these are programming errors in |
161 | so C<NDEBUG> will disable this checking): these are programming errors in |
162 | the libev caller and need to be fixed there. |
162 | the libev caller and need to be fixed there. |
163 | |
163 | |
|
|
164 | Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive |
|
|
165 | consistency checking code inside libev that can be used to check for |
|
|
166 | internal inconsistencies, suually caused by application bugs. |
|
|
167 | |
164 | Libev also has a few internal error-checking C<assert>ions, and also has |
168 | Libev also has a few internal error-checking C<assert>ions. These do not |
165 | extensive consistency checking code. These do not trigger under normal |
|
|
166 | circumstances, as they indicate either a bug in libev or worse. |
169 | trigger under normal circumstances, as they indicate either a bug in libev |
|
|
170 | or worse. |
167 | |
171 | |
168 | |
172 | |
169 | =head1 GLOBAL FUNCTIONS |
173 | =head1 GLOBAL FUNCTIONS |
170 | |
174 | |
171 | These functions can be called anytime, even before initialising the |
175 | These functions can be called anytime, even before initialising the |
… | |
… | |
476 | unblocking the signals. |
480 | unblocking the signals. |
477 | |
481 | |
478 | It's also required by POSIX in a threaded program, as libev calls |
482 | It's also required by POSIX in a threaded program, as libev calls |
479 | C<sigprocmask>, whose behaviour is officially unspecified. |
483 | C<sigprocmask>, whose behaviour is officially unspecified. |
480 | |
484 | |
481 | This flag's behaviour will become the default in future versions of libev. |
485 | =item C<EVFLAG_NOTIMERFD> |
|
|
486 | |
|
|
487 | When this flag is specified, the libev will avoid using a C<timerfd> to |
|
|
488 | detect time jumps. It will still be able to detect time jumps, but takes |
|
|
489 | longer and has a lower accuracy in doing so, but saves a file descriptor |
|
|
490 | per loop. |
|
|
491 | |
|
|
492 | The current implementation only tries to use a C<timerfd> when the first |
|
|
493 | C<ev_periodic> watcher is started and falls back on other methods if it |
|
|
494 | cannot be created, but this behaviour might change in the future. |
482 | |
495 | |
483 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
496 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
484 | |
497 | |
485 | This is your standard select(2) backend. Not I<completely> standard, as |
498 | This is your standard select(2) backend. Not I<completely> standard, as |
486 | libev tries to roll its own fd_set with no limits on the number of fds, |
499 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
1205 | with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher |
1218 | with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher |
1206 | *) >>), 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 |
1207 | corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. |
1220 | corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. |
1208 | |
1221 | |
1209 | As long as your watcher is active (has been started but not stopped) you |
1222 | As long as your watcher is active (has been started but not stopped) you |
1210 | must not touch the values stored in it. Most specifically you must never |
1223 | must not touch the values stored in it except when explicitly documented |
1211 | reinitialise it or call its C<ev_TYPE_set> macro. |
1224 | otherwise. Most specifically you must never reinitialise it or call its |
|
|
1225 | C<ev_TYPE_set> macro. |
1212 | |
1226 | |
1213 | Each and every callback receives the event loop pointer as first, the |
1227 | Each and every callback receives the event loop pointer as first, the |
1214 | registered watcher structure as second, and a bitset of received events as |
1228 | registered watcher structure as second, and a bitset of received events as |
1215 | third argument. |
1229 | third argument. |
1216 | |
1230 | |
… | |
… | |
1531 | |
1545 | |
1532 | Many event loops support I<watcher priorities>, which are usually small |
1546 | Many event loops support I<watcher priorities>, which are usually small |
1533 | integers that influence the ordering of event callback invocation |
1547 | integers that influence the ordering of event callback invocation |
1534 | between watchers in some way, all else being equal. |
1548 | between watchers in some way, all else being equal. |
1535 | |
1549 | |
1536 | In libev, Watcher priorities can be set using C<ev_set_priority>. See its |
1550 | In libev, watcher priorities can be set using C<ev_set_priority>. See its |
1537 | description for the more technical details such as the actual priority |
1551 | description for the more technical details such as the actual priority |
1538 | range. |
1552 | range. |
1539 | |
1553 | |
1540 | There are two common ways how these these priorities are being interpreted |
1554 | There are two common ways how these these priorities are being interpreted |
1541 | by event loops: |
1555 | by event loops: |
… | |
… | |
1635 | |
1649 | |
1636 | This section describes each watcher in detail, but will not repeat |
1650 | This section describes each watcher in detail, but will not repeat |
1637 | information given in the last section. Any initialisation/set macros, |
1651 | information given in the last section. Any initialisation/set macros, |
1638 | functions and members specific to the watcher type are explained. |
1652 | functions and members specific to the watcher type are explained. |
1639 | |
1653 | |
1640 | Members are additionally marked with either I<[read-only]>, meaning that, |
1654 | Most members are additionally marked with either I<[read-only]>, meaning |
1641 | while the watcher is active, you can look at the member and expect some |
1655 | that, while the watcher is active, you can look at the member and expect |
1642 | sensible content, but you must not modify it (you can modify it while the |
1656 | some sensible content, but you must not modify it (you can modify it while |
1643 | watcher is stopped to your hearts content), or I<[read-write]>, which |
1657 | the watcher is stopped to your hearts content), or I<[read-write]>, which |
1644 | means you can expect it to have some sensible content while the watcher |
1658 | means you can expect it to have some sensible content while the watcher is |
1645 | is active, but you can also modify it. Modifying it may not do something |
1659 | active, but you can also modify it (within the same thread as the event |
|
|
1660 | loop, i.e. without creating data races). Modifying it may not do something |
1646 | sensible or take immediate effect (or do anything at all), but libev will |
1661 | sensible or take immediate effect (or do anything at all), but libev will |
1647 | not crash or malfunction in any way. |
1662 | not crash or malfunction in any way. |
1648 | |
1663 | |
|
|
1664 | In any case, the documentation for each member will explain what the |
|
|
1665 | effects are, and if there are any additional access restrictions. |
1649 | |
1666 | |
1650 | =head2 C<ev_io> - is this file descriptor readable or writable? |
1667 | =head2 C<ev_io> - is this file descriptor readable or writable? |
1651 | |
1668 | |
1652 | I/O watchers check whether a file descriptor is readable or writable |
1669 | I/O watchers check whether a file descriptor is readable or writable |
1653 | in each iteration of the event loop, or, more precisely, when reading |
1670 | in each iteration of the event loop, or, more precisely, when reading |
… | |
… | |
1745 | when you rarely read from a file instead of from a socket, and want to |
1762 | when you rarely read from a file instead of from a socket, and want to |
1746 | reuse the same code path. |
1763 | reuse the same code path. |
1747 | |
1764 | |
1748 | =head3 The special problem of fork |
1765 | =head3 The special problem of fork |
1749 | |
1766 | |
1750 | Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()> |
1767 | Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()> |
1751 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1768 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1752 | to be told about it in the child if you want to continue to use it in the |
1769 | to be told about it in the child if you want to continue to use it in the |
1753 | child. |
1770 | child. |
1754 | |
1771 | |
1755 | To support fork in your child processes, you have to call C<ev_loop_fork |
1772 | To support fork in your child processes, you have to call C<ev_loop_fork |
… | |
… | |
1813 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1830 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1814 | |
1831 | |
1815 | =item ev_io_set (ev_io *, int fd, int events) |
1832 | =item ev_io_set (ev_io *, int fd, int events) |
1816 | |
1833 | |
1817 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1834 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1818 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or |
1835 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE>, both |
1819 | C<EV_READ | EV_WRITE>, to express the desire to receive the given events. |
1836 | C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given |
|
|
1837 | events. |
1820 | |
1838 | |
1821 | =item int fd [read-only] |
1839 | Note that setting the C<events> to C<0> and starting the watcher is |
|
|
1840 | supported, but not specially optimized - if your program sometimes happens |
|
|
1841 | to generate this combination this is fine, but if it is easy to avoid |
|
|
1842 | starting an io watcher watching for no events you should do so. |
1822 | |
1843 | |
1823 | The file descriptor being watched. |
1844 | =item ev_io_modify (ev_io *, int events) |
1824 | |
1845 | |
|
|
1846 | Similar to C<ev_io_set>, but only changes the requested events. Using this |
|
|
1847 | might be faster with some backends, as libev can assume that the C<fd> |
|
|
1848 | still refers to the same underlying file description, something it cannot |
|
|
1849 | do when using C<ev_io_set>. |
|
|
1850 | |
|
|
1851 | =item int fd [no-modify] |
|
|
1852 | |
|
|
1853 | The file descriptor being watched. While it can be read at any time, you |
|
|
1854 | must not modify this member even when the watcher is stopped - always use |
|
|
1855 | C<ev_io_set> for that. |
|
|
1856 | |
1825 | =item int events [read-only] |
1857 | =item int events [no-modify] |
1826 | |
1858 | |
1827 | The events being watched. |
1859 | The set of events the fd is being watched for, among other flags. Remember |
|
|
1860 | that this is a bit set - to test for C<EV_READ>, use C<< w->events & |
|
|
1861 | EV_READ >>, and similarly for C<EV_WRITE>. |
|
|
1862 | |
|
|
1863 | As with C<fd>, you must not modify this member even when the watcher is |
|
|
1864 | stopped, always use C<ev_io_set> or C<ev_io_modify> for that. |
1828 | |
1865 | |
1829 | =back |
1866 | =back |
1830 | |
1867 | |
1831 | =head3 Examples |
1868 | =head3 Examples |
1832 | |
1869 | |
… | |
… | |
4230 | method. |
4267 | method. |
4231 | |
4268 | |
4232 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
4269 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
4233 | clashing with the C<set (loop)> method. |
4270 | clashing with the C<set (loop)> method. |
4234 | |
4271 | |
|
|
4272 | For C<ev::io> watchers there is an additional C<set> method that acepts a |
|
|
4273 | new event mask only, and internally calls C<ev_io_modfify>. |
|
|
4274 | |
4235 | =item w->start () |
4275 | =item w->start () |
4236 | |
4276 | |
4237 | Starts the watcher. Note that there is no C<loop> argument, as the |
4277 | Starts the watcher. Note that there is no C<loop> argument, as the |
4238 | constructor already stores the event loop. |
4278 | constructor already stores the event loop. |
4239 | |
4279 | |
… | |
… | |
4480 | |
4520 | |
4481 | ev_select.c only when select backend is enabled |
4521 | ev_select.c only when select backend is enabled |
4482 | ev_poll.c only when poll backend is enabled |
4522 | ev_poll.c only when poll backend is enabled |
4483 | ev_epoll.c only when the epoll backend is enabled |
4523 | ev_epoll.c only when the epoll backend is enabled |
4484 | ev_linuxaio.c only when the linux aio backend is enabled |
4524 | ev_linuxaio.c only when the linux aio backend is enabled |
|
|
4525 | ev_iouring.c only when the linux io_uring backend is enabled |
4485 | ev_kqueue.c only when the kqueue backend is enabled |
4526 | ev_kqueue.c only when the kqueue backend is enabled |
4486 | ev_port.c only when the solaris port backend is enabled |
4527 | ev_port.c only when the solaris port backend is enabled |
4487 | |
4528 | |
4488 | F<ev.c> includes the backend files directly when enabled, so you only need |
4529 | F<ev.c> includes the backend files directly when enabled, so you only need |
4489 | to compile this single file. |
4530 | to compile this single file. |
… | |
… | |
4610 | available and will probe for kernel support at runtime. This will improve |
4651 | available and will probe for kernel support at runtime. This will improve |
4611 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
4652 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
4612 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
4653 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
4613 | 2.7 or newer, otherwise disabled. |
4654 | 2.7 or newer, otherwise disabled. |
4614 | |
4655 | |
|
|
4656 | =item EV_USE_SIGNALFD |
|
|
4657 | |
|
|
4658 | If defined to be C<1>, then libev will assume that C<signalfd ()> is |
|
|
4659 | available and will probe for kernel support at runtime. This enables |
|
|
4660 | the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If |
|
|
4661 | undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4662 | 2.7 or newer, otherwise disabled. |
|
|
4663 | |
|
|
4664 | =item EV_USE_TIMERFD |
|
|
4665 | |
|
|
4666 | If defined to be C<1>, then libev will assume that C<timerfd ()> is |
|
|
4667 | available and will probe for kernel support at runtime. This allows |
|
|
4668 | libev to detect time jumps accurately. If undefined, it will be enabled |
|
|
4669 | if the headers indicate GNU/Linux + Glibc 2.8 or newer and define |
|
|
4670 | C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled. |
|
|
4671 | |
|
|
4672 | =item EV_USE_EVENTFD |
|
|
4673 | |
|
|
4674 | If defined to be C<1>, then libev will assume that C<eventfd ()> is |
|
|
4675 | available and will probe for kernel support at runtime. This will improve |
|
|
4676 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
|
|
4677 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4678 | 2.7 or newer, otherwise disabled. |
|
|
4679 | |
4615 | =item EV_USE_SELECT |
4680 | =item EV_USE_SELECT |
4616 | |
4681 | |
4617 | If undefined or defined to be C<1>, libev will compile in support for the |
4682 | If undefined or defined to be C<1>, libev will compile in support for the |
4618 | C<select>(2) backend. No attempt at auto-detection will be done: if no |
4683 | C<select>(2) backend. No attempt at auto-detection will be done: if no |
4619 | other method takes over, select will be it. Otherwise the select backend |
4684 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
4682 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4747 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4683 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4748 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4684 | |
4749 | |
4685 | =item EV_USE_LINUXAIO |
4750 | =item EV_USE_LINUXAIO |
4686 | |
4751 | |
|
|
4752 | If defined to be C<1>, libev will compile in support for the Linux aio |
|
|
4753 | backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be |
|
|
4754 | enabled on linux, otherwise disabled. |
|
|
4755 | |
|
|
4756 | =item EV_USE_IOURING |
|
|
4757 | |
4687 | If defined to be C<1>, libev will compile in support for the Linux |
4758 | If defined to be C<1>, libev will compile in support for the Linux |
4688 | aio backend. Due to it's currenbt limitations it has to be requested |
4759 | io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's |
4689 | explicitly. If undefined, it will be enabled on linux, otherwise |
4760 | current limitations it has to be requested explicitly. If undefined, it |
4690 | disabled. |
4761 | will be enabled on linux, otherwise disabled. |
4691 | |
4762 | |
4692 | =item EV_USE_KQUEUE |
4763 | =item EV_USE_KQUEUE |
4693 | |
4764 | |
4694 | If defined to be C<1>, libev will compile in support for the BSD style |
4765 | If defined to be C<1>, libev will compile in support for the BSD style |
4695 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
4766 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
… | |
… | |
4973 | called. If set to C<2>, then the internal verification code will be |
5044 | called. If set to C<2>, then the internal verification code will be |
4974 | called once per loop, which can slow down libev. If set to C<3>, then the |
5045 | called once per loop, which can slow down libev. If set to C<3>, then the |
4975 | verification code will be called very frequently, which will slow down |
5046 | verification code will be called very frequently, which will slow down |
4976 | libev considerably. |
5047 | libev considerably. |
4977 | |
5048 | |
|
|
5049 | Verification errors are reported via C's C<assert> mechanism, so if you |
|
|
5050 | disable that (e.g. by defining C<NDEBUG>) then no errors will be reported. |
|
|
5051 | |
4978 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
5052 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
4979 | will be C<0>. |
5053 | will be C<0>. |
4980 | |
5054 | |
4981 | =item EV_COMMON |
5055 | =item EV_COMMON |
4982 | |
5056 | |