… | |
… | |
131 | .\} |
131 | .\} |
132 | .rm #[ #] #H #V #F C |
132 | .rm #[ #] #H #V #F C |
133 | .\" ======================================================================== |
133 | .\" ======================================================================== |
134 | .\" |
134 | .\" |
135 | .IX Title "LIBEV 3" |
135 | .IX Title "LIBEV 3" |
136 | .TH LIBEV 3 "2019-06-25" "libev-4.25" "libev - high performance full featured event loop" |
136 | .TH LIBEV 3 "2019-12-20" "libev-4.27" "libev - high performance full featured event loop" |
137 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
137 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
138 | .\" way too many mistakes in technical documents. |
138 | .\" way too many mistakes in technical documents. |
139 | .if n .ad l |
139 | .if n .ad l |
140 | .nh |
140 | .nh |
141 | .SH "NAME" |
141 | .SH "NAME" |
… | |
… | |
593 | threads that are not interested in handling them. |
593 | threads that are not interested in handling them. |
594 | .Sp |
594 | .Sp |
595 | Signalfd will not be used by default as this changes your signal mask, and |
595 | Signalfd will not be used by default as this changes your signal mask, and |
596 | there are a lot of shoddy libraries and programs (glib's threadpool for |
596 | there are a lot of shoddy libraries and programs (glib's threadpool for |
597 | example) that can't properly initialise their signal masks. |
597 | example) that can't properly initialise their signal masks. |
|
|
598 | .ie n .IP """EVFLAG_NOTIMERFD""" 4 |
|
|
599 | .el .IP "\f(CWEVFLAG_NOTIMERFD\fR" 4 |
|
|
600 | .IX Item "EVFLAG_NOTIMERFD" |
|
|
601 | When this flag is specified, the libev will avoid using a \f(CW\*(C`timerfd\*(C'\fR to |
|
|
602 | detect time jumps. It will still be able to detect time jumps, but takes |
|
|
603 | longer and has a lower accuracy in doing so, but saves a file descriptor |
|
|
604 | per loop. |
598 | .ie n .IP """EVFLAG_NOSIGMASK""" 4 |
605 | .ie n .IP """EVFLAG_NOSIGMASK""" 4 |
599 | .el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4 |
606 | .el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4 |
600 | .IX Item "EVFLAG_NOSIGMASK" |
607 | .IX Item "EVFLAG_NOSIGMASK" |
601 | When this flag is specified, then libev will avoid to modify the signal |
608 | When this flag is specified, then libev will avoid to modify the signal |
602 | mask. Specifically, this means you have to make sure signals are unblocked |
609 | mask. Specifically, this means you have to make sure signals are unblocked |
… | |
… | |
1654 | .IX Subsection "WATCHER PRIORITY MODELS" |
1661 | .IX Subsection "WATCHER PRIORITY MODELS" |
1655 | Many event loops support \fIwatcher priorities\fR, which are usually small |
1662 | Many event loops support \fIwatcher priorities\fR, which are usually small |
1656 | integers that influence the ordering of event callback invocation |
1663 | integers that influence the ordering of event callback invocation |
1657 | between watchers in some way, all else being equal. |
1664 | between watchers in some way, all else being equal. |
1658 | .PP |
1665 | .PP |
1659 | In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its |
1666 | In libev, watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its |
1660 | description for the more technical details such as the actual priority |
1667 | description for the more technical details such as the actual priority |
1661 | range. |
1668 | range. |
1662 | .PP |
1669 | .PP |
1663 | There are two common ways how these these priorities are being interpreted |
1670 | There are two common ways how these these priorities are being interpreted |
1664 | by event loops: |
1671 | by event loops: |
… | |
… | |
1871 | reuse the same code path. |
1878 | reuse the same code path. |
1872 | .PP |
1879 | .PP |
1873 | \fIThe special problem of fork\fR |
1880 | \fIThe special problem of fork\fR |
1874 | .IX Subsection "The special problem of fork" |
1881 | .IX Subsection "The special problem of fork" |
1875 | .PP |
1882 | .PP |
1876 | Some backends (epoll, kqueue, probably linuxaio) do not support \f(CW\*(C`fork ()\*(C'\fR |
1883 | Some backends (epoll, kqueue, linuxaio, iouring) do not support \f(CW\*(C`fork ()\*(C'\fR |
1877 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1884 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1878 | to be told about it in the child if you want to continue to use it in the |
1885 | to be told about it in the child if you want to continue to use it in the |
1879 | child. |
1886 | child. |
1880 | .PP |
1887 | .PP |
1881 | To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork |
1888 | To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork |
… | |
… | |
4624 | \& |
4631 | \& |
4625 | \& ev_select.c only when select backend is enabled |
4632 | \& ev_select.c only when select backend is enabled |
4626 | \& ev_poll.c only when poll backend is enabled |
4633 | \& ev_poll.c only when poll backend is enabled |
4627 | \& ev_epoll.c only when the epoll backend is enabled |
4634 | \& ev_epoll.c only when the epoll backend is enabled |
4628 | \& ev_linuxaio.c only when the linux aio backend is enabled |
4635 | \& ev_linuxaio.c only when the linux aio backend is enabled |
|
|
4636 | \& ev_iouring.c only when the linux io_uring backend is enabled |
4629 | \& ev_kqueue.c only when the kqueue backend is enabled |
4637 | \& ev_kqueue.c only when the kqueue backend is enabled |
4630 | \& ev_port.c only when the solaris port backend is enabled |
4638 | \& ev_port.c only when the solaris port backend is enabled |
4631 | .Ve |
4639 | .Ve |
4632 | .PP |
4640 | .PP |
4633 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
4641 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
… | |
… | |
4746 | higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). |
4754 | higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). |
4747 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
4755 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
4748 | .IX Item "EV_USE_NANOSLEEP" |
4756 | .IX Item "EV_USE_NANOSLEEP" |
4749 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
4757 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
4750 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
4758 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
|
|
4759 | .IP "\s-1EV_USE_EVENTFD\s0" 4 |
|
|
4760 | .IX Item "EV_USE_EVENTFD" |
|
|
4761 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is |
|
|
4762 | available and will probe for kernel support at runtime. This will improve |
|
|
4763 | \&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. |
|
|
4764 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4765 | 2.7 or newer, otherwise disabled. |
|
|
4766 | .IP "\s-1EV_USE_SIGNALFD\s0" 4 |
|
|
4767 | .IX Item "EV_USE_SIGNALFD" |
|
|
4768 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`signalfd ()\*(C'\fR is |
|
|
4769 | available and will probe for kernel support at runtime. This enables |
|
|
4770 | the use of \s-1EVFLAG_SIGNALFD\s0 for faster and simpler signal handling. If |
|
|
4771 | undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4772 | 2.7 or newer, otherwise disabled. |
|
|
4773 | .IP "\s-1EV_USE_TIMERFD\s0" 4 |
|
|
4774 | .IX Item "EV_USE_TIMERFD" |
|
|
4775 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`timerfd ()\*(C'\fR is |
|
|
4776 | available and will probe for kernel support at runtime. This allows |
|
|
4777 | libev to detect time jumps accurately. If undefined, it will be enabled |
|
|
4778 | if the headers indicate GNU/Linux + Glibc 2.8 or newer and define |
|
|
4779 | \&\f(CW\*(C`TFD_TIMER_CANCEL_ON_SET\*(C'\fR, otherwise disabled. |
4751 | .IP "\s-1EV_USE_EVENTFD\s0" 4 |
4780 | .IP "\s-1EV_USE_EVENTFD\s0" 4 |
4752 | .IX Item "EV_USE_EVENTFD" |
4781 | .IX Item "EV_USE_EVENTFD" |
4753 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is |
4782 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is |
4754 | available and will probe for kernel support at runtime. This will improve |
4783 | available and will probe for kernel support at runtime. This will improve |
4755 | \&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. |
4784 | \&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. |
… | |
… | |
4816 | otherwise another method will be used as fallback. This is the preferred |
4845 | otherwise another method will be used as fallback. This is the preferred |
4817 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4846 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4818 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4847 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4819 | .IP "\s-1EV_USE_LINUXAIO\s0" 4 |
4848 | .IP "\s-1EV_USE_LINUXAIO\s0" 4 |
4820 | .IX Item "EV_USE_LINUXAIO" |
4849 | .IX Item "EV_USE_LINUXAIO" |
|
|
4850 | If defined to be \f(CW1\fR, libev will compile in support for the Linux aio |
|
|
4851 | backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). If undefined, it will be |
|
|
4852 | enabled on linux, otherwise disabled. |
|
|
4853 | .IP "\s-1EV_USE_IOURING\s0" 4 |
|
|
4854 | .IX Item "EV_USE_IOURING" |
4821 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
4855 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
4822 | aio backend. Due to it's currenbt limitations it has to be requested |
4856 | io_uring backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). Due to it's |
4823 | explicitly. If undefined, it will be enabled on linux, otherwise |
4857 | current limitations it has to be requested explicitly. If undefined, it |
4824 | disabled. |
4858 | will be enabled on linux, otherwise disabled. |
4825 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
4859 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
4826 | .IX Item "EV_USE_KQUEUE" |
4860 | .IX Item "EV_USE_KQUEUE" |
4827 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
4861 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
4828 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
4862 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
4829 | otherwise another method will be used as fallback. This is the preferred |
4863 | otherwise another method will be used as fallback. This is the preferred |