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

Comparing libev/ev.3 (file contents):
Revision 1.86 by root, Wed Feb 16 08:07:25 2011 UTC vs.
Revision 1.119 by root, Wed Jan 22 02:00:13 2020 UTC

1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) 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 "2011-01-31" "libev-4.04" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2020-01-22" "libev-4.31" "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
245\&\f(CW\*(C`ev_check\*(C'\fR watchers) as well as file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even 254\&\f(CW\*(C`ev_check\*(C'\fR watchers) as well as file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even
246limited support for fork events (\f(CW\*(C`ev_fork\*(C'\fR). 255limited support for fork events (\f(CW\*(C`ev_fork\*(C'\fR).
247.PP 256.PP
248It also is quite fast (see this 257It also is quite fast (see this
249<benchmark> comparing it to libevent 258benchmark <http://libev.schmorp.de/bench.html> comparing it to libevent
250for example). 259for example).
251.SS "\s-1CONVENTIONS\s0" 260.SS "\s-1CONVENTIONS\s0"
252.IX Subsection "CONVENTIONS" 261.IX Subsection "CONVENTIONS"
253Libev is very configurable. In this manual the default (and most common) 262Libev is very configurable. In this manual the default (and most common)
254configuration will be described, which supports multiple event loops. For 263configuration will be described, which supports multiple event loops. For
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
295.IX Item "ev_tstamp ev_time ()" 308.IX Item "ev_tstamp ev_time ()"
296Returns the current time as libev would use it. Please note that the 309Returns the current time as libev would use it. Please note that the
297\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp 310\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp
298you actually want to know. Also interesting is the combination of 311you actually want to know. Also interesting is the combination of
299\&\f(CW\*(C`ev_update_now\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR. 312\&\f(CW\*(C`ev_now_update\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR.
300.IP "ev_sleep (ev_tstamp interval)" 4 313.IP "ev_sleep (ev_tstamp interval)" 4
301.IX Item "ev_sleep (ev_tstamp interval)" 314.IX Item "ev_sleep (ev_tstamp interval)"
302Sleep for the given interval: The current thread will be blocked until 315Sleep for the given interval: The current thread will be blocked
303either it is interrupted or the given time interval has passed. Basically 316until either it is interrupted or the given time interval has
317passed (approximately \- it might return a bit earlier even if not
318interrupted). Returns immediately if \f(CW\*(C`interval <= 0\*(C'\fR.
319.Sp
304this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR. 320Basically this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR.
321.Sp
322The range of the \f(CW\*(C`interval\*(C'\fR is limited \- libev only guarantees to work
323with sleep times of up to one day (\f(CW\*(C`interval <= 86400\*(C'\fR).
305.IP "int ev_version_major ()" 4 324.IP "int ev_version_major ()" 4
306.IX Item "int ev_version_major ()" 325.IX Item "int ev_version_major ()"
307.PD 0 326.PD 0
308.IP "int ev_version_minor ()" 4 327.IP "int ev_version_minor ()" 4
309.IX Item "int ev_version_minor ()" 328.IX Item "int ev_version_minor ()"
361current system. To find which embeddable backends might be supported on 380current system. To find which embeddable backends might be supported on
362the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends () 381the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
363& ev_supported_backends ()\*(C'\fR, likewise for recommended ones. 382& ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
364.Sp 383.Sp
365See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 384See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
366.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 385.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4
367.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 386.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())"
368Sets the allocation function to use (the prototype is similar \- the 387Sets the allocation function to use (the prototype is similar \- the
369semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is 388semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
370used to allocate and free memory (no surprises here). If it returns zero 389used to allocate and free memory (no surprises here). If it returns zero
371when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort 390when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
372or take some potentially destructive action. 391or take some potentially destructive action.
377.Sp 396.Sp
378You could override this function in high-availability programs to, say, 397You could override this function in high-availability programs to, say,
379free 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,
380or 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.
381.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
382Example: 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
383retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). 418retries.
384.Sp 419.Sp
385.Vb 6 420.Vb 8
386\& static void * 421\& static void *
387\& persistent_realloc (void *ptr, size_t size) 422\& persistent_realloc (void *ptr, size_t size)
388\& { 423\& {
424\& if (!size)
425\& {
426\& free (ptr);
427\& return 0;
428\& }
429\&
389\& for (;;) 430\& for (;;)
390\& { 431\& {
391\& void *newptr = realloc (ptr, size); 432\& void *newptr = realloc (ptr, size);
392\& 433\&
393\& if (newptr) 434\& if (newptr)
398\& } 439\& }
399\& 440\&
400\& ... 441\& ...
401\& ev_set_allocator (persistent_realloc); 442\& ev_set_allocator (persistent_realloc);
402.Ve 443.Ve
403.IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4 444.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
404.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))" 445.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())"
405Set the callback function to call on a retryable system call error (such 446Set the callback function to call on a retryable system call error (such
406as failed select, poll, epoll_wait). The message is a printable string 447as failed select, poll, epoll_wait). The message is a printable string
407indicating the system call or subsystem causing the problem. If this 448indicating the system call or subsystem causing the problem. If this
408callback is set, then libev will expect it to remedy the situation, no 449callback is set, then libev will expect it to remedy the situation, no
409matter what, when it returns. That is, libev will generally retry the 450matter what, when it returns. That is, libev will generally retry the
508.IX Item "EVFLAG_NOENV" 549.IX Item "EVFLAG_NOENV"
509If 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
510or setgid) then libev will \fInot\fR look at the environment variable 551or setgid) then libev will \fInot\fR look at the environment variable
511\&\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
512override 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
513useful to try out specific backends to test their performance, or to work 554useful to try out specific backends to test their performance, to work
514around 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).
515.ie n .IP """EVFLAG_FORKCHECK""" 4 558.ie n .IP """EVFLAG_FORKCHECK""" 4
516.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 559.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
517.IX Item "EVFLAG_FORKCHECK" 560.IX Item "EVFLAG_FORKCHECK"
518Instead 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
519make 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.
520.Sp 563.Sp
521This 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,
522and 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
523iterations and little real work, but is usually not noticeable (on my 566iterations and little real work, but is usually not noticeable (on my
524GNU/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
525without 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
526\&\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).
527.Sp 571.Sp
528The 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
529forget about forgetting to tell libev about forking) when you use this 573forget about forgetting to tell libev about forking, although you still
530flag. 574have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
531.Sp 575.Sp
532This 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
533environment variable. 577environment variable.
534.ie n .IP """EVFLAG_NOINOTIFY""" 4 578.ie n .IP """EVFLAG_NOINOTIFY""" 4
535.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 579.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
553example) that can't properly initialise their signal masks. 597example) that can't properly initialise their signal masks.
554.ie n .IP """EVFLAG_NOSIGMASK""" 4 598.ie n .IP """EVFLAG_NOSIGMASK""" 4
555.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4 599.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
556.IX Item "EVFLAG_NOSIGMASK" 600.IX Item "EVFLAG_NOSIGMASK"
557When this flag is specified, then libev will avoid to modify the signal 601When this flag is specified, then libev will avoid to modify the signal
558mask. Specifically, this means you ahve to make sure signals are unblocked 602mask. Specifically, this means you have to make sure signals are unblocked
559when you want to receive them. 603when you want to receive them.
560.Sp 604.Sp
561This behaviour is useful when you want to do your own signal handling, or 605This behaviour is useful when you want to do your own signal handling, or
562want to handle signals only in specific threads and want to avoid libev 606want to handle signals only in specific threads and want to avoid libev
563unblocking the signals. 607unblocking the signals.
564.Sp 608.Sp
565It's also required by \s-1POSIX\s0 in a threaded program, as libev calls 609It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
566\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified. 610\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
611.ie n .IP """EVFLAG_NOTIMERFD""" 4
612.el .IP "\f(CWEVFLAG_NOTIMERFD\fR" 4
613.IX Item "EVFLAG_NOTIMERFD"
614When this flag is specified, the libev will avoid using a \f(CW\*(C`timerfd\*(C'\fR to
615detect time jumps. It will still be able to detect time jumps, but takes
616longer and has a lower accuracy in doing so, but saves a file descriptor
617per loop.
567.Sp 618.Sp
568This flag's behaviour will become the default in future versions of libev. 619The current implementation only tries to use a \f(CW\*(C`timerfd\*(C'\fR when the first
620\&\f(CW\*(C`ev_periodic\*(C'\fR watcher is started and falls back on other methods if it
621cannot be created, but this behaviour might change in the future.
569.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 622.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
570.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 623.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
571.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 624.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
572This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 625This is your standard \fBselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
573libev tries to roll its own fd_set with no limits on the number of fds, 626libev tries to roll its own fd_set with no limits on the number of fds,
574but if that fails, expect a fairly low limit on the number of fds when 627but if that fails, expect a fairly low limit on the number of fds when
575using this backend. It doesn't scale too well (O(highest_fd)), but its 628using this backend. It doesn't scale too well (O(highest_fd)), but its
576usually the fastest backend for a low number of (low-numbered :) fds. 629usually the fastest backend for a low number of (low-numbered :) fds.
577.Sp 630.Sp
585This 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 638This 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
586\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the 639\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
587\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). 640\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
588.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 641.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
589.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 642.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
590.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 643.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
591And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 644And this is your standard \fBpoll\fR\|(2) backend. It's more complicated
592than select, but handles sparse fds better and has no artificial 645than select, but handles sparse fds better and has no artificial
593limit on the number of fds you can use (except it will slow down 646limit on the number of fds you can use (except it will slow down
594considerably with a lot of inactive fds). It scales similarly to select, 647considerably with a lot of inactive fds). It scales similarly to select,
595i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for 648i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
596performance tips. 649performance tips.
597.Sp 650.Sp
598This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 651This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
599\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 652\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
600.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 653.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
601.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 654.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
602.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 655.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
603Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 656Use the Linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
604kernels). 657kernels).
605.Sp 658.Sp
606For few fds, this backend is a bit little slower than poll and select, 659For few fds, this backend is a bit little slower than poll and select, but
607but it scales phenomenally better. While poll and select usually scale 660it scales phenomenally better. While poll and select usually scale like
608like O(total_fds) where n is the total number of fds (or the highest fd), 661O(total_fds) where total_fds is the total number of fds (or the highest
609epoll scales either O(1) or O(active_fds). 662fd), epoll scales either O(1) or O(active_fds).
610.Sp 663.Sp
611The epoll mechanism deserves honorable mention as the most misdesigned 664The epoll mechanism deserves honorable mention as the most misdesigned
612of the more advanced event mechanisms: mere annoyances include silently 665of the more advanced event mechanisms: mere annoyances include silently
613dropping file descriptors, requiring a system call per change per file 666dropping file descriptors, requiring a system call per change per file
614descriptor (and unnecessary guessing of parameters), problems with dup, 667descriptor (and unnecessary guessing of parameters), problems with dup,
6170.1ms) and so on. The biggest issue is fork races, however \- if a program 6700.1ms) and so on. The biggest issue is fork races, however \- if a program
618forks then \fIboth\fR parent and child process have to recreate the epoll 671forks then \fIboth\fR parent and child process have to recreate the epoll
619set, which can take considerable time (one syscall per file descriptor) 672set, which can take considerable time (one syscall per file descriptor)
620and is of course hard to detect. 673and is of course hard to detect.
621.Sp 674.Sp
622Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but 675Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work,
623of course \fIdoesn't\fR, and epoll just loves to report events for totally 676but of course \fIdoesn't\fR, and epoll just loves to report events for
624\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot 677totally \fIdifferent\fR file descriptors (even already closed ones, so
625even remove them from the set) than registered in the set (especially 678one cannot even remove them from the set) than registered in the set
626on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by 679(especially on \s-1SMP\s0 systems). Libev tries to counter these spurious
627employing an additional generation counter and comparing that against the 680notifications by employing an additional generation counter and comparing
628events to filter out spurious ones, recreating the set when required. Last 681that against the events to filter out spurious ones, recreating the set
682when required. Epoll also erroneously rounds down timeouts, but gives you
683no way to know when and by how much, so sometimes you have to busy-wait
684because epoll returns immediately despite a nonzero timeout. And last
629not least, it also refuses to work with some file descriptors which work 685not least, it also refuses to work with some file descriptors which work
630perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...). 686perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...).
631.Sp 687.Sp
632Epoll is truly the train wreck analog among event poll mechanisms, 688Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
633a frankenpoll, cobbled together in a hurry, no thought to design or 689cobbled together in a hurry, no thought to design or interaction with
634interaction with others. 690others. Oh, the pain, will it ever stop...
635.Sp 691.Sp
636While stopping, setting and starting an I/O watcher in the same iteration 692While stopping, setting and starting an I/O watcher in the same iteration
637will result in some caching, there is still a system call per such 693will result in some caching, there is still a system call per such
638incident (because the same \fIfile descriptor\fR could point to a different 694incident (because the same \fIfile descriptor\fR could point to a different
639\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed 695\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
651All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or 707All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
652faster than epoll for maybe up to a hundred file descriptors, depending on 708faster than epoll for maybe up to a hundred file descriptors, depending on
653the usage. So sad. 709the usage. So sad.
654.Sp 710.Sp
655While nominally embeddable in other event loops, this feature is broken in 711While nominally embeddable in other event loops, this feature is broken in
656all kernel versions tested so far. 712a lot of kernel revisions, but probably(!) works in current versions.
713.Sp
714This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
715\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
716.ie n .IP """EVBACKEND_LINUXAIO"" (value 64, Linux)" 4
717.el .IP "\f(CWEVBACKEND_LINUXAIO\fR (value 64, Linux)" 4
718.IX Item "EVBACKEND_LINUXAIO (value 64, Linux)"
719Use 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
720only tries to use it in 4.19+).
721.Sp
722This is another Linux train wreck of an event interface.
723.Sp
724If this backend works for you (as of this writing, it was very
725experimental), it is the best event interface available on Linux and might
726be well worth enabling it \- if it isn't available in your kernel this will
727be detected and this backend will be skipped.
728.Sp
729This backend can batch oneshot requests and supports a user-space ring
730buffer to receive events. It also doesn't suffer from most of the design
731problems of epoll (such as not being able to remove event sources from
732the epoll set), and generally sounds too good to be true. Because, this
733being the Linux kernel, of course it suffers from a whole new set of
734limitations, forcing you to fall back to epoll, inheriting all its design
735issues.
736.Sp
737For one, it is not easily embeddable (but probably could be done using
738an event fd at some extra overhead). It also is subject to a system wide
739limit that can be configured in \fI/proc/sys/fs/aio\-max\-nr\fR. If no \s-1AIO\s0
740requests are left, this backend will be skipped during initialisation, and
741will switch to epoll when the loop is active.
742.Sp
743Most problematic in practice, however, is that not all file descriptors
744work with it. For example, in Linux 5.1, \s-1TCP\s0 sockets, pipes, event fds,
745files, \fI/dev/null\fR and many others are supported, but ttys do not work
746properly (a known bug that the kernel developers don't care about, see
747<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
748(yet?) a generic event polling interface.
749.Sp
750Overall, it seems the Linux developers just don't want it to have a
751generic event handling mechanism other than \f(CW\*(C`select\*(C'\fR or \f(CW\*(C`poll\*(C'\fR.
752.Sp
753To work around all these problem, the current version of libev uses its
754epoll backend as a fallback for file descriptor types that do not work. Or
755falls back completely to epoll if the kernel acts up.
657.Sp 756.Sp
658This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 757This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
659\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 758\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
660.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 759.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
661.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 760.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
662.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 761.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
663Kqueue deserves special mention, as at the time of this writing, it 762Kqueue deserves special mention, as at the time this backend was
664was broken on all BSDs except NetBSD (usually it doesn't work reliably 763implemented, it was broken on all BSDs except NetBSD (usually it doesn't
665with anything but sockets and pipes, except on Darwin, where of course 764work reliably with anything but sockets and pipes, except on Darwin,
666it's completely useless). Unlike epoll, however, whose brokenness 765where of course it's completely useless). Unlike epoll, however, whose
667is by design, these kqueue bugs can (and eventually will) be fixed 766brokenness is by design, these kqueue bugs can be (and mostly have been)
668without \s-1API\s0 changes to existing programs. For this reason it's not being 767fixed without \s-1API\s0 changes to existing programs. For this reason it's not
669\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using 768being \*(L"auto-detected\*(R" on all platforms unless you explicitly specify it
670\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) 769in the flags (i.e. using \f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a
671system like NetBSD. 770known-to-be-good (\-enough) system like NetBSD.
672.Sp 771.Sp
673You still can embed kqueue into a normal poll or select backend and use it 772You still can embed kqueue into a normal poll or select backend and use it
674only for sockets (after having made sure that sockets work with kqueue on 773only for sockets (after having made sure that sockets work with kqueue on
675the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 774the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
676.Sp 775.Sp
677It scales in the same way as the epoll backend, but the interface to the 776It scales in the same way as the epoll backend, but the interface to the
678kernel is more efficient (which says nothing about its actual speed, of 777kernel is more efficient (which says nothing about its actual speed, of
679course). While stopping, setting and starting an I/O watcher does never 778course). While stopping, setting and starting an I/O watcher does never
680cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 779cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
681two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but 780two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
682sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 781might have to leak fds on fork, but it's more sane than epoll) and it
683cases 782drops fds silently in similarly hard-to-detect cases.
684.Sp 783.Sp
685This backend usually performs well under most conditions. 784This backend usually performs well under most conditions.
686.Sp 785.Sp
687While nominally embeddable in other event loops, this doesn't work 786While nominally embeddable in other event loops, this doesn't work
688everywhere, so you might need to test for this. And since it is broken 787everywhere, so you might need to test for this. And since it is broken
689almost everywhere, you should only use it when you have a lot of sockets 788almost everywhere, you should only use it when you have a lot of sockets
690(for which it usually works), by embedding it into another event loop 789(for which it usually works), by embedding it into another event loop
691(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 790(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
692also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. 791also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
693.Sp 792.Sp
694This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 793This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
695\&\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 794\&\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
696\&\f(CW\*(C`NOTE_EOF\*(C'\fR. 795\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
697.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 796.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
701implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets 800implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
702and is not embeddable, which would limit the usefulness of this backend 801and is not embeddable, which would limit the usefulness of this backend
703immensely. 802immensely.
704.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 803.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
705.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 804.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
706.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 805.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
707This uses the Solaris 10 event port mechanism. As with everything on Solaris, 806This uses the Solaris 10 event port mechanism. As with everything on Solaris,
708it's really slow, but it still scales very well (O(active_fds)). 807it's really slow, but it still scales very well (O(active_fds)).
709.Sp 808.Sp
710While this backend scales well, it requires one system call per active 809While this backend scales well, it requires one system call per active
711file descriptor per loop iteration. For small and medium numbers of file 810file descriptor per loop iteration. For small and medium numbers of file
717among the OS-specific backends (I vastly prefer correctness over speed 816among the OS-specific backends (I vastly prefer correctness over speed
718hacks). 817hacks).
719.Sp 818.Sp
720On the negative side, the interface is \fIbizarre\fR \- so bizarre that 819On the negative side, the interface is \fIbizarre\fR \- so bizarre that
721even sun itself gets it wrong in their code examples: The event polling 820even sun itself gets it wrong in their code examples: The event polling
722function sometimes returning events to the caller even though an error 821function sometimes returns events to the caller even though an error
723occurred, but with no indication whether it has done so or not (yes, it's 822occurred, but with no indication whether it has done so or not (yes, it's
724even documented that way) \- deadly for edge-triggered interfaces where 823even documented that way) \- deadly for edge-triggered interfaces where you
725you absolutely have to know whether an event occurred or not because you 824absolutely have to know whether an event occurred or not because you have
726have to re-arm the watcher. 825to re-arm the watcher.
727.Sp 826.Sp
728Fortunately libev seems to be able to work around these idiocies. 827Fortunately libev seems to be able to work around these idiocies.
729.Sp 828.Sp
730This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 829This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
731\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 830\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
765used if available. 864used if available.
766.Sp 865.Sp
767.Vb 1 866.Vb 1
768\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 867\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
769.Ve 868.Ve
869.Sp
870Example: Similarly, on linux, you mgiht want to take advantage of the
871linux aio backend if possible, but fall back to something else if that
872isn't available.
873.Sp
874.Vb 1
875\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
876.Ve
770.RE 877.RE
771.IP "ev_loop_destroy (loop)" 4 878.IP "ev_loop_destroy (loop)" 4
772.IX Item "ev_loop_destroy (loop)" 879.IX Item "ev_loop_destroy (loop)"
773Destroys an event loop object (frees all memory and kernel state 880Destroys an event loop object (frees all memory and kernel state
774etc.). None of the active event watchers will be stopped in the normal 881etc.). None of the active event watchers will be stopped in the normal
790except in the rare occasion where you really need to free its resources. 897except in the rare occasion where you really need to free its resources.
791If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR 898If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
792and \f(CW\*(C`ev_loop_destroy\*(C'\fR. 899and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
793.IP "ev_loop_fork (loop)" 4 900.IP "ev_loop_fork (loop)" 4
794.IX Item "ev_loop_fork (loop)" 901.IX Item "ev_loop_fork (loop)"
795This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to 902This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations
796reinitialise the kernel state for backends that have one. Despite the 903to reinitialise the kernel state for backends that have one. Despite
797name, you can call it anytime, but it makes most sense after forking, in 904the name, you can call it anytime you are allowed to start or stop
798the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the 905watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most
799child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. 906sense after forking, in the child process. You \fImust\fR call it (or use
907\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
800.Sp 908.Sp
909In addition, if you want to reuse a loop (via this function or
910\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR.
911.Sp
801Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after 912Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
802a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is 913a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
803because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things 914because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
804during fork. 915during fork.
805.Sp 916.Sp
806On the other hand, you only need to call this function in the child 917On the other hand, you only need to call this function in the child
900given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR 1011given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
901without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR. 1012without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
902.Sp 1013.Sp
903Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the 1014Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
904event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR). 1015event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
905.IP "ev_run (loop, int flags)" 4 1016.IP "bool ev_run (loop, int flags)" 4
906.IX Item "ev_run (loop, int flags)" 1017.IX Item "bool ev_run (loop, int flags)"
907Finally, this is it, the event handler. This function usually is called 1018Finally, this is it, the event handler. This function usually is called
908after you have initialised all your watchers and you want to start 1019after you have initialised all your watchers and you want to start
909handling events. It will ask the operating system for any new events, call 1020handling events. It will ask the operating system for any new events, call
910the watcher callbacks, an then repeat the whole process indefinitely: This 1021the watcher callbacks, and then repeat the whole process indefinitely: This
911is why event loops are called \fIloops\fR. 1022is why event loops are called \fIloops\fR.
912.Sp 1023.Sp
913If the flags argument is specified as \f(CW0\fR, it will keep handling events 1024If the flags argument is specified as \f(CW0\fR, it will keep handling events
914until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was 1025until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
915called. 1026called.
1027.Sp
1028The return value is false if there are no more active watchers (which
1029usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
1030(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
916.Sp 1031.Sp
917Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than 1032Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
918relying on all watchers to be stopped when deciding when a program has 1033relying on all watchers to be stopped when deciding when a program has
919finished (especially in interactive programs), but having a program 1034finished (especially in interactive programs), but having a program
920that automatically loops as long as it has to and no longer by virtue 1035that automatically loops as long as it has to and no longer by virtue
921of relying on its watchers stopping correctly, that is truly a thing of 1036of relying on its watchers stopping correctly, that is truly a thing of
922beauty. 1037beauty.
923.Sp 1038.Sp
924This function is also \fImostly\fR exception-safe \- you can break out of 1039This function is \fImostly\fR exception-safe \- you can break out of a
925a \f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+ 1040\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
926exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor 1041exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
927will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks. 1042will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
928.Sp 1043.Sp
929A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle 1044A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
930those events and any already outstanding ones, but will not wait and 1045those events and any already outstanding ones, but will not wait and
942This is useful if you are waiting for some external event in conjunction 1057This is useful if you are waiting for some external event in conjunction
943with something not expressible using other libev watchers (i.e. "roll your 1058with something not expressible using other libev watchers (i.e. "roll your
944own \f(CW\*(C`ev_run\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 1059own \f(CW\*(C`ev_run\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
945usually a better approach for this kind of thing. 1060usually a better approach for this kind of thing.
946.Sp 1061.Sp
947Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does: 1062Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does (this is for your
1063understanding, not a guarantee that things will work exactly like this in
1064future versions):
948.Sp 1065.Sp
949.Vb 10 1066.Vb 10
950\& \- Increment loop depth. 1067\& \- Increment loop depth.
951\& \- Reset the ev_break status. 1068\& \- Reset the ev_break status.
952\& \- Before the first iteration, call any pending watchers. 1069\& \- Before the first iteration, call any pending watchers.
1067overhead for the actual polling but can deliver many events at once. 1184overhead for the actual polling but can deliver many events at once.
1068.Sp 1185.Sp
1069By setting a higher \fIio collect interval\fR you allow libev to spend more 1186By setting a higher \fIio collect interval\fR you allow libev to spend more
1070time collecting I/O events, so you can handle more events per iteration, 1187time collecting I/O events, so you can handle more events per iteration,
1071at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and 1188at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
1072\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will 1189\&\f(CW\*(C`ev_timer\*(C'\fR) will not be affected. Setting this to a non-null value will
1073introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The 1190introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
1074sleep time ensures that libev will not poll for I/O events more often then 1191sleep time ensures that libev will not poll for I/O events more often then
1075once per this interval, on average. 1192once per this interval, on average (as long as the host time resolution is
1193good enough).
1076.Sp 1194.Sp
1077Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 1195Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
1078to spend more time collecting timeouts, at the expense of increased 1196to spend more time collecting timeouts, at the expense of increased
1079latency/jitter/inexactness (the watcher callback will be called 1197latency/jitter/inexactness (the watcher callback will be called
1080later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null 1198later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
1124this callback instead. This is useful, for example, when you want to 1242this callback instead. This is useful, for example, when you want to
1125invoke the actual watchers inside another context (another thread etc.). 1243invoke the actual watchers inside another context (another thread etc.).
1126.Sp 1244.Sp
1127If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new 1245If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1128callback. 1246callback.
1129.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4 1247.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
1130.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))" 1248.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
1131Sometimes you want to share the same loop between multiple threads. This 1249Sometimes you want to share the same loop between multiple threads. This
1132can be done relatively simply by putting mutex_lock/unlock calls around 1250can be done relatively simply by putting mutex_lock/unlock calls around
1133each call to a libev function. 1251each call to a libev function.
1134.Sp 1252.Sp
1135However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible 1253However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1136to wait for it to return. One way around this is to wake up the event 1254to wait for it to return. One way around this is to wake up the event
1137loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`av_async_send\*(C'\fR, another way is to set these 1255loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`ev_async_send\*(C'\fR, another way is to set these
1138\&\fIrelease\fR and \fIacquire\fR callbacks on the loop. 1256\&\fIrelease\fR and \fIacquire\fR callbacks on the loop.
1139.Sp 1257.Sp
1140When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is 1258When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1141suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just 1259suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1142afterwards. 1260afterwards.
1283.PD 0 1401.PD 0
1284.ie n .IP """EV_CHECK""" 4 1402.ie n .IP """EV_CHECK""" 4
1285.el .IP "\f(CWEV_CHECK\fR" 4 1403.el .IP "\f(CWEV_CHECK\fR" 4
1286.IX Item "EV_CHECK" 1404.IX Item "EV_CHECK"
1287.PD 1405.PD
1288All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts 1406All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
1289to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1407gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
1290\&\f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it invokes any callbacks for any 1408just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1409for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1410watchers invoked before the event loop sleeps or polls for new events, and
1411\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1412or lower priority within an event loop iteration.
1413.Sp
1291received events. Callbacks of both watcher types can start and stop as 1414Callbacks of both watcher types can start and stop as many watchers as
1292many watchers as they want, and all of them will be taken into account 1415they want, and all of them will be taken into account (for example, a
1293(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1416\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
1294\&\f(CW\*(C`ev_run\*(C'\fR from blocking). 1417blocking).
1295.ie n .IP """EV_EMBED""" 4 1418.ie n .IP """EV_EMBED""" 4
1296.el .IP "\f(CWEV_EMBED\fR" 4 1419.el .IP "\f(CWEV_EMBED\fR" 4
1297.IX Item "EV_EMBED" 1420.IX Item "EV_EMBED"
1298The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1421The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1299.ie n .IP """EV_FORK""" 4 1422.ie n .IP """EV_FORK""" 4
1328bug in your program. 1451bug in your program.
1329.Sp 1452.Sp
1330Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1453Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
1331example it might indicate that a fd is readable or writable, and if your 1454example it might indicate that a fd is readable or writable, and if your
1332callbacks is well-written it can just attempt the operation and cope with 1455callbacks is well-written it can just attempt the operation and cope with
1333the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1456the error from \fBread()\fR or \fBwrite()\fR. This will not work in multi-threaded
1334programs, though, as the fd could already be closed and reused for another 1457programs, though, as the fd could already be closed and reused for another
1335thing, so beware. 1458thing, so beware.
1336.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1459.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1337.IX Subsection "GENERIC WATCHER FUNCTIONS" 1460.IX Subsection "GENERIC WATCHER FUNCTIONS"
1338.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1461.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1339.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1462.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1340.IX Item "ev_init (ev_TYPE *watcher, callback)" 1463.IX Item "ev_init (ev_TYPE *watcher, callback)"
1341This macro initialises the generic portion of a watcher. The contents 1464This macro initialises the generic portion of a watcher. The contents
1420make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR 1543make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1421it). 1544it).
1422.IP "callback ev_cb (ev_TYPE *watcher)" 4 1545.IP "callback ev_cb (ev_TYPE *watcher)" 4
1423.IX Item "callback ev_cb (ev_TYPE *watcher)" 1546.IX Item "callback ev_cb (ev_TYPE *watcher)"
1424Returns the callback currently set on the watcher. 1547Returns the callback currently set on the watcher.
1425.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1548.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
1426.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1549.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
1427Change the callback. You can change the callback at virtually any time 1550Change the callback. You can change the callback at virtually any time
1428(modulo threads). 1551(modulo threads).
1429.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 1552.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1430.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" 1553.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1431.PD 0 1554.PD 0
1449or might not have been clamped to the valid range. 1572or might not have been clamped to the valid range.
1450.Sp 1573.Sp
1451The default priority used by watchers when no priority has been set is 1574The default priority used by watchers when no priority has been set is
1452always \f(CW0\fR, which is supposed to not be too high and not be too low :). 1575always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1453.Sp 1576.Sp
1454See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1577See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1455priorities. 1578priorities.
1456.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1579.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1457.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1580.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1458Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1581Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1459\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1582\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1479not started in the first place. 1602not started in the first place.
1480.Sp 1603.Sp
1481See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related 1604See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1482functions that do not need a watcher. 1605functions that do not need a watcher.
1483.PP 1606.PP
1484See 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 1607See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1485\&\s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0\*(R" idioms. 1608OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1486.SS "\s-1WATCHER\s0 \s-1STATES\s0" 1609.SS "\s-1WATCHER STATES\s0"
1487.IX Subsection "WATCHER STATES" 1610.IX Subsection "WATCHER STATES"
1488There are various watcher states mentioned throughout this manual \- 1611There are various watcher states mentioned throughout this manual \-
1489active, pending and so on. In this section these states and the rules to 1612active, pending and so on. In this section these states and the rules to
1490transition between them will be described in more detail \- and while these 1613transition between them will be described in more detail \- and while these
1491rules might look complicated, they usually do \*(L"the right thing\*(R". 1614rules might look complicated, they usually do \*(L"the right thing\*(R".
1492.IP "initialiased" 4 1615.IP "initialised" 4
1493.IX Item "initialiased" 1616.IX Item "initialised"
1494Before a watcher can be registered with the event looop it has to be 1617Before a watcher can be registered with the event loop it has to be
1495initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to 1618initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1496\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function. 1619\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1497.Sp 1620.Sp
1498In this state it is simply some block of memory that is suitable for 1621In this state it is simply some block of memory that is suitable for
1499use in an event loop. It can be moved around, freed, reused etc. at 1622use in an event loop. It can be moved around, freed, reused etc. at
1534.Sp 1657.Sp
1535While stopped (and not pending) the watcher is essentially in the 1658While stopped (and not pending) the watcher is essentially in the
1536initialised state, that is, it can be reused, moved, modified in any way 1659initialised state, that is, it can be reused, moved, modified in any way
1537you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR 1660you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1538it again). 1661it again).
1539.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1662.SS "\s-1WATCHER PRIORITY MODELS\s0"
1540.IX Subsection "WATCHER PRIORITY MODELS" 1663.IX Subsection "WATCHER PRIORITY MODELS"
1541Many event loops support \fIwatcher priorities\fR, which are usually small 1664Many event loops support \fIwatcher priorities\fR, which are usually small
1542integers that influence the ordering of event callback invocation 1665integers that influence the ordering of event callback invocation
1543between watchers in some way, all else being equal. 1666between watchers in some way, all else being equal.
1544.PP 1667.PP
1545In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its 1668In libev, watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1546description for the more technical details such as the actual priority 1669description for the more technical details such as the actual priority
1547range. 1670range.
1548.PP 1671.PP
1549There are two common ways how these these priorities are being interpreted 1672There are two common ways how these these priorities are being interpreted
1550by event loops: 1673by event loops:
1644.IX Header "WATCHER TYPES" 1767.IX Header "WATCHER TYPES"
1645This section describes each watcher in detail, but will not repeat 1768This section describes each watcher in detail, but will not repeat
1646information given in the last section. Any initialisation/set macros, 1769information given in the last section. Any initialisation/set macros,
1647functions and members specific to the watcher type are explained. 1770functions and members specific to the watcher type are explained.
1648.PP 1771.PP
1649Members are additionally marked with either \fI[read\-only]\fR, meaning that, 1772Most members are additionally marked with either \fI[read\-only]\fR, meaning
1650while the watcher is active, you can look at the member and expect some 1773that, while the watcher is active, you can look at the member and expect
1651sensible content, but you must not modify it (you can modify it while the 1774some sensible content, but you must not modify it (you can modify it while
1652watcher is stopped to your hearts content), or \fI[read\-write]\fR, which 1775the watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1653means you can expect it to have some sensible content while the watcher 1776means you can expect it to have some sensible content while the watcher
1654is active, but you can also modify it. Modifying it may not do something 1777is active, but you can also modify it. Modifying it may not do something
1655sensible or take immediate effect (or do anything at all), but libev will 1778sensible or take immediate effect (or do anything at all), but libev will
1656not crash or malfunction in any way. 1779not crash or malfunction in any way.
1780.PP
1781In any case, the documentation for each member will explain what the
1782effects are, and if there are any additional access restrictions.
1657.ie n .SS """ev_io"" \- is this file descriptor readable or writable?" 1783.ie n .SS """ev_io"" \- is this file descriptor readable or writable?"
1658.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?" 1784.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?"
1659.IX Subsection "ev_io - is this file descriptor readable or writable?" 1785.IX Subsection "ev_io - is this file descriptor readable or writable?"
1660I/O watchers check whether a file descriptor is readable or writable 1786I/O watchers check whether a file descriptor is readable or writable
1661in each iteration of the event loop, or, more precisely, when reading 1787in each iteration of the event loop, or, more precisely, when reading
1689But really, best use non-blocking mode. 1815But really, best use non-blocking mode.
1690.PP 1816.PP
1691\fIThe special problem of disappearing file descriptors\fR 1817\fIThe special problem of disappearing file descriptors\fR
1692.IX Subsection "The special problem of disappearing file descriptors" 1818.IX Subsection "The special problem of disappearing file descriptors"
1693.PP 1819.PP
1694Some backends (e.g. kqueue, epoll) need to be told about closing a file 1820Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1695descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means, 1821a file descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other
1696such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file 1822means, such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some
1697descriptor, but when it goes away, the operating system will silently drop 1823file descriptor, but when it goes away, the operating system will silently
1698this interest. If another file descriptor with the same number then is 1824drop this interest. If another file descriptor with the same number then
1699registered with libev, there is no efficient way to see that this is, in 1825is registered with libev, there is no efficient way to see that this is,
1700fact, a different file descriptor. 1826in fact, a different file descriptor.
1701.PP 1827.PP
1702To avoid having to explicitly tell libev about such cases, libev follows 1828To avoid having to explicitly tell libev about such cases, libev follows
1703the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev 1829the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1704will assume that this is potentially a new file descriptor, otherwise 1830will assume that this is potentially a new file descriptor, otherwise
1705it is assumed that the file descriptor stays the same. That means that 1831it is assumed that the file descriptor stays the same. That means that
1742wish to read \- you would first have to request some data. 1868wish to read \- you would first have to request some data.
1743.PP 1869.PP
1744Since files are typically not-so-well supported by advanced notification 1870Since files are typically not-so-well supported by advanced notification
1745mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect 1871mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1746to files, even though you should not use it. The reason for this is 1872to files, even though you should not use it. The reason for this is
1747convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT\s0, which is 1873convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1748usually a tty, often a pipe, but also sometimes files or special devices 1874usually a tty, often a pipe, but also sometimes files or special devices
1749(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with 1875(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1750\&\fI/dev/urandom\fR), and even though the file might better be served with 1876\&\fI/dev/urandom\fR), and even though the file might better be served with
1751asynchronous I/O instead of with non-blocking I/O, it is still useful when 1877asynchronous I/O instead of with non-blocking I/O, it is still useful when
1752it \*(L"just works\*(R" instead of freezing. 1878it \*(L"just works\*(R" instead of freezing.
1753.PP 1879.PP
1754So avoid file descriptors pointing to files when you know it (e.g. use 1880So avoid file descriptors pointing to files when you know it (e.g. use
1755libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT\s0, or 1881libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1756when you rarely read from a file instead of from a socket, and want to 1882when you rarely read from a file instead of from a socket, and want to
1757reuse the same code path. 1883reuse the same code path.
1758.PP 1884.PP
1759\fIThe special problem of fork\fR 1885\fIThe special problem of fork\fR
1760.IX Subsection "The special problem of fork" 1886.IX Subsection "The special problem of fork"
1761.PP 1887.PP
1762Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1888Some backends (epoll, kqueue, linuxaio, iouring) do not support \f(CW\*(C`fork ()\*(C'\fR
1763useless behaviour. Libev fully supports fork, but needs to be told about 1889at all or exhibit useless behaviour. Libev fully supports fork, but needs
1764it in the child if you want to continue to use it in the child. 1890to be told about it in the child if you want to continue to use it in the
1891child.
1765.PP 1892.PP
1766To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork 1893To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1767()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to 1894()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1768\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1895\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1769.PP 1896.PP
1770\fIThe special problem of \s-1SIGPIPE\s0\fR 1897\fIThe special problem of \s-1SIGPIPE\s0\fR
1771.IX Subsection "The special problem of SIGPIPE" 1898.IX Subsection "The special problem of SIGPIPE"
1772.PP 1899.PP
1773While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1900While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1774when writing to a pipe whose other end has been closed, your program gets 1901when writing to a pipe whose other end has been closed, your program gets
1775sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs 1902sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1776this is sensible behaviour, for daemons, this is usually undesirable. 1903this is sensible behaviour, for daemons, this is usually undesirable.
1777.PP 1904.PP
1778So when you encounter spurious, unexplained daemon exits, make sure you 1905So when you encounter spurious, unexplained daemon exits, make sure you
1779ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon 1906ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1780somewhere, as that would have given you a big clue). 1907somewhere, as that would have given you a big clue).
1781.PP 1908.PP
1782\fIThe special problem of \fIaccept()\fIing when you can't\fR 1909\fIThe special problem of \f(BIaccept()\fIing when you can't\fR
1783.IX Subsection "The special problem of accept()ing when you can't" 1910.IX Subsection "The special problem of accept()ing when you can't"
1784.PP 1911.PP
1785Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, 1912Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
1786found in post\-2004 Linux) have the peculiar behaviour of not removing a 1913found in post\-2004 Linux) have the peculiar behaviour of not removing a
1787connection from the pending queue in all error cases. 1914connection from the pending queue in all error cases.
1828.IX Item "ev_io_set (ev_io *, int fd, int events)" 1955.IX Item "ev_io_set (ev_io *, int fd, int events)"
1829.PD 1956.PD
1830Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1957Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
1831receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or 1958receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
1832\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events. 1959\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events.
1960.IP "ev_io_modify (ev_io *, int events)" 4
1961.IX Item "ev_io_modify (ev_io *, int events)"
1962Similar to \f(CW\*(C`ev_io_set\*(C'\fR, but only changes the event mask. Using this might
1963be faster with some backends, as libev can assume that the \f(CW\*(C`fd\*(C'\fR still
1964refers to the same underlying file description, something it cannot do
1965when using \f(CW\*(C`ev_io_set\*(C'\fR.
1833.IP "int fd [read\-only]" 4 1966.IP "int fd [no\-modify]" 4
1834.IX Item "int fd [read-only]" 1967.IX Item "int fd [no-modify]"
1835The file descriptor being watched. 1968The file descriptor being watched. While it can be read at any time, you
1969must not modify this member even when the watcher is stopped \- always use
1970\&\f(CW\*(C`ev_io_set\*(C'\fR for that.
1836.IP "int events [read\-only]" 4 1971.IP "int events [no\-modify]" 4
1837.IX Item "int events [read-only]" 1972.IX Item "int events [no-modify]"
1838The events being watched. 1973The set of events being watched, among other flags. This field is a
1974bit set \- to test for \f(CW\*(C`EV_READ\*(C'\fR, use \f(CW\*(C`w\->events & EV_READ\*(C'\fR, and
1975similarly for \f(CW\*(C`EV_WRITE\*(C'\fR.
1976.Sp
1977As with \f(CW\*(C`fd\*(C'\fR, you must not modify this member even when the watcher is
1978stopped, always use \f(CW\*(C`ev_io_set\*(C'\fR or \f(CW\*(C`ev_io_modify\*(C'\fR for that.
1839.PP 1979.PP
1840\fIExamples\fR 1980\fIExamples\fR
1841.IX Subsection "Examples" 1981.IX Subsection "Examples"
1842.PP 1982.PP
1843Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1983Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
1871detecting time jumps is hard, and some inaccuracies are unavoidable (the 2011detecting time jumps is hard, and some inaccuracies are unavoidable (the
1872monotonic clock option helps a lot here). 2012monotonic clock option helps a lot here).
1873.PP 2013.PP
1874The callback is guaranteed to be invoked only \fIafter\fR its timeout has 2014The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1875passed (not \fIat\fR, so on systems with very low-resolution clocks this 2015passed (not \fIat\fR, so on systems with very low-resolution clocks this
1876might introduce a small delay). If multiple timers become ready during the 2016might introduce a small delay, see \*(L"the special problem of being too
2017early\*(R", below). If multiple timers become ready during the same loop
1877same loop iteration then the ones with earlier time-out values are invoked 2018iteration then the ones with earlier time-out values are invoked before
1878before ones of the same priority with later time-out values (but this is 2019ones of the same priority with later time-out values (but this is no
1879no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively). 2020longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1880.PP 2021.PP
1881\fIBe smart about timeouts\fR 2022\fIBe smart about timeouts\fR
1882.IX Subsection "Be smart about timeouts" 2023.IX Subsection "Be smart about timeouts"
1883.PP 2024.PP
1884Many real-world problems involve some kind of timeout, usually for error 2025Many real-world problems involve some kind of timeout, usually for error
1966.Sp 2107.Sp
1967In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, 2108In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
1968but remember the time of last activity, and check for a real timeout only 2109but remember the time of last activity, and check for a real timeout only
1969within the callback: 2110within the callback:
1970.Sp 2111.Sp
1971.Vb 1 2112.Vb 3
2113\& ev_tstamp timeout = 60.;
1972\& ev_tstamp last_activity; // time of last activity 2114\& ev_tstamp last_activity; // time of last activity
2115\& ev_timer timer;
1973\& 2116\&
1974\& static void 2117\& static void
1975\& callback (EV_P_ ev_timer *w, int revents) 2118\& callback (EV_P_ ev_timer *w, int revents)
1976\& { 2119\& {
1977\& ev_tstamp now = ev_now (EV_A); 2120\& // calculate when the timeout would happen
1978\& ev_tstamp timeout = last_activity + 60.; 2121\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
1979\& 2122\&
1980\& // if last_activity + 60. is older than now, we did time out 2123\& // if negative, it means we the timeout already occurred
1981\& if (timeout < now) 2124\& if (after < 0.)
1982\& { 2125\& {
1983\& // timeout occurred, take action 2126\& // timeout occurred, take action
1984\& } 2127\& }
1985\& else 2128\& else
1986\& { 2129\& {
1987\& // callback was invoked, but there was some activity, re\-arm 2130\& // callback was invoked, but there was some recent
1988\& // the watcher to fire in last_activity + 60, which is 2131\& // activity. simply restart the timer to time out
1989\& // guaranteed to be in the future, so "again" is positive: 2132\& // after "after" seconds, which is the earliest time
1990\& w\->repeat = timeout \- now; 2133\& // the timeout can occur.
2134\& ev_timer_set (w, after, 0.);
1991\& ev_timer_again (EV_A_ w); 2135\& ev_timer_start (EV_A_ w);
1992\& } 2136\& }
1993\& } 2137\& }
1994.Ve 2138.Ve
1995.Sp 2139.Sp
1996To summarise the callback: first calculate the real timeout (defined 2140To summarise the callback: first calculate in how many seconds the
1997as \*(L"60 seconds after the last activity\*(R"), then check if that time has 2141timeout will occur (by calculating the absolute time when it would occur,
1998been reached, which means something \fIdid\fR, in fact, time out. Otherwise 2142\&\f(CW\*(C`last_activity + timeout\*(C'\fR, and subtracting the current time, \f(CW\*(C`ev_now
1999the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so 2143(EV_A)\*(C'\fR from that).
2000re-schedule the timer to fire at that future time, to see if maybe we have
2001a timeout then.
2002.Sp 2144.Sp
2003Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the 2145If this value is negative, then we are already past the timeout, i.e. we
2004\&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running. 2146timed out, and need to do whatever is needed in this case.
2147.Sp
2148Otherwise, we now the earliest time at which the timeout would trigger,
2149and simply start the timer with this timeout value.
2150.Sp
2151In other words, each time the callback is invoked it will check whether
2152the timeout occurred. If not, it will simply reschedule itself to check
2153again at the earliest time it could time out. Rinse. Repeat.
2005.Sp 2154.Sp
2006This scheme causes more callback invocations (about one every 60 seconds 2155This scheme causes more callback invocations (about one every 60 seconds
2007minus half the average time between activity), but virtually no calls to 2156minus half the average time between activity), but virtually no calls to
2008libev to change the timeout. 2157libev to change the timeout.
2009.Sp 2158.Sp
2010To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR 2159To start the machinery, simply initialise the watcher and set
2011to the current time (meaning we just have some activity :), then call the 2160\&\f(CW\*(C`last_activity\*(C'\fR to the current time (meaning there was some activity just
2012callback, which will \*(L"do the right thing\*(R" and start the timer: 2161now), then call the callback, which will \*(L"do the right thing\*(R" and start
2162the timer:
2013.Sp 2163.Sp
2014.Vb 3 2164.Vb 3
2165\& last_activity = ev_now (EV_A);
2015\& ev_init (timer, callback); 2166\& ev_init (&timer, callback);
2016\& last_activity = ev_now (loop); 2167\& callback (EV_A_ &timer, 0);
2017\& callback (loop, timer, EV_TIMER);
2018.Ve 2168.Ve
2019.Sp 2169.Sp
2020And when there is some activity, simply store the current time in 2170When there is some activity, simply store the current time in
2021\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: 2171\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
2022.Sp 2172.Sp
2023.Vb 1 2173.Vb 2
2174\& if (activity detected)
2024\& last_activity = ev_now (loop); 2175\& last_activity = ev_now (EV_A);
2176.Ve
2177.Sp
2178When your timeout value changes, then the timeout can be changed by simply
2179providing a new value, stopping the timer and calling the callback, which
2180will again do the right thing (for example, time out immediately :).
2181.Sp
2182.Vb 3
2183\& timeout = new_value;
2184\& ev_timer_stop (EV_A_ &timer);
2185\& callback (EV_A_ &timer, 0);
2025.Ve 2186.Ve
2026.Sp 2187.Sp
2027This technique is slightly more complex, but in most cases where the 2188This technique is slightly more complex, but in most cases where the
2028time-out is unlikely to be triggered, much more efficient. 2189time-out is unlikely to be triggered, much more efficient.
2029.Sp
2030Changing the timeout is trivial as well (if it isn't hard-coded in the
2031callback :) \- just change the timeout and invoke the callback, which will
2032fix things for you.
2033.IP "4. Wee, just use a double-linked list for your timeouts." 4 2190.IP "4. Wee, just use a double-linked list for your timeouts." 4
2034.IX Item "4. Wee, just use a double-linked list for your timeouts." 2191.IX Item "4. Wee, just use a double-linked list for your timeouts."
2035If there is not one request, but many thousands (millions...), all 2192If there is not one request, but many thousands (millions...), all
2036employing some kind of timeout with the same timeout value, then one can 2193employing some kind of timeout with the same timeout value, then one can
2037do even better: 2194do even better:
2061Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2218Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
2062rather complicated, but extremely efficient, something that really pays 2219rather complicated, but extremely efficient, something that really pays
2063off after the first million or so of active timers, i.e. it's usually 2220off after the first million or so of active timers, i.e. it's usually
2064overkill :) 2221overkill :)
2065.PP 2222.PP
2223\fIThe special problem of being too early\fR
2224.IX Subsection "The special problem of being too early"
2225.PP
2226If you ask a timer to call your callback after three seconds, then
2227you expect it to be invoked after three seconds \- but of course, this
2228cannot be guaranteed to infinite precision. Less obviously, it cannot be
2229guaranteed to any precision by libev \- imagine somebody suspending the
2230process with a \s-1STOP\s0 signal for a few hours for example.
2231.PP
2232So, libev tries to invoke your callback as soon as possible \fIafter\fR the
2233delay has occurred, but cannot guarantee this.
2234.PP
2235A less obvious failure mode is calling your callback too early: many event
2236loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but
2237this can cause your callback to be invoked much earlier than you would
2238expect.
2239.PP
2240To see why, imagine a system with a clock that only offers full second
2241resolution (think windows if you can't come up with a broken enough \s-1OS\s0
2242yourself). If you schedule a one-second timer at the time 500.9, then the
2243event loop will schedule your timeout to elapse at a system time of 500
2244(500.9 truncated to the resolution) + 1, or 501.
2245.PP
2246If an event library looks at the timeout 0.1s later, it will see \*(L"501 >=
2247501\*(R" and invoke the callback 0.1s after it was started, even though a
2248one-second delay was requested \- this is being \*(L"too early\*(R", despite best
2249intentions.
2250.PP
2251This is the reason why libev will never invoke the callback if the elapsed
2252delay equals the requested delay, but only when the elapsed delay is
2253larger than the requested delay. In the example above, libev would only invoke
2254the callback at system time 502, or 1.1s after the timer was started.
2255.PP
2256So, while libev cannot guarantee that your callback will be invoked
2257exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested
2258delay has actually elapsed, or in other words, it always errs on the \*(L"too
2259late\*(R" side of things.
2260.PP
2066\fIThe special problem of time updates\fR 2261\fIThe special problem of time updates\fR
2067.IX Subsection "The special problem of time updates" 2262.IX Subsection "The special problem of time updates"
2068.PP 2263.PP
2069Establishing the current time is a costly operation (it usually takes at 2264Establishing the current time is a costly operation (it usually takes
2070least two system calls): \s-1EV\s0 therefore updates its idea of the current 2265at least one system call): \s-1EV\s0 therefore updates its idea of the current
2071time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a 2266time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a
2072growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling 2267growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
2073lots of events in one iteration. 2268lots of events in one iteration.
2074.PP 2269.PP
2075The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2270The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
2076time. This is usually the right thing as this timestamp refers to the time 2271time. This is usually the right thing as this timestamp refers to the time
2077of the event triggering whatever timeout you are modifying/starting. If 2272of the event triggering whatever timeout you are modifying/starting. If
2078you suspect event processing to be delayed and you \fIneed\fR to base the 2273you suspect event processing to be delayed and you \fIneed\fR to base the
2079timeout on the current time, use something like this to adjust for this: 2274timeout on the current time, use something like the following to adjust
2275for it:
2080.PP 2276.PP
2081.Vb 1 2277.Vb 1
2082\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 2278\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
2083.Ve 2279.Ve
2084.PP 2280.PP
2085If the event loop is suspended for a long time, you can also force an 2281If the event loop is suspended for a long time, you can also force an
2086update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 2282update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
2087()\*(C'\fR. 2283()\*(C'\fR, although that will push the event time of all outstanding events
2284further into the future.
2285.PP
2286\fIThe special problem of unsynchronised clocks\fR
2287.IX Subsection "The special problem of unsynchronised clocks"
2288.PP
2289Modern systems have a variety of clocks \- libev itself uses the normal
2290\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time
2291jumps).
2292.PP
2293Neither of these clocks is synchronised with each other or any other clock
2294on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time
2295than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example,
2296a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher
2297than a directly following call to \f(CW\*(C`time\*(C'\fR.
2298.PP
2299The moral of this is to only compare libev-related timestamps with
2300\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than
2301a second or so.
2302.PP
2303One more problem arises due to this lack of synchronisation: if libev uses
2304the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR
2305or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is
2306invoked, you will find that sometimes the callback is a bit \*(L"early\*(R".
2307.PP
2308This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so
2309libev makes sure your callback is not invoked before the delay happened,
2310\&\fImeasured according to the real time\fR, not the system clock.
2311.PP
2312If your timeouts are based on a physical timescale (e.g. \*(L"time out this
2313connection after 100 seconds\*(R") then this shouldn't bother you as it is
2314exactly the right behaviour.
2315.PP
2316If you want to compare wall clock/system timestamps to your timers, then
2317you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock
2318time, where your comparisons will always generate correct results.
2088.PP 2319.PP
2089\fIThe special problems of suspended animation\fR 2320\fIThe special problems of suspended animation\fR
2090.IX Subsection "The special problems of suspended animation" 2321.IX Subsection "The special problems of suspended animation"
2091.PP 2322.PP
2092When you leave the server world it is quite customary to hit machines that 2323When you leave the server world it is quite customary to hit machines that
2123.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2354.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
2124.PD 0 2355.PD 0
2125.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2356.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
2126.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 2357.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
2127.PD 2358.PD
2128Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR 2359Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds (fractional and
2129is \f(CW0.\fR, then it will automatically be stopped once the timeout is 2360negative values are supported). If \f(CW\*(C`repeat\*(C'\fR is \f(CW0.\fR, then it will
2130reached. If it is positive, then the timer will automatically be 2361automatically be stopped once the timeout is reached. If it is positive,
2131configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, 2362then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
2132until stopped manually. 2363seconds later, again, and again, until stopped manually.
2133.Sp 2364.Sp
2134The timer itself will do a best-effort at avoiding drift, that is, if 2365The timer itself will do a best-effort at avoiding drift, that is, if
2135you configure a timer to trigger every 10 seconds, then it will normally 2366you configure a timer to trigger every 10 seconds, then it will normally
2136trigger at exactly 10 second intervals. If, however, your program cannot 2367trigger at exactly 10 second intervals. If, however, your program cannot
2137keep up with the timer (because it takes longer than those 10 seconds to 2368keep up with the timer (because it takes longer than those 10 seconds to
2138do stuff) the timer will not fire more than once per event loop iteration. 2369do stuff) the timer will not fire more than once per event loop iteration.
2139.IP "ev_timer_again (loop, ev_timer *)" 4 2370.IP "ev_timer_again (loop, ev_timer *)" 4
2140.IX Item "ev_timer_again (loop, ev_timer *)" 2371.IX Item "ev_timer_again (loop, ev_timer *)"
2141This will act as if the timer timed out and restart it again if it is 2372This will act as if the timer timed out, and restarts it again if it is
2142repeating. The exact semantics are: 2373repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the
2374timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR.
2143.Sp 2375.Sp
2376The exact semantics are as in the following rules, all of which will be
2377applied to the watcher:
2378.RS 4
2144If the timer is pending, its pending status is cleared. 2379.IP "If the timer is pending, the pending status is always cleared." 4
2145.Sp 2380.IX Item "If the timer is pending, the pending status is always cleared."
2381.PD 0
2146If the timer is started but non-repeating, stop it (as if it timed out). 2382.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4
2147.Sp 2383.IX Item "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)."
2148If the timer is repeating, either start it if necessary (with the 2384.ie n .IP "If the timer is repeating, make the ""repeat"" value the new timeout and start the timer, if necessary." 4
2149\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 2385.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4
2386.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary."
2387.RE
2388.RS 4
2389.PD
2150.Sp 2390.Sp
2151This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a 2391This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
2152usage example. 2392usage example.
2393.RE
2153.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4 2394.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
2154.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 2395.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
2155Returns the remaining time until a timer fires. If the timer is active, 2396Returns the remaining time until a timer fires. If the timer is active,
2156then this time is relative to the current event loop time, otherwise it's 2397then this time is relative to the current event loop time, otherwise it's
2157the timeout value currently configured. 2398the timeout value currently configured.
2209Periodic watchers are also timers of a kind, but they are very versatile 2450Periodic watchers are also timers of a kind, but they are very versatile
2210(and unfortunately a bit complex). 2451(and unfortunately a bit complex).
2211.PP 2452.PP
2212Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or 2453Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
2213relative time, the physical time that passes) but on wall clock time 2454relative time, the physical time that passes) but on wall clock time
2214(absolute time, the thing you can read on your calender or clock). The 2455(absolute time, the thing you can read on your calendar or clock). The
2215difference is that wall clock time can run faster or slower than real 2456difference is that wall clock time can run faster or slower than real
2216time, and time jumps are not uncommon (e.g. when you adjust your 2457time, and time jumps are not uncommon (e.g. when you adjust your
2217wrist-watch). 2458wrist-watch).
2218.PP 2459.PP
2219You can tell a periodic watcher to trigger after some specific point 2460You can tell a periodic watcher to trigger after some specific point
2224\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting 2465\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2225it, as it uses a relative timeout). 2466it, as it uses a relative timeout).
2226.PP 2467.PP
2227\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex 2468\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
2228timers, such as triggering an event on each \*(L"midnight, local time\*(R", or 2469timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
2229other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as 2470other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2230those cannot react to time jumps. 2471watchers, as those cannot react to time jumps.
2231.PP 2472.PP
2232As with timers, the callback is guaranteed to be invoked only when the 2473As with timers, the callback is guaranteed to be invoked only when the
2233point in time where it is supposed to trigger has passed. If multiple 2474point in time where it is supposed to trigger has passed. If multiple
2234timers become ready during the same loop iteration then the ones with 2475timers become ready during the same loop iteration then the ones with
2235earlier time-out values are invoked before ones with later time-out values 2476earlier time-out values are invoked before ones with later time-out values
2277.Sp 2518.Sp
2278Another way to think about it (for the mathematically inclined) is that 2519Another way to think about it (for the mathematically inclined) is that
2279\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2520\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
2280time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps. 2521time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
2281.Sp 2522.Sp
2282For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near 2523The \f(CW\*(C`interval\*(C'\fR \fI\s-1MUST\s0\fR be positive, and for numerical stability, the
2283\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 2524interval value should be higher than \f(CW\*(C`1/8192\*(C'\fR (which is around 100
2284this value, and in fact is often specified as zero. 2525microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have
2526at most a similar magnitude as the current time (say, within a factor of
2527ten). Typical values for offset are, in fact, \f(CW0\fR or something between
2528\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range.
2285.Sp 2529.Sp
2286Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 2530Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
2287speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability 2531speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
2288will of course deteriorate. Libev itself tries to be exact to be about one 2532will of course deteriorate. Libev itself tries to be exact to be about one
2289millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). 2533millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
2293In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being 2537In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
2294ignored. Instead, each time the periodic watcher gets scheduled, the 2538ignored. Instead, each time the periodic watcher gets scheduled, the
2295reschedule callback will be called with the watcher as first, and the 2539reschedule callback will be called with the watcher as first, and the
2296current time as second argument. 2540current time as second argument.
2297.Sp 2541.Sp
2298\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2542\&\s-1NOTE:\s0 \fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
2299or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly 2543or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2300allowed by documentation here\fR. 2544allowed by documentation here\fR.
2301.Sp 2545.Sp
2302If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2546If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2303it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2547it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2321.Sp 2565.Sp
2322\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2566\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
2323equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. 2567equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2324.Sp 2568.Sp
2325This can be used to create very complex timers, such as a timer that 2569This can be used to create very complex timers, such as a timer that
2326triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the 2570triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate
2327next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2571the next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for
2328you do this is, again, up to you (but it is not trivial, which is the main 2572this. Here is a (completely untested, no error checking) example on how to
2329reason I omitted it as an example). 2573do this:
2574.Sp
2575.Vb 1
2576\& #include <time.h>
2577\&
2578\& static ev_tstamp
2579\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2580\& {
2581\& time_t tnow = (time_t)now;
2582\& struct tm tm;
2583\& localtime_r (&tnow, &tm);
2584\&
2585\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2586\& ++tm.tm_mday; // midnight next day
2587\&
2588\& return mktime (&tm);
2589\& }
2590.Ve
2591.Sp
2592Note: this code might run into trouble on days that have more then two
2593midnights (beginning and end).
2330.RE 2594.RE
2331.RS 4 2595.RS 4
2332.RE 2596.RE
2333.IP "ev_periodic_again (loop, ev_periodic *)" 4 2597.IP "ev_periodic_again (loop, ev_periodic *)" 4
2334.IX Item "ev_periodic_again (loop, ev_periodic *)" 2598.IX Item "ev_periodic_again (loop, ev_periodic *)"
2419only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your 2683only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
2420default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for 2684default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
2421\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At 2685\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
2422the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop. 2686the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2423.PP 2687.PP
2424When the first watcher gets started will libev actually register something 2688Only after the first watcher for a signal is started will libev actually
2425with the kernel (thus it coexists with your own signal handlers as long as 2689register something with the kernel. It thus coexists with your own signal
2426you don't register any with libev for the same signal). 2690handlers as long as you don't register any with libev for the same signal.
2427.PP 2691.PP
2428If possible and supported, libev will install its handlers with 2692If possible and supported, libev will install its handlers with
2429\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should 2693\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
2430not be unduly interrupted. If you have a problem with system calls getting 2694not be unduly interrupted. If you have a problem with system calls getting
2431interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher 2695interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2492The signal the watcher watches out for. 2756The signal the watcher watches out for.
2493.PP 2757.PP
2494\fIExamples\fR 2758\fIExamples\fR
2495.IX Subsection "Examples" 2759.IX Subsection "Examples"
2496.PP 2760.PP
2497Example: Try to exit cleanly on \s-1SIGINT\s0. 2761Example: Try to exit cleanly on \s-1SIGINT.\s0
2498.PP 2762.PP
2499.Vb 5 2763.Vb 5
2500\& static void 2764\& static void
2501\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2765\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2502\& { 2766\& {
2617.ie n .SS """ev_stat"" \- did the file attributes just change?" 2881.ie n .SS """ev_stat"" \- did the file attributes just change?"
2618.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2882.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2619.IX Subsection "ev_stat - did the file attributes just change?" 2883.IX Subsection "ev_stat - did the file attributes just change?"
2620This watches a file system path for attribute changes. That is, it calls 2884This watches a file system path for attribute changes. That is, it calls
2621\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) 2885\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2622and sees if it changed compared to the last time, invoking the callback if 2886and sees if it changed compared to the last time, invoking the callback
2623it did. 2887if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2888happen after the watcher has been started will be reported.
2624.PP 2889.PP
2625The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2890The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
2626not exist\*(R" is a status change like any other. The condition \*(L"path does not 2891not exist\*(R" is a status change like any other. The condition \*(L"path does not
2627exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the 2892exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
2628\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at 2893\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
2658compilation environment, which means that on systems with large file 2923compilation environment, which means that on systems with large file
2659support disabled by default, you get the 32 bit version of the stat 2924support disabled by default, you get the 32 bit version of the stat
2660structure. When using the library from programs that change the \s-1ABI\s0 to 2925structure. When using the library from programs that change the \s-1ABI\s0 to
2661use 64 bit file offsets the programs will fail. In that case you have to 2926use 64 bit file offsets the programs will fail. In that case you have to
2662compile libev with the same flags to get binary compatibility. This is 2927compile libev with the same flags to get binary compatibility. This is
2663obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2928obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2664most noticeably displayed with ev_stat and large file support. 2929most noticeably displayed with ev_stat and large file support.
2665.PP 2930.PP
2666The solution for this is to lobby your distribution maker to make large 2931The solution for this is to lobby your distribution maker to make large
2667file interfaces available by default (as e.g. FreeBSD does) and not 2932file interfaces available by default (as e.g. FreeBSD does) and not
2668optional. Libev cannot simply switch on large file support because it has 2933optional. Libev cannot simply switch on large file support because it has
2859Apart from keeping your process non-blocking (which is a useful 3124Apart from keeping your process non-blocking (which is a useful
2860effect on its own sometimes), idle watchers are a good place to do 3125effect on its own sometimes), idle watchers are a good place to do
2861\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the 3126\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2862event loop has handled all outstanding events. 3127event loop has handled all outstanding events.
2863.PP 3128.PP
3129\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3130.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3131.PP
3132As long as there is at least one active idle watcher, libev will never
3133sleep unnecessarily. Or in other words, it will loop as fast as possible.
3134For this to work, the idle watcher doesn't need to be invoked at all \- the
3135lowest priority will do.
3136.PP
3137This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3138to do something on each event loop iteration \- for example to balance load
3139between different connections.
3140.PP
3141See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3142example.
3143.PP
2864\fIWatcher-Specific Functions and Data Members\fR 3144\fIWatcher-Specific Functions and Data Members\fR
2865.IX Subsection "Watcher-Specific Functions and Data Members" 3145.IX Subsection "Watcher-Specific Functions and Data Members"
2866.IP "ev_idle_init (ev_idle *, callback)" 4 3146.IP "ev_idle_init (ev_idle *, callback)" 4
2867.IX Item "ev_idle_init (ev_idle *, callback)" 3147.IX Item "ev_idle_init (ev_idle *, callback)"
2868Initialises and configures the idle watcher \- it has no parameters of any 3148Initialises and configures the idle watcher \- it has no parameters of any
2873.IX Subsection "Examples" 3153.IX Subsection "Examples"
2874.PP 3154.PP
2875Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 3155Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
2876callback, free it. Also, use no error checking, as usual. 3156callback, free it. Also, use no error checking, as usual.
2877.PP 3157.PP
2878.Vb 7 3158.Vb 5
2879\& static void 3159\& static void
2880\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3160\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2881\& { 3161\& {
3162\& // stop the watcher
3163\& ev_idle_stop (loop, w);
3164\&
3165\& // now we can free it
2882\& free (w); 3166\& free (w);
3167\&
2883\& // now do something you wanted to do when the program has 3168\& // now do something you wanted to do when the program has
2884\& // no longer anything immediate to do. 3169\& // no longer anything immediate to do.
2885\& } 3170\& }
2886\& 3171\&
2887\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3172\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2889\& ev_idle_start (loop, idle_watcher); 3174\& ev_idle_start (loop, idle_watcher);
2890.Ve 3175.Ve
2891.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" 3176.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
2892.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 3177.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
2893.IX Subsection "ev_prepare and ev_check - customise your event loop!" 3178.IX Subsection "ev_prepare and ev_check - customise your event loop!"
2894Prepare and check watchers are usually (but not always) used in pairs: 3179Prepare and check watchers are often (but not always) used in pairs:
2895prepare watchers get invoked before the process blocks and check watchers 3180prepare watchers get invoked before the process blocks and check watchers
2896afterwards. 3181afterwards.
2897.PP 3182.PP
2898You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter 3183You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the
2899the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 3184current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or
2900watchers. Other loops than the current one are fine, however. The 3185\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine,
2901rationale behind this is that you do not need to check for recursion in 3186however. The rationale behind this is that you do not need to check
2902those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 3187for recursion in those watchers, i.e. the sequence will always be
2903\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 3188\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each
2904called in pairs bracketing the blocking call. 3189kind they will always be called in pairs bracketing the blocking call.
2905.PP 3190.PP
2906Their main purpose is to integrate other event mechanisms into libev and 3191Their main purpose is to integrate other event mechanisms into libev and
2907their use is somewhat advanced. They could be used, for example, to track 3192their use is somewhat advanced. They could be used, for example, to track
2908variable changes, implement your own watchers, integrate net-snmp or a 3193variable changes, implement your own watchers, integrate net-snmp or a
2909coroutine library and lots more. They are also occasionally useful if 3194coroutine library and lots more. They are also occasionally useful if
2927with priority higher than or equal to the event loop and one coroutine 3212with priority higher than or equal to the event loop and one coroutine
2928of lower priority, but only once, using idle watchers to keep the event 3213of lower priority, but only once, using idle watchers to keep the event
2929loop from blocking if lower-priority coroutines are active, thus mapping 3214loop from blocking if lower-priority coroutines are active, thus mapping
2930low-priority coroutines to idle/background tasks). 3215low-priority coroutines to idle/background tasks).
2931.PP 3216.PP
2932It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 3217When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
2933priority, to ensure that they are being run before any other watchers 3218highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
2934after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers). 3219any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3220watchers).
2935.PP 3221.PP
2936Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not 3222Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
2937activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they 3223activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
2938might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As 3224might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
2939\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event 3225\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
2940loops those other event loops might be in an unusable state until their 3226loops those other event loops might be in an unusable state until their
2941\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with 3227\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
2942others). 3228others).
3229.PP
3230\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3231.IX Subsection "Abusing an ev_check watcher for its side-effect"
3232.PP
3233\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3234useful because they are called once per event loop iteration. For
3235example, if you want to handle a large number of connections fairly, you
3236normally only do a bit of work for each active connection, and if there
3237is more work to do, you wait for the next event loop iteration, so other
3238connections have a chance of making progress.
3239.PP
3240Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3241next event loop iteration. However, that isn't as soon as possible \-
3242without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3243.PP
3244This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3245single global idle watcher that is active as long as you have one active
3246\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3247will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3248invoked. Neither watcher alone can do that.
2943.PP 3249.PP
2944\fIWatcher-Specific Functions and Data Members\fR 3250\fIWatcher-Specific Functions and Data Members\fR
2945.IX Subsection "Watcher-Specific Functions and Data Members" 3251.IX Subsection "Watcher-Specific Functions and Data Members"
2946.IP "ev_prepare_init (ev_prepare *, callback)" 4 3252.IP "ev_prepare_init (ev_prepare *, callback)" 4
2947.IX Item "ev_prepare_init (ev_prepare *, callback)" 3253.IX Item "ev_prepare_init (ev_prepare *, callback)"
3058.Ve 3364.Ve
3059.PP 3365.PP
3060Method 4: Do not use a prepare or check watcher because the module you 3366Method 4: Do not use a prepare or check watcher because the module you
3061want to embed is not flexible enough to support it. Instead, you can 3367want to embed is not flexible enough to support it. Instead, you can
3062override their poll function. The drawback with this solution is that the 3368override their poll function. The drawback with this solution is that the
3063main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses 3369main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
3064this approach, effectively embedding \s-1EV\s0 as a client into the horrible 3370this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3065libglib event loop. 3371libglib event loop.
3066.PP 3372.PP
3067.Vb 4 3373.Vb 4
3068\& static gint 3374\& static gint
3152\fIWatcher-Specific Functions and Data Members\fR 3458\fIWatcher-Specific Functions and Data Members\fR
3153.IX Subsection "Watcher-Specific Functions and Data Members" 3459.IX Subsection "Watcher-Specific Functions and Data Members"
3154.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3460.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
3155.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3461.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
3156.PD 0 3462.PD 0
3157.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3463.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
3158.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3464.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
3159.PD 3465.PD
3160Configures the watcher to embed the given loop, which must be 3466Configures the watcher to embed the given loop, which must be
3161embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3467embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
3162invoked automatically, otherwise it is the responsibility of the callback 3468invoked automatically, otherwise it is the responsibility of the callback
3163to invoke it (it will continue to be called until the sweep has been done, 3469to invoke it (it will continue to be called until the sweep has been done,
3182.PP 3488.PP
3183.Vb 3 3489.Vb 3
3184\& struct ev_loop *loop_hi = ev_default_init (0); 3490\& struct ev_loop *loop_hi = ev_default_init (0);
3185\& struct ev_loop *loop_lo = 0; 3491\& struct ev_loop *loop_lo = 0;
3186\& ev_embed embed; 3492\& ev_embed embed;
3187\& 3493\&
3188\& // see if there is a chance of getting one that works 3494\& // see if there is a chance of getting one that works
3189\& // (remember that a flags value of 0 means autodetection) 3495\& // (remember that a flags value of 0 means autodetection)
3190\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3496\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3191\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3497\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3192\& : 0; 3498\& : 0;
3208.PP 3514.PP
3209.Vb 3 3515.Vb 3
3210\& struct ev_loop *loop = ev_default_init (0); 3516\& struct ev_loop *loop = ev_default_init (0);
3211\& struct ev_loop *loop_socket = 0; 3517\& struct ev_loop *loop_socket = 0;
3212\& ev_embed embed; 3518\& ev_embed embed;
3213\& 3519\&
3214\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3520\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3215\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3521\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3216\& { 3522\& {
3217\& ev_embed_init (&embed, 0, loop_socket); 3523\& ev_embed_init (&embed, 0, loop_socket);
3218\& ev_embed_start (loop, &embed); 3524\& ev_embed_start (loop, &embed);
3226.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3532.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
3227.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 3533.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
3228.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 3534.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
3229Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 3535Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
3230whoever is a good citizen cared to tell libev about it by calling 3536whoever is a good citizen cared to tell libev about it by calling
3231\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 3537\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
3232event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 3538and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
3233and only in the child after the fork. If whoever good citizen calling 3539after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
3234\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 3540and calls it in the wrong process, the fork handlers will be invoked, too,
3235handlers will be invoked, too, of course. 3541of course.
3236.PP 3542.PP
3237\fIThe special problem of life after fork \- how is it possible?\fR 3543\fIThe special problem of life after fork \- how is it possible?\fR
3238.IX Subsection "The special problem of life after fork - how is it possible?" 3544.IX Subsection "The special problem of life after fork - how is it possible?"
3239.PP 3545.PP
3240Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set 3546Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set
3241up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This 3547up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3242sequence should be handled by libev without any problems. 3548sequence should be handled by libev without any problems.
3243.PP 3549.PP
3244This changes when the application actually wants to do event handling 3550This changes when the application actually wants to do event handling
3245in the child, or both parent in child, in effect \*(L"continuing\*(R" after the 3551in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3326it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe. 3632it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3327.PP 3633.PP
3328This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3634This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
3329too, are asynchronous in nature, and signals, too, will be compressed 3635too, are asynchronous in nature, and signals, too, will be compressed
3330(i.e. the number of callback invocations may be less than the number of 3636(i.e. the number of callback invocations may be less than the number of
3331\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). In fact, you could use signal watchers as a kind 3637\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
3332of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused 3638of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3333signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread, 3639signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3334even without knowing which loop owns the signal. 3640even without knowing which loop owns the signal.
3335.PP
3336Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not
3337just the default loop.
3338.PP 3641.PP
3339\fIQueueing\fR 3642\fIQueueing\fR
3340.IX Subsection "Queueing" 3643.IX Subsection "Queueing"
3341.PP 3644.PP
3342\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason 3645\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
3437Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, 3740Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads,
3438signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the 3741signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the
3439embedding section below on what exactly this means). 3742embedding section below on what exactly this means).
3440.Sp 3743.Sp
3441Note that, as with other watchers in libev, multiple events might get 3744Note that, as with other watchers in libev, multiple events might get
3442compressed into a single callback invocation (another way to look at this 3745compressed into a single callback invocation (another way to look at
3443is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered, set on \f(CW\*(C`ev_async_send\*(C'\fR, 3746this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on
3444reset when the event loop detects that). 3747\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that).
3445.Sp 3748.Sp
3446This call incurs the overhead of a system call only once per event loop 3749This call incurs the overhead of at most one extra system call per event
3447iteration, so while the overhead might be noticeable, it doesn't apply to 3750loop iteration, if the event loop is blocked, and no syscall at all if
3448repeated calls to \f(CW\*(C`ev_async_send\*(C'\fR for the same event loop. 3751the event loop (or your program) is processing events. That means that
3752repeated calls are basically free (there is no need to avoid calls for
3753performance reasons) and that the overhead becomes smaller (typically
3754zero) under load.
3449.IP "bool = ev_async_pending (ev_async *)" 4 3755.IP "bool = ev_async_pending (ev_async *)" 4
3450.IX Item "bool = ev_async_pending (ev_async *)" 3756.IX Item "bool = ev_async_pending (ev_async *)"
3451Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 3757Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
3452watcher but the event has not yet been processed (or even noted) by the 3758watcher but the event has not yet been processed (or even noted) by the
3453event loop. 3759event loop.
3462is a time window between the event loop checking and resetting the async 3768is a time window between the event loop checking and resetting the async
3463notification, and the callback being invoked. 3769notification, and the callback being invoked.
3464.SH "OTHER FUNCTIONS" 3770.SH "OTHER FUNCTIONS"
3465.IX Header "OTHER FUNCTIONS" 3771.IX Header "OTHER FUNCTIONS"
3466There are some other functions of possible interest. Described. Here. Now. 3772There are some other functions of possible interest. Described. Here. Now.
3467.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3773.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" 4
3468.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3774.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)"
3469This function combines a simple timer and an I/O watcher, calls your 3775This function combines a simple timer and an I/O watcher, calls your
3470callback on whichever event happens first and automatically stops both 3776callback on whichever event happens first and automatically stops both
3471watchers. This is useful if you want to wait for a single event on an fd 3777watchers. This is useful if you want to wait for a single event on an fd
3472or timeout without having to allocate/configure/start/stop/free one or 3778or timeout without having to allocate/configure/start/stop/free one or
3473more watchers yourself. 3779more watchers yourself.
3485\&\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 3791\&\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
3486value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR 3792value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3487a timeout and an io event at the same time \- you probably should give io 3793a timeout and an io event at the same time \- you probably should give io
3488events precedence. 3794events precedence.
3489.Sp 3795.Sp
3490Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3796Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3491.Sp 3797.Sp
3492.Vb 7 3798.Vb 7
3493\& static void stdin_ready (int revents, void *arg) 3799\& static void stdin_ready (int revents, void *arg)
3494\& { 3800\& {
3495\& if (revents & EV_READ) 3801\& if (revents & EV_READ)
3501\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3807\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3502.Ve 3808.Ve
3503.IP "ev_feed_fd_event (loop, int fd, int revents)" 4 3809.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
3504.IX Item "ev_feed_fd_event (loop, int fd, int revents)" 3810.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
3505Feed an event on the given fd, as if a file descriptor backend detected 3811Feed an event on the given fd, as if a file descriptor backend detected
3506the given events it. 3812the given events.
3507.IP "ev_feed_signal_event (loop, int signum)" 4 3813.IP "ev_feed_signal_event (loop, int signum)" 4
3508.IX Item "ev_feed_signal_event (loop, int signum)" 3814.IX Item "ev_feed_signal_event (loop, int signum)"
3509Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR, 3815Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
3510which is async-safe. 3816which is async-safe.
3511.SH "COMMON OR USEFUL IDIOMS (OR BOTH)" 3817.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3512.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)" 3818.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3513This section explains some common idioms that are not immediately 3819This section explains some common idioms that are not immediately
3514obvious. Note that examples are sprinkled over the whole manual, and this 3820obvious. Note that examples are sprinkled over the whole manual, and this
3515section only contains stuff that wouldn't fit anywhere else. 3821section only contains stuff that wouldn't fit anywhere else.
3516.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 3822.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3517.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 3823.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3518Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read 3824Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3519or modify at any time: libev will completely ignore it. This can be used 3825or modify at any time: libev will completely ignore it. This can be used
3520to associate arbitrary data with your watcher. If you need more data and 3826to associate arbitrary data with your watcher. If you need more data and
3521don't want to allocate memory separately and store a pointer to it in that 3827don't want to allocate memory separately and store a pointer to it in that
3547\& } 3853\& }
3548.Ve 3854.Ve
3549.PP 3855.PP
3550More interesting and less C\-conformant ways of casting your callback 3856More interesting and less C\-conformant ways of casting your callback
3551function type instead have been omitted. 3857function type instead have been omitted.
3552.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0" 3858.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3553.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS" 3859.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3554Another common scenario is to use some data structure with multiple 3860Another common scenario is to use some data structure with multiple
3555embedded watchers, in effect creating your own watcher that combines 3861embedded watchers, in effect creating your own watcher that combines
3556multiple libev event sources into one \*(L"super-watcher\*(R": 3862multiple libev event sources into one \*(L"super-watcher\*(R":
3557.PP 3863.PP
3585\& { 3891\& {
3586\& struct my_biggy big = (struct my_biggy *) 3892\& struct my_biggy big = (struct my_biggy *)
3587\& (((char *)w) \- offsetof (struct my_biggy, t2)); 3893\& (((char *)w) \- offsetof (struct my_biggy, t2));
3588\& } 3894\& }
3589.Ve 3895.Ve
3590.SS "\s-1MODEL/NESTED\s0 \s-1EVENT\s0 \s-1LOOP\s0 \s-1INVOCATIONS\s0 \s-1AND\s0 \s-1EXIT\s0 \s-1CONDITIONS\s0" 3896.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3897.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3898Often you have structures like this in event-based programs:
3899.PP
3900.Vb 4
3901\& callback ()
3902\& {
3903\& free (request);
3904\& }
3905\&
3906\& request = start_new_request (..., callback);
3907.Ve
3908.PP
3909The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be
3910used to cancel the operation, or do other things with it.
3911.PP
3912It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that
3913immediately invoke the callback, for example, to report errors. Or you add
3914some caching layer that finds that it can skip the lengthy aspects of the
3915operation and simply invoke the callback with the result.
3916.PP
3917The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR
3918has returned, so \f(CW\*(C`request\*(C'\fR is not set.
3919.PP
3920Even if you pass the request by some safer means to the callback, you
3921might want to do something to the request after starting it, such as
3922canceling it, which probably isn't working so well when the callback has
3923already been invoked.
3924.PP
3925A common way around all these issues is to make sure that
3926\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3927\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3928delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3929example, or more sneakily, by reusing an existing (stopped) watcher and
3930pushing it into the pending queue:
3931.PP
3932.Vb 2
3933\& ev_set_cb (watcher, callback);
3934\& ev_feed_event (EV_A_ watcher, 0);
3935.Ve
3936.PP
3937This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3938invoked, while not delaying callback invocation too much.
3939.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3591.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS" 3940.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3592Often (especially in \s-1GUI\s0 toolkits) there are places where you have 3941Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3593\&\fImodal\fR interaction, which is most easily implemented by recursively 3942\&\fImodal\fR interaction, which is most easily implemented by recursively
3594invoking \f(CW\*(C`ev_run\*(C'\fR. 3943invoking \f(CW\*(C`ev_run\*(C'\fR.
3595.PP 3944.PP
3596This brings the problem of exiting \- a callback might want to finish the 3945This brings the problem of exiting \- a callback might want to finish the
3597main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but 3946main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
3598a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one 3947a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
3599and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some 3948and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3600other combination: In these cases, \f(CW\*(C`ev_break\*(C'\fR will not work alone. 3949other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3601.PP 3950.PP
3602The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR 3951The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3603invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is 3952invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3604triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR: 3953triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3605.PP 3954.PP
3608\& int exit_main_loop = 0; 3957\& int exit_main_loop = 0;
3609\& 3958\&
3610\& while (!exit_main_loop) 3959\& while (!exit_main_loop)
3611\& ev_run (EV_DEFAULT_ EVRUN_ONCE); 3960\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3612\& 3961\&
3613\& // in a model watcher 3962\& // in a modal watcher
3614\& int exit_nested_loop = 0; 3963\& int exit_nested_loop = 0;
3615\& 3964\&
3616\& while (!exit_nested_loop) 3965\& while (!exit_nested_loop)
3617\& ev_run (EV_A_ EVRUN_ONCE); 3966\& ev_run (EV_A_ EVRUN_ONCE);
3618.Ve 3967.Ve
3627\& exit_main_loop = 1; 3976\& exit_main_loop = 1;
3628\& 3977\&
3629\& // exit both 3978\& // exit both
3630\& exit_main_loop = exit_nested_loop = 1; 3979\& exit_main_loop = exit_nested_loop = 1;
3631.Ve 3980.Ve
3632.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0" 3981.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3633.IX Subsection "THREAD LOCKING EXAMPLE" 3982.IX Subsection "THREAD LOCKING EXAMPLE"
3634Here is a fictitious example of how to run an event loop in a different 3983Here is a fictitious example of how to run an event loop in a different
3635thread from where callbacks are being invoked and watchers are 3984thread from where callbacks are being invoked and watchers are
3636created/added/removed. 3985created/added/removed.
3637.PP 3986.PP
3778.PP 4127.PP
3779Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise 4128Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
3780an event loop currently blocking in the kernel will have no knowledge 4129an event loop currently blocking in the kernel will have no knowledge
3781about the newly added timer. By waking up the loop it will pick up any new 4130about the newly added timer. By waking up the loop it will pick up any new
3782watchers in the next event loop iteration. 4131watchers in the next event loop iteration.
3783.SS "\s-1THREADS\s0, \s-1COROUTINES\s0, \s-1CONTINUATIONS\s0, \s-1QUEUES\s0... \s-1INSTEAD\s0 \s-1OF\s0 \s-1CALLBACKS\s0" 4132.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
3784.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS" 4133.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
3785While the overhead of a callback that e.g. schedules a thread is small, it 4134While the overhead of a callback that e.g. schedules a thread is small, it
3786is still an overhead. If you embed libev, and your main usage is with some 4135is still an overhead. If you embed libev, and your main usage is with some
3787kind of threads or coroutines, you might want to customise libev so that 4136kind of threads or coroutines, you might want to customise libev so that
3788doesn't need callbacks anymore. 4137doesn't need callbacks anymore.
3810.PP 4159.PP
3811.Vb 6 4160.Vb 6
3812\& void 4161\& void
3813\& wait_for_event (ev_watcher *w) 4162\& wait_for_event (ev_watcher *w)
3814\& { 4163\& {
3815\& ev_cb_set (w) = current_coro; 4164\& ev_set_cb (w, current_coro);
3816\& switch_to (libev_coro); 4165\& switch_to (libev_coro);
3817\& } 4166\& }
3818.Ve 4167.Ve
3819.PP 4168.PP
3820That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and 4169That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
3821continues the libev coroutine, which, when appropriate, switches back to 4170continues the libev coroutine, which, when appropriate, switches back to
3822this or any other coroutine. I am sure if you sue this your own :) 4171this or any other coroutine.
3823.PP 4172.PP
3824You can do similar tricks if you have, say, threads with an event queue \- 4173You can do similar tricks if you have, say, threads with an event queue \-
3825instead of storing a coroutine, you store the queue object and instead of 4174instead of storing a coroutine, you store the queue object and instead of
3826switching to a coroutine, you push the watcher onto the queue and notify 4175switching to a coroutine, you push the watcher onto the queue and notify
3827any waiters. 4176any waiters.
3828.PP 4177.PP
3829To embed libev, see \s-1EMBEDDING\s0, but in short, it's easiest to create two 4178To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
3830files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files: 4179files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
3831.PP 4180.PP
3832.Vb 4 4181.Vb 4
3833\& // my_ev.h 4182\& // my_ev.h
3834\& #define EV_CB_DECLARE(type) struct my_coro *cb; 4183\& #define EV_CB_DECLARE(type) struct my_coro *cb;
3835\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb); 4184\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
3836\& #include "../libev/ev.h" 4185\& #include "../libev/ev.h"
3837\& 4186\&
3838\& // my_ev.c 4187\& // my_ev.c
3839\& #define EV_H "my_ev.h" 4188\& #define EV_H "my_ev.h"
3840\& #include "../libev/ev.c" 4189\& #include "../libev/ev.c"
3873.IP "\(bu" 4 4222.IP "\(bu" 4
3874The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 4223The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
3875to use the libev header file and library. 4224to use the libev header file and library.
3876.SH "\*(C+ SUPPORT" 4225.SH "\*(C+ SUPPORT"
3877.IX Header " SUPPORT" 4226.IX Header " SUPPORT"
4227.SS "C \s-1API\s0"
4228.IX Subsection "C API"
4229The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4230libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4231will work fine.
4232.PP
4233Proper exception specifications might have to be added to callbacks passed
4234to libev: exceptions may be thrown only from watcher callbacks, all other
4235callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4236callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4237specification. If you have code that needs to be compiled as both C and
4238\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4239.PP
4240.Vb 6
4241\& static void
4242\& fatal_error (const char *msg) EV_NOEXCEPT
4243\& {
4244\& perror (msg);
4245\& abort ();
4246\& }
4247\&
4248\& ...
4249\& ev_set_syserr_cb (fatal_error);
4250.Ve
4251.PP
4252The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4253\&\f(CW\*(C`ev_invoke\*(C'\fR, \f(CW\*(C`ev_invoke_pending\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR (the latter
4254because it runs cleanup watchers).
4255.PP
4256Throwing exceptions in watcher callbacks is only supported if libev itself
4257is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4258throwing exceptions through C libraries (most do).
4259.SS "\*(C+ \s-1API\s0"
4260.IX Subsection " API"
3878Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4261Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
3879you to use some convenience methods to start/stop watchers and also change 4262you to use some convenience methods to start/stop watchers and also change
3880the callback model to a model using method callbacks on objects. 4263the callback model to a model using method callbacks on objects.
3881.PP 4264.PP
3882To use it, 4265To use it,
3898Currently, functions, static and non-static member functions and classes 4281Currently, functions, static and non-static member functions and classes
3899with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy 4282with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
3900to add as long as they only need one additional pointer for context. If 4283to add as long as they only need one additional pointer for context. If
3901you need support for other types of functors please contact the author 4284you need support for other types of functors please contact the author
3902(preferably after implementing it). 4285(preferably after implementing it).
4286.PP
4287For all this to work, your \*(C+ compiler either has to use the same calling
4288conventions as your C compiler (for static member functions), or you have
4289to embed libev and compile libev itself as \*(C+.
3903.PP 4290.PP
3904Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4291Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
3905.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4 4292.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
3906.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4293.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
3907.IX Item "ev::READ, ev::WRITE etc." 4294.IX Item "ev::READ, ev::WRITE etc."
3915.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 4302.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
3916.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 4303.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
3917For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 4304For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
3918the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 4305the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
3919which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 4306which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
3920defines by many implementations. 4307defined by many implementations.
3921.Sp 4308.Sp
3922All of those classes have these methods: 4309All of those classes have these methods:
3923.RS 4 4310.RS 4
3924.IP "ev::TYPE::TYPE ()" 4 4311.IP "ev::TYPE::TYPE ()" 4
3925.IX Item "ev::TYPE::TYPE ()" 4312.IX Item "ev::TYPE::TYPE ()"
3988\& void operator() (ev::io &w, int revents) 4375\& void operator() (ev::io &w, int revents)
3989\& { 4376\& {
3990\& ... 4377\& ...
3991\& } 4378\& }
3992\& } 4379\& }
3993\& 4380\&
3994\& myfunctor f; 4381\& myfunctor f;
3995\& 4382\&
3996\& ev::io w; 4383\& ev::io w;
3997\& w.set (&f); 4384\& w.set (&f);
3998.Ve 4385.Ve
4016.IX Item "w->set (loop)" 4403.IX Item "w->set (loop)"
4017Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4404Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
4018do this when the watcher is inactive (and not pending either). 4405do this when the watcher is inactive (and not pending either).
4019.IP "w\->set ([arguments])" 4 4406.IP "w\->set ([arguments])" 4
4020.IX Item "w->set ([arguments])" 4407.IX Item "w->set ([arguments])"
4021Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this 4408Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4022method or a suitable start method must be called at least once. Unlike the 4409with the same arguments. Either this method or a suitable start method
4023C counterpart, an active watcher gets automatically stopped and restarted 4410must be called at least once. Unlike the C counterpart, an active watcher
4024when reconfiguring it with this method. 4411gets automatically stopped and restarted when reconfiguring it with this
4412method.
4413.Sp
4414For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4415clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
4025.IP "w\->start ()" 4 4416.IP "w\->start ()" 4
4026.IX Item "w->start ()" 4417.IX Item "w->start ()"
4027Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4418Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
4028constructor already stores the event loop. 4419constructor already stores the event loop.
4029.IP "w\->start ([arguments])" 4 4420.IP "w\->start ([arguments])" 4
4056.PP 4447.PP
4057.Vb 5 4448.Vb 5
4058\& class myclass 4449\& class myclass
4059\& { 4450\& {
4060\& ev::io io ; void io_cb (ev::io &w, int revents); 4451\& ev::io io ; void io_cb (ev::io &w, int revents);
4061\& ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4452\& ev::io io2 ; void io2_cb (ev::io &w, int revents);
4062\& ev::idle idle; void idle_cb (ev::idle &w, int revents); 4453\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
4063\& 4454\&
4064\& myclass (int fd) 4455\& myclass (int fd)
4065\& { 4456\& {
4066\& io .set <myclass, &myclass::io_cb > (this); 4457\& io .set <myclass, &myclass::io_cb > (this);
4087there are additional modules that implement libev-compatible interfaces 4478there are additional modules that implement libev-compatible interfaces
4088to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), 4479to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
4089\&\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 4480\&\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
4090and \f(CW\*(C`EV::Glib\*(C'\fR). 4481and \f(CW\*(C`EV::Glib\*(C'\fR).
4091.Sp 4482.Sp
4092It can be found and installed via \s-1CPAN\s0, its homepage is at 4483It can be found and installed via \s-1CPAN,\s0 its homepage is at
4093<http://software.schmorp.de/pkg/EV>. 4484<http://software.schmorp.de/pkg/EV>.
4094.IP "Python" 4 4485.IP "Python" 4
4095.IX Item "Python" 4486.IX Item "Python"
4096Python bindings can be found at <http://code.google.com/p/pyev/>. It 4487Python bindings can be found at <http://code.google.com/p/pyev/>. It
4097seems to be quite complete and well-documented. 4488seems to be quite complete and well-documented.
4109A haskell binding to libev is available at 4500A haskell binding to libev is available at
4110<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>. 4501<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4111.IP "D" 4 4502.IP "D" 4
4112.IX Item "D" 4503.IX Item "D"
4113Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4504Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4114be found at <http://proj.llucax.com.ar/wiki/evd>. 4505be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4115.IP "Ocaml" 4 4506.IP "Ocaml" 4
4116.IX Item "Ocaml" 4507.IX Item "Ocaml"
4117Erkki Seppala has written Ocaml bindings for libev, to be found at 4508Erkki Seppala has written Ocaml bindings for libev, to be found at
4118<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. 4509<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4119.IP "Lua" 4 4510.IP "Lua" 4
4120.IX Item "Lua" 4511.IX Item "Lua"
4121Brian Maher has written a partial interface to libev for lua (at the 4512Brian Maher has written a partial interface to libev for lua (at the
4122time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at 4513time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4123<http://github.com/brimworks/lua\-ev>. 4514<http://github.com/brimworks/lua\-ev>.
4515.IP "Javascript" 4
4516.IX Item "Javascript"
4517Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4518.IP "Others" 4
4519.IX Item "Others"
4520There are others, and I stopped counting.
4124.SH "MACRO MAGIC" 4521.SH "MACRO MAGIC"
4125.IX Header "MACRO MAGIC" 4522.IX Header "MACRO MAGIC"
4126Libev can be compiled with a variety of options, the most fundamental 4523Libev can be compiled with a variety of options, the most fundamental
4127of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 4524of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
4128functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 4525functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
4163suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 4560suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
4164.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4 4561.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
4165.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 4562.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
4166.IX Item "EV_DEFAULT, EV_DEFAULT_" 4563.IX Item "EV_DEFAULT, EV_DEFAULT_"
4167Similar to the other two macros, this gives you the value of the default 4564Similar to the other two macros, this gives you the value of the default
4168loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 4565loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop
4566will be initialised if it isn't already initialised.
4567.Sp
4568For non-multiplicity builds, these macros do nothing, so you always have
4569to initialise the loop somewhere.
4169.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4 4570.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
4170.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 4571.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
4171.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" 4572.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
4172Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the 4573Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
4173default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour 4574default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
4207.SS "\s-1FILESETS\s0" 4608.SS "\s-1FILESETS\s0"
4208.IX Subsection "FILESETS" 4609.IX Subsection "FILESETS"
4209Depending on what features you need you need to include one or more sets of files 4610Depending on what features you need you need to include one or more sets of files
4210in your application. 4611in your application.
4211.PP 4612.PP
4212\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4613\fI\s-1CORE EVENT LOOP\s0\fR
4213.IX Subsection "CORE EVENT LOOP" 4614.IX Subsection "CORE EVENT LOOP"
4214.PP 4615.PP
4215To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4616To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
4216configuration (no autoconf): 4617configuration (no autoconf):
4217.PP 4618.PP
4244\& ev_vars.h 4645\& ev_vars.h
4245\& ev_wrap.h 4646\& ev_wrap.h
4246\& 4647\&
4247\& ev_win32.c required on win32 platforms only 4648\& ev_win32.c required on win32 platforms only
4248\& 4649\&
4249\& ev_select.c only when select backend is enabled (which is enabled by default) 4650\& ev_select.c only when select backend is enabled
4250\& ev_poll.c only when poll backend is enabled (disabled by default) 4651\& ev_poll.c only when poll backend is enabled
4251\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4652\& ev_epoll.c only when the epoll backend is enabled
4653\& ev_linuxaio.c only when the linux aio backend is enabled
4654\& ev_iouring.c only when the linux io_uring backend is enabled
4252\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4655\& ev_kqueue.c only when the kqueue backend is enabled
4253\& ev_port.c only when the solaris port backend is enabled (disabled by default) 4656\& ev_port.c only when the solaris port backend is enabled
4254.Ve 4657.Ve
4255.PP 4658.PP
4256\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4659\&\fIev.c\fR includes the backend files directly when enabled, so you only need
4257to compile this single file. 4660to compile this single file.
4258.PP 4661.PP
4259\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4662\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
4260.IX Subsection "LIBEVENT COMPATIBILITY API" 4663.IX Subsection "LIBEVENT COMPATIBILITY API"
4261.PP 4664.PP
4262To include the libevent compatibility \s-1API\s0, also include: 4665To include the libevent compatibility \s-1API,\s0 also include:
4263.PP 4666.PP
4264.Vb 1 4667.Vb 1
4265\& #include "event.c" 4668\& #include "event.c"
4266.Ve 4669.Ve
4267.PP 4670.PP
4269.PP 4672.PP
4270.Vb 1 4673.Vb 1
4271\& #include "event.h" 4674\& #include "event.h"
4272.Ve 4675.Ve
4273.PP 4676.PP
4274in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4677in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
4275.PP 4678.PP
4276You need the following additional files for this: 4679You need the following additional files for this:
4277.PP 4680.PP
4278.Vb 2 4681.Vb 2
4279\& event.h 4682\& event.h
4280\& event.c 4683\& event.c
4281.Ve 4684.Ve
4282.PP 4685.PP
4283\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4686\fI\s-1AUTOCONF SUPPORT\s0\fR
4284.IX Subsection "AUTOCONF SUPPORT" 4687.IX Subsection "AUTOCONF SUPPORT"
4285.PP 4688.PP
4286Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4689Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
4287whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4690whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
4288\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4691\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
4291For this of course you need the m4 file: 4694For this of course you need the m4 file:
4292.PP 4695.PP
4293.Vb 1 4696.Vb 1
4294\& libev.m4 4697\& libev.m4
4295.Ve 4698.Ve
4296.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4699.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
4297.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4700.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
4298Libev can be configured via a variety of preprocessor symbols you have to 4701Libev can be configured via a variety of preprocessor symbols you have to
4299define before including (or compiling) any of its files. The default in 4702define before including (or compiling) any of its files. The default in
4300the absence of autoconf is documented for every option. 4703the absence of autoconf is documented for every option.
4301.PP 4704.PP
4302Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different 4705Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4303values when compiling libev vs. including \fIev.h\fR, so it is permissible 4706values when compiling libev vs. including \fIev.h\fR, so it is permissible
4304to redefine them before including \fIev.h\fR without breaking compatibility 4707to redefine them before including \fIev.h\fR without breaking compatibility
4305to a compiled library. All other symbols change the \s-1ABI\s0, which means all 4708to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4306users of libev and the libev code itself must be compiled with compatible 4709users of libev and the libev code itself must be compiled with compatible
4307settings. 4710settings.
4308.IP "\s-1EV_COMPAT3\s0 (h)" 4 4711.IP "\s-1EV_COMPAT3\s0 (h)" 4
4309.IX Item "EV_COMPAT3 (h)" 4712.IX Item "EV_COMPAT3 (h)"
4310Backwards compatibility is a major concern for libev. This is why this 4713Backwards compatibility is a major concern for libev. This is why this
4328supported). It will also not define any of the structs usually found in 4731supported). It will also not define any of the structs usually found in
4329\&\fIevent.h\fR that are not directly supported by the libev core alone. 4732\&\fIevent.h\fR that are not directly supported by the libev core alone.
4330.Sp 4733.Sp
4331In standalone mode, libev will still try to automatically deduce the 4734In standalone mode, libev will still try to automatically deduce the
4332configuration, but has to be more conservative. 4735configuration, but has to be more conservative.
4736.IP "\s-1EV_USE_FLOOR\s0" 4
4737.IX Item "EV_USE_FLOOR"
4738If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its
4739periodic reschedule calculations, otherwise libev will fall back on a
4740portable (slower) implementation. If you enable this, you usually have to
4741link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR
4742function is not available will fail, so the safe default is to not enable
4743this.
4333.IP "\s-1EV_USE_MONOTONIC\s0" 4 4744.IP "\s-1EV_USE_MONOTONIC\s0" 4
4334.IX Item "EV_USE_MONOTONIC" 4745.IX Item "EV_USE_MONOTONIC"
4335If defined to be \f(CW1\fR, libev will try to detect the availability of the 4746If defined to be \f(CW1\fR, libev will try to detect the availability of the
4336monotonic clock option at both compile time and runtime. Otherwise no 4747monotonic clock option at both compile time and runtime. Otherwise no
4337use of the monotonic clock option will be attempted. If you enable this, 4748use of the monotonic clock option will be attempted. If you enable this,
4361higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). 4772higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR).
4362.IP "\s-1EV_USE_NANOSLEEP\s0" 4 4773.IP "\s-1EV_USE_NANOSLEEP\s0" 4
4363.IX Item "EV_USE_NANOSLEEP" 4774.IX Item "EV_USE_NANOSLEEP"
4364If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available 4775If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
4365and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. 4776and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
4777.IP "\s-1EV_USE_EVENTFD\s0" 4
4778.IX Item "EV_USE_EVENTFD"
4779If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4780available and will probe for kernel support at runtime. This will improve
4781\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4782If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
47832.7 or newer, otherwise disabled.
4784.IP "\s-1EV_USE_SIGNALFD\s0" 4
4785.IX Item "EV_USE_SIGNALFD"
4786If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`signalfd ()\*(C'\fR is
4787available and will probe for kernel support at runtime. This enables
4788the use of \s-1EVFLAG_SIGNALFD\s0 for faster and simpler signal handling. If
4789undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
47902.7 or newer, otherwise disabled.
4791.IP "\s-1EV_USE_TIMERFD\s0" 4
4792.IX Item "EV_USE_TIMERFD"
4793If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`timerfd ()\*(C'\fR is
4794available and will probe for kernel support at runtime. This allows
4795libev to detect time jumps accurately. If undefined, it will be enabled
4796if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4797\&\f(CW\*(C`TFD_TIMER_CANCEL_ON_SET\*(C'\fR, otherwise disabled.
4366.IP "\s-1EV_USE_EVENTFD\s0" 4 4798.IP "\s-1EV_USE_EVENTFD\s0" 4
4367.IX Item "EV_USE_EVENTFD" 4799.IX Item "EV_USE_EVENTFD"
4368If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is 4800If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4369available and will probe for kernel support at runtime. This will improve 4801available and will probe for kernel support at runtime. This will improve
4370\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. 4802\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4411.IX Item "EV_WIN32_CLOSE_FD(fd)" 4843.IX Item "EV_WIN32_CLOSE_FD(fd)"
4412If programs implement their own fd to handle mapping on win32, then this 4844If programs implement their own fd to handle mapping on win32, then this
4413macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister 4845macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4414file descriptors again. Note that the replacement function has to close 4846file descriptors again. Note that the replacement function has to close
4415the underlying \s-1OS\s0 handle. 4847the underlying \s-1OS\s0 handle.
4848.IP "\s-1EV_USE_WSASOCKET\s0" 4
4849.IX Item "EV_USE_WSASOCKET"
4850If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4851communication socket, which works better in some environments. Otherwise,
4852the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4853environments.
4416.IP "\s-1EV_USE_POLL\s0" 4 4854.IP "\s-1EV_USE_POLL\s0" 4
4417.IX Item "EV_USE_POLL" 4855.IX Item "EV_USE_POLL"
4418If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4856If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
4419backend. Otherwise it will be enabled on non\-win32 platforms. It 4857backend. Otherwise it will be enabled on non\-win32 platforms. It
4420takes precedence over select. 4858takes precedence over select.
4423If defined to be \f(CW1\fR, libev will compile in support for the Linux 4861If defined to be \f(CW1\fR, libev will compile in support for the Linux
4424\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 4862\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
4425otherwise another method will be used as fallback. This is the preferred 4863otherwise another method will be used as fallback. This is the preferred
4426backend for GNU/Linux systems. If undefined, it will be enabled if the 4864backend for GNU/Linux systems. If undefined, it will be enabled if the
4427headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4865headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4866.IP "\s-1EV_USE_LINUXAIO\s0" 4
4867.IX Item "EV_USE_LINUXAIO"
4868If defined to be \f(CW1\fR, libev will compile in support for the Linux aio
4869backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). If undefined, it will be
4870enabled on linux, otherwise disabled.
4871.IP "\s-1EV_USE_IOURING\s0" 4
4872.IX Item "EV_USE_IOURING"
4873If defined to be \f(CW1\fR, libev will compile in support for the Linux
4874io_uring backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). Due to it's
4875current limitations it has to be requested explicitly. If undefined, it
4876will be enabled on linux, otherwise disabled.
4428.IP "\s-1EV_USE_KQUEUE\s0" 4 4877.IP "\s-1EV_USE_KQUEUE\s0" 4
4429.IX Item "EV_USE_KQUEUE" 4878.IX Item "EV_USE_KQUEUE"
4430If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4879If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
4431\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 4880\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
4432otherwise another method will be used as fallback. This is the preferred 4881otherwise another method will be used as fallback. This is the preferred
4449.IX Item "EV_USE_INOTIFY" 4898.IX Item "EV_USE_INOTIFY"
4450If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 4899If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
4451interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 4900interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
4452be detected at runtime. If undefined, it will be enabled if the headers 4901be detected at runtime. If undefined, it will be enabled if the headers
4453indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4902indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4903.IP "\s-1EV_NO_SMP\s0" 4
4904.IX Item "EV_NO_SMP"
4905If defined to be \f(CW1\fR, libev will assume that memory is always coherent
4906between threads, that is, threads can be used, but threads never run on
4907different cpus (or different cpu cores). This reduces dependencies
4908and makes libev faster.
4909.IP "\s-1EV_NO_THREADS\s0" 4
4910.IX Item "EV_NO_THREADS"
4911If defined to be \f(CW1\fR, libev will assume that it will never be called from
4912different threads (that includes signal handlers), which is a stronger
4913assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4914libev faster.
4454.IP "\s-1EV_ATOMIC_T\s0" 4 4915.IP "\s-1EV_ATOMIC_T\s0" 4
4455.IX Item "EV_ATOMIC_T" 4916.IX Item "EV_ATOMIC_T"
4456Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4917Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4457access is atomic with respect to other threads or signal contexts. No such 4918access is atomic with respect to other threads or signal contexts. No
4458type is easily found in the C language, so you can provide your own type 4919such type is easily found in the C language, so you can provide your own
4459that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" 4920type that you know is safe for your purposes. It is used both for signal
4460as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. 4921handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4922watchers.
4461.Sp 4923.Sp
4462In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4924In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4463(from \fIsignal.h\fR), which is usually good enough on most platforms. 4925(from \fIsignal.h\fR), which is usually good enough on most platforms.
4464.IP "\s-1EV_H\s0 (h)" 4 4926.IP "\s-1EV_H\s0 (h)" 4
4465.IX Item "EV_H (h)" 4927.IX Item "EV_H (h)"
4486If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 4948If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
4487will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 4949will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
4488additional independent event loops. Otherwise there will be no support 4950additional independent event loops. Otherwise there will be no support
4489for multiple event loops and there is no first event loop pointer 4951for multiple event loops and there is no first event loop pointer
4490argument. Instead, all functions act on the single default loop. 4952argument. Instead, all functions act on the single default loop.
4953.Sp
4954Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a
4955default loop when multiplicity is switched off \- you always have to
4956initialise the loop manually in this case.
4491.IP "\s-1EV_MINPRI\s0" 4 4957.IP "\s-1EV_MINPRI\s0" 4
4492.IX Item "EV_MINPRI" 4958.IX Item "EV_MINPRI"
4493.PD 0 4959.PD 0
4494.IP "\s-1EV_MAXPRI\s0" 4 4960.IP "\s-1EV_MAXPRI\s0" 4
4495.IX Item "EV_MAXPRI" 4961.IX Item "EV_MAXPRI"
4503all the priorities, so having many of them (hundreds) uses a lot of space 4969all the priorities, so having many of them (hundreds) uses a lot of space
4504and time, so using the defaults of five priorities (\-2 .. +2) is usually 4970and time, so using the defaults of five priorities (\-2 .. +2) is usually
4505fine. 4971fine.
4506.Sp 4972.Sp
4507If your embedding application does not need any priorities, defining these 4973If your embedding application does not need any priorities, defining these
4508both to \f(CW0\fR will save some memory and \s-1CPU\s0. 4974both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4509.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 4975.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
4510.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." 4976.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."
4511If undefined or defined to be \f(CW1\fR (and the platform supports it), then 4977If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4512the respective watcher type is supported. If defined to be \f(CW0\fR, then it 4978the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4513is not. Disabling watcher types mainly saves code size. 4979is not. Disabling watcher types mainly saves code size.
4514.IP "\s-1EV_FEATURES\s0" 4 4980.IP "\s-1EV_FEATURES\s0" 4
4531\& #define EV_CHILD_ENABLE 1 4997\& #define EV_CHILD_ENABLE 1
4532\& #define EV_ASYNC_ENABLE 1 4998\& #define EV_ASYNC_ENABLE 1
4533.Ve 4999.Ve
4534.Sp 5000.Sp
4535The actual value is a bitset, it can be a combination of the following 5001The actual value is a bitset, it can be a combination of the following
4536values: 5002values (by default, all of these are enabled):
4537.RS 4 5003.RS 4
4538.ie n .IP "1 \- faster/larger code" 4 5004.ie n .IP "1 \- faster/larger code" 4
4539.el .IP "\f(CW1\fR \- faster/larger code" 4 5005.el .IP "\f(CW1\fR \- faster/larger code" 4
4540.IX Item "1 - faster/larger code" 5006.IX Item "1 - faster/larger code"
4541Use larger code to speed up some operations. 5007Use larger code to speed up some operations.
4544code size by roughly 30% on amd64). 5010code size by roughly 30% on amd64).
4545.Sp 5011.Sp
4546When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with 5012When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4547gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of 5013gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4548assertions. 5014assertions.
5015.Sp
5016The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
5017(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4549.ie n .IP "2 \- faster/larger data structures" 4 5018.ie n .IP "2 \- faster/larger data structures" 4
4550.el .IP "\f(CW2\fR \- faster/larger data structures" 4 5019.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4551.IX Item "2 - faster/larger data structures" 5020.IX Item "2 - faster/larger data structures"
4552Replaces the small 2\-heap for timer management by a faster 4\-heap, larger 5021Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4553hash table sizes and so on. This will usually further increase code size 5022hash table sizes and so on. This will usually further increase code size
4554and can additionally have an effect on the size of data structures at 5023and can additionally have an effect on the size of data structures at
4555runtime. 5024runtime.
5025.Sp
5026The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
5027(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4556.ie n .IP "4 \- full \s-1API\s0 configuration" 4 5028.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4557.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 5029.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4558.IX Item "4 - full API configuration" 5030.IX Item "4 - full API configuration"
4559This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and 5031This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4560enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1). 5032enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4592With an intelligent-enough linker (gcc+binutils are intelligent enough 5064With an intelligent-enough linker (gcc+binutils are intelligent enough
4593when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by 5065when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by
4594your program might be left out as well \- a binary starting a timer and an 5066your program might be left out as well \- a binary starting a timer and an
4595I/O watcher then might come out at only 5Kb. 5067I/O watcher then might come out at only 5Kb.
4596.RE 5068.RE
5069.IP "\s-1EV_API_STATIC\s0" 4
5070.IX Item "EV_API_STATIC"
5071If this symbol is defined (by default it is not), then all identifiers
5072will have static linkage. This means that libev will not export any
5073identifiers, and you cannot link against libev anymore. This can be useful
5074when you embed libev, only want to use libev functions in a single file,
5075and do not want its identifiers to be visible.
5076.Sp
5077To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that
5078wants to use libev.
5079.Sp
5080This option only works when libev is compiled with a C compiler, as \*(C+
5081doesn't support the required declaration syntax.
4597.IP "\s-1EV_AVOID_STDIO\s0" 4 5082.IP "\s-1EV_AVOID_STDIO\s0" 4
4598.IX Item "EV_AVOID_STDIO" 5083.IX Item "EV_AVOID_STDIO"
4599If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio 5084If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio
4600functions (printf, scanf, perror etc.). This will increase the code size 5085functions (printf, scanf, perror etc.). This will increase the code size
4601somewhat, but if your program doesn't otherwise depend on stdio and your 5086somewhat, but if your program doesn't otherwise depend on stdio and your
4653called. If set to \f(CW2\fR, then the internal verification code will be 5138called. If set to \f(CW2\fR, then the internal verification code will be
4654called once per loop, which can slow down libev. If set to \f(CW3\fR, then the 5139called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
4655verification code will be called very frequently, which will slow down 5140verification code will be called very frequently, which will slow down
4656libev considerably. 5141libev considerably.
4657.Sp 5142.Sp
5143Verification errors are reported via C's \f(CW\*(C`assert\*(C'\fR mechanism, so if you
5144disable that (e.g. by defining \f(CW\*(C`NDEBUG\*(C'\fR) then no errors will be reported.
5145.Sp
4658The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it 5146The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4659will be \f(CW0\fR. 5147will be \f(CW0\fR.
4660.IP "\s-1EV_COMMON\s0" 4 5148.IP "\s-1EV_COMMON\s0" 4
4661.IX Item "EV_COMMON" 5149.IX Item "EV_COMMON"
4662By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 5150By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
4683and the way callbacks are invoked and set. Must expand to a struct member 5171and the way callbacks are invoked and set. Must expand to a struct member
4684definition and a statement, respectively. See the \fIev.h\fR header file for 5172definition and a statement, respectively. See the \fIev.h\fR header file for
4685their default definitions. One possible use for overriding these is to 5173their default definitions. One possible use for overriding these is to
4686avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5174avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
4687method calls instead of plain function calls in \*(C+. 5175method calls instead of plain function calls in \*(C+.
4688.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5176.SS "\s-1EXPORTED API SYMBOLS\s0"
4689.IX Subsection "EXPORTED API SYMBOLS" 5177.IX Subsection "EXPORTED API SYMBOLS"
4690If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 5178If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
4691exported symbols, you can use the provided \fISymbol.*\fR files which list 5179exported symbols, you can use the provided \fISymbol.*\fR files which list
4692all public symbols, one per line: 5180all public symbols, one per line:
4693.PP 5181.PP
4747\& #include "ev_cpp.h" 5235\& #include "ev_cpp.h"
4748\& #include "ev.c" 5236\& #include "ev.c"
4749.Ve 5237.Ve
4750.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5238.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4751.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5239.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4752.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5240.SS "\s-1THREADS AND COROUTINES\s0"
4753.IX Subsection "THREADS AND COROUTINES" 5241.IX Subsection "THREADS AND COROUTINES"
4754\fI\s-1THREADS\s0\fR 5242\fI\s-1THREADS\s0\fR
4755.IX Subsection "THREADS" 5243.IX Subsection "THREADS"
4756.PP 5244.PP
4757All libev functions are reentrant and thread-safe unless explicitly 5245All libev functions are reentrant and thread-safe unless explicitly
4803An example use would be to communicate signals or other events that only 5291An example use would be to communicate signals or other events that only
4804work in the default loop by registering the signal watcher with the 5292work in the default loop by registering the signal watcher with the
4805default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 5293default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
4806watcher callback into the event loop interested in the signal. 5294watcher callback into the event loop interested in the signal.
4807.PP 5295.PP
4808See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R". 5296See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
4809.PP 5297.PP
4810\fI\s-1COROUTINES\s0\fR 5298\fI\s-1COROUTINES\s0\fR
4811.IX Subsection "COROUTINES" 5299.IX Subsection "COROUTINES"
4812.PP 5300.PP
4813Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5301Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
4818that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 5306that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
4819.PP 5307.PP
4820Care has been taken to ensure that libev does not keep local state inside 5308Care has been taken to ensure that libev does not keep local state inside
4821\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as 5309\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
4822they do not call any callbacks. 5310they do not call any callbacks.
4823.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5311.SS "\s-1COMPILER WARNINGS\s0"
4824.IX Subsection "COMPILER WARNINGS" 5312.IX Subsection "COMPILER WARNINGS"
4825Depending on your compiler and compiler settings, you might get no or a 5313Depending on your compiler and compiler settings, you might get no or a
4826lot of warnings when compiling libev code. Some people are apparently 5314lot of warnings when compiling libev code. Some people are apparently
4827scared by this. 5315scared by this.
4828.PP 5316.PP
4880.PP 5368.PP
4881If you need, for some reason, empty reports from valgrind for your project 5369If you need, for some reason, empty reports from valgrind for your project
4882I suggest using suppression lists. 5370I suggest using suppression lists.
4883.SH "PORTABILITY NOTES" 5371.SH "PORTABILITY NOTES"
4884.IX Header "PORTABILITY NOTES" 5372.IX Header "PORTABILITY NOTES"
4885.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" 5373.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
4886.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" 5374.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
4887GNU/Linux is the only common platform that supports 64 bit file/large file 5375GNU/Linux is the only common platform that supports 64 bit file/large file
4888interfaces but \fIdisables\fR them by default. 5376interfaces but \fIdisables\fR them by default.
4889.PP 5377.PP
4890That means that libev compiled in the default environment doesn't support 5378That means that libev compiled in the default environment doesn't support
4891files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. 5379files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
4892.PP 5380.PP
4893Unfortunately, many programs try to work around this GNU/Linux issue 5381Unfortunately, many programs try to work around this GNU/Linux issue
4894by enabling the large file \s-1API\s0, which makes them incompatible with the 5382by enabling the large file \s-1API,\s0 which makes them incompatible with the
4895standard libev compiled for their system. 5383standard libev compiled for their system.
4896.PP 5384.PP
4897Likewise, libev cannot enable the large file \s-1API\s0 itself as this would 5385Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
4898suddenly make it incompatible to the default compile time environment, 5386suddenly make it incompatible to the default compile time environment,
4899i.e. all programs not using special compile switches. 5387i.e. all programs not using special compile switches.
4900.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" 5388.SS "\s-1OS/X AND DARWIN BUGS\s0"
4901.IX Subsection "OS/X AND DARWIN BUGS" 5389.IX Subsection "OS/X AND DARWIN BUGS"
4902The whole thing is a bug if you ask me \- basically any system interface 5390The whole thing is a bug if you ask me \- basically any system interface
4903you touch is broken, whether it is locales, poll, kqueue or even the 5391you touch is broken, whether it is locales, poll, kqueue or even the
4904OpenGL drivers. 5392OpenGL drivers.
4905.PP 5393.PP
4927.PP 5415.PP
4928\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5416\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
4929.IX Subsection "select is buggy" 5417.IX Subsection "select is buggy"
4930.PP 5418.PP
4931All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5419All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
4932one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file 5420one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file
4933descriptors you can pass in to 1024 \- your program suddenly crashes when 5421descriptors you can pass in to 1024 \- your program suddenly crashes when
4934you use more. 5422you use more.
4935.PP 5423.PP
4936There is an undocumented \*(L"workaround\*(R" for this \- defining 5424There is an undocumented \*(L"workaround\*(R" for this \- defining
4937\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR 5425\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
4938work on \s-1OS/X\s0. 5426work on \s-1OS/X.\s0
4939.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5427.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
4940.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" 5428.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
4941\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR 5429\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
4942.IX Subsection "errno reentrancy" 5430.IX Subsection "errno reentrancy"
4943.PP 5431.PP
4944The default compile environment on Solaris is unfortunately so 5432The default compile environment on Solaris is unfortunately so
4961great. 5449great.
4962.PP 5450.PP
4963If you can't get it to work, you can try running the program by setting 5451If you can't get it to work, you can try running the program by setting
4964the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and 5452the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
4965\&\f(CW\*(C`select\*(C'\fR backends. 5453\&\f(CW\*(C`select\*(C'\fR backends.
4966.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" 5454.SS "\s-1AIX POLL BUG\s0"
4967.IX Subsection "AIX POLL BUG" 5455.IX Subsection "AIX POLL BUG"
4968\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around 5456\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
4969this by trying to avoid the poll backend altogether (i.e. it's not even 5457this by trying to avoid the poll backend altogether (i.e. it's not even
4970compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine 5458compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
4971with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway. 5459with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
4972.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5460.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
4973.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5461.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
4974\fIGeneral issues\fR 5462\fIGeneral issues\fR
4975.IX Subsection "General issues" 5463.IX Subsection "General issues"
4976.PP 5464.PP
4977Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5465Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
4978requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 5466requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
4979model. Libev still offers limited functionality on this platform in 5467model. Libev still offers limited functionality on this platform in
4980the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 5468the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
4981descriptors. This only applies when using Win32 natively, not when using 5469descriptors. This only applies when using Win32 natively, not when using
4982e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5470e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4983as every compielr comes with a slightly differently broken/incompatible 5471as every compiler comes with a slightly differently broken/incompatible
4984environment. 5472environment.
4985.PP 5473.PP
4986Lifting these limitations would basically require the full 5474Lifting these limitations would basically require the full
4987re-implementation of the I/O system. If you are into this kind of thing, 5475re-implementation of the I/O system. If you are into this kind of thing,
4988then note that glib does exactly that for you in a very portable way (note 5476then note that glib does exactly that for you in a very portable way (note
5046\& #define EV_USE_SELECT 1 5534\& #define EV_USE_SELECT 1
5047\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5535\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5048.Ve 5536.Ve
5049.PP 5537.PP
5050Note that winsockets handling of fd sets is O(n), so you can easily get a 5538Note that winsockets handling of fd sets is O(n), so you can easily get a
5051complexity in the O(nA\*^X) range when using win32. 5539complexity in the O(nX) range when using win32.
5052.PP 5540.PP
5053\fILimited number of file descriptors\fR 5541\fILimited number of file descriptors\fR
5054.IX Subsection "Limited number of file descriptors" 5542.IX Subsection "Limited number of file descriptors"
5055.PP 5543.PP
5056Windows has numerous arbitrary (and low) limits on things. 5544Windows has numerous arbitrary (and low) limits on things.
5072by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR 5560by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
5073(another arbitrary limit), but is broken in many versions of the Microsoft 5561(another arbitrary limit), but is broken in many versions of the Microsoft
5074runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets 5562runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
5075(depending on windows version and/or the phase of the moon). To get more, 5563(depending on windows version and/or the phase of the moon). To get more,
5076you need to wrap all I/O functions and provide your own fd management, but 5564you need to wrap all I/O functions and provide your own fd management, but
5077the cost of calling select (O(nA\*^X)) will likely make this unworkable. 5565the cost of calling select (O(nX)) will likely make this unworkable.
5078.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5566.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5079.IX Subsection "PORTABILITY REQUIREMENTS" 5567.IX Subsection "PORTABILITY REQUIREMENTS"
5080In addition to a working ISO-C implementation and of course the 5568In addition to a working ISO-C implementation and of course the
5081backend-specific APIs, libev relies on a few additional extensions: 5569backend-specific APIs, libev relies on a few additional extensions:
5082.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 5570.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
5083.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5571.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
5084.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5572.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
5085Libev assumes not only that all watcher pointers have the same internal 5573Libev assumes not only that all watcher pointers have the same internal
5086structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5574structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5087assumes that the same (machine) code can be used to call any watcher 5575assumes that the same (machine) code can be used to call any watcher
5088callback: The watcher callbacks have different type signatures, but libev 5576callback: The watcher callbacks have different type signatures, but libev
5089calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5577calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5578.IP "null pointers and integer zero are represented by 0 bytes" 4
5579.IX Item "null pointers and integer zero are represented by 0 bytes"
5580Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5581relies on this setting pointers and integers to null.
5090.IP "pointer accesses must be thread-atomic" 4 5582.IP "pointer accesses must be thread-atomic" 4
5091.IX Item "pointer accesses must be thread-atomic" 5583.IX Item "pointer accesses must be thread-atomic"
5092Accessing a pointer value must be atomic, it must both be readable and 5584Accessing a pointer value must be atomic, it must both be readable and
5093writable in one piece \- this is the case on all current architectures. 5585writable in one piece \- this is the case on all current architectures.
5094.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5586.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
5107thread\*(R" or will block signals process-wide, both behaviours would 5599thread\*(R" or will block signals process-wide, both behaviours would
5108be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5600be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5109\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5601\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5110.Sp 5602.Sp
5111The most portable way to handle signals is to block signals in all threads 5603The most portable way to handle signals is to block signals in all threads
5112except the initial one, and run the default loop in the initial thread as 5604except the initial one, and run the signal handling loop in the initial
5113well. 5605thread as well.
5114.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5606.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
5115.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 5607.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
5116.IX Item "long must be large enough for common memory allocation sizes" 5608.IX Item "long must be large enough for common memory allocation sizes"
5117To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally 5609To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
5118instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX 5610instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
5119systems (Microsoft...) this might be unexpectedly low, but is still at 5611systems (Microsoft...) this might be unexpectedly low, but is still at
5120least 31 bits everywhere, which is enough for hundreds of millions of 5612least 31 bits everywhere, which is enough for hundreds of millions of
5121watchers. 5613watchers.
5122.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5614.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
5124.IX Item "double must hold a time value in seconds with enough accuracy" 5616.IX Item "double must hold a time value in seconds with enough accuracy"
5125The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5617The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
5126have at least 51 bits of mantissa (and 9 bits of exponent), which is 5618have at least 51 bits of mantissa (and 9 bits of exponent), which is
5127good enough for at least into the year 4000 with millisecond accuracy 5619good enough for at least into the year 4000 with millisecond accuracy
5128(the design goal for libev). This requirement is overfulfilled by 5620(the design goal for libev). This requirement is overfulfilled by
5129implementations using \s-1IEEE\s0 754, which is basically all existing ones. With 5621implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5622.Sp
5130\&\s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least 2200. 5623With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5624year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5625is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5626something like that, just kidding).
5131.PP 5627.PP
5132If you know of other additional requirements drop me a note. 5628If you know of other additional requirements drop me a note.
5133.SH "ALGORITHMIC COMPLEXITIES" 5629.SH "ALGORITHMIC COMPLEXITIES"
5134.IX Header "ALGORITHMIC COMPLEXITIES" 5630.IX Header "ALGORITHMIC COMPLEXITIES"
5135In this section the complexities of (many of) the algorithms used inside 5631In this section the complexities of (many of) the algorithms used inside
5189.IX Item "Processing ev_async_send: O(number_of_async_watchers)" 5685.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
5190.IP "Processing signals: O(max_signal_number)" 4 5686.IP "Processing signals: O(max_signal_number)" 4
5191.IX Item "Processing signals: O(max_signal_number)" 5687.IX Item "Processing signals: O(max_signal_number)"
5192.PD 5688.PD
5193Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 5689Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
5194calls in the current loop iteration. Checking for async and signal events 5690calls in the current loop iteration and the loop is currently
5691blocked. Checking for async and signal events involves iterating over all
5195involves iterating over all running async watchers or all signal numbers. 5692running async watchers or all signal numbers.
5196.SH "PORTING FROM LIBEV 3.X TO 4.X" 5693.SH "PORTING FROM LIBEV 3.X TO 4.X"
5197.IX Header "PORTING FROM LIBEV 3.X TO 4.X" 5694.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5198The major version 4 introduced some incompatible changes to the \s-1API\s0. 5695The major version 4 introduced some incompatible changes to the \s-1API.\s0
5199.PP 5696.PP
5200At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions 5697At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5201for all changes, so most programs should still compile. The compatibility 5698for all changes, so most programs should still compile. The compatibility
5202layer might be removed in later versions of libev, so better update to the 5699layer might be removed in later versions of libev, so better update to the
5203new \s-1API\s0 early than late. 5700new \s-1API\s0 early than late.
5204.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 5701.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5205.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 5702.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5206.IX Item "EV_COMPAT3 backwards compatibility mechanism" 5703.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5207The backward compatibility mechanism can be controlled by 5704The backward compatibility mechanism can be controlled by
5208\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1MACROS\s0\*(R" in \s-1PREPROCESSOR\s0 \s-1SYMBOLS\s0 in the \s-1EMBEDDING\s0 5705\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5209section. 5706section.
5210.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 5707.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5211.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 5708.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5212.IX Item "ev_default_destroy and ev_default_fork have been removed" 5709.IX Item "ev_default_destroy and ev_default_fork have been removed"
5213These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: 5710These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5253.SH "GLOSSARY" 5750.SH "GLOSSARY"
5254.IX Header "GLOSSARY" 5751.IX Header "GLOSSARY"
5255.IP "active" 4 5752.IP "active" 4
5256.IX Item "active" 5753.IX Item "active"
5257A watcher is active as long as it has been started and not yet stopped. 5754A watcher is active as long as it has been started and not yet stopped.
5258See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5755See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5259.IP "application" 4 5756.IP "application" 4
5260.IX Item "application" 5757.IX Item "application"
5261In this document, an application is whatever is using libev. 5758In this document, an application is whatever is using libev.
5262.IP "backend" 4 5759.IP "backend" 4
5263.IX Item "backend" 5760.IX Item "backend"
5290The model used to describe how an event loop handles and processes 5787The model used to describe how an event loop handles and processes
5291watchers and events. 5788watchers and events.
5292.IP "pending" 4 5789.IP "pending" 4
5293.IX Item "pending" 5790.IX Item "pending"
5294A watcher is pending as soon as the corresponding event has been 5791A watcher is pending as soon as the corresponding event has been
5295detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5792detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5296.IP "real time" 4 5793.IP "real time" 4
5297.IX Item "real time" 5794.IX Item "real time"
5298The physical time that is observed. It is apparently strictly monotonic :) 5795The physical time that is observed. It is apparently strictly monotonic :)
5299.IP "wall-clock time" 4 5796.IP "wall-clock time" 4
5300.IX Item "wall-clock time" 5797.IX Item "wall-clock time"
5301The time and date as shown on clocks. Unlike real time, it can actually 5798The time and date as shown on clocks. Unlike real time, it can actually
5302be wrong and jump forwards and backwards, e.g. when the you adjust your 5799be wrong and jump forwards and backwards, e.g. when you adjust your
5303clock. 5800clock.
5304.IP "watcher" 4 5801.IP "watcher" 4
5305.IX Item "watcher" 5802.IX Item "watcher"
5306A data structure that describes interest in certain events. Watchers need 5803A data structure that describes interest in certain events. Watchers need
5307to be started (attached to an event loop) before they can receive events. 5804to be started (attached to an event loop) before they can receive events.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines