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

Comparing libev/ev.3 (file contents):
Revision 1.94 by root, Sun May 6 19:51:52 2012 UTC vs.
Revision 1.117 by root, Fri Dec 20 20:51:46 2019 UTC

1.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) 1.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
36.el\{\ 36.el\{\
37. ds -- \|\(em\| 37. ds -- \|\(em\|
38. ds PI \(*p 38. ds PI \(*p
39. ds L" `` 39. ds L" ``
40. ds R" '' 40. ds R" ''
41. ds C`
42. ds C'
41'br\} 43'br\}
42.\" 44.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
45.el .ds Aq ' 47.el .ds Aq '
46.\" 48.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is >0, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
51.ie \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
52. de IX 55.de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54.. 56..
55. nr % 0 57.nr rF 0
56. rr F 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{\
60. if \nF \{\
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
63..
64. if !\nF==2 \{\
65. nr % 0
66. nr F 2
67. \}
68. \}
57.\} 69.\}
58.el \{\ 70.rr rF
59. de IX
60..
61.\}
62.\" 71.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
66.if n \{\ 75.if n \{\
122.\} 131.\}
123.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
124.\" ======================================================================== 133.\" ========================================================================
125.\" 134.\"
126.IX Title "LIBEV 3" 135.IX Title "LIBEV 3"
127.TH LIBEV 3 "2012-05-06" "libev-4.11" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2019-12-20" "libev-4.27" "libev - high performance full featured event loop"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
130.if n .ad l 139.if n .ad l
131.nh 140.nh
132.SH "NAME" 141.SH "NAME"
134.SH "SYNOPSIS" 143.SH "SYNOPSIS"
135.IX Header "SYNOPSIS" 144.IX Header "SYNOPSIS"
136.Vb 1 145.Vb 1
137\& #include <ev.h> 146\& #include <ev.h>
138.Ve 147.Ve
139.SS "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 148.SS "\s-1EXAMPLE PROGRAM\s0"
140.IX Subsection "EXAMPLE PROGRAM" 149.IX Subsection "EXAMPLE PROGRAM"
141.Vb 2 150.Vb 2
142\& // a single header file is required 151\& // a single header file is required
143\& #include <ev.h> 152\& #include <ev.h>
144\& 153\&
212throughout this document. 221throughout this document.
213.SH "WHAT TO READ WHEN IN A HURRY" 222.SH "WHAT TO READ WHEN IN A HURRY"
214.IX Header "WHAT TO READ WHEN IN A HURRY" 223.IX Header "WHAT TO READ WHEN IN A HURRY"
215This manual tries to be very detailed, but unfortunately, this also makes 224This manual tries to be very detailed, but unfortunately, this also makes
216it very long. If you just want to know the basics of libev, I suggest 225it very long. If you just want to know the basics of libev, I suggest
217reading \*(L"\s-1ANATOMY\s0 \s-1OF\s0 A \s-1WATCHER\s0\*(R", then the \*(L"\s-1EXAMPLE\s0 \s-1PROGRAM\s0\*(R" above and 226reading \*(L"\s-1ANATOMY OF A WATCHER\*(R"\s0, then the \*(L"\s-1EXAMPLE PROGRAM\*(R"\s0 above and
218look up the missing functions in \*(L"\s-1GLOBAL\s0 \s-1FUNCTIONS\s0\*(R" and the \f(CW\*(C`ev_io\*(C'\fR and 227look up the missing functions in \*(L"\s-1GLOBAL FUNCTIONS\*(R"\s0 and the \f(CW\*(C`ev_io\*(C'\fR and
219\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER\s0 \s-1TYPES\s0\*(R". 228\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER TYPES\*(R"\s0.
220.SH "ABOUT LIBEV" 229.SH "ABOUT LIBEV"
221.IX Header "ABOUT LIBEV" 230.IX Header "ABOUT LIBEV"
222Libev is an event loop: you register interest in certain events (such as a 231Libev is an event loop: you register interest in certain events (such as a
223file descriptor being readable or a timeout occurring), and it will manage 232file descriptor being readable or a timeout occurring), and it will manage
224these event sources and provide your program with events. 233these event sources and provide your program with events.
231watchers\fR, which are relatively small C structures you initialise with the 240watchers\fR, which are relatively small C structures you initialise with the
232details of the event, and then hand it over to libev by \fIstarting\fR the 241details of the event, and then hand it over to libev by \fIstarting\fR the
233watcher. 242watcher.
234.SS "\s-1FEATURES\s0" 243.SS "\s-1FEATURES\s0"
235.IX Subsection "FEATURES" 244.IX Subsection "FEATURES"
236Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 245Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific aio and \f(CW\*(C`epoll\*(C'\fR
237BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 246interfaces, the BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port
238for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 247mechanisms for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR
239(for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner 248interface (for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner
240inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative 249inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative
241timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling 250timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling
242(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status 251(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status
243change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event 252change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event
244loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and 253loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and
255more info about various configuration options please have a look at 264more info about various configuration options please have a look at
256\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support 265\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
257for multiple event loops, then all functions taking an initial argument of 266for multiple event loops, then all functions taking an initial argument of
258name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have 267name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
259this argument. 268this argument.
260.SS "\s-1TIME\s0 \s-1REPRESENTATION\s0" 269.SS "\s-1TIME REPRESENTATION\s0"
261.IX Subsection "TIME REPRESENTATION" 270.IX Subsection "TIME REPRESENTATION"
262Libev represents time as a single floating point number, representing 271Libev represents time as a single floating point number, representing
263the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice 272the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice
264somewhere near the beginning of 1970, details are complicated, don't 273somewhere near the beginning of 1970, details are complicated, don't
265ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use 274ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use
282When libev detects a usage error such as a negative timer interval, then 291When libev detects a usage error such as a negative timer interval, then
283it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism, 292it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism,
284so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in 293so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in
285the libev caller and need to be fixed there. 294the libev caller and need to be fixed there.
286.PP 295.PP
296Via the \f(CW\*(C`EV_FREQUENT\*(C'\fR macro you can compile in and/or enable extensive
297consistency checking code inside libev that can be used to check for
298internal inconsistencies, suually caused by application bugs.
299.PP
287Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has 300Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions. These do not
288extensive consistency checking code. These do not trigger under normal
289circumstances, as they indicate either a bug in libev or worse. 301trigger under normal circumstances, as they indicate either a bug in libev
302or worse.
290.SH "GLOBAL FUNCTIONS" 303.SH "GLOBAL FUNCTIONS"
291.IX Header "GLOBAL FUNCTIONS" 304.IX Header "GLOBAL FUNCTIONS"
292These functions can be called anytime, even before initialising the 305These functions can be called anytime, even before initialising the
293library in any way. 306library in any way.
294.IP "ev_tstamp ev_time ()" 4 307.IP "ev_tstamp ev_time ()" 4
383.Sp 396.Sp
384You could override this function in high-availability programs to, say, 397You could override this function in high-availability programs to, say,
385free some memory if it cannot allocate memory, to use a special allocator, 398free some memory if it cannot allocate memory, to use a special allocator,
386or even to sleep a while and retry until some memory is available. 399or even to sleep a while and retry until some memory is available.
387.Sp 400.Sp
401Example: The following is the \f(CW\*(C`realloc\*(C'\fR function that libev itself uses
402which should work with \f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions of all kinds and
403is probably a good basis for your own implementation.
404.Sp
405.Vb 5
406\& static void *
407\& ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
408\& {
409\& if (size)
410\& return realloc (ptr, size);
411\&
412\& free (ptr);
413\& return 0;
414\& }
415.Ve
416.Sp
388Example: Replace the libev allocator with one that waits a bit and then 417Example: Replace the libev allocator with one that waits a bit and then
389retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). 418retries.
390.Sp 419.Sp
391.Vb 6 420.Vb 8
392\& static void * 421\& static void *
393\& persistent_realloc (void *ptr, size_t size) 422\& persistent_realloc (void *ptr, size_t size)
394\& { 423\& {
424\& if (!size)
425\& {
426\& free (ptr);
427\& return 0;
428\& }
429\&
395\& for (;;) 430\& for (;;)
396\& { 431\& {
397\& void *newptr = realloc (ptr, size); 432\& void *newptr = realloc (ptr, size);
398\& 433\&
399\& if (newptr) 434\& if (newptr)
514.IX Item "EVFLAG_NOENV" 549.IX Item "EVFLAG_NOENV"
515If this flag bit is or'ed into the flag value (or the program runs setuid 550If this flag bit is or'ed into the flag value (or the program runs setuid
516or setgid) then libev will \fInot\fR look at the environment variable 551or setgid) then libev will \fInot\fR look at the environment variable
517\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 552\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
518override the flags completely if it is found in the environment. This is 553override the flags completely if it is found in the environment. This is
519useful to try out specific backends to test their performance, or to work 554useful to try out specific backends to test their performance, to work
520around bugs. 555around bugs, or to make libev threadsafe (accessing environment variables
556cannot be done in a threadsafe way, but usually it works if no other
557thread modifies them).
521.ie n .IP """EVFLAG_FORKCHECK""" 4 558.ie n .IP """EVFLAG_FORKCHECK""" 4
522.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 559.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
523.IX Item "EVFLAG_FORKCHECK" 560.IX Item "EVFLAG_FORKCHECK"
524Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also 561Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
525make libev check for a fork in each iteration by enabling this flag. 562make libev check for a fork in each iteration by enabling this flag.
526.Sp 563.Sp
527This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 564This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
528and thus this might slow down your event loop if you do a lot of loop 565and thus this might slow down your event loop if you do a lot of loop
529iterations and little real work, but is usually not noticeable (on my 566iterations and little real work, but is usually not noticeable (on my
530GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 567GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn
531without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has 568sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux
532\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 569system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc
570versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again).
533.Sp 571.Sp
534The big advantage of this flag is that you can forget about fork (and 572The big advantage of this flag is that you can forget about fork (and
535forget about forgetting to tell libev about forking) when you use this 573forget about forgetting to tell libev about forking, although you still
536flag. 574have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
537.Sp 575.Sp
538This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 576This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
539environment variable. 577environment variable.
540.ie n .IP """EVFLAG_NOINOTIFY""" 4 578.ie n .IP """EVFLAG_NOINOTIFY""" 4
541.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 579.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
555threads that are not interested in handling them. 593threads that are not interested in handling them.
556.Sp 594.Sp
557Signalfd will not be used by default as this changes your signal mask, and 595Signalfd will not be used by default as this changes your signal mask, and
558there are a lot of shoddy libraries and programs (glib's threadpool for 596there are a lot of shoddy libraries and programs (glib's threadpool for
559example) that can't properly initialise their signal masks. 597example) 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"
601When this flag is specified, the libev will avoid using a \f(CW\*(C`timerfd\*(C'\fR to
602detect time jumps. It will still be able to detect time jumps, but takes
603longer and has a lower accuracy in doing so, but saves a file descriptor
604per loop.
560.ie n .IP """EVFLAG_NOSIGMASK""" 4 605.ie n .IP """EVFLAG_NOSIGMASK""" 4
561.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4 606.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
562.IX Item "EVFLAG_NOSIGMASK" 607.IX Item "EVFLAG_NOSIGMASK"
563When this flag is specified, then libev will avoid to modify the signal 608When this flag is specified, then libev will avoid to modify the signal
564mask. Specifically, this means you have to make sure signals are unblocked 609mask. Specifically, this means you have to make sure signals are unblocked
572\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified. 617\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
573.Sp 618.Sp
574This flag's behaviour will become the default in future versions of libev. 619This flag's behaviour will become the default in future versions of libev.
575.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 620.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
576.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 621.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
577.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 622.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
578This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 623This is your standard \fBselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
579libev tries to roll its own fd_set with no limits on the number of fds, 624libev tries to roll its own fd_set with no limits on the number of fds,
580but if that fails, expect a fairly low limit on the number of fds when 625but if that fails, expect a fairly low limit on the number of fds when
581using this backend. It doesn't scale too well (O(highest_fd)), but its 626using this backend. It doesn't scale too well (O(highest_fd)), but its
582usually the fastest backend for a low number of (low-numbered :) fds. 627usually the fastest backend for a low number of (low-numbered :) fds.
583.Sp 628.Sp
591This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the 636This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the
592\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the 637\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
593\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). 638\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
594.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 639.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
595.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 640.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
596.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 641.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
597And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 642And this is your standard \fBpoll\fR\|(2) backend. It's more complicated
598than select, but handles sparse fds better and has no artificial 643than select, but handles sparse fds better and has no artificial
599limit on the number of fds you can use (except it will slow down 644limit on the number of fds you can use (except it will slow down
600considerably with a lot of inactive fds). It scales similarly to select, 645considerably with a lot of inactive fds). It scales similarly to select,
601i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for 646i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
602performance tips. 647performance tips.
603.Sp 648.Sp
604This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 649This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
605\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 650\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
606.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 651.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
607.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 652.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
608.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 653.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
609Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 654Use the Linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
610kernels). 655kernels).
611.Sp 656.Sp
612For few fds, this backend is a bit little slower than poll and select, but 657For few fds, this backend is a bit little slower than poll and select, but
613it scales phenomenally better. While poll and select usually scale like 658it scales phenomenally better. While poll and select usually scale like
614O(total_fds) where total_fds is the total number of fds (or the highest 659O(total_fds) where total_fds is the total number of fds (or the highest
660All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or 705All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
661faster than epoll for maybe up to a hundred file descriptors, depending on 706faster than epoll for maybe up to a hundred file descriptors, depending on
662the usage. So sad. 707the usage. So sad.
663.Sp 708.Sp
664While nominally embeddable in other event loops, this feature is broken in 709While nominally embeddable in other event loops, this feature is broken in
665all kernel versions tested so far. 710a lot of kernel revisions, but probably(!) works in current versions.
711.Sp
712This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
713\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
714.ie n .IP """EVBACKEND_LINUXAIO"" (value 64, Linux)" 4
715.el .IP "\f(CWEVBACKEND_LINUXAIO\fR (value 64, Linux)" 4
716.IX Item "EVBACKEND_LINUXAIO (value 64, Linux)"
717Use the Linux-specific Linux \s-1AIO\s0 (\fInot\fR \f(CWaio(7)\fR but \f(CWio_submit(2)\fR) event interface available in post\-4.18 kernels (but libev
718only tries to use it in 4.19+).
719.Sp
720This is another Linux train wreck of an event interface.
721.Sp
722If this backend works for you (as of this writing, it was very
723experimental), it is the best event interface available on Linux and might
724be well worth enabling it \- if it isn't available in your kernel this will
725be detected and this backend will be skipped.
726.Sp
727This backend can batch oneshot requests and supports a user-space ring
728buffer to receive events. It also doesn't suffer from most of the design
729problems of epoll (such as not being able to remove event sources from
730the epoll set), and generally sounds too good to be true. Because, this
731being the Linux kernel, of course it suffers from a whole new set of
732limitations, forcing you to fall back to epoll, inheriting all its design
733issues.
734.Sp
735For one, it is not easily embeddable (but probably could be done using
736an event fd at some extra overhead). It also is subject to a system wide
737limit that can be configured in \fI/proc/sys/fs/aio\-max\-nr\fR. If no \s-1AIO\s0
738requests are left, this backend will be skipped during initialisation, and
739will switch to epoll when the loop is active.
740.Sp
741Most problematic in practice, however, is that not all file descriptors
742work with it. For example, in Linux 5.1, \s-1TCP\s0 sockets, pipes, event fds,
743files, \fI/dev/null\fR and many others are supported, but ttys do not work
744properly (a known bug that the kernel developers don't care about, see
745<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
746(yet?) a generic event polling interface.
747.Sp
748Overall, it seems the Linux developers just don't want it to have a
749generic event handling mechanism other than \f(CW\*(C`select\*(C'\fR or \f(CW\*(C`poll\*(C'\fR.
750.Sp
751To work around all these problem, the current version of libev uses its
752epoll backend as a fallback for file descriptor types that do not work. Or
753falls back completely to epoll if the kernel acts up.
666.Sp 754.Sp
667This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 755This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
668\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 756\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
669.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 757.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
670.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 758.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
671.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 759.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
672Kqueue deserves special mention, as at the time of this writing, it 760Kqueue deserves special mention, as at the time this backend was
673was broken on all BSDs except NetBSD (usually it doesn't work reliably 761implemented, it was broken on all BSDs except NetBSD (usually it doesn't
674with anything but sockets and pipes, except on Darwin, where of course 762work reliably with anything but sockets and pipes, except on Darwin,
675it's completely useless). Unlike epoll, however, whose brokenness 763where of course it's completely useless). Unlike epoll, however, whose
676is by design, these kqueue bugs can (and eventually will) be fixed 764brokenness is by design, these kqueue bugs can be (and mostly have been)
677without \s-1API\s0 changes to existing programs. For this reason it's not being 765fixed without \s-1API\s0 changes to existing programs. For this reason it's not
678\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using 766being \*(L"auto-detected\*(R" on all platforms unless you explicitly specify it
679\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) 767in the flags (i.e. using \f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a
680system like NetBSD. 768known-to-be-good (\-enough) system like NetBSD.
681.Sp 769.Sp
682You still can embed kqueue into a normal poll or select backend and use it 770You still can embed kqueue into a normal poll or select backend and use it
683only for sockets (after having made sure that sockets work with kqueue on 771only for sockets (after having made sure that sockets work with kqueue on
684the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 772the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
685.Sp 773.Sp
686It scales in the same way as the epoll backend, but the interface to the 774It scales in the same way as the epoll backend, but the interface to the
687kernel is more efficient (which says nothing about its actual speed, of 775kernel is more efficient (which says nothing about its actual speed, of
688course). While stopping, setting and starting an I/O watcher does never 776course). While stopping, setting and starting an I/O watcher does never
689cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 777cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
690two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you 778two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
691might have to leak fd's on fork, but it's more sane than epoll) and it 779might have to leak fds on fork, but it's more sane than epoll) and it
692drops fds silently in similarly hard-to-detect cases 780drops fds silently in similarly hard-to-detect cases.
693.Sp 781.Sp
694This backend usually performs well under most conditions. 782This backend usually performs well under most conditions.
695.Sp 783.Sp
696While nominally embeddable in other event loops, this doesn't work 784While nominally embeddable in other event loops, this doesn't work
697everywhere, so you might need to test for this. And since it is broken 785everywhere, so you might need to test for this. And since it is broken
698almost everywhere, you should only use it when you have a lot of sockets 786almost everywhere, you should only use it when you have a lot of sockets
699(for which it usually works), by embedding it into another event loop 787(for which it usually works), by embedding it into another event loop
700(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course 788(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course
701also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. 789also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
702.Sp 790.Sp
703This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 791This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
704\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with 792\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with
705\&\f(CW\*(C`NOTE_EOF\*(C'\fR. 793\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
706.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 794.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
710implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets 798implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
711and is not embeddable, which would limit the usefulness of this backend 799and is not embeddable, which would limit the usefulness of this backend
712immensely. 800immensely.
713.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 801.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
714.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 802.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
715.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 803.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
716This uses the Solaris 10 event port mechanism. As with everything on Solaris, 804This uses the Solaris 10 event port mechanism. As with everything on Solaris,
717it's really slow, but it still scales very well (O(active_fds)). 805it's really slow, but it still scales very well (O(active_fds)).
718.Sp 806.Sp
719While this backend scales well, it requires one system call per active 807While this backend scales well, it requires one system call per active
720file descriptor per loop iteration. For small and medium numbers of file 808file descriptor per loop iteration. For small and medium numbers of file
774used if available. 862used if available.
775.Sp 863.Sp
776.Vb 1 864.Vb 1
777\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 865\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
778.Ve 866.Ve
867.Sp
868Example: Similarly, on linux, you mgiht want to take advantage of the
869linux aio backend if possible, but fall back to something else if that
870isn't available.
871.Sp
872.Vb 1
873\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
874.Ve
779.RE 875.RE
780.IP "ev_loop_destroy (loop)" 4 876.IP "ev_loop_destroy (loop)" 4
781.IX Item "ev_loop_destroy (loop)" 877.IX Item "ev_loop_destroy (loop)"
782Destroys an event loop object (frees all memory and kernel state 878Destroys an event loop object (frees all memory and kernel state
783etc.). None of the active event watchers will be stopped in the normal 879etc.). None of the active event watchers will be stopped in the normal
799except in the rare occasion where you really need to free its resources. 895except in the rare occasion where you really need to free its resources.
800If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR 896If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
801and \f(CW\*(C`ev_loop_destroy\*(C'\fR. 897and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
802.IP "ev_loop_fork (loop)" 4 898.IP "ev_loop_fork (loop)" 4
803.IX Item "ev_loop_fork (loop)" 899.IX Item "ev_loop_fork (loop)"
804This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to 900This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations
805reinitialise the kernel state for backends that have one. Despite the 901to reinitialise the kernel state for backends that have one. Despite
806name, you can call it anytime, but it makes most sense after forking, in 902the name, you can call it anytime you are allowed to start or stop
807the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the 903watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most
808child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. 904sense after forking, in the child process. You \fImust\fR call it (or use
905\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
809.Sp 906.Sp
907In addition, if you want to reuse a loop (via this function or
908\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR.
909.Sp
810Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after 910Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
811a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is 911a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
812because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things 912because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
813during fork. 913during fork.
814.Sp 914.Sp
815On the other hand, you only need to call this function in the child 915On the other hand, you only need to call this function in the child
1349bug in your program. 1449bug in your program.
1350.Sp 1450.Sp
1351Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1451Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
1352example it might indicate that a fd is readable or writable, and if your 1452example it might indicate that a fd is readable or writable, and if your
1353callbacks is well-written it can just attempt the operation and cope with 1453callbacks is well-written it can just attempt the operation and cope with
1354the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1454the error from \fBread()\fR or \fBwrite()\fR. This will not work in multi-threaded
1355programs, though, as the fd could already be closed and reused for another 1455programs, though, as the fd could already be closed and reused for another
1356thing, so beware. 1456thing, so beware.
1357.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1457.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1358.IX Subsection "GENERIC WATCHER FUNCTIONS" 1458.IX Subsection "GENERIC WATCHER FUNCTIONS"
1359.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1459.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1360.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1460.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1361.IX Item "ev_init (ev_TYPE *watcher, callback)" 1461.IX Item "ev_init (ev_TYPE *watcher, callback)"
1362This macro initialises the generic portion of a watcher. The contents 1462This macro initialises the generic portion of a watcher. The contents
1470or might not have been clamped to the valid range. 1570or might not have been clamped to the valid range.
1471.Sp 1571.Sp
1472The default priority used by watchers when no priority has been set is 1572The default priority used by watchers when no priority has been set is
1473always \f(CW0\fR, which is supposed to not be too high and not be too low :). 1573always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1474.Sp 1574.Sp
1475See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1575See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1476priorities. 1576priorities.
1477.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1577.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1478.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1578.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1479Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1579Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1480\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1580\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1500not started in the first place. 1600not started in the first place.
1501.Sp 1601.Sp
1502See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related 1602See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1503functions that do not need a watcher. 1603functions that do not need a watcher.
1504.PP 1604.PP
1505See also the \*(L"\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0\*(R" and \*(L"\s-1BUILDING\s0 \s-1YOUR\s0 1605See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1506\&\s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0\*(R" idioms. 1606OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1507.SS "\s-1WATCHER\s0 \s-1STATES\s0" 1607.SS "\s-1WATCHER STATES\s0"
1508.IX Subsection "WATCHER STATES" 1608.IX Subsection "WATCHER STATES"
1509There are various watcher states mentioned throughout this manual \- 1609There are various watcher states mentioned throughout this manual \-
1510active, pending and so on. In this section these states and the rules to 1610active, pending and so on. In this section these states and the rules to
1511transition between them will be described in more detail \- and while these 1611transition between them will be described in more detail \- and while these
1512rules might look complicated, they usually do \*(L"the right thing\*(R". 1612rules might look complicated, they usually do \*(L"the right thing\*(R".
1513.IP "initialiased" 4 1613.IP "initialised" 4
1514.IX Item "initialiased" 1614.IX Item "initialised"
1515Before a watcher can be registered with the event loop it has to be 1615Before a watcher can be registered with the event loop it has to be
1516initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to 1616initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1517\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function. 1617\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1518.Sp 1618.Sp
1519In this state it is simply some block of memory that is suitable for 1619In this state it is simply some block of memory that is suitable for
1555.Sp 1655.Sp
1556While stopped (and not pending) the watcher is essentially in the 1656While stopped (and not pending) the watcher is essentially in the
1557initialised state, that is, it can be reused, moved, modified in any way 1657initialised state, that is, it can be reused, moved, modified in any way
1558you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR 1658you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1559it again). 1659it again).
1560.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1660.SS "\s-1WATCHER PRIORITY MODELS\s0"
1561.IX Subsection "WATCHER PRIORITY MODELS" 1661.IX Subsection "WATCHER PRIORITY MODELS"
1562Many event loops support \fIwatcher priorities\fR, which are usually small 1662Many event loops support \fIwatcher priorities\fR, which are usually small
1563integers that influence the ordering of event callback invocation 1663integers that influence the ordering of event callback invocation
1564between watchers in some way, all else being equal. 1664between watchers in some way, all else being equal.
1565.PP 1665.PP
1566In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its 1666In libev, watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1567description for the more technical details such as the actual priority 1667description for the more technical details such as the actual priority
1568range. 1668range.
1569.PP 1669.PP
1570There are two common ways how these these priorities are being interpreted 1670There are two common ways how these these priorities are being interpreted
1571by event loops: 1671by event loops:
1710But really, best use non-blocking mode. 1810But really, best use non-blocking mode.
1711.PP 1811.PP
1712\fIThe special problem of disappearing file descriptors\fR 1812\fIThe special problem of disappearing file descriptors\fR
1713.IX Subsection "The special problem of disappearing file descriptors" 1813.IX Subsection "The special problem of disappearing file descriptors"
1714.PP 1814.PP
1715Some backends (e.g. kqueue, epoll) need to be told about closing a file 1815Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1716descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means, 1816a file descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other
1717such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file 1817means, such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some
1718descriptor, but when it goes away, the operating system will silently drop 1818file descriptor, but when it goes away, the operating system will silently
1719this interest. If another file descriptor with the same number then is 1819drop this interest. If another file descriptor with the same number then
1720registered with libev, there is no efficient way to see that this is, in 1820is registered with libev, there is no efficient way to see that this is,
1721fact, a different file descriptor. 1821in fact, a different file descriptor.
1722.PP 1822.PP
1723To avoid having to explicitly tell libev about such cases, libev follows 1823To avoid having to explicitly tell libev about such cases, libev follows
1724the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev 1824the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1725will assume that this is potentially a new file descriptor, otherwise 1825will assume that this is potentially a new file descriptor, otherwise
1726it is assumed that the file descriptor stays the same. That means that 1826it is assumed that the file descriptor stays the same. That means that
1763wish to read \- you would first have to request some data. 1863wish to read \- you would first have to request some data.
1764.PP 1864.PP
1765Since files are typically not-so-well supported by advanced notification 1865Since files are typically not-so-well supported by advanced notification
1766mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect 1866mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1767to files, even though you should not use it. The reason for this is 1867to files, even though you should not use it. The reason for this is
1768convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT\s0, which is 1868convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1769usually a tty, often a pipe, but also sometimes files or special devices 1869usually a tty, often a pipe, but also sometimes files or special devices
1770(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with 1870(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1771\&\fI/dev/urandom\fR), and even though the file might better be served with 1871\&\fI/dev/urandom\fR), and even though the file might better be served with
1772asynchronous I/O instead of with non-blocking I/O, it is still useful when 1872asynchronous I/O instead of with non-blocking I/O, it is still useful when
1773it \*(L"just works\*(R" instead of freezing. 1873it \*(L"just works\*(R" instead of freezing.
1774.PP 1874.PP
1775So avoid file descriptors pointing to files when you know it (e.g. use 1875So avoid file descriptors pointing to files when you know it (e.g. use
1776libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT\s0, or 1876libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1777when you rarely read from a file instead of from a socket, and want to 1877when you rarely read from a file instead of from a socket, and want to
1778reuse the same code path. 1878reuse the same code path.
1779.PP 1879.PP
1780\fIThe special problem of fork\fR 1880\fIThe special problem of fork\fR
1781.IX Subsection "The special problem of fork" 1881.IX Subsection "The special problem of fork"
1782.PP 1882.PP
1783Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1883Some backends (epoll, kqueue, linuxaio, iouring) do not support \f(CW\*(C`fork ()\*(C'\fR
1784useless behaviour. Libev fully supports fork, but needs to be told about 1884at all or exhibit useless behaviour. Libev fully supports fork, but needs
1785it in the child if you want to continue to use it in the child. 1885to be told about it in the child if you want to continue to use it in the
1886child.
1786.PP 1887.PP
1787To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork 1888To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1788()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to 1889()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1789\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1890\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1790.PP 1891.PP
1791\fIThe special problem of \s-1SIGPIPE\s0\fR 1892\fIThe special problem of \s-1SIGPIPE\s0\fR
1792.IX Subsection "The special problem of SIGPIPE" 1893.IX Subsection "The special problem of SIGPIPE"
1793.PP 1894.PP
1794While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1895While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1795when writing to a pipe whose other end has been closed, your program gets 1896when writing to a pipe whose other end has been closed, your program gets
1796sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs 1897sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1797this is sensible behaviour, for daemons, this is usually undesirable. 1898this is sensible behaviour, for daemons, this is usually undesirable.
1798.PP 1899.PP
1799So when you encounter spurious, unexplained daemon exits, make sure you 1900So when you encounter spurious, unexplained daemon exits, make sure you
1800ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon 1901ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1801somewhere, as that would have given you a big clue). 1902somewhere, as that would have given you a big clue).
1802.PP 1903.PP
1803\fIThe special problem of \fIaccept()\fIing when you can't\fR 1904\fIThe special problem of \f(BIaccept()\fIing when you can't\fR
1804.IX Subsection "The special problem of accept()ing when you can't" 1905.IX Subsection "The special problem of accept()ing when you can't"
1805.PP 1906.PP
1806Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, 1907Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
1807found in post\-2004 Linux) have the peculiar behaviour of not removing a 1908found in post\-2004 Linux) have the peculiar behaviour of not removing a
1808connection from the pending queue in all error cases. 1909connection from the pending queue in all error cases.
2150.PP 2251.PP
2151The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2252The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
2152time. This is usually the right thing as this timestamp refers to the time 2253time. This is usually the right thing as this timestamp refers to the time
2153of the event triggering whatever timeout you are modifying/starting. If 2254of the event triggering whatever timeout you are modifying/starting. If
2154you suspect event processing to be delayed and you \fIneed\fR to base the 2255you suspect event processing to be delayed and you \fIneed\fR to base the
2155timeout on the current time, use something like this to adjust for this: 2256timeout on the current time, use something like the following to adjust
2257for it:
2156.PP 2258.PP
2157.Vb 1 2259.Vb 1
2158\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 2260\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
2159.Ve 2261.Ve
2160.PP 2262.PP
2161If the event loop is suspended for a long time, you can also force an 2263If the event loop is suspended for a long time, you can also force an
2162update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 2264update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
2163()\*(C'\fR. 2265()\*(C'\fR, although that will push the event time of all outstanding events
2266further into the future.
2164.PP 2267.PP
2165\fIThe special problem of unsynchronised clocks\fR 2268\fIThe special problem of unsynchronised clocks\fR
2166.IX Subsection "The special problem of unsynchronised clocks" 2269.IX Subsection "The special problem of unsynchronised clocks"
2167.PP 2270.PP
2168Modern systems have a variety of clocks \- libev itself uses the normal 2271Modern systems have a variety of clocks \- libev itself uses the normal
2233.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2336.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
2234.PD 0 2337.PD 0
2235.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2338.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
2236.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 2339.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
2237.PD 2340.PD
2238Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR 2341Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds (fractional and
2239is \f(CW0.\fR, then it will automatically be stopped once the timeout is 2342negative values are supported). If \f(CW\*(C`repeat\*(C'\fR is \f(CW0.\fR, then it will
2240reached. If it is positive, then the timer will automatically be 2343automatically be stopped once the timeout is reached. If it is positive,
2241configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, 2344then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
2242until stopped manually. 2345seconds later, again, and again, until stopped manually.
2243.Sp 2346.Sp
2244The timer itself will do a best-effort at avoiding drift, that is, if 2347The timer itself will do a best-effort at avoiding drift, that is, if
2245you configure a timer to trigger every 10 seconds, then it will normally 2348you configure a timer to trigger every 10 seconds, then it will normally
2246trigger at exactly 10 second intervals. If, however, your program cannot 2349trigger at exactly 10 second intervals. If, however, your program cannot
2247keep up with the timer (because it takes longer than those 10 seconds to 2350keep up with the timer (because it takes longer than those 10 seconds to
2329Periodic watchers are also timers of a kind, but they are very versatile 2432Periodic watchers are also timers of a kind, but they are very versatile
2330(and unfortunately a bit complex). 2433(and unfortunately a bit complex).
2331.PP 2434.PP
2332Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or 2435Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
2333relative time, the physical time that passes) but on wall clock time 2436relative time, the physical time that passes) but on wall clock time
2334(absolute time, the thing you can read on your calender or clock). The 2437(absolute time, the thing you can read on your calendar or clock). The
2335difference is that wall clock time can run faster or slower than real 2438difference is that wall clock time can run faster or slower than real
2336time, and time jumps are not uncommon (e.g. when you adjust your 2439time, and time jumps are not uncommon (e.g. when you adjust your
2337wrist-watch). 2440wrist-watch).
2338.PP 2441.PP
2339You can tell a periodic watcher to trigger after some specific point 2442You can tell a periodic watcher to trigger after some specific point
2344\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting 2447\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2345it, as it uses a relative timeout). 2448it, as it uses a relative timeout).
2346.PP 2449.PP
2347\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex 2450\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
2348timers, such as triggering an event on each \*(L"midnight, local time\*(R", or 2451timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
2349other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as 2452other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2350those cannot react to time jumps. 2453watchers, as those cannot react to time jumps.
2351.PP 2454.PP
2352As with timers, the callback is guaranteed to be invoked only when the 2455As with timers, the callback is guaranteed to be invoked only when the
2353point in time where it is supposed to trigger has passed. If multiple 2456point in time where it is supposed to trigger has passed. If multiple
2354timers become ready during the same loop iteration then the ones with 2457timers become ready during the same loop iteration then the ones with
2355earlier time-out values are invoked before ones with later time-out values 2458earlier time-out values are invoked before ones with later time-out values
2416In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being 2519In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
2417ignored. Instead, each time the periodic watcher gets scheduled, the 2520ignored. Instead, each time the periodic watcher gets scheduled, the
2418reschedule callback will be called with the watcher as first, and the 2521reschedule callback will be called with the watcher as first, and the
2419current time as second argument. 2522current time as second argument.
2420.Sp 2523.Sp
2421\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2524\&\s-1NOTE:\s0 \fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
2422or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly 2525or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2423allowed by documentation here\fR. 2526allowed by documentation here\fR.
2424.Sp 2527.Sp
2425If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2528If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2426it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2529it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2444.Sp 2547.Sp
2445\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2548\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
2446equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. 2549equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2447.Sp 2550.Sp
2448This can be used to create very complex timers, such as a timer that 2551This can be used to create very complex timers, such as a timer that
2449triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the 2552triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate
2450next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2553the next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for
2451you do this is, again, up to you (but it is not trivial, which is the main 2554this. Here is a (completely untested, no error checking) example on how to
2452reason I omitted it as an example). 2555do this:
2556.Sp
2557.Vb 1
2558\& #include <time.h>
2559\&
2560\& static ev_tstamp
2561\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2562\& {
2563\& time_t tnow = (time_t)now;
2564\& struct tm tm;
2565\& localtime_r (&tnow, &tm);
2566\&
2567\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2568\& ++tm.tm_mday; // midnight next day
2569\&
2570\& return mktime (&tm);
2571\& }
2572.Ve
2573.Sp
2574Note: this code might run into trouble on days that have more then two
2575midnights (beginning and end).
2453.RE 2576.RE
2454.RS 4 2577.RS 4
2455.RE 2578.RE
2456.IP "ev_periodic_again (loop, ev_periodic *)" 4 2579.IP "ev_periodic_again (loop, ev_periodic *)" 4
2457.IX Item "ev_periodic_again (loop, ev_periodic *)" 2580.IX Item "ev_periodic_again (loop, ev_periodic *)"
2542only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your 2665only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
2543default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for 2666default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
2544\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At 2667\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
2545the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop. 2668the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2546.PP 2669.PP
2547When the first watcher gets started will libev actually register something 2670Only after the first watcher for a signal is started will libev actually
2548with the kernel (thus it coexists with your own signal handlers as long as 2671register something with the kernel. It thus coexists with your own signal
2549you don't register any with libev for the same signal). 2672handlers as long as you don't register any with libev for the same signal.
2550.PP 2673.PP
2551If possible and supported, libev will install its handlers with 2674If possible and supported, libev will install its handlers with
2552\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should 2675\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
2553not be unduly interrupted. If you have a problem with system calls getting 2676not be unduly interrupted. If you have a problem with system calls getting
2554interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher 2677interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2615The signal the watcher watches out for. 2738The signal the watcher watches out for.
2616.PP 2739.PP
2617\fIExamples\fR 2740\fIExamples\fR
2618.IX Subsection "Examples" 2741.IX Subsection "Examples"
2619.PP 2742.PP
2620Example: Try to exit cleanly on \s-1SIGINT\s0. 2743Example: Try to exit cleanly on \s-1SIGINT.\s0
2621.PP 2744.PP
2622.Vb 5 2745.Vb 5
2623\& static void 2746\& static void
2624\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2747\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2625\& { 2748\& {
2740.ie n .SS """ev_stat"" \- did the file attributes just change?" 2863.ie n .SS """ev_stat"" \- did the file attributes just change?"
2741.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2864.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2742.IX Subsection "ev_stat - did the file attributes just change?" 2865.IX Subsection "ev_stat - did the file attributes just change?"
2743This watches a file system path for attribute changes. That is, it calls 2866This watches a file system path for attribute changes. That is, it calls
2744\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) 2867\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2745and sees if it changed compared to the last time, invoking the callback if 2868and sees if it changed compared to the last time, invoking the callback
2746it did. 2869if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2870happen after the watcher has been started will be reported.
2747.PP 2871.PP
2748The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2872The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
2749not exist\*(R" is a status change like any other. The condition \*(L"path does not 2873not exist\*(R" is a status change like any other. The condition \*(L"path does not
2750exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the 2874exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
2751\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at 2875\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
2781compilation environment, which means that on systems with large file 2905compilation environment, which means that on systems with large file
2782support disabled by default, you get the 32 bit version of the stat 2906support disabled by default, you get the 32 bit version of the stat
2783structure. When using the library from programs that change the \s-1ABI\s0 to 2907structure. When using the library from programs that change the \s-1ABI\s0 to
2784use 64 bit file offsets the programs will fail. In that case you have to 2908use 64 bit file offsets the programs will fail. In that case you have to
2785compile libev with the same flags to get binary compatibility. This is 2909compile libev with the same flags to get binary compatibility. This is
2786obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2910obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2787most noticeably displayed with ev_stat and large file support. 2911most noticeably displayed with ev_stat and large file support.
2788.PP 2912.PP
2789The solution for this is to lobby your distribution maker to make large 2913The solution for this is to lobby your distribution maker to make large
2790file interfaces available by default (as e.g. FreeBSD does) and not 2914file interfaces available by default (as e.g. FreeBSD does) and not
2791optional. Libev cannot simply switch on large file support because it has 2915optional. Libev cannot simply switch on large file support because it has
3036.IX Subsection "ev_prepare and ev_check - customise your event loop!" 3160.IX Subsection "ev_prepare and ev_check - customise your event loop!"
3037Prepare and check watchers are often (but not always) used in pairs: 3161Prepare and check watchers are often (but not always) used in pairs:
3038prepare watchers get invoked before the process blocks and check watchers 3162prepare watchers get invoked before the process blocks and check watchers
3039afterwards. 3163afterwards.
3040.PP 3164.PP
3041You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter 3165You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the
3042the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 3166current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or
3043watchers. Other loops than the current one are fine, however. The 3167\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine,
3044rationale behind this is that you do not need to check for recursion in 3168however. The rationale behind this is that you do not need to check
3045those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 3169for recursion in those watchers, i.e. the sequence will always be
3046\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 3170\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each
3047called in pairs bracketing the blocking call. 3171kind they will always be called in pairs bracketing the blocking call.
3048.PP 3172.PP
3049Their main purpose is to integrate other event mechanisms into libev and 3173Their main purpose is to integrate other event mechanisms into libev and
3050their use is somewhat advanced. They could be used, for example, to track 3174their use is somewhat advanced. They could be used, for example, to track
3051variable changes, implement your own watchers, integrate net-snmp or a 3175variable changes, implement your own watchers, integrate net-snmp or a
3052coroutine library and lots more. They are also occasionally useful if 3176coroutine library and lots more. They are also occasionally useful if
3222.Ve 3346.Ve
3223.PP 3347.PP
3224Method 4: Do not use a prepare or check watcher because the module you 3348Method 4: Do not use a prepare or check watcher because the module you
3225want to embed is not flexible enough to support it. Instead, you can 3349want to embed is not flexible enough to support it. Instead, you can
3226override their poll function. The drawback with this solution is that the 3350override their poll function. The drawback with this solution is that the
3227main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses 3351main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
3228this approach, effectively embedding \s-1EV\s0 as a client into the horrible 3352this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3229libglib event loop. 3353libglib event loop.
3230.PP 3354.PP
3231.Vb 4 3355.Vb 4
3232\& static gint 3356\& static gint
3316\fIWatcher-Specific Functions and Data Members\fR 3440\fIWatcher-Specific Functions and Data Members\fR
3317.IX Subsection "Watcher-Specific Functions and Data Members" 3441.IX Subsection "Watcher-Specific Functions and Data Members"
3318.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3442.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
3319.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3443.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
3320.PD 0 3444.PD 0
3321.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3445.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
3322.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3446.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
3323.PD 3447.PD
3324Configures the watcher to embed the given loop, which must be 3448Configures the watcher to embed the given loop, which must be
3325embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3449embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
3326invoked automatically, otherwise it is the responsibility of the callback 3450invoked automatically, otherwise it is the responsibility of the callback
3327to invoke it (it will continue to be called until the sweep has been done, 3451to invoke it (it will continue to be called until the sweep has been done,
3346.PP 3470.PP
3347.Vb 3 3471.Vb 3
3348\& struct ev_loop *loop_hi = ev_default_init (0); 3472\& struct ev_loop *loop_hi = ev_default_init (0);
3349\& struct ev_loop *loop_lo = 0; 3473\& struct ev_loop *loop_lo = 0;
3350\& ev_embed embed; 3474\& ev_embed embed;
3351\& 3475\&
3352\& // see if there is a chance of getting one that works 3476\& // see if there is a chance of getting one that works
3353\& // (remember that a flags value of 0 means autodetection) 3477\& // (remember that a flags value of 0 means autodetection)
3354\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3478\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3355\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3479\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3356\& : 0; 3480\& : 0;
3372.PP 3496.PP
3373.Vb 3 3497.Vb 3
3374\& struct ev_loop *loop = ev_default_init (0); 3498\& struct ev_loop *loop = ev_default_init (0);
3375\& struct ev_loop *loop_socket = 0; 3499\& struct ev_loop *loop_socket = 0;
3376\& ev_embed embed; 3500\& ev_embed embed;
3377\& 3501\&
3378\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3502\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3379\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3503\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3380\& { 3504\& {
3381\& ev_embed_init (&embed, 0, loop_socket); 3505\& ev_embed_init (&embed, 0, loop_socket);
3382\& ev_embed_start (loop, &embed); 3506\& ev_embed_start (loop, &embed);
3390.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3514.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
3391.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 3515.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
3392.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 3516.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
3393Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 3517Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
3394whoever is a good citizen cared to tell libev about it by calling 3518whoever is a good citizen cared to tell libev about it by calling
3395\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 3519\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
3396event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 3520and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
3397and only in the child after the fork. If whoever good citizen calling 3521after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
3398\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 3522and calls it in the wrong process, the fork handlers will be invoked, too,
3399handlers will be invoked, too, of course. 3523of course.
3400.PP 3524.PP
3401\fIThe special problem of life after fork \- how is it possible?\fR 3525\fIThe special problem of life after fork \- how is it possible?\fR
3402.IX Subsection "The special problem of life after fork - how is it possible?" 3526.IX Subsection "The special problem of life after fork - how is it possible?"
3403.PP 3527.PP
3404Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set 3528Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set
3405up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This 3529up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3406sequence should be handled by libev without any problems. 3530sequence should be handled by libev without any problems.
3407.PP 3531.PP
3408This changes when the application actually wants to do event handling 3532This changes when the application actually wants to do event handling
3409in the child, or both parent in child, in effect \*(L"continuing\*(R" after the 3533in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3626is a time window between the event loop checking and resetting the async 3750is a time window between the event loop checking and resetting the async
3627notification, and the callback being invoked. 3751notification, and the callback being invoked.
3628.SH "OTHER FUNCTIONS" 3752.SH "OTHER FUNCTIONS"
3629.IX Header "OTHER FUNCTIONS" 3753.IX Header "OTHER FUNCTIONS"
3630There are some other functions of possible interest. Described. Here. Now. 3754There are some other functions of possible interest. Described. Here. Now.
3631.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3755.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" 4
3632.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3756.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)"
3633This function combines a simple timer and an I/O watcher, calls your 3757This function combines a simple timer and an I/O watcher, calls your
3634callback on whichever event happens first and automatically stops both 3758callback on whichever event happens first and automatically stops both
3635watchers. This is useful if you want to wait for a single event on an fd 3759watchers. This is useful if you want to wait for a single event on an fd
3636or timeout without having to allocate/configure/start/stop/free one or 3760or timeout without having to allocate/configure/start/stop/free one or
3637more watchers yourself. 3761more watchers yourself.
3649\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR 3773\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
3650value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR 3774value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3651a timeout and an io event at the same time \- you probably should give io 3775a timeout and an io event at the same time \- you probably should give io
3652events precedence. 3776events precedence.
3653.Sp 3777.Sp
3654Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3778Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3655.Sp 3779.Sp
3656.Vb 7 3780.Vb 7
3657\& static void stdin_ready (int revents, void *arg) 3781\& static void stdin_ready (int revents, void *arg)
3658\& { 3782\& {
3659\& if (revents & EV_READ) 3783\& if (revents & EV_READ)
3675.SH "COMMON OR USEFUL IDIOMS (OR BOTH)" 3799.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3676.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)" 3800.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3677This section explains some common idioms that are not immediately 3801This section explains some common idioms that are not immediately
3678obvious. Note that examples are sprinkled over the whole manual, and this 3802obvious. Note that examples are sprinkled over the whole manual, and this
3679section only contains stuff that wouldn't fit anywhere else. 3803section only contains stuff that wouldn't fit anywhere else.
3680.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 3804.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3681.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 3805.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3682Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read 3806Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3683or modify at any time: libev will completely ignore it. This can be used 3807or modify at any time: libev will completely ignore it. This can be used
3684to associate arbitrary data with your watcher. If you need more data and 3808to associate arbitrary data with your watcher. If you need more data and
3685don't want to allocate memory separately and store a pointer to it in that 3809don't want to allocate memory separately and store a pointer to it in that
3711\& } 3835\& }
3712.Ve 3836.Ve
3713.PP 3837.PP
3714More interesting and less C\-conformant ways of casting your callback 3838More interesting and less C\-conformant ways of casting your callback
3715function type instead have been omitted. 3839function type instead have been omitted.
3716.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0" 3840.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3717.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS" 3841.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3718Another common scenario is to use some data structure with multiple 3842Another common scenario is to use some data structure with multiple
3719embedded watchers, in effect creating your own watcher that combines 3843embedded watchers, in effect creating your own watcher that combines
3720multiple libev event sources into one \*(L"super-watcher\*(R": 3844multiple libev event sources into one \*(L"super-watcher\*(R":
3721.PP 3845.PP
3749\& { 3873\& {
3750\& struct my_biggy big = (struct my_biggy *) 3874\& struct my_biggy big = (struct my_biggy *)
3751\& (((char *)w) \- offsetof (struct my_biggy, t2)); 3875\& (((char *)w) \- offsetof (struct my_biggy, t2));
3752\& } 3876\& }
3753.Ve 3877.Ve
3754.SS "\s-1AVOIDING\s0 \s-1FINISHING\s0 \s-1BEFORE\s0 \s-1RETURNING\s0" 3878.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3755.IX Subsection "AVOIDING FINISHING BEFORE RETURNING" 3879.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3756Often you have structures like this in event-based programs: 3880Often you have structures like this in event-based programs:
3757.PP 3881.PP
3758.Vb 4 3882.Vb 4
3759\& callback () 3883\& callback ()
3781already been invoked. 3905already been invoked.
3782.PP 3906.PP
3783A common way around all these issues is to make sure that 3907A common way around all these issues is to make sure that
3784\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If 3908\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3785\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially 3909\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3786delay invoking the callback by e.g. using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher 3910delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3787for example, or more sneakily, by reusing an existing (stopped) watcher 3911example, or more sneakily, by reusing an existing (stopped) watcher and
3788and pushing it into the pending queue: 3912pushing it into the pending queue:
3789.PP 3913.PP
3790.Vb 2 3914.Vb 2
3791\& ev_set_cb (watcher, callback); 3915\& ev_set_cb (watcher, callback);
3792\& ev_feed_event (EV_A_ watcher, 0); 3916\& ev_feed_event (EV_A_ watcher, 0);
3793.Ve 3917.Ve
3794.PP 3918.PP
3795This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is 3919This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3796invoked, while not delaying callback invocation too much. 3920invoked, while not delaying callback invocation too much.
3797.SS "\s-1MODEL/NESTED\s0 \s-1EVENT\s0 \s-1LOOP\s0 \s-1INVOCATIONS\s0 \s-1AND\s0 \s-1EXIT\s0 \s-1CONDITIONS\s0" 3921.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3798.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS" 3922.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3799Often (especially in \s-1GUI\s0 toolkits) there are places where you have 3923Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3800\&\fImodal\fR interaction, which is most easily implemented by recursively 3924\&\fImodal\fR interaction, which is most easily implemented by recursively
3801invoking \f(CW\*(C`ev_run\*(C'\fR. 3925invoking \f(CW\*(C`ev_run\*(C'\fR.
3802.PP 3926.PP
3803This brings the problem of exiting \- a callback might want to finish the 3927This brings the problem of exiting \- a callback might want to finish the
3804main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but 3928main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
3805a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one 3929a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
3806and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some 3930and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3807other combination: In these cases, \f(CW\*(C`ev_break\*(C'\fR will not work alone. 3931other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3808.PP 3932.PP
3809The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR 3933The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3810invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is 3934invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3811triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR: 3935triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3812.PP 3936.PP
3834\& exit_main_loop = 1; 3958\& exit_main_loop = 1;
3835\& 3959\&
3836\& // exit both 3960\& // exit both
3837\& exit_main_loop = exit_nested_loop = 1; 3961\& exit_main_loop = exit_nested_loop = 1;
3838.Ve 3962.Ve
3839.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0" 3963.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3840.IX Subsection "THREAD LOCKING EXAMPLE" 3964.IX Subsection "THREAD LOCKING EXAMPLE"
3841Here is a fictitious example of how to run an event loop in a different 3965Here is a fictitious example of how to run an event loop in a different
3842thread from where callbacks are being invoked and watchers are 3966thread from where callbacks are being invoked and watchers are
3843created/added/removed. 3967created/added/removed.
3844.PP 3968.PP
3985.PP 4109.PP
3986Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise 4110Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
3987an event loop currently blocking in the kernel will have no knowledge 4111an event loop currently blocking in the kernel will have no knowledge
3988about the newly added timer. By waking up the loop it will pick up any new 4112about the newly added timer. By waking up the loop it will pick up any new
3989watchers in the next event loop iteration. 4113watchers in the next event loop iteration.
3990.SS "\s-1THREADS\s0, \s-1COROUTINES\s0, \s-1CONTINUATIONS\s0, \s-1QUEUES\s0... \s-1INSTEAD\s0 \s-1OF\s0 \s-1CALLBACKS\s0" 4114.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
3991.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS" 4115.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
3992While the overhead of a callback that e.g. schedules a thread is small, it 4116While the overhead of a callback that e.g. schedules a thread is small, it
3993is still an overhead. If you embed libev, and your main usage is with some 4117is still an overhead. If you embed libev, and your main usage is with some
3994kind of threads or coroutines, you might want to customise libev so that 4118kind of threads or coroutines, you might want to customise libev so that
3995doesn't need callbacks anymore. 4119doesn't need callbacks anymore.
4031You can do similar tricks if you have, say, threads with an event queue \- 4155You can do similar tricks if you have, say, threads with an event queue \-
4032instead of storing a coroutine, you store the queue object and instead of 4156instead of storing a coroutine, you store the queue object and instead of
4033switching to a coroutine, you push the watcher onto the queue and notify 4157switching to a coroutine, you push the watcher onto the queue and notify
4034any waiters. 4158any waiters.
4035.PP 4159.PP
4036To embed libev, see \*(L"\s-1EMBEDDING\s0\*(R", but in short, it's easiest to create two 4160To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
4037files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files: 4161files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
4038.PP 4162.PP
4039.Vb 4 4163.Vb 4
4040\& // my_ev.h 4164\& // my_ev.h
4041\& #define EV_CB_DECLARE(type) struct my_coro *cb; 4165\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4042\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb); 4166\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4043\& #include "../libev/ev.h" 4167\& #include "../libev/ev.h"
4044\& 4168\&
4045\& // my_ev.c 4169\& // my_ev.c
4046\& #define EV_H "my_ev.h" 4170\& #define EV_H "my_ev.h"
4047\& #include "../libev/ev.c" 4171\& #include "../libev/ev.c"
4087The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the 4211The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4088libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0 4212libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4089will work fine. 4213will work fine.
4090.PP 4214.PP
4091Proper exception specifications might have to be added to callbacks passed 4215Proper exception specifications might have to be added to callbacks passed
4092to libev: exceptions may be thrown only from watcher callbacks, all 4216to libev: exceptions may be thrown only from watcher callbacks, all other
4093other callbacks (allocator, syserr, loop acquire/release and periodioc 4217callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4094reschedule callbacks) must not throw exceptions, and might need a \f(CW\*(C`throw 4218callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4095()\*(C'\fR specification. If you have code that needs to be compiled as both C 4219specification. If you have code that needs to be compiled as both C and
4096and \*(C+ you can use the \f(CW\*(C`EV_THROW\*(C'\fR macro for this: 4220\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4097.PP 4221.PP
4098.Vb 6 4222.Vb 6
4099\& static void 4223\& static void
4100\& fatal_error (const char *msg) EV_THROW 4224\& fatal_error (const char *msg) EV_NOEXCEPT
4101\& { 4225\& {
4102\& perror (msg); 4226\& perror (msg);
4103\& abort (); 4227\& abort ();
4104\& } 4228\& }
4105\& 4229\&
4233\& void operator() (ev::io &w, int revents) 4357\& void operator() (ev::io &w, int revents)
4234\& { 4358\& {
4235\& ... 4359\& ...
4236\& } 4360\& }
4237\& } 4361\& }
4238\& 4362\&
4239\& myfunctor f; 4363\& myfunctor f;
4240\& 4364\&
4241\& ev::io w; 4365\& ev::io w;
4242\& w.set (&f); 4366\& w.set (&f);
4243.Ve 4367.Ve
4261.IX Item "w->set (loop)" 4385.IX Item "w->set (loop)"
4262Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4386Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
4263do this when the watcher is inactive (and not pending either). 4387do this when the watcher is inactive (and not pending either).
4264.IP "w\->set ([arguments])" 4 4388.IP "w\->set ([arguments])" 4
4265.IX Item "w->set ([arguments])" 4389.IX Item "w->set ([arguments])"
4266Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this 4390Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4267method or a suitable start method must be called at least once. Unlike the 4391with the same arguments. Either this method or a suitable start method
4268C counterpart, an active watcher gets automatically stopped and restarted 4392must be called at least once. Unlike the C counterpart, an active watcher
4269when reconfiguring it with this method. 4393gets automatically stopped and restarted when reconfiguring it with this
4394method.
4395.Sp
4396For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4397clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
4270.IP "w\->start ()" 4 4398.IP "w\->start ()" 4
4271.IX Item "w->start ()" 4399.IX Item "w->start ()"
4272Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4400Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
4273constructor already stores the event loop. 4401constructor already stores the event loop.
4274.IP "w\->start ([arguments])" 4 4402.IP "w\->start ([arguments])" 4
4332there are additional modules that implement libev-compatible interfaces 4460there are additional modules that implement libev-compatible interfaces
4333to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), 4461to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
4334\&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR 4462\&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR
4335and \f(CW\*(C`EV::Glib\*(C'\fR). 4463and \f(CW\*(C`EV::Glib\*(C'\fR).
4336.Sp 4464.Sp
4337It can be found and installed via \s-1CPAN\s0, its homepage is at 4465It can be found and installed via \s-1CPAN,\s0 its homepage is at
4338<http://software.schmorp.de/pkg/EV>. 4466<http://software.schmorp.de/pkg/EV>.
4339.IP "Python" 4 4467.IP "Python" 4
4340.IX Item "Python" 4468.IX Item "Python"
4341Python bindings can be found at <http://code.google.com/p/pyev/>. It 4469Python bindings can be found at <http://code.google.com/p/pyev/>. It
4342seems to be quite complete and well-documented. 4470seems to be quite complete and well-documented.
4350Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR 4478Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
4351makes rev work even on mingw. 4479makes rev work even on mingw.
4352.IP "Haskell" 4 4480.IP "Haskell" 4
4353.IX Item "Haskell" 4481.IX Item "Haskell"
4354A haskell binding to libev is available at 4482A haskell binding to libev is available at
4355http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev <http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4483<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4356.IP "D" 4 4484.IP "D" 4
4357.IX Item "D" 4485.IX Item "D"
4358Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4486Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4359be found at <http://www.llucax.com.ar/proj/ev.d/index.html>. 4487be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4360.IP "Ocaml" 4 4488.IP "Ocaml" 4
4361.IX Item "Ocaml" 4489.IX Item "Ocaml"
4362Erkki Seppala has written Ocaml bindings for libev, to be found at 4490Erkki Seppala has written Ocaml bindings for libev, to be found at
4363http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/ <http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4491<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4364.IP "Lua" 4 4492.IP "Lua" 4
4365.IX Item "Lua" 4493.IX Item "Lua"
4366Brian Maher has written a partial interface to libev for lua (at the 4494Brian Maher has written a partial interface to libev for lua (at the
4367time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at 4495time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4368http://github.com/brimworks/lua\-ev <http://github.com/brimworks/lua-ev>. 4496<http://github.com/brimworks/lua\-ev>.
4369.IP "Javascript" 4 4497.IP "Javascript" 4
4370.IX Item "Javascript" 4498.IX Item "Javascript"
4371Node.js (<http://nodejs.org>) uses libev as the underlying event library. 4499Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4372.IP "Others" 4 4500.IP "Others" 4
4373.IX Item "Others" 4501.IX Item "Others"
4462.SS "\s-1FILESETS\s0" 4590.SS "\s-1FILESETS\s0"
4463.IX Subsection "FILESETS" 4591.IX Subsection "FILESETS"
4464Depending on what features you need you need to include one or more sets of files 4592Depending on what features you need you need to include one or more sets of files
4465in your application. 4593in your application.
4466.PP 4594.PP
4467\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4595\fI\s-1CORE EVENT LOOP\s0\fR
4468.IX Subsection "CORE EVENT LOOP" 4596.IX Subsection "CORE EVENT LOOP"
4469.PP 4597.PP
4470To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4598To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
4471configuration (no autoconf): 4599configuration (no autoconf):
4472.PP 4600.PP
4499\& ev_vars.h 4627\& ev_vars.h
4500\& ev_wrap.h 4628\& ev_wrap.h
4501\& 4629\&
4502\& ev_win32.c required on win32 platforms only 4630\& ev_win32.c required on win32 platforms only
4503\& 4631\&
4504\& ev_select.c only when select backend is enabled (which is enabled by default) 4632\& ev_select.c only when select backend is enabled
4505\& ev_poll.c only when poll backend is enabled (disabled by default) 4633\& ev_poll.c only when poll backend is enabled
4506\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4634\& ev_epoll.c only when the epoll 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
4507\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4637\& ev_kqueue.c only when the kqueue backend is enabled
4508\& ev_port.c only when the solaris port backend is enabled (disabled by default) 4638\& ev_port.c only when the solaris port backend is enabled
4509.Ve 4639.Ve
4510.PP 4640.PP
4511\&\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
4512to compile this single file. 4642to compile this single file.
4513.PP 4643.PP
4514\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4644\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
4515.IX Subsection "LIBEVENT COMPATIBILITY API" 4645.IX Subsection "LIBEVENT COMPATIBILITY API"
4516.PP 4646.PP
4517To include the libevent compatibility \s-1API\s0, also include: 4647To include the libevent compatibility \s-1API,\s0 also include:
4518.PP 4648.PP
4519.Vb 1 4649.Vb 1
4520\& #include "event.c" 4650\& #include "event.c"
4521.Ve 4651.Ve
4522.PP 4652.PP
4524.PP 4654.PP
4525.Vb 1 4655.Vb 1
4526\& #include "event.h" 4656\& #include "event.h"
4527.Ve 4657.Ve
4528.PP 4658.PP
4529in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4659in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
4530.PP 4660.PP
4531You need the following additional files for this: 4661You need the following additional files for this:
4532.PP 4662.PP
4533.Vb 2 4663.Vb 2
4534\& event.h 4664\& event.h
4535\& event.c 4665\& event.c
4536.Ve 4666.Ve
4537.PP 4667.PP
4538\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4668\fI\s-1AUTOCONF SUPPORT\s0\fR
4539.IX Subsection "AUTOCONF SUPPORT" 4669.IX Subsection "AUTOCONF SUPPORT"
4540.PP 4670.PP
4541Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4671Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
4542whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4672whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
4543\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4673\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
4546For this of course you need the m4 file: 4676For this of course you need the m4 file:
4547.PP 4677.PP
4548.Vb 1 4678.Vb 1
4549\& libev.m4 4679\& libev.m4
4550.Ve 4680.Ve
4551.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4681.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
4552.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4682.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
4553Libev can be configured via a variety of preprocessor symbols you have to 4683Libev can be configured via a variety of preprocessor symbols you have to
4554define before including (or compiling) any of its files. The default in 4684define before including (or compiling) any of its files. The default in
4555the absence of autoconf is documented for every option. 4685the absence of autoconf is documented for every option.
4556.PP 4686.PP
4557Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different 4687Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4558values when compiling libev vs. including \fIev.h\fR, so it is permissible 4688values when compiling libev vs. including \fIev.h\fR, so it is permissible
4559to redefine them before including \fIev.h\fR without breaking compatibility 4689to redefine them before including \fIev.h\fR without breaking compatibility
4560to a compiled library. All other symbols change the \s-1ABI\s0, which means all 4690to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4561users of libev and the libev code itself must be compiled with compatible 4691users of libev and the libev code itself must be compiled with compatible
4562settings. 4692settings.
4563.IP "\s-1EV_COMPAT3\s0 (h)" 4 4693.IP "\s-1EV_COMPAT3\s0 (h)" 4
4564.IX Item "EV_COMPAT3 (h)" 4694.IX Item "EV_COMPAT3 (h)"
4565Backwards compatibility is a major concern for libev. This is why this 4695Backwards compatibility is a major concern for libev. This is why this
4624higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). 4754higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR).
4625.IP "\s-1EV_USE_NANOSLEEP\s0" 4 4755.IP "\s-1EV_USE_NANOSLEEP\s0" 4
4626.IX Item "EV_USE_NANOSLEEP" 4756.IX Item "EV_USE_NANOSLEEP"
4627If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available 4757If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
4628and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. 4758and 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"
4761If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4762available 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.
4764If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
47652.7 or newer, otherwise disabled.
4766.IP "\s-1EV_USE_SIGNALFD\s0" 4
4767.IX Item "EV_USE_SIGNALFD"
4768If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`signalfd ()\*(C'\fR is
4769available and will probe for kernel support at runtime. This enables
4770the use of \s-1EVFLAG_SIGNALFD\s0 for faster and simpler signal handling. If
4771undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
47722.7 or newer, otherwise disabled.
4773.IP "\s-1EV_USE_TIMERFD\s0" 4
4774.IX Item "EV_USE_TIMERFD"
4775If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`timerfd ()\*(C'\fR is
4776available and will probe for kernel support at runtime. This allows
4777libev to detect time jumps accurately. If undefined, it will be enabled
4778if 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.
4629.IP "\s-1EV_USE_EVENTFD\s0" 4 4780.IP "\s-1EV_USE_EVENTFD\s0" 4
4630.IX Item "EV_USE_EVENTFD" 4781.IX Item "EV_USE_EVENTFD"
4631If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is 4782If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4632available and will probe for kernel support at runtime. This will improve 4783available and will probe for kernel support at runtime. This will improve
4633\&\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.
4679.IP "\s-1EV_USE_WSASOCKET\s0" 4 4830.IP "\s-1EV_USE_WSASOCKET\s0" 4
4680.IX Item "EV_USE_WSASOCKET" 4831.IX Item "EV_USE_WSASOCKET"
4681If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal 4832If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4682communication socket, which works better in some environments. Otherwise, 4833communication socket, which works better in some environments. Otherwise,
4683the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other 4834the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4684enviornments. 4835environments.
4685.IP "\s-1EV_USE_POLL\s0" 4 4836.IP "\s-1EV_USE_POLL\s0" 4
4686.IX Item "EV_USE_POLL" 4837.IX Item "EV_USE_POLL"
4687If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4838If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
4688backend. Otherwise it will be enabled on non\-win32 platforms. It 4839backend. Otherwise it will be enabled on non\-win32 platforms. It
4689takes precedence over select. 4840takes precedence over select.
4692If defined to be \f(CW1\fR, libev will compile in support for the Linux 4843If defined to be \f(CW1\fR, libev will compile in support for the Linux
4693\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 4844\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
4694otherwise another method will be used as fallback. This is the preferred 4845otherwise another method will be used as fallback. This is the preferred
4695backend for GNU/Linux systems. If undefined, it will be enabled if the 4846backend for GNU/Linux systems. If undefined, it will be enabled if the
4696headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4847headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4848.IP "\s-1EV_USE_LINUXAIO\s0" 4
4849.IX Item "EV_USE_LINUXAIO"
4850If defined to be \f(CW1\fR, libev will compile in support for the Linux aio
4851backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). If undefined, it will be
4852enabled on linux, otherwise disabled.
4853.IP "\s-1EV_USE_IOURING\s0" 4
4854.IX Item "EV_USE_IOURING"
4855If defined to be \f(CW1\fR, libev will compile in support for the Linux
4856io_uring backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). Due to it's
4857current limitations it has to be requested explicitly. If undefined, it
4858will be enabled on linux, otherwise disabled.
4697.IP "\s-1EV_USE_KQUEUE\s0" 4 4859.IP "\s-1EV_USE_KQUEUE\s0" 4
4698.IX Item "EV_USE_KQUEUE" 4860.IX Item "EV_USE_KQUEUE"
4699If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4861If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
4700\&\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,
4701otherwise another method will be used as fallback. This is the preferred 4863otherwise another method will be used as fallback. This is the preferred
4726between threads, that is, threads can be used, but threads never run on 4888between threads, that is, threads can be used, but threads never run on
4727different cpus (or different cpu cores). This reduces dependencies 4889different cpus (or different cpu cores). This reduces dependencies
4728and makes libev faster. 4890and makes libev faster.
4729.IP "\s-1EV_NO_THREADS\s0" 4 4891.IP "\s-1EV_NO_THREADS\s0" 4
4730.IX Item "EV_NO_THREADS" 4892.IX Item "EV_NO_THREADS"
4731If defined to be \f(CW1\fR, libev will assume that it will never be called 4893If defined to be \f(CW1\fR, libev will assume that it will never be called from
4732from different threads, which is a stronger assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, 4894different threads (that includes signal handlers), which is a stronger
4733above. This reduces dependencies and makes libev faster. 4895assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4896libev faster.
4734.IP "\s-1EV_ATOMIC_T\s0" 4 4897.IP "\s-1EV_ATOMIC_T\s0" 4
4735.IX Item "EV_ATOMIC_T" 4898.IX Item "EV_ATOMIC_T"
4736Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4899Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4737access is atomic and serialised with respect to other threads or signal 4900access is atomic with respect to other threads or signal contexts. No
4738contexts. No such type is easily found in the C language, so you can 4901such type is easily found in the C language, so you can provide your own
4739provide your own type that you know is safe for your purposes. It is used 4902type that you know is safe for your purposes. It is used both for signal
4740both for signal handler \*(L"locking\*(R" as well as for signal and thread safety 4903handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4741in \f(CW\*(C`ev_async\*(C'\fR watchers. 4904watchers.
4742.Sp 4905.Sp
4743In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4906In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4744(from \fIsignal.h\fR), which is usually good enough on most platforms, 4907(from \fIsignal.h\fR), which is usually good enough on most platforms.
4745although strictly speaking using a type that also implies a memory fence
4746is required.
4747.IP "\s-1EV_H\s0 (h)" 4 4908.IP "\s-1EV_H\s0 (h)" 4
4748.IX Item "EV_H (h)" 4909.IX Item "EV_H (h)"
4749The name of the \fIev.h\fR header file used to include it. The default if 4910The name of the \fIev.h\fR header file used to include it. The default if
4750undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 4911undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
4751used to virtually rename the \fIev.h\fR header file in case of conflicts. 4912used to virtually rename the \fIev.h\fR header file in case of conflicts.
4790all the priorities, so having many of them (hundreds) uses a lot of space 4951all the priorities, so having many of them (hundreds) uses a lot of space
4791and time, so using the defaults of five priorities (\-2 .. +2) is usually 4952and time, so using the defaults of five priorities (\-2 .. +2) is usually
4792fine. 4953fine.
4793.Sp 4954.Sp
4794If your embedding application does not need any priorities, defining these 4955If your embedding application does not need any priorities, defining these
4795both to \f(CW0\fR will save some memory and \s-1CPU\s0. 4956both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4796.IP "\s-1EV_PERIODIC_ENABLE\s0, \s-1EV_IDLE_ENABLE\s0, \s-1EV_EMBED_ENABLE\s0, \s-1EV_STAT_ENABLE\s0, \s-1EV_PREPARE_ENABLE\s0, \s-1EV_CHECK_ENABLE\s0, \s-1EV_FORK_ENABLE\s0, \s-1EV_SIGNAL_ENABLE\s0, \s-1EV_ASYNC_ENABLE\s0, \s-1EV_CHILD_ENABLE\s0." 4 4957.IP "\s-1EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE.\s0" 4
4797.IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE." 4958.IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE."
4798If undefined or defined to be \f(CW1\fR (and the platform supports it), then 4959If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4799the respective watcher type is supported. If defined to be \f(CW0\fR, then it 4960the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4800is not. Disabling watcher types mainly saves code size. 4961is not. Disabling watcher types mainly saves code size.
4801.IP "\s-1EV_FEATURES\s0" 4 4962.IP "\s-1EV_FEATURES\s0" 4
4959called. If set to \f(CW2\fR, then the internal verification code will be 5120called. If set to \f(CW2\fR, then the internal verification code will be
4960called once per loop, which can slow down libev. If set to \f(CW3\fR, then the 5121called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
4961verification code will be called very frequently, which will slow down 5122verification code will be called very frequently, which will slow down
4962libev considerably. 5123libev considerably.
4963.Sp 5124.Sp
5125Verification errors are reported via C's \f(CW\*(C`assert\*(C'\fR mechanism, so if you
5126disable that (e.g. by defining \f(CW\*(C`NDEBUG\*(C'\fR) then no errors will be reported.
5127.Sp
4964The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it 5128The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4965will be \f(CW0\fR. 5129will be \f(CW0\fR.
4966.IP "\s-1EV_COMMON\s0" 4 5130.IP "\s-1EV_COMMON\s0" 4
4967.IX Item "EV_COMMON" 5131.IX Item "EV_COMMON"
4968By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 5132By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
4989and the way callbacks are invoked and set. Must expand to a struct member 5153and the way callbacks are invoked and set. Must expand to a struct member
4990definition and a statement, respectively. See the \fIev.h\fR header file for 5154definition and a statement, respectively. See the \fIev.h\fR header file for
4991their default definitions. One possible use for overriding these is to 5155their default definitions. One possible use for overriding these is to
4992avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5156avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
4993method calls instead of plain function calls in \*(C+. 5157method calls instead of plain function calls in \*(C+.
4994.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5158.SS "\s-1EXPORTED API SYMBOLS\s0"
4995.IX Subsection "EXPORTED API SYMBOLS" 5159.IX Subsection "EXPORTED API SYMBOLS"
4996If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 5160If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
4997exported symbols, you can use the provided \fISymbol.*\fR files which list 5161exported symbols, you can use the provided \fISymbol.*\fR files which list
4998all public symbols, one per line: 5162all public symbols, one per line:
4999.PP 5163.PP
5053\& #include "ev_cpp.h" 5217\& #include "ev_cpp.h"
5054\& #include "ev.c" 5218\& #include "ev.c"
5055.Ve 5219.Ve
5056.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5220.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
5057.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5221.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
5058.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5222.SS "\s-1THREADS AND COROUTINES\s0"
5059.IX Subsection "THREADS AND COROUTINES" 5223.IX Subsection "THREADS AND COROUTINES"
5060\fI\s-1THREADS\s0\fR 5224\fI\s-1THREADS\s0\fR
5061.IX Subsection "THREADS" 5225.IX Subsection "THREADS"
5062.PP 5226.PP
5063All libev functions are reentrant and thread-safe unless explicitly 5227All libev functions are reentrant and thread-safe unless explicitly
5109An example use would be to communicate signals or other events that only 5273An example use would be to communicate signals or other events that only
5110work in the default loop by registering the signal watcher with the 5274work in the default loop by registering the signal watcher with the
5111default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 5275default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
5112watcher callback into the event loop interested in the signal. 5276watcher callback into the event loop interested in the signal.
5113.PP 5277.PP
5114See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R". 5278See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
5115.PP 5279.PP
5116\fI\s-1COROUTINES\s0\fR 5280\fI\s-1COROUTINES\s0\fR
5117.IX Subsection "COROUTINES" 5281.IX Subsection "COROUTINES"
5118.PP 5282.PP
5119Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5283Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
5124that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 5288that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
5125.PP 5289.PP
5126Care has been taken to ensure that libev does not keep local state inside 5290Care has been taken to ensure that libev does not keep local state inside
5127\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as 5291\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
5128they do not call any callbacks. 5292they do not call any callbacks.
5129.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5293.SS "\s-1COMPILER WARNINGS\s0"
5130.IX Subsection "COMPILER WARNINGS" 5294.IX Subsection "COMPILER WARNINGS"
5131Depending on your compiler and compiler settings, you might get no or a 5295Depending on your compiler and compiler settings, you might get no or a
5132lot of warnings when compiling libev code. Some people are apparently 5296lot of warnings when compiling libev code. Some people are apparently
5133scared by this. 5297scared by this.
5134.PP 5298.PP
5186.PP 5350.PP
5187If you need, for some reason, empty reports from valgrind for your project 5351If you need, for some reason, empty reports from valgrind for your project
5188I suggest using suppression lists. 5352I suggest using suppression lists.
5189.SH "PORTABILITY NOTES" 5353.SH "PORTABILITY NOTES"
5190.IX Header "PORTABILITY NOTES" 5354.IX Header "PORTABILITY NOTES"
5191.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" 5355.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
5192.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" 5356.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
5193GNU/Linux is the only common platform that supports 64 bit file/large file 5357GNU/Linux is the only common platform that supports 64 bit file/large file
5194interfaces but \fIdisables\fR them by default. 5358interfaces but \fIdisables\fR them by default.
5195.PP 5359.PP
5196That means that libev compiled in the default environment doesn't support 5360That means that libev compiled in the default environment doesn't support
5197files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. 5361files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
5198.PP 5362.PP
5199Unfortunately, many programs try to work around this GNU/Linux issue 5363Unfortunately, many programs try to work around this GNU/Linux issue
5200by enabling the large file \s-1API\s0, which makes them incompatible with the 5364by enabling the large file \s-1API,\s0 which makes them incompatible with the
5201standard libev compiled for their system. 5365standard libev compiled for their system.
5202.PP 5366.PP
5203Likewise, libev cannot enable the large file \s-1API\s0 itself as this would 5367Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
5204suddenly make it incompatible to the default compile time environment, 5368suddenly make it incompatible to the default compile time environment,
5205i.e. all programs not using special compile switches. 5369i.e. all programs not using special compile switches.
5206.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" 5370.SS "\s-1OS/X AND DARWIN BUGS\s0"
5207.IX Subsection "OS/X AND DARWIN BUGS" 5371.IX Subsection "OS/X AND DARWIN BUGS"
5208The whole thing is a bug if you ask me \- basically any system interface 5372The whole thing is a bug if you ask me \- basically any system interface
5209you touch is broken, whether it is locales, poll, kqueue or even the 5373you touch is broken, whether it is locales, poll, kqueue or even the
5210OpenGL drivers. 5374OpenGL drivers.
5211.PP 5375.PP
5233.PP 5397.PP
5234\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5398\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
5235.IX Subsection "select is buggy" 5399.IX Subsection "select is buggy"
5236.PP 5400.PP
5237All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5401All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
5238one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file 5402one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file
5239descriptors you can pass in to 1024 \- your program suddenly crashes when 5403descriptors you can pass in to 1024 \- your program suddenly crashes when
5240you use more. 5404you use more.
5241.PP 5405.PP
5242There is an undocumented \*(L"workaround\*(R" for this \- defining 5406There is an undocumented \*(L"workaround\*(R" for this \- defining
5243\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR 5407\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
5244work on \s-1OS/X\s0. 5408work on \s-1OS/X.\s0
5245.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5409.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
5246.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" 5410.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
5247\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR 5411\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
5248.IX Subsection "errno reentrancy" 5412.IX Subsection "errno reentrancy"
5249.PP 5413.PP
5250The default compile environment on Solaris is unfortunately so 5414The default compile environment on Solaris is unfortunately so
5267great. 5431great.
5268.PP 5432.PP
5269If you can't get it to work, you can try running the program by setting 5433If you can't get it to work, you can try running the program by setting
5270the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and 5434the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
5271\&\f(CW\*(C`select\*(C'\fR backends. 5435\&\f(CW\*(C`select\*(C'\fR backends.
5272.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" 5436.SS "\s-1AIX POLL BUG\s0"
5273.IX Subsection "AIX POLL BUG" 5437.IX Subsection "AIX POLL BUG"
5274\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around 5438\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
5275this by trying to avoid the poll backend altogether (i.e. it's not even 5439this by trying to avoid the poll backend altogether (i.e. it's not even
5276compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine 5440compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
5277with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway. 5441with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
5278.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5442.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
5279.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5443.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
5280\fIGeneral issues\fR 5444\fIGeneral issues\fR
5281.IX Subsection "General issues" 5445.IX Subsection "General issues"
5282.PP 5446.PP
5283Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5447Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
5352\& #define EV_USE_SELECT 1 5516\& #define EV_USE_SELECT 1
5353\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5517\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5354.Ve 5518.Ve
5355.PP 5519.PP
5356Note that winsockets handling of fd sets is O(n), so you can easily get a 5520Note that winsockets handling of fd sets is O(n), so you can easily get a
5357complexity in the O(nA\*^X) range when using win32. 5521complexity in the O(nX) range when using win32.
5358.PP 5522.PP
5359\fILimited number of file descriptors\fR 5523\fILimited number of file descriptors\fR
5360.IX Subsection "Limited number of file descriptors" 5524.IX Subsection "Limited number of file descriptors"
5361.PP 5525.PP
5362Windows has numerous arbitrary (and low) limits on things. 5526Windows has numerous arbitrary (and low) limits on things.
5378by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR 5542by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
5379(another arbitrary limit), but is broken in many versions of the Microsoft 5543(another arbitrary limit), but is broken in many versions of the Microsoft
5380runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets 5544runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
5381(depending on windows version and/or the phase of the moon). To get more, 5545(depending on windows version and/or the phase of the moon). To get more,
5382you need to wrap all I/O functions and provide your own fd management, but 5546you need to wrap all I/O functions and provide your own fd management, but
5383the cost of calling select (O(nA\*^X)) will likely make this unworkable. 5547the cost of calling select (O(nX)) will likely make this unworkable.
5384.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5548.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5385.IX Subsection "PORTABILITY REQUIREMENTS" 5549.IX Subsection "PORTABILITY REQUIREMENTS"
5386In addition to a working ISO-C implementation and of course the 5550In addition to a working ISO-C implementation and of course the
5387backend-specific APIs, libev relies on a few additional extensions: 5551backend-specific APIs, libev relies on a few additional extensions:
5388.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 5552.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
5389.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5553.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
5390.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5554.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
5391Libev assumes not only that all watcher pointers have the same internal 5555Libev assumes not only that all watcher pointers have the same internal
5392structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5556structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5393assumes that the same (machine) code can be used to call any watcher 5557assumes that the same (machine) code can be used to call any watcher
5394callback: The watcher callbacks have different type signatures, but libev 5558callback: The watcher callbacks have different type signatures, but libev
5395calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5559calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5560.IP "null pointers and integer zero are represented by 0 bytes" 4
5561.IX Item "null pointers and integer zero are represented by 0 bytes"
5562Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5563relies on this setting pointers and integers to null.
5396.IP "pointer accesses must be thread-atomic" 4 5564.IP "pointer accesses must be thread-atomic" 4
5397.IX Item "pointer accesses must be thread-atomic" 5565.IX Item "pointer accesses must be thread-atomic"
5398Accessing a pointer value must be atomic, it must both be readable and 5566Accessing a pointer value must be atomic, it must both be readable and
5399writable in one piece \- this is the case on all current architectures. 5567writable in one piece \- this is the case on all current architectures.
5400.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5568.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
5413thread\*(R" or will block signals process-wide, both behaviours would 5581thread\*(R" or will block signals process-wide, both behaviours would
5414be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5582be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5415\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5583\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5416.Sp 5584.Sp
5417The most portable way to handle signals is to block signals in all threads 5585The most portable way to handle signals is to block signals in all threads
5418except the initial one, and run the default loop in the initial thread as 5586except the initial one, and run the signal handling loop in the initial
5419well. 5587thread as well.
5420.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5588.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
5421.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 5589.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
5422.IX Item "long must be large enough for common memory allocation sizes" 5590.IX Item "long must be large enough for common memory allocation sizes"
5423To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally 5591To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
5424instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX 5592instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
5425systems (Microsoft...) this might be unexpectedly low, but is still at 5593systems (Microsoft...) this might be unexpectedly low, but is still at
5426least 31 bits everywhere, which is enough for hundreds of millions of 5594least 31 bits everywhere, which is enough for hundreds of millions of
5427watchers. 5595watchers.
5428.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5596.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
5430.IX Item "double must hold a time value in seconds with enough accuracy" 5598.IX Item "double must hold a time value in seconds with enough accuracy"
5431The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5599The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
5432have at least 51 bits of mantissa (and 9 bits of exponent), which is 5600have at least 51 bits of mantissa (and 9 bits of exponent), which is
5433good enough for at least into the year 4000 with millisecond accuracy 5601good enough for at least into the year 4000 with millisecond accuracy
5434(the design goal for libev). This requirement is overfulfilled by 5602(the design goal for libev). This requirement is overfulfilled by
5435implementations using \s-1IEEE\s0 754, which is basically all existing ones. 5603implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5436.Sp 5604.Sp
5437With \s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least the 5605With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5438year 2255 (and millisecond accuracy till the year 287396 \- by then, libev 5606year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5439is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or 5607is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5440something like that, just kidding). 5608something like that, just kidding).
5441.PP 5609.PP
5442If you know of other additional requirements drop me a note. 5610If you know of other additional requirements drop me a note.
5504calls in the current loop iteration and the loop is currently 5672calls in the current loop iteration and the loop is currently
5505blocked. Checking for async and signal events involves iterating over all 5673blocked. Checking for async and signal events involves iterating over all
5506running async watchers or all signal numbers. 5674running async watchers or all signal numbers.
5507.SH "PORTING FROM LIBEV 3.X TO 4.X" 5675.SH "PORTING FROM LIBEV 3.X TO 4.X"
5508.IX Header "PORTING FROM LIBEV 3.X TO 4.X" 5676.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5509The major version 4 introduced some incompatible changes to the \s-1API\s0. 5677The major version 4 introduced some incompatible changes to the \s-1API.\s0
5510.PP 5678.PP
5511At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions 5679At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5512for all changes, so most programs should still compile. The compatibility 5680for all changes, so most programs should still compile. The compatibility
5513layer might be removed in later versions of libev, so better update to the 5681layer might be removed in later versions of libev, so better update to the
5514new \s-1API\s0 early than late. 5682new \s-1API\s0 early than late.
5515.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 5683.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5516.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 5684.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5517.IX Item "EV_COMPAT3 backwards compatibility mechanism" 5685.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5518The backward compatibility mechanism can be controlled by 5686The backward compatibility mechanism can be controlled by
5519\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0\*(R" in the \*(L"\s-1EMBEDDING\s0\*(R" 5687\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5520section. 5688section.
5521.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 5689.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5522.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 5690.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5523.IX Item "ev_default_destroy and ev_default_fork have been removed" 5691.IX Item "ev_default_destroy and ev_default_fork have been removed"
5524These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: 5692These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5564.SH "GLOSSARY" 5732.SH "GLOSSARY"
5565.IX Header "GLOSSARY" 5733.IX Header "GLOSSARY"
5566.IP "active" 4 5734.IP "active" 4
5567.IX Item "active" 5735.IX Item "active"
5568A watcher is active as long as it has been started and not yet stopped. 5736A watcher is active as long as it has been started and not yet stopped.
5569See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5737See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5570.IP "application" 4 5738.IP "application" 4
5571.IX Item "application" 5739.IX Item "application"
5572In this document, an application is whatever is using libev. 5740In this document, an application is whatever is using libev.
5573.IP "backend" 4 5741.IP "backend" 4
5574.IX Item "backend" 5742.IX Item "backend"
5601The model used to describe how an event loop handles and processes 5769The model used to describe how an event loop handles and processes
5602watchers and events. 5770watchers and events.
5603.IP "pending" 4 5771.IP "pending" 4
5604.IX Item "pending" 5772.IX Item "pending"
5605A watcher is pending as soon as the corresponding event has been 5773A watcher is pending as soon as the corresponding event has been
5606detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5774detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5607.IP "real time" 4 5775.IP "real time" 4
5608.IX Item "real time" 5776.IX Item "real time"
5609The physical time that is observed. It is apparently strictly monotonic :) 5777The physical time that is observed. It is apparently strictly monotonic :)
5610.IP "wall-clock time" 4 5778.IP "wall-clock time" 4
5611.IX Item "wall-clock time" 5779.IX Item "wall-clock time"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines