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.126 by root, Sat Jun 3 08:53:03 2023 UTC

1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) 1.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
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 "2023-05-15" "libev-4.33" "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
708it's really slow, but it still scales very well (O(active_fds)). 807Solaris, it'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
712descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend 811descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
713might perform better. 812might perform better.
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.
970\& \- Queue all expired timers. 1087\& \- Queue all expired timers.
971\& \- Queue all expired periodics. 1088\& \- Queue all expired periodics.
972\& \- Queue all idle watchers with priority higher than that of pending events. 1089\& \- Queue all idle watchers with priority higher than that of pending events.
973\& \- Queue all check watchers. 1090\& \- Queue all check watchers.
974\& \- Call all queued watchers in reverse order (i.e. check watchers first). 1091\& \- Call all queued watchers in reverse order (i.e. check watchers first).
975\& Signals and child watchers are implemented as I/O watchers, and will 1092\& Signals, async and child watchers are implemented as I/O watchers, and
976\& be handled here by queueing them when their watcher gets executed. 1093\& will be handled here by queueing them when their watcher gets executed.
977\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT 1094\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
978\& were used, or there are no active watchers, goto FINISH, otherwise 1095\& were used, or there are no active watchers, goto FINISH, otherwise
979\& continue with step LOOP. 1096\& continue with step LOOP.
980\& FINISH: 1097\& FINISH:
981\& \- Reset the ev_break status iff it was EVBREAK_ONE. 1098\& \- Reset the ev_break status iff it was EVBREAK_ONE.
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.
1231with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher 1349with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher
1232*)\*(C'\fR), and you can stop watching for events at any time by calling the 1350*)\*(C'\fR), and you can stop watching for events at any time by calling the
1233corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR. 1351corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR.
1234.PP 1352.PP
1235As long as your watcher is active (has been started but not stopped) you 1353As long as your watcher is active (has been started but not stopped) you
1236must not touch the values stored in it. Most specifically you must never 1354must not touch the values stored in it except when explicitly documented
1237reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro. 1355otherwise. Most specifically you must never reinitialise it or call its
1356\&\f(CW\*(C`ev_TYPE_set\*(C'\fR macro.
1238.PP 1357.PP
1239Each and every callback receives the event loop pointer as first, the 1358Each and every callback receives the event loop pointer as first, the
1240registered watcher structure as second, and a bitset of received events as 1359registered watcher structure as second, and a bitset of received events as
1241third argument. 1360third argument.
1242.PP 1361.PP
1283.PD 0 1402.PD 0
1284.ie n .IP """EV_CHECK""" 4 1403.ie n .IP """EV_CHECK""" 4
1285.el .IP "\f(CWEV_CHECK\fR" 4 1404.el .IP "\f(CWEV_CHECK\fR" 4
1286.IX Item "EV_CHECK" 1405.IX Item "EV_CHECK"
1287.PD 1406.PD
1288All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts 1407All \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 1408gather 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 1409just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1410for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1411watchers invoked before the event loop sleeps or polls for new events, and
1412\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1413or lower priority within an event loop iteration.
1414.Sp
1291received events. Callbacks of both watcher types can start and stop as 1415Callbacks 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 1416they 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 1417\&\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). 1418blocking).
1295.ie n .IP """EV_EMBED""" 4 1419.ie n .IP """EV_EMBED""" 4
1296.el .IP "\f(CWEV_EMBED\fR" 4 1420.el .IP "\f(CWEV_EMBED\fR" 4
1297.IX Item "EV_EMBED" 1421.IX Item "EV_EMBED"
1298The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1422The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1299.ie n .IP """EV_FORK""" 4 1423.ie n .IP """EV_FORK""" 4
1328bug in your program. 1452bug in your program.
1329.Sp 1453.Sp
1330Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1454Libev 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 1455example 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 1456callbacks 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 1457the 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 1458programs, though, as the fd could already be closed and reused for another
1335thing, so beware. 1459thing, so beware.
1336.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1460.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1337.IX Subsection "GENERIC WATCHER FUNCTIONS" 1461.IX Subsection "GENERIC WATCHER FUNCTIONS"
1338.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1462.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1339.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1463.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1340.IX Item "ev_init (ev_TYPE *watcher, callback)" 1464.IX Item "ev_init (ev_TYPE *watcher, callback)"
1341This macro initialises the generic portion of a watcher. The contents 1465This macro initialises the generic portion of a watcher. The contents
1408therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. 1532therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
1409.IP "bool ev_is_active (ev_TYPE *watcher)" 4 1533.IP "bool ev_is_active (ev_TYPE *watcher)" 4
1410.IX Item "bool ev_is_active (ev_TYPE *watcher)" 1534.IX Item "bool ev_is_active (ev_TYPE *watcher)"
1411Returns a true value iff the watcher is active (i.e. it has been started 1535Returns a true value iff the watcher is active (i.e. it has been started
1412and not yet been stopped). As long as a watcher is active you must not modify 1536and not yet been stopped). As long as a watcher is active you must not modify
1413it. 1537it unless documented otherwise.
1538.Sp
1539Obviously, it is safe to call this on an active watcher, or actually any
1540watcher that is initialised.
1414.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 1541.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
1415.IX Item "bool ev_is_pending (ev_TYPE *watcher)" 1542.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
1416Returns a true value iff the watcher is pending, (i.e. it has outstanding 1543Returns a true value iff the watcher is pending, (i.e. it has outstanding
1417events but its callback has not yet been invoked). As long as a watcher 1544events but its callback has not yet been invoked). As long as a watcher
1418is pending (but not active) you must not call an init function on it (but 1545is pending (but not active) you must not call an init function on it (but
1419\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must 1546\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
1420make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR 1547make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1421it). 1548it).
1549.Sp
1550It is safe to call this on any watcher in any state as long as it is
1551initialised.
1422.IP "callback ev_cb (ev_TYPE *watcher)" 4 1552.IP "callback ev_cb (ev_TYPE *watcher)" 4
1423.IX Item "callback ev_cb (ev_TYPE *watcher)" 1553.IX Item "callback ev_cb (ev_TYPE *watcher)"
1424Returns the callback currently set on the watcher. 1554Returns the callback currently set on the watcher.
1425.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1555.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
1426.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1556.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
1427Change the callback. You can change the callback at virtually any time 1557Change the callback. You can change the callback at virtually any time
1428(modulo threads). 1558(modulo threads).
1429.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 1559.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1430.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" 1560.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1431.PD 0 1561.PD 0
1439from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). 1569from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
1440.Sp 1570.Sp
1441If you need to suppress invocation when higher priority events are pending 1571If you need to suppress invocation when higher priority events are pending
1442you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. 1572you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
1443.Sp 1573.Sp
1444You \fImust not\fR change the priority of a watcher as long as it is active or 1574You \fImust not\fR change the priority of a watcher as long as it is active
1445pending. 1575or pending. Reading the priority with \f(CW\*(C`ev_priority\*(C'\fR is fine in any state.
1446.Sp 1576.Sp
1447Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is 1577Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
1448fine, as long as you do not mind that the priority value you query might 1578fine, as long as you do not mind that the priority value you query might
1449or might not have been clamped to the valid range. 1579or might not have been clamped to the valid range.
1450.Sp 1580.Sp
1451The default priority used by watchers when no priority has been set is 1581The 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 :). 1582always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1453.Sp 1583.Sp
1454See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1584See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1455priorities. 1585priorities.
1456.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1586.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1457.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1587.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 1588Invoke 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 1589\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1469callback to be invoked, which can be accomplished with this function. 1599callback to be invoked, which can be accomplished with this function.
1470.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4 1600.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4
1471.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 1601.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)"
1472Feeds the given event set into the event loop, as if the specified event 1602Feeds the given event set into the event loop, as if the specified event
1473had happened for the specified watcher (which must be a pointer to an 1603had happened for the specified watcher (which must be a pointer to an
1474initialised but not necessarily started event watcher). Obviously you must 1604initialised but not necessarily started event watcher, though it can be
1475not free the watcher as long as it has pending events. 1605active). Obviously you must not free the watcher as long as it has pending
1606events.
1476.Sp 1607.Sp
1477Stopping the watcher, letting libev invoke it, or calling 1608Stopping the watcher, letting libev invoke it, or calling
1478\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was 1609\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was
1479not started in the first place. 1610not started in the first place.
1480.Sp 1611.Sp
1481See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related 1612See 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. 1613functions that do not need a watcher.
1483.PP 1614.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 1615See 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. 1616OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1486.SS "\s-1WATCHER\s0 \s-1STATES\s0" 1617.SS "\s-1WATCHER STATES\s0"
1487.IX Subsection "WATCHER STATES" 1618.IX Subsection "WATCHER STATES"
1488There are various watcher states mentioned throughout this manual \- 1619There are various watcher states mentioned throughout this manual \-
1489active, pending and so on. In this section these states and the rules to 1620active, 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 1621transition between them will be described in more detail \- and while these
1491rules might look complicated, they usually do \*(L"the right thing\*(R". 1622rules might look complicated, they usually do \*(L"the right thing\*(R".
1492.IP "initialiased" 4 1623.IP "initialised" 4
1493.IX Item "initialiased" 1624.IX Item "initialised"
1494Before a watcher can be registered with the event looop it has to be 1625Before 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 1626initialised. 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. 1627\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1497.Sp 1628.Sp
1498In this state it is simply some block of memory that is suitable for 1629In 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 1630use in an event loop. It can be moved around, freed, reused etc. at
1501\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again. 1632\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again.
1502.IP "started/running/active" 4 1633.IP "started/running/active" 4
1503.IX Item "started/running/active" 1634.IX Item "started/running/active"
1504Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes 1635Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1505property of the event loop, and is actively waiting for events. While in 1636property of the event loop, and is actively waiting for events. While in
1506this state it cannot be accessed (except in a few documented ways), moved, 1637this state it cannot be accessed (except in a few documented ways, such as
1507freed or anything else \- the only legal thing is to keep a pointer to it, 1638stoping it), moved, freed or anything else \- the only legal thing is to
1508and call libev functions on it that are documented to work on active watchers. 1639keep a pointer to it, and call libev functions on it that are documented
1640to work on active watchers.
1641.Sp
1642As a rule of thumb, before accessing a member or calling any function on
1643a watcher, it should be stopped (or freshly initialised). If that is not
1644convenient, you can check the documentation for that function or member to
1645see if it is safe to use on an active watcher.
1509.IP "pending" 4 1646.IP "pending" 4
1510.IX Item "pending" 1647.IX Item "pending"
1511If a watcher is active and libev determines that an event it is interested 1648If a watcher is active and libev determines that an event it is interested
1512in has occurred (such as a timer expiring), it will become pending. It will 1649in has occurred (such as a timer expiring), it will become pending. It
1513stay in this pending state until either it is stopped or its callback is 1650will stay in this pending state until either it is explicitly stopped or
1514about to be invoked, so it is not normally pending inside the watcher 1651its callback is about to be invoked, so it is not normally pending inside
1515callback. 1652the watcher callback.
1516.Sp 1653.Sp
1517The watcher might or might not be active while it is pending (for example, 1654Generally, the watcher might or might not be active while it is pending
1518an expired non-repeating timer can be pending but no longer active). If it 1655(for example, an expired non-repeating timer can be pending but no longer
1519is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR), 1656active). If it is pending but not active, it can be freely accessed (e.g.
1520but it is still property of the event loop at this time, so cannot be 1657by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR), but it is still property of the event loop at
1521moved, freed or reused. And if it is active the rules described in the 1658this time, so cannot be moved, freed or reused. And if it is active the
1522previous item still apply. 1659rules described in the previous item still apply.
1660.Sp
1661Explicitly stopping a watcher will also clear the pending state
1662unconditionally, so it is safe to stop a watcher and then free it.
1523.Sp 1663.Sp
1524It is also possible to feed an event on a watcher that is not active (e.g. 1664It is also possible to feed an event on a watcher that is not active (e.g.
1525via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being 1665via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being
1526active. 1666active.
1527.IP "stopped" 4 1667.IP "stopped" 4
1534.Sp 1674.Sp
1535While stopped (and not pending) the watcher is essentially in the 1675While stopped (and not pending) the watcher is essentially in the
1536initialised state, that is, it can be reused, moved, modified in any way 1676initialised 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 1677you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1538it again). 1678it again).
1539.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1679.SS "\s-1WATCHER PRIORITY MODELS\s0"
1540.IX Subsection "WATCHER PRIORITY MODELS" 1680.IX Subsection "WATCHER PRIORITY MODELS"
1541Many event loops support \fIwatcher priorities\fR, which are usually small 1681Many event loops support \fIwatcher priorities\fR, which are usually small
1542integers that influence the ordering of event callback invocation 1682integers that influence the ordering of event callback invocation
1543between watchers in some way, all else being equal. 1683between watchers in some way, all else being equal.
1544.PP 1684.PP
1545In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its 1685In 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 1686description for the more technical details such as the actual priority
1547range. 1687range.
1548.PP 1688.PP
1549There are two common ways how these these priorities are being interpreted 1689There are two common ways how these these priorities are being interpreted
1550by event loops: 1690by event loops:
1644.IX Header "WATCHER TYPES" 1784.IX Header "WATCHER TYPES"
1645This section describes each watcher in detail, but will not repeat 1785This section describes each watcher in detail, but will not repeat
1646information given in the last section. Any initialisation/set macros, 1786information given in the last section. Any initialisation/set macros,
1647functions and members specific to the watcher type are explained. 1787functions and members specific to the watcher type are explained.
1648.PP 1788.PP
1649Members are additionally marked with either \fI[read\-only]\fR, meaning that, 1789Most 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 1790that, 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 1791some 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 1792the 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 1793means you can expect it to have some sensible content while the watcher is
1654is active, but you can also modify it. Modifying it may not do something 1794active, but you can also modify it (within the same thread as the event
1795loop, i.e. without creating data races). Modifying it may not do something
1655sensible or take immediate effect (or do anything at all), but libev will 1796sensible or take immediate effect (or do anything at all), but libev will
1656not crash or malfunction in any way. 1797not crash or malfunction in any way.
1798.PP
1799In any case, the documentation for each member will explain what the
1800effects are, and if there are any additional access restrictions.
1657.ie n .SS """ev_io"" \- is this file descriptor readable or writable?" 1801.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?" 1802.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?" 1803.IX Subsection "ev_io - is this file descriptor readable or writable?"
1660I/O watchers check whether a file descriptor is readable or writable 1804I/O watchers check whether a file descriptor is readable or writable
1661in each iteration of the event loop, or, more precisely, when reading 1805in each iteration of the event loop, or, more precisely, when reading
1689But really, best use non-blocking mode. 1833But really, best use non-blocking mode.
1690.PP 1834.PP
1691\fIThe special problem of disappearing file descriptors\fR 1835\fIThe special problem of disappearing file descriptors\fR
1692.IX Subsection "The special problem of disappearing file descriptors" 1836.IX Subsection "The special problem of disappearing file descriptors"
1693.PP 1837.PP
1694Some backends (e.g. kqueue, epoll) need to be told about closing a file 1838Some 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, 1839a 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 1840means, 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 1841file descriptor, but when it goes away, the operating system will silently
1698this interest. If another file descriptor with the same number then is 1842drop 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 1843is registered with libev, there is no efficient way to see that this is,
1700fact, a different file descriptor. 1844in fact, a different file descriptor.
1701.PP 1845.PP
1702To avoid having to explicitly tell libev about such cases, libev follows 1846To 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 1847the 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 1848will assume that this is potentially a new file descriptor, otherwise
1705it is assumed that the file descriptor stays the same. That means that 1849it is assumed that the file descriptor stays the same. That means that
1742wish to read \- you would first have to request some data. 1886wish to read \- you would first have to request some data.
1743.PP 1887.PP
1744Since files are typically not-so-well supported by advanced notification 1888Since files are typically not-so-well supported by advanced notification
1745mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect 1889mechanism, 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 1890to 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 1891convenience: 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 1892usually 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 1893(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 1894\&\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 1895asynchronous I/O instead of with non-blocking I/O, it is still useful when
1752it \*(L"just works\*(R" instead of freezing. 1896it \*(L"just works\*(R" instead of freezing.
1753.PP 1897.PP
1754So avoid file descriptors pointing to files when you know it (e.g. use 1898So 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 1899libeio), 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 1900when you rarely read from a file instead of from a socket, and want to
1757reuse the same code path. 1901reuse the same code path.
1758.PP 1902.PP
1759\fIThe special problem of fork\fR 1903\fIThe special problem of fork\fR
1760.IX Subsection "The special problem of fork" 1904.IX Subsection "The special problem of fork"
1761.PP 1905.PP
1762Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1906Some 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 1907at 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. 1908to be told about it in the child if you want to continue to use it in the
1909child.
1765.PP 1910.PP
1766To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork 1911To 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 1912()\*(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. 1913\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1769.PP 1914.PP
1770\fIThe special problem of \s-1SIGPIPE\s0\fR 1915\fIThe special problem of \s-1SIGPIPE\s0\fR
1771.IX Subsection "The special problem of SIGPIPE" 1916.IX Subsection "The special problem of SIGPIPE"
1772.PP 1917.PP
1773While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1918While 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 1919when 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 1920sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1776this is sensible behaviour, for daemons, this is usually undesirable. 1921this is sensible behaviour, for daemons, this is usually undesirable.
1777.PP 1922.PP
1778So when you encounter spurious, unexplained daemon exits, make sure you 1923So 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 1924ignore \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). 1925somewhere, as that would have given you a big clue).
1781.PP 1926.PP
1782\fIThe special problem of \fIaccept()\fIing when you can't\fR 1927\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" 1928.IX Subsection "The special problem of accept()ing when you can't"
1784.PP 1929.PP
1785Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, 1930Many 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 1931found in post\-2004 Linux) have the peculiar behaviour of not removing a
1787connection from the pending queue in all error cases. 1932connection from the pending queue in all error cases.
1826.PD 0 1971.PD 0
1827.IP "ev_io_set (ev_io *, int fd, int events)" 4 1972.IP "ev_io_set (ev_io *, int fd, int events)" 4
1828.IX Item "ev_io_set (ev_io *, int fd, int events)" 1973.IX Item "ev_io_set (ev_io *, int fd, int events)"
1829.PD 1974.PD
1830Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1975Configures 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 1976receive 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, both
1832\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events. 1977\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR or \f(CW0\fR, to express the desire to receive the given
1978events.
1979.Sp
1980Note that setting the \f(CW\*(C`events\*(C'\fR to \f(CW0\fR and starting the watcher is
1981supported, but not specially optimized \- if your program sometimes happens
1982to generate this combination this is fine, but if it is easy to avoid
1983starting an io watcher watching for no events you should do so.
1984.IP "ev_io_modify (ev_io *, int events)" 4
1985.IX Item "ev_io_modify (ev_io *, int events)"
1986Similar to \f(CW\*(C`ev_io_set\*(C'\fR, but only changes the requested events. Using this
1987might be faster with some backends, as libev can assume that the \f(CW\*(C`fd\*(C'\fR
1988still refers to the same underlying file description, something it cannot
1989do when using \f(CW\*(C`ev_io_set\*(C'\fR.
1833.IP "int fd [read\-only]" 4 1990.IP "int fd [no\-modify]" 4
1834.IX Item "int fd [read-only]" 1991.IX Item "int fd [no-modify]"
1835The file descriptor being watched. 1992The file descriptor being watched. While it can be read at any time, you
1993must not modify this member even when the watcher is stopped \- always use
1994\&\f(CW\*(C`ev_io_set\*(C'\fR for that.
1836.IP "int events [read\-only]" 4 1995.IP "int events [no\-modify]" 4
1837.IX Item "int events [read-only]" 1996.IX Item "int events [no-modify]"
1838The events being watched. 1997The set of events the fd is being watched for, among other flags. Remember
1998that this is a bit set \- to test for \f(CW\*(C`EV_READ\*(C'\fR, use \f(CW\*(C`w\->events &
1999EV_READ\*(C'\fR, and similarly for \f(CW\*(C`EV_WRITE\*(C'\fR.
2000.Sp
2001As with \f(CW\*(C`fd\*(C'\fR, you must not modify this member even when the watcher is
2002stopped, always use \f(CW\*(C`ev_io_set\*(C'\fR or \f(CW\*(C`ev_io_modify\*(C'\fR for that.
1839.PP 2003.PP
1840\fIExamples\fR 2004\fIExamples\fR
1841.IX Subsection "Examples" 2005.IX Subsection "Examples"
1842.PP 2006.PP
1843Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 2007Example: 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 2035detecting time jumps is hard, and some inaccuracies are unavoidable (the
1872monotonic clock option helps a lot here). 2036monotonic clock option helps a lot here).
1873.PP 2037.PP
1874The callback is guaranteed to be invoked only \fIafter\fR its timeout has 2038The 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 2039passed (not \fIat\fR, so on systems with very low-resolution clocks this
1876might introduce a small delay). If multiple timers become ready during the 2040might introduce a small delay, see \*(L"the special problem of being too
2041early\*(R", below). If multiple timers become ready during the same loop
1877same loop iteration then the ones with earlier time-out values are invoked 2042iteration 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 2043ones 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). 2044longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1880.PP 2045.PP
1881\fIBe smart about timeouts\fR 2046\fIBe smart about timeouts\fR
1882.IX Subsection "Be smart about timeouts" 2047.IX Subsection "Be smart about timeouts"
1883.PP 2048.PP
1884Many real-world problems involve some kind of timeout, usually for error 2049Many real-world problems involve some kind of timeout, usually for error
1966.Sp 2131.Sp
1967In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, 2132In 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 2133but remember the time of last activity, and check for a real timeout only
1969within the callback: 2134within the callback:
1970.Sp 2135.Sp
1971.Vb 1 2136.Vb 3
2137\& ev_tstamp timeout = 60.;
1972\& ev_tstamp last_activity; // time of last activity 2138\& ev_tstamp last_activity; // time of last activity
2139\& ev_timer timer;
1973\& 2140\&
1974\& static void 2141\& static void
1975\& callback (EV_P_ ev_timer *w, int revents) 2142\& callback (EV_P_ ev_timer *w, int revents)
1976\& { 2143\& {
1977\& ev_tstamp now = ev_now (EV_A); 2144\& // calculate when the timeout would happen
1978\& ev_tstamp timeout = last_activity + 60.; 2145\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
1979\& 2146\&
1980\& // if last_activity + 60. is older than now, we did time out 2147\& // if negative, it means we the timeout already occurred
1981\& if (timeout < now) 2148\& if (after < 0.)
1982\& { 2149\& {
1983\& // timeout occurred, take action 2150\& // timeout occurred, take action
1984\& } 2151\& }
1985\& else 2152\& else
1986\& { 2153\& {
1987\& // callback was invoked, but there was some activity, re\-arm 2154\& // callback was invoked, but there was some recent
1988\& // the watcher to fire in last_activity + 60, which is 2155\& // activity. simply restart the timer to time out
1989\& // guaranteed to be in the future, so "again" is positive: 2156\& // after "after" seconds, which is the earliest time
1990\& w\->repeat = timeout \- now; 2157\& // the timeout can occur.
2158\& ev_timer_set (w, after, 0.);
1991\& ev_timer_again (EV_A_ w); 2159\& ev_timer_start (EV_A_ w);
1992\& } 2160\& }
1993\& } 2161\& }
1994.Ve 2162.Ve
1995.Sp 2163.Sp
1996To summarise the callback: first calculate the real timeout (defined 2164To 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 2165timeout will occur (by calculating the absolute time when it would occur,
1998been reached, which means something \fIdid\fR, in fact, time out. Otherwise 2166\&\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 2167(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 2168.Sp
2003Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the 2169If 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. 2170timed out, and need to do whatever is needed in this case.
2171.Sp
2172Otherwise, we now the earliest time at which the timeout would trigger,
2173and simply start the timer with this timeout value.
2174.Sp
2175In other words, each time the callback is invoked it will check whether
2176the timeout occurred. If not, it will simply reschedule itself to check
2177again at the earliest time it could time out. Rinse. Repeat.
2005.Sp 2178.Sp
2006This scheme causes more callback invocations (about one every 60 seconds 2179This scheme causes more callback invocations (about one every 60 seconds
2007minus half the average time between activity), but virtually no calls to 2180minus half the average time between activity), but virtually no calls to
2008libev to change the timeout. 2181libev to change the timeout.
2009.Sp 2182.Sp
2010To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR 2183To start the machinery, simply initialise the watcher and set
2011to the current time (meaning we just have some activity :), then call the 2184\&\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: 2185now), then call the callback, which will \*(L"do the right thing\*(R" and start
2186the timer:
2013.Sp 2187.Sp
2014.Vb 3 2188.Vb 3
2189\& last_activity = ev_now (EV_A);
2015\& ev_init (timer, callback); 2190\& ev_init (&timer, callback);
2016\& last_activity = ev_now (loop); 2191\& callback (EV_A_ &timer, 0);
2017\& callback (loop, timer, EV_TIMER);
2018.Ve 2192.Ve
2019.Sp 2193.Sp
2020And when there is some activity, simply store the current time in 2194When there is some activity, simply store the current time in
2021\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: 2195\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
2022.Sp 2196.Sp
2023.Vb 1 2197.Vb 2
2198\& if (activity detected)
2024\& last_activity = ev_now (loop); 2199\& last_activity = ev_now (EV_A);
2200.Ve
2201.Sp
2202When your timeout value changes, then the timeout can be changed by simply
2203providing a new value, stopping the timer and calling the callback, which
2204will again do the right thing (for example, time out immediately :).
2205.Sp
2206.Vb 3
2207\& timeout = new_value;
2208\& ev_timer_stop (EV_A_ &timer);
2209\& callback (EV_A_ &timer, 0);
2025.Ve 2210.Ve
2026.Sp 2211.Sp
2027This technique is slightly more complex, but in most cases where the 2212This technique is slightly more complex, but in most cases where the
2028time-out is unlikely to be triggered, much more efficient. 2213time-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 2214.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." 2215.IX Item "4. Wee, just use a double-linked list for your timeouts."
2035If there is not one request, but many thousands (millions...), all 2216If there is not one request, but many thousands (millions...), all
2036employing some kind of timeout with the same timeout value, then one can 2217employing some kind of timeout with the same timeout value, then one can
2037do even better: 2218do even better:
2061Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2242Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
2062rather complicated, but extremely efficient, something that really pays 2243rather complicated, but extremely efficient, something that really pays
2063off after the first million or so of active timers, i.e. it's usually 2244off after the first million or so of active timers, i.e. it's usually
2064overkill :) 2245overkill :)
2065.PP 2246.PP
2247\fIThe special problem of being too early\fR
2248.IX Subsection "The special problem of being too early"
2249.PP
2250If you ask a timer to call your callback after three seconds, then
2251you expect it to be invoked after three seconds \- but of course, this
2252cannot be guaranteed to infinite precision. Less obviously, it cannot be
2253guaranteed to any precision by libev \- imagine somebody suspending the
2254process with a \s-1STOP\s0 signal for a few hours for example.
2255.PP
2256So, libev tries to invoke your callback as soon as possible \fIafter\fR the
2257delay has occurred, but cannot guarantee this.
2258.PP
2259A less obvious failure mode is calling your callback too early: many event
2260loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but
2261this can cause your callback to be invoked much earlier than you would
2262expect.
2263.PP
2264To see why, imagine a system with a clock that only offers full second
2265resolution (think windows if you can't come up with a broken enough \s-1OS\s0
2266yourself). If you schedule a one-second timer at the time 500.9, then the
2267event loop will schedule your timeout to elapse at a system time of 500
2268(500.9 truncated to the resolution) + 1, or 501.
2269.PP
2270If an event library looks at the timeout 0.1s later, it will see \*(L"501 >=
2271501\*(R" and invoke the callback 0.1s after it was started, even though a
2272one-second delay was requested \- this is being \*(L"too early\*(R", despite best
2273intentions.
2274.PP
2275This is the reason why libev will never invoke the callback if the elapsed
2276delay equals the requested delay, but only when the elapsed delay is
2277larger than the requested delay. In the example above, libev would only invoke
2278the callback at system time 502, or 1.1s after the timer was started.
2279.PP
2280So, while libev cannot guarantee that your callback will be invoked
2281exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested
2282delay has actually elapsed, or in other words, it always errs on the \*(L"too
2283late\*(R" side of things.
2284.PP
2066\fIThe special problem of time updates\fR 2285\fIThe special problem of time updates\fR
2067.IX Subsection "The special problem of time updates" 2286.IX Subsection "The special problem of time updates"
2068.PP 2287.PP
2069Establishing the current time is a costly operation (it usually takes at 2288Establishing the current time is a costly operation (it usually takes
2070least two system calls): \s-1EV\s0 therefore updates its idea of the current 2289at 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 2290time 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 2291growing 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. 2292lots of events in one iteration.
2074.PP 2293.PP
2075The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2294The 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 2295time. This is usually the right thing as this timestamp refers to the time
2077of the event triggering whatever timeout you are modifying/starting. If 2296of the event triggering whatever timeout you are modifying/starting. If
2078you suspect event processing to be delayed and you \fIneed\fR to base the 2297you 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: 2298timeout on the current time, use something like the following to adjust
2299for it:
2080.PP 2300.PP
2081.Vb 1 2301.Vb 1
2082\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 2302\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
2083.Ve 2303.Ve
2084.PP 2304.PP
2085If the event loop is suspended for a long time, you can also force an 2305If 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 2306update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
2087()\*(C'\fR. 2307()\*(C'\fR, although that will push the event time of all outstanding events
2308further into the future.
2309.PP
2310\fIThe special problem of unsynchronised clocks\fR
2311.IX Subsection "The special problem of unsynchronised clocks"
2312.PP
2313Modern systems have a variety of clocks \- libev itself uses the normal
2314\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time
2315jumps).
2316.PP
2317Neither of these clocks is synchronised with each other or any other clock
2318on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time
2319than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example,
2320a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher
2321than a directly following call to \f(CW\*(C`time\*(C'\fR.
2322.PP
2323The moral of this is to only compare libev-related timestamps with
2324\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than
2325a second or so.
2326.PP
2327One more problem arises due to this lack of synchronisation: if libev uses
2328the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR
2329or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is
2330invoked, you will find that sometimes the callback is a bit \*(L"early\*(R".
2331.PP
2332This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so
2333libev makes sure your callback is not invoked before the delay happened,
2334\&\fImeasured according to the real time\fR, not the system clock.
2335.PP
2336If your timeouts are based on a physical timescale (e.g. \*(L"time out this
2337connection after 100 seconds\*(R") then this shouldn't bother you as it is
2338exactly the right behaviour.
2339.PP
2340If you want to compare wall clock/system timestamps to your timers, then
2341you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock
2342time, where your comparisons will always generate correct results.
2088.PP 2343.PP
2089\fIThe special problems of suspended animation\fR 2344\fIThe special problems of suspended animation\fR
2090.IX Subsection "The special problems of suspended animation" 2345.IX Subsection "The special problems of suspended animation"
2091.PP 2346.PP
2092When you leave the server world it is quite customary to hit machines that 2347When 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)" 2378.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
2124.PD 0 2379.PD 0
2125.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2380.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)" 2381.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
2127.PD 2382.PD
2128Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR 2383Configure 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 2384negative 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 2385automatically 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, 2386then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
2132until stopped manually. 2387seconds later, again, and again, until stopped manually.
2133.Sp 2388.Sp
2134The timer itself will do a best-effort at avoiding drift, that is, if 2389The 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 2390you configure a timer to trigger every 10 seconds, then it will normally
2136trigger at exactly 10 second intervals. If, however, your program cannot 2391trigger at exactly 10 second intervals. If, however, your program cannot
2137keep up with the timer (because it takes longer than those 10 seconds to 2392keep 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. 2393do stuff) the timer will not fire more than once per event loop iteration.
2139.IP "ev_timer_again (loop, ev_timer *)" 4 2394.IP "ev_timer_again (loop, ev_timer *)" 4
2140.IX Item "ev_timer_again (loop, ev_timer *)" 2395.IX Item "ev_timer_again (loop, ev_timer *)"
2141This will act as if the timer timed out and restart it again if it is 2396This will act as if the timer timed out, and restarts it again if it is
2142repeating. The exact semantics are: 2397repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the
2398timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR.
2143.Sp 2399.Sp
2400The exact semantics are as in the following rules, all of which will be
2401applied to the watcher:
2402.RS 4
2144If the timer is pending, its pending status is cleared. 2403.IP "If the timer is pending, the pending status is always cleared." 4
2145.Sp 2404.IX Item "If the timer is pending, the pending status is always cleared."
2405.PD 0
2146If the timer is started but non-repeating, stop it (as if it timed out). 2406.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4
2147.Sp 2407.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 2408.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. 2409.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4
2410.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary."
2411.RE
2412.RS 4
2413.PD
2150.Sp 2414.Sp
2151This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a 2415This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
2152usage example. 2416usage example.
2417.RE
2153.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4 2418.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
2154.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 2419.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
2155Returns the remaining time until a timer fires. If the timer is active, 2420Returns 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 2421then this time is relative to the current event loop time, otherwise it's
2157the timeout value currently configured. 2422the timeout value currently configured.
2209Periodic watchers are also timers of a kind, but they are very versatile 2474Periodic watchers are also timers of a kind, but they are very versatile
2210(and unfortunately a bit complex). 2475(and unfortunately a bit complex).
2211.PP 2476.PP
2212Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or 2477Unlike \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 2478relative 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 2479(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 2480difference 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 2481time, and time jumps are not uncommon (e.g. when you adjust your
2217wrist-watch). 2482wrist-watch).
2218.PP 2483.PP
2219You can tell a periodic watcher to trigger after some specific point 2484You 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 2489\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2225it, as it uses a relative timeout). 2490it, as it uses a relative timeout).
2226.PP 2491.PP
2227\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex 2492\&\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 2493timers, 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 2494other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2230those cannot react to time jumps. 2495watchers, as those cannot react to time jumps.
2231.PP 2496.PP
2232As with timers, the callback is guaranteed to be invoked only when the 2497As 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 2498point in time where it is supposed to trigger has passed. If multiple
2234timers become ready during the same loop iteration then the ones with 2499timers become ready during the same loop iteration then the ones with
2235earlier time-out values are invoked before ones with later time-out values 2500earlier time-out values are invoked before ones with later time-out values
2277.Sp 2542.Sp
2278Another way to think about it (for the mathematically inclined) is that 2543Another 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 2544\&\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. 2545time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
2281.Sp 2546.Sp
2282For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near 2547The \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 2548interval 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. 2549microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have
2550at most a similar magnitude as the current time (say, within a factor of
2551ten). Typical values for offset are, in fact, \f(CW0\fR or something between
2552\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range.
2285.Sp 2553.Sp
2286Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 2554Note 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 2555speed 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 2556will 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). 2557millisecond (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 2561In 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 2562ignored. Instead, each time the periodic watcher gets scheduled, the
2295reschedule callback will be called with the watcher as first, and the 2563reschedule callback will be called with the watcher as first, and the
2296current time as second argument. 2564current time as second argument.
2297.Sp 2565.Sp
2298\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2566\&\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 2567or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2300allowed by documentation here\fR. 2568allowed by documentation here\fR.
2301.Sp 2569.Sp
2302If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2570If 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 2571it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2321.Sp 2589.Sp
2322\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2590\&\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. 2591equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2324.Sp 2592.Sp
2325This can be used to create very complex timers, such as a timer that 2593This 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 2594triggers 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 2595the 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 2596this. Here is a (completely untested, no error checking) example on how to
2329reason I omitted it as an example). 2597do this:
2598.Sp
2599.Vb 1
2600\& #include <time.h>
2601\&
2602\& static ev_tstamp
2603\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2604\& {
2605\& time_t tnow = (time_t)now;
2606\& struct tm tm;
2607\& localtime_r (&tnow, &tm);
2608\&
2609\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2610\& ++tm.tm_mday; // midnight next day
2611\&
2612\& return mktime (&tm);
2613\& }
2614.Ve
2615.Sp
2616Note: this code might run into trouble on days that have more then two
2617midnights (beginning and end).
2330.RE 2618.RE
2331.RS 4 2619.RS 4
2332.RE 2620.RE
2333.IP "ev_periodic_again (loop, ev_periodic *)" 4 2621.IP "ev_periodic_again (loop, ev_periodic *)" 4
2334.IX Item "ev_periodic_again (loop, ev_periodic *)" 2622.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 2707only 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 2708default 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 2709\&\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. 2710the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2423.PP 2711.PP
2424When the first watcher gets started will libev actually register something 2712Only 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 2713register something with the kernel. It thus coexists with your own signal
2426you don't register any with libev for the same signal). 2714handlers as long as you don't register any with libev for the same signal.
2427.PP 2715.PP
2428If possible and supported, libev will install its handlers with 2716If 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 2717\&\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 2718not 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 2719interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2492The signal the watcher watches out for. 2780The signal the watcher watches out for.
2493.PP 2781.PP
2494\fIExamples\fR 2782\fIExamples\fR
2495.IX Subsection "Examples" 2783.IX Subsection "Examples"
2496.PP 2784.PP
2497Example: Try to exit cleanly on \s-1SIGINT\s0. 2785Example: Try to exit cleanly on \s-1SIGINT.\s0
2498.PP 2786.PP
2499.Vb 5 2787.Vb 5
2500\& static void 2788\& static void
2501\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2789\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2502\& { 2790\& {
2617.ie n .SS """ev_stat"" \- did the file attributes just change?" 2905.ie n .SS """ev_stat"" \- did the file attributes just change?"
2618.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2906.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2619.IX Subsection "ev_stat - did the file attributes just change?" 2907.IX Subsection "ev_stat - did the file attributes just change?"
2620This watches a file system path for attribute changes. That is, it calls 2908This 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) 2909\&\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 2910and sees if it changed compared to the last time, invoking the callback
2623it did. 2911if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2912happen after the watcher has been started will be reported.
2624.PP 2913.PP
2625The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2914The 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 2915not 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 2916exist\*(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 2917\&\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 2947compilation environment, which means that on systems with large file
2659support disabled by default, you get the 32 bit version of the stat 2948support 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 2949structure. 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 2950use 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 2951compile 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 2952obviously 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. 2953most noticeably displayed with ev_stat and large file support.
2665.PP 2954.PP
2666The solution for this is to lobby your distribution maker to make large 2955The solution for this is to lobby your distribution maker to make large
2667file interfaces available by default (as e.g. FreeBSD does) and not 2956file interfaces available by default (as e.g. FreeBSD does) and not
2668optional. Libev cannot simply switch on large file support because it has 2957optional. Libev cannot simply switch on large file support because it has
2859Apart from keeping your process non-blocking (which is a useful 3148Apart from keeping your process non-blocking (which is a useful
2860effect on its own sometimes), idle watchers are a good place to do 3149effect 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 3150\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2862event loop has handled all outstanding events. 3151event loop has handled all outstanding events.
2863.PP 3152.PP
3153\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3154.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3155.PP
3156As long as there is at least one active idle watcher, libev will never
3157sleep unnecessarily. Or in other words, it will loop as fast as possible.
3158For this to work, the idle watcher doesn't need to be invoked at all \- the
3159lowest priority will do.
3160.PP
3161This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3162to do something on each event loop iteration \- for example to balance load
3163between different connections.
3164.PP
3165See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3166example.
3167.PP
2864\fIWatcher-Specific Functions and Data Members\fR 3168\fIWatcher-Specific Functions and Data Members\fR
2865.IX Subsection "Watcher-Specific Functions and Data Members" 3169.IX Subsection "Watcher-Specific Functions and Data Members"
2866.IP "ev_idle_init (ev_idle *, callback)" 4 3170.IP "ev_idle_init (ev_idle *, callback)" 4
2867.IX Item "ev_idle_init (ev_idle *, callback)" 3171.IX Item "ev_idle_init (ev_idle *, callback)"
2868Initialises and configures the idle watcher \- it has no parameters of any 3172Initialises and configures the idle watcher \- it has no parameters of any
2873.IX Subsection "Examples" 3177.IX Subsection "Examples"
2874.PP 3178.PP
2875Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 3179Example: 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. 3180callback, free it. Also, use no error checking, as usual.
2877.PP 3181.PP
2878.Vb 7 3182.Vb 5
2879\& static void 3183\& static void
2880\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3184\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2881\& { 3185\& {
3186\& // stop the watcher
3187\& ev_idle_stop (loop, w);
3188\&
3189\& // now we can free it
2882\& free (w); 3190\& free (w);
3191\&
2883\& // now do something you wanted to do when the program has 3192\& // now do something you wanted to do when the program has
2884\& // no longer anything immediate to do. 3193\& // no longer anything immediate to do.
2885\& } 3194\& }
2886\& 3195\&
2887\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3196\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2889\& ev_idle_start (loop, idle_watcher); 3198\& ev_idle_start (loop, idle_watcher);
2890.Ve 3199.Ve
2891.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" 3200.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!" 3201.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!" 3202.IX Subsection "ev_prepare and ev_check - customise your event loop!"
2894Prepare and check watchers are usually (but not always) used in pairs: 3203Prepare and check watchers are often (but not always) used in pairs:
2895prepare watchers get invoked before the process blocks and check watchers 3204prepare watchers get invoked before the process blocks and check watchers
2896afterwards. 3205afterwards.
2897.PP 3206.PP
2898You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter 3207You \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 3208current 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 3209\&\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 3210however. 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, 3211for 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 3212\&\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. 3213kind they will always be called in pairs bracketing the blocking call.
2905.PP 3214.PP
2906Their main purpose is to integrate other event mechanisms into libev and 3215Their main purpose is to integrate other event mechanisms into libev and
2907their use is somewhat advanced. They could be used, for example, to track 3216their use is somewhat advanced. They could be used, for example, to track
2908variable changes, implement your own watchers, integrate net-snmp or a 3217variable changes, implement your own watchers, integrate net-snmp or a
2909coroutine library and lots more. They are also occasionally useful if 3218coroutine library and lots more. They are also occasionally useful if
2927with priority higher than or equal to the event loop and one coroutine 3236with 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 3237of lower priority, but only once, using idle watchers to keep the event
2929loop from blocking if lower-priority coroutines are active, thus mapping 3238loop from blocking if lower-priority coroutines are active, thus mapping
2930low-priority coroutines to idle/background tasks). 3239low-priority coroutines to idle/background tasks).
2931.PP 3240.PP
2932It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 3241When 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 3242highest (\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). 3243any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3244watchers).
2935.PP 3245.PP
2936Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not 3246Also, \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 3247activate (\*(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 3248might 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 3249\&\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 3250loops 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 3251\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
2942others). 3252others).
3253.PP
3254\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3255.IX Subsection "Abusing an ev_check watcher for its side-effect"
3256.PP
3257\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3258useful because they are called once per event loop iteration. For
3259example, if you want to handle a large number of connections fairly, you
3260normally only do a bit of work for each active connection, and if there
3261is more work to do, you wait for the next event loop iteration, so other
3262connections have a chance of making progress.
3263.PP
3264Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3265next event loop iteration. However, that isn't as soon as possible \-
3266without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3267.PP
3268This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3269single global idle watcher that is active as long as you have one active
3270\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3271will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3272invoked. Neither watcher alone can do that.
2943.PP 3273.PP
2944\fIWatcher-Specific Functions and Data Members\fR 3274\fIWatcher-Specific Functions and Data Members\fR
2945.IX Subsection "Watcher-Specific Functions and Data Members" 3275.IX Subsection "Watcher-Specific Functions and Data Members"
2946.IP "ev_prepare_init (ev_prepare *, callback)" 4 3276.IP "ev_prepare_init (ev_prepare *, callback)" 4
2947.IX Item "ev_prepare_init (ev_prepare *, callback)" 3277.IX Item "ev_prepare_init (ev_prepare *, callback)"
3058.Ve 3388.Ve
3059.PP 3389.PP
3060Method 4: Do not use a prepare or check watcher because the module you 3390Method 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 3391want to embed is not flexible enough to support it. Instead, you can
3062override their poll function. The drawback with this solution is that the 3392override 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 3393main 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 3394this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3065libglib event loop. 3395libglib event loop.
3066.PP 3396.PP
3067.Vb 4 3397.Vb 4
3068\& static gint 3398\& static gint
3152\fIWatcher-Specific Functions and Data Members\fR 3482\fIWatcher-Specific Functions and Data Members\fR
3153.IX Subsection "Watcher-Specific Functions and Data Members" 3483.IX Subsection "Watcher-Specific Functions and Data Members"
3154.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3484.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)" 3485.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
3156.PD 0 3486.PD 0
3157.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3487.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)" 3488.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
3159.PD 3489.PD
3160Configures the watcher to embed the given loop, which must be 3490Configures 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 3491embeddable. 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 3492invoked automatically, otherwise it is the responsibility of the callback
3163to invoke it (it will continue to be called until the sweep has been done, 3493to invoke it (it will continue to be called until the sweep has been done,
3182.PP 3512.PP
3183.Vb 3 3513.Vb 3
3184\& struct ev_loop *loop_hi = ev_default_init (0); 3514\& struct ev_loop *loop_hi = ev_default_init (0);
3185\& struct ev_loop *loop_lo = 0; 3515\& struct ev_loop *loop_lo = 0;
3186\& ev_embed embed; 3516\& ev_embed embed;
3187\& 3517\&
3188\& // see if there is a chance of getting one that works 3518\& // see if there is a chance of getting one that works
3189\& // (remember that a flags value of 0 means autodetection) 3519\& // (remember that a flags value of 0 means autodetection)
3190\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3520\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3191\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3521\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3192\& : 0; 3522\& : 0;
3208.PP 3538.PP
3209.Vb 3 3539.Vb 3
3210\& struct ev_loop *loop = ev_default_init (0); 3540\& struct ev_loop *loop = ev_default_init (0);
3211\& struct ev_loop *loop_socket = 0; 3541\& struct ev_loop *loop_socket = 0;
3212\& ev_embed embed; 3542\& ev_embed embed;
3213\& 3543\&
3214\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3544\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3215\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3545\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3216\& { 3546\& {
3217\& ev_embed_init (&embed, 0, loop_socket); 3547\& ev_embed_init (&embed, 0, loop_socket);
3218\& ev_embed_start (loop, &embed); 3548\& ev_embed_start (loop, &embed);
3226.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3556.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" 3557.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" 3558.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 3559Fork 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 3560whoever 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 3561\&\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, 3562and 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 3563after 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 3564and calls it in the wrong process, the fork handlers will be invoked, too,
3235handlers will be invoked, too, of course. 3565of course.
3236.PP 3566.PP
3237\fIThe special problem of life after fork \- how is it possible?\fR 3567\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?" 3568.IX Subsection "The special problem of life after fork - how is it possible?"
3239.PP 3569.PP
3240Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set 3570Most 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 3571up/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. 3572sequence should be handled by libev without any problems.
3243.PP 3573.PP
3244This changes when the application actually wants to do event handling 3574This 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 3575in 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. 3656it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3327.PP 3657.PP
3328This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3658This 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 3659too, 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 3660(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 3661\&\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 3662of \*(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, 3663signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3334even without knowing which loop owns the signal. 3664even 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 3665.PP
3339\fIQueueing\fR 3666\fIQueueing\fR
3340.IX Subsection "Queueing" 3667.IX Subsection "Queueing"
3341.PP 3668.PP
3342\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason 3669\&\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, 3764Unlike \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 3765signal 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). 3766embedding section below on what exactly this means).
3440.Sp 3767.Sp
3441Note that, as with other watchers in libev, multiple events might get 3768Note that, as with other watchers in libev, multiple events might get
3442compressed into a single callback invocation (another way to look at this 3769compressed 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, 3770this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on
3444reset when the event loop detects that). 3771\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that).
3445.Sp 3772.Sp
3446This call incurs the overhead of a system call only once per event loop 3773This 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 3774loop 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. 3775the event loop (or your program) is processing events. That means that
3776repeated calls are basically free (there is no need to avoid calls for
3777performance reasons) and that the overhead becomes smaller (typically
3778zero) under load.
3449.IP "bool = ev_async_pending (ev_async *)" 4 3779.IP "bool = ev_async_pending (ev_async *)" 4
3450.IX Item "bool = ev_async_pending (ev_async *)" 3780.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 3781Returns 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 3782watcher but the event has not yet been processed (or even noted) by the
3453event loop. 3783event loop.
3462is a time window between the event loop checking and resetting the async 3792is a time window between the event loop checking and resetting the async
3463notification, and the callback being invoked. 3793notification, and the callback being invoked.
3464.SH "OTHER FUNCTIONS" 3794.SH "OTHER FUNCTIONS"
3465.IX Header "OTHER FUNCTIONS" 3795.IX Header "OTHER FUNCTIONS"
3466There are some other functions of possible interest. Described. Here. Now. 3796There are some other functions of possible interest. Described. Here. Now.
3467.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3797.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)" 3798.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 3799This function combines a simple timer and an I/O watcher, calls your
3470callback on whichever event happens first and automatically stops both 3800callback 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 3801watchers. 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 3802or timeout without having to allocate/configure/start/stop/free one or
3473more watchers yourself. 3803more 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 3815\&\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 3816value 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 3817a timeout and an io event at the same time \- you probably should give io
3488events precedence. 3818events precedence.
3489.Sp 3819.Sp
3490Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3820Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3491.Sp 3821.Sp
3492.Vb 7 3822.Vb 7
3493\& static void stdin_ready (int revents, void *arg) 3823\& static void stdin_ready (int revents, void *arg)
3494\& { 3824\& {
3495\& if (revents & EV_READ) 3825\& if (revents & EV_READ)
3501\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3831\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3502.Ve 3832.Ve
3503.IP "ev_feed_fd_event (loop, int fd, int revents)" 4 3833.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
3504.IX Item "ev_feed_fd_event (loop, int fd, int revents)" 3834.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 3835Feed an event on the given fd, as if a file descriptor backend detected
3506the given events it. 3836the given events.
3507.IP "ev_feed_signal_event (loop, int signum)" 4 3837.IP "ev_feed_signal_event (loop, int signum)" 4
3508.IX Item "ev_feed_signal_event (loop, int signum)" 3838.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, 3839Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
3510which is async-safe. 3840which is async-safe.
3511.SH "COMMON OR USEFUL IDIOMS (OR BOTH)" 3841.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3512.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)" 3842.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3513This section explains some common idioms that are not immediately 3843This section explains some common idioms that are not immediately
3514obvious. Note that examples are sprinkled over the whole manual, and this 3844obvious. Note that examples are sprinkled over the whole manual, and this
3515section only contains stuff that wouldn't fit anywhere else. 3845section 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" 3846.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3517.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 3847.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 3848Each 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 3849or 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 3850to 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 3851don't want to allocate memory separately and store a pointer to it in that
3547\& } 3877\& }
3548.Ve 3878.Ve
3549.PP 3879.PP
3550More interesting and less C\-conformant ways of casting your callback 3880More interesting and less C\-conformant ways of casting your callback
3551function type instead have been omitted. 3881function type instead have been omitted.
3552.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0" 3882.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3553.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS" 3883.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3554Another common scenario is to use some data structure with multiple 3884Another common scenario is to use some data structure with multiple
3555embedded watchers, in effect creating your own watcher that combines 3885embedded watchers, in effect creating your own watcher that combines
3556multiple libev event sources into one \*(L"super-watcher\*(R": 3886multiple libev event sources into one \*(L"super-watcher\*(R":
3557.PP 3887.PP
3585\& { 3915\& {
3586\& struct my_biggy big = (struct my_biggy *) 3916\& struct my_biggy big = (struct my_biggy *)
3587\& (((char *)w) \- offsetof (struct my_biggy, t2)); 3917\& (((char *)w) \- offsetof (struct my_biggy, t2));
3588\& } 3918\& }
3589.Ve 3919.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" 3920.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3921.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3922Often you have structures like this in event-based programs:
3923.PP
3924.Vb 4
3925\& callback ()
3926\& {
3927\& free (request);
3928\& }
3929\&
3930\& request = start_new_request (..., callback);
3931.Ve
3932.PP
3933The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be
3934used to cancel the operation, or do other things with it.
3935.PP
3936It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that
3937immediately invoke the callback, for example, to report errors. Or you add
3938some caching layer that finds that it can skip the lengthy aspects of the
3939operation and simply invoke the callback with the result.
3940.PP
3941The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR
3942has returned, so \f(CW\*(C`request\*(C'\fR is not set.
3943.PP
3944Even if you pass the request by some safer means to the callback, you
3945might want to do something to the request after starting it, such as
3946canceling it, which probably isn't working so well when the callback has
3947already been invoked.
3948.PP
3949A common way around all these issues is to make sure that
3950\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3951\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3952delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3953example, or more sneakily, by reusing an existing (stopped) watcher and
3954pushing it into the pending queue:
3955.PP
3956.Vb 2
3957\& ev_set_cb (watcher, callback);
3958\& ev_feed_event (EV_A_ watcher, 0);
3959.Ve
3960.PP
3961This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3962invoked, while not delaying callback invocation too much.
3963.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3591.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS" 3964.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3592Often (especially in \s-1GUI\s0 toolkits) there are places where you have 3965Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3593\&\fImodal\fR interaction, which is most easily implemented by recursively 3966\&\fImodal\fR interaction, which is most easily implemented by recursively
3594invoking \f(CW\*(C`ev_run\*(C'\fR. 3967invoking \f(CW\*(C`ev_run\*(C'\fR.
3595.PP 3968.PP
3596This brings the problem of exiting \- a callback might want to finish the 3969This 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 3970main \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 3971a 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 3972and 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. 3973other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3601.PP 3974.PP
3602The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR 3975The 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 3976invocation, 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: 3977triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3605.PP 3978.PP
3608\& int exit_main_loop = 0; 3981\& int exit_main_loop = 0;
3609\& 3982\&
3610\& while (!exit_main_loop) 3983\& while (!exit_main_loop)
3611\& ev_run (EV_DEFAULT_ EVRUN_ONCE); 3984\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3612\& 3985\&
3613\& // in a model watcher 3986\& // in a modal watcher
3614\& int exit_nested_loop = 0; 3987\& int exit_nested_loop = 0;
3615\& 3988\&
3616\& while (!exit_nested_loop) 3989\& while (!exit_nested_loop)
3617\& ev_run (EV_A_ EVRUN_ONCE); 3990\& ev_run (EV_A_ EVRUN_ONCE);
3618.Ve 3991.Ve
3627\& exit_main_loop = 1; 4000\& exit_main_loop = 1;
3628\& 4001\&
3629\& // exit both 4002\& // exit both
3630\& exit_main_loop = exit_nested_loop = 1; 4003\& exit_main_loop = exit_nested_loop = 1;
3631.Ve 4004.Ve
3632.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0" 4005.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3633.IX Subsection "THREAD LOCKING EXAMPLE" 4006.IX Subsection "THREAD LOCKING EXAMPLE"
3634Here is a fictitious example of how to run an event loop in a different 4007Here is a fictitious example of how to run an event loop in a different
3635thread from where callbacks are being invoked and watchers are 4008thread from where callbacks are being invoked and watchers are
3636created/added/removed. 4009created/added/removed.
3637.PP 4010.PP
3645.PP 4018.PP
3646First, you need to associate some data with the event loop: 4019First, you need to associate some data with the event loop:
3647.PP 4020.PP
3648.Vb 6 4021.Vb 6
3649\& typedef struct { 4022\& typedef struct {
3650\& mutex_t lock; /* global loop lock */ 4023\& pthread_mutex_t lock; /* global loop lock */
4024\& pthread_t tid;
4025\& pthread_cond_t invoke_cv;
3651\& ev_async async_w; 4026\& ev_async async_w;
3652\& thread_t tid;
3653\& cond_t invoke_cv;
3654\& } userdata; 4027\& } userdata;
3655\& 4028\&
3656\& void prepare_loop (EV_P) 4029\& void prepare_loop (EV_P)
3657\& { 4030\& {
3658\& // for simplicity, we use a static userdata struct. 4031\& // for simplicity, we use a static userdata struct.
3659\& static userdata u; 4032\& static userdata u;
3660\& 4033\&
3661\& ev_async_init (&u\->async_w, async_cb); 4034\& ev_async_init (&u.async_w, async_cb);
3662\& ev_async_start (EV_A_ &u\->async_w); 4035\& ev_async_start (EV_A_ &u.async_w);
3663\& 4036\&
3664\& pthread_mutex_init (&u\->lock, 0); 4037\& pthread_mutex_init (&u.lock, 0);
3665\& pthread_cond_init (&u\->invoke_cv, 0); 4038\& pthread_cond_init (&u.invoke_cv, 0);
3666\& 4039\&
3667\& // now associate this with the loop 4040\& // now associate this with the loop
3668\& ev_set_userdata (EV_A_ u); 4041\& ev_set_userdata (EV_A_ &u);
3669\& ev_set_invoke_pending_cb (EV_A_ l_invoke); 4042\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3670\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 4043\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3671\& 4044\&
3672\& // then create the thread running ev_run 4045\& // then create the thread running ev_run
3673\& pthread_create (&u\->tid, 0, l_run, EV_A); 4046\& pthread_create (&u.tid, 0, l_run, EV_A);
3674\& } 4047\& }
3675.Ve 4048.Ve
3676.PP 4049.PP
3677The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used 4050The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3678solely to wake up the event loop so it takes notice of any new watchers 4051solely to wake up the event loop so it takes notice of any new watchers
3778.PP 4151.PP
3779Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise 4152Note 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 4153an 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 4154about the newly added timer. By waking up the loop it will pick up any new
3782watchers in the next event loop iteration. 4155watchers 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" 4156.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
3784.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS" 4157.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
3785While the overhead of a callback that e.g. schedules a thread is small, it 4158While 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 4159is 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 4160kind of threads or coroutines, you might want to customise libev so that
3788doesn't need callbacks anymore. 4161doesn't need callbacks anymore.
3810.PP 4183.PP
3811.Vb 6 4184.Vb 6
3812\& void 4185\& void
3813\& wait_for_event (ev_watcher *w) 4186\& wait_for_event (ev_watcher *w)
3814\& { 4187\& {
3815\& ev_cb_set (w) = current_coro; 4188\& ev_set_cb (w, current_coro);
3816\& switch_to (libev_coro); 4189\& switch_to (libev_coro);
3817\& } 4190\& }
3818.Ve 4191.Ve
3819.PP 4192.PP
3820That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and 4193That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
3821continues the libev coroutine, which, when appropriate, switches back to 4194continues the libev coroutine, which, when appropriate, switches back to
3822this or any other coroutine. I am sure if you sue this your own :) 4195this or any other coroutine.
3823.PP 4196.PP
3824You can do similar tricks if you have, say, threads with an event queue \- 4197You 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 4198instead 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 4199switching to a coroutine, you push the watcher onto the queue and notify
3827any waiters. 4200any waiters.
3828.PP 4201.PP
3829To embed libev, see \s-1EMBEDDING\s0, but in short, it's easiest to create two 4202To 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: 4203files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
3831.PP 4204.PP
3832.Vb 4 4205.Vb 4
3833\& // my_ev.h 4206\& // my_ev.h
3834\& #define EV_CB_DECLARE(type) struct my_coro *cb; 4207\& #define EV_CB_DECLARE(type) struct my_coro *cb;
3835\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb); 4208\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
3836\& #include "../libev/ev.h" 4209\& #include "../libev/ev.h"
3837\& 4210\&
3838\& // my_ev.c 4211\& // my_ev.c
3839\& #define EV_H "my_ev.h" 4212\& #define EV_H "my_ev.h"
3840\& #include "../libev/ev.c" 4213\& #include "../libev/ev.c"
3873.IP "\(bu" 4 4246.IP "\(bu" 4
3874The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 4247The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
3875to use the libev header file and library. 4248to use the libev header file and library.
3876.SH "\*(C+ SUPPORT" 4249.SH "\*(C+ SUPPORT"
3877.IX Header " SUPPORT" 4250.IX Header " SUPPORT"
4251.SS "C \s-1API\s0"
4252.IX Subsection "C API"
4253The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4254libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4255will work fine.
4256.PP
4257Proper exception specifications might have to be added to callbacks passed
4258to libev: exceptions may be thrown only from watcher callbacks, all other
4259callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4260callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4261specification. If you have code that needs to be compiled as both C and
4262\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4263.PP
4264.Vb 6
4265\& static void
4266\& fatal_error (const char *msg) EV_NOEXCEPT
4267\& {
4268\& perror (msg);
4269\& abort ();
4270\& }
4271\&
4272\& ...
4273\& ev_set_syserr_cb (fatal_error);
4274.Ve
4275.PP
4276The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4277\&\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
4278because it runs cleanup watchers).
4279.PP
4280Throwing exceptions in watcher callbacks is only supported if libev itself
4281is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4282throwing exceptions through C libraries (most do).
4283.SS "\*(C+ \s-1API\s0"
4284.IX Subsection " API"
3878Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4285Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
3879you to use some convenience methods to start/stop watchers and also change 4286you to use some convenience methods to start/stop watchers and also change
3880the callback model to a model using method callbacks on objects. 4287the callback model to a model using method callbacks on objects.
3881.PP 4288.PP
3882To use it, 4289To use it,
3898Currently, functions, static and non-static member functions and classes 4305Currently, 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 4306with \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 4307to 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 4308you need support for other types of functors please contact the author
3902(preferably after implementing it). 4309(preferably after implementing it).
4310.PP
4311For all this to work, your \*(C+ compiler either has to use the same calling
4312conventions as your C compiler (for static member functions), or you have
4313to embed libev and compile libev itself as \*(C+.
3903.PP 4314.PP
3904Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4315Here 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 4316.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
3906.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4317.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
3907.IX Item "ev::READ, ev::WRITE etc." 4318.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 4326.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." 4327.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 4328For 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 4329the 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 4330which 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. 4331defined by many implementations.
3921.Sp 4332.Sp
3922All of those classes have these methods: 4333All of those classes have these methods:
3923.RS 4 4334.RS 4
3924.IP "ev::TYPE::TYPE ()" 4 4335.IP "ev::TYPE::TYPE ()" 4
3925.IX Item "ev::TYPE::TYPE ()" 4336.IX Item "ev::TYPE::TYPE ()"
3988\& void operator() (ev::io &w, int revents) 4399\& void operator() (ev::io &w, int revents)
3989\& { 4400\& {
3990\& ... 4401\& ...
3991\& } 4402\& }
3992\& } 4403\& }
3993\& 4404\&
3994\& myfunctor f; 4405\& myfunctor f;
3995\& 4406\&
3996\& ev::io w; 4407\& ev::io w;
3997\& w.set (&f); 4408\& w.set (&f);
3998.Ve 4409.Ve
4016.IX Item "w->set (loop)" 4427.IX Item "w->set (loop)"
4017Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4428Associates 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). 4429do this when the watcher is inactive (and not pending either).
4019.IP "w\->set ([arguments])" 4 4430.IP "w\->set ([arguments])" 4
4020.IX Item "w->set ([arguments])" 4431.IX Item "w->set ([arguments])"
4021Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this 4432Basically 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 4433with the same arguments. Either this method or a suitable start method
4023C counterpart, an active watcher gets automatically stopped and restarted 4434must be called at least once. Unlike the C counterpart, an active watcher
4024when reconfiguring it with this method. 4435gets automatically stopped and restarted when reconfiguring it with this
4436method.
4437.Sp
4438For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4439clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
4440.Sp
4441For \f(CW\*(C`ev::io\*(C'\fR watchers there is an additional \f(CW\*(C`set\*(C'\fR method that acepts a
4442new event mask only, and internally calls \f(CW\*(C`ev_io_modify\*(C'\fR.
4025.IP "w\->start ()" 4 4443.IP "w\->start ()" 4
4026.IX Item "w->start ()" 4444.IX Item "w->start ()"
4027Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4445Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
4028constructor already stores the event loop. 4446constructor already stores the event loop.
4029.IP "w\->start ([arguments])" 4 4447.IP "w\->start ([arguments])" 4
4056.PP 4474.PP
4057.Vb 5 4475.Vb 5
4058\& class myclass 4476\& class myclass
4059\& { 4477\& {
4060\& ev::io io ; void io_cb (ev::io &w, int revents); 4478\& ev::io io ; void io_cb (ev::io &w, int revents);
4061\& ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4479\& ev::io io2 ; void io2_cb (ev::io &w, int revents);
4062\& ev::idle idle; void idle_cb (ev::idle &w, int revents); 4480\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
4063\& 4481\&
4064\& myclass (int fd) 4482\& myclass (int fd)
4065\& { 4483\& {
4066\& io .set <myclass, &myclass::io_cb > (this); 4484\& io .set <myclass, &myclass::io_cb > (this);
4087there are additional modules that implement libev-compatible interfaces 4505there 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), 4506to \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 4507\&\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). 4508and \f(CW\*(C`EV::Glib\*(C'\fR).
4091.Sp 4509.Sp
4092It can be found and installed via \s-1CPAN\s0, its homepage is at 4510It can be found and installed via \s-1CPAN,\s0 its homepage is at
4093<http://software.schmorp.de/pkg/EV>. 4511<http://software.schmorp.de/pkg/EV>.
4094.IP "Python" 4 4512.IP "Python" 4
4095.IX Item "Python" 4513.IX Item "Python"
4096Python bindings can be found at <http://code.google.com/p/pyev/>. It 4514Python bindings can be found at <http://code.google.com/p/pyev/>. It
4097seems to be quite complete and well-documented. 4515seems to be quite complete and well-documented.
4109A haskell binding to libev is available at 4527A haskell binding to libev is available at
4110<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>. 4528<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4111.IP "D" 4 4529.IP "D" 4
4112.IX Item "D" 4530.IX Item "D"
4113Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4531Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4114be found at <http://proj.llucax.com.ar/wiki/evd>. 4532be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4115.IP "Ocaml" 4 4533.IP "Ocaml" 4
4116.IX Item "Ocaml" 4534.IX Item "Ocaml"
4117Erkki Seppala has written Ocaml bindings for libev, to be found at 4535Erkki Seppala has written Ocaml bindings for libev, to be found at
4118<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. 4536<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4119.IP "Lua" 4 4537.IP "Lua" 4
4120.IX Item "Lua" 4538.IX Item "Lua"
4121Brian Maher has written a partial interface to libev for lua (at the 4539Brian 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 4540time 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>. 4541<http://github.com/brimworks/lua\-ev>.
4542.IP "Javascript" 4
4543.IX Item "Javascript"
4544Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4545.IP "Others" 4
4546.IX Item "Others"
4547There are others, and I stopped counting.
4124.SH "MACRO MAGIC" 4548.SH "MACRO MAGIC"
4125.IX Header "MACRO MAGIC" 4549.IX Header "MACRO MAGIC"
4126Libev can be compiled with a variety of options, the most fundamental 4550Libev 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) 4551of 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. 4552functions 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. 4587suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
4164.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4 4588.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
4165.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 4589.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
4166.IX Item "EV_DEFAULT, EV_DEFAULT_" 4590.IX Item "EV_DEFAULT, EV_DEFAULT_"
4167Similar to the other two macros, this gives you the value of the default 4591Similar to the other two macros, this gives you the value of the default
4168loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 4592loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop
4593will be initialised if it isn't already initialised.
4594.Sp
4595For non-multiplicity builds, these macros do nothing, so you always have
4596to initialise the loop somewhere.
4169.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4 4597.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
4170.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 4598.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
4171.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" 4599.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 4600Usage 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 4601default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
4207.SS "\s-1FILESETS\s0" 4635.SS "\s-1FILESETS\s0"
4208.IX Subsection "FILESETS" 4636.IX Subsection "FILESETS"
4209Depending on what features you need you need to include one or more sets of files 4637Depending on what features you need you need to include one or more sets of files
4210in your application. 4638in your application.
4211.PP 4639.PP
4212\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4640\fI\s-1CORE EVENT LOOP\s0\fR
4213.IX Subsection "CORE EVENT LOOP" 4641.IX Subsection "CORE EVENT LOOP"
4214.PP 4642.PP
4215To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4643To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
4216configuration (no autoconf): 4644configuration (no autoconf):
4217.PP 4645.PP
4244\& ev_vars.h 4672\& ev_vars.h
4245\& ev_wrap.h 4673\& ev_wrap.h
4246\& 4674\&
4247\& ev_win32.c required on win32 platforms only 4675\& ev_win32.c required on win32 platforms only
4248\& 4676\&
4249\& ev_select.c only when select backend is enabled (which is enabled by default) 4677\& ev_select.c only when select backend is enabled
4250\& ev_poll.c only when poll backend is enabled (disabled by default) 4678\& ev_poll.c only when poll backend is enabled
4251\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4679\& ev_epoll.c only when the epoll backend is enabled
4680\& ev_linuxaio.c only when the linux aio backend is enabled
4681\& 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) 4682\& 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) 4683\& ev_port.c only when the solaris port backend is enabled
4254.Ve 4684.Ve
4255.PP 4685.PP
4256\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4686\&\fIev.c\fR includes the backend files directly when enabled, so you only need
4257to compile this single file. 4687to compile this single file.
4258.PP 4688.PP
4259\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4689\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
4260.IX Subsection "LIBEVENT COMPATIBILITY API" 4690.IX Subsection "LIBEVENT COMPATIBILITY API"
4261.PP 4691.PP
4262To include the libevent compatibility \s-1API\s0, also include: 4692To include the libevent compatibility \s-1API,\s0 also include:
4263.PP 4693.PP
4264.Vb 1 4694.Vb 1
4265\& #include "event.c" 4695\& #include "event.c"
4266.Ve 4696.Ve
4267.PP 4697.PP
4269.PP 4699.PP
4270.Vb 1 4700.Vb 1
4271\& #include "event.h" 4701\& #include "event.h"
4272.Ve 4702.Ve
4273.PP 4703.PP
4274in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4704in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
4275.PP 4705.PP
4276You need the following additional files for this: 4706You need the following additional files for this:
4277.PP 4707.PP
4278.Vb 2 4708.Vb 2
4279\& event.h 4709\& event.h
4280\& event.c 4710\& event.c
4281.Ve 4711.Ve
4282.PP 4712.PP
4283\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4713\fI\s-1AUTOCONF SUPPORT\s0\fR
4284.IX Subsection "AUTOCONF SUPPORT" 4714.IX Subsection "AUTOCONF SUPPORT"
4285.PP 4715.PP
4286Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4716Instead 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 4717whatever 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 4718\&\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: 4721For this of course you need the m4 file:
4292.PP 4722.PP
4293.Vb 1 4723.Vb 1
4294\& libev.m4 4724\& libev.m4
4295.Ve 4725.Ve
4296.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4726.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
4297.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4727.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
4298Libev can be configured via a variety of preprocessor symbols you have to 4728Libev can be configured via a variety of preprocessor symbols you have to
4299define before including (or compiling) any of its files. The default in 4729define before including (or compiling) any of its files. The default in
4300the absence of autoconf is documented for every option. 4730the absence of autoconf is documented for every option.
4301.PP 4731.PP
4302Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different 4732Symbols 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 4733values when compiling libev vs. including \fIev.h\fR, so it is permissible
4304to redefine them before including \fIev.h\fR without breaking compatibility 4734to 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 4735to 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 4736users of libev and the libev code itself must be compiled with compatible
4307settings. 4737settings.
4308.IP "\s-1EV_COMPAT3\s0 (h)" 4 4738.IP "\s-1EV_COMPAT3\s0 (h)" 4
4309.IX Item "EV_COMPAT3 (h)" 4739.IX Item "EV_COMPAT3 (h)"
4310Backwards compatibility is a major concern for libev. This is why this 4740Backwards compatibility is a major concern for libev. This is why this
4328supported). It will also not define any of the structs usually found in 4758supported). 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. 4759\&\fIevent.h\fR that are not directly supported by the libev core alone.
4330.Sp 4760.Sp
4331In standalone mode, libev will still try to automatically deduce the 4761In standalone mode, libev will still try to automatically deduce the
4332configuration, but has to be more conservative. 4762configuration, but has to be more conservative.
4763.IP "\s-1EV_USE_FLOOR\s0" 4
4764.IX Item "EV_USE_FLOOR"
4765If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its
4766periodic reschedule calculations, otherwise libev will fall back on a
4767portable (slower) implementation. If you enable this, you usually have to
4768link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR
4769function is not available will fail, so the safe default is to not enable
4770this.
4333.IP "\s-1EV_USE_MONOTONIC\s0" 4 4771.IP "\s-1EV_USE_MONOTONIC\s0" 4
4334.IX Item "EV_USE_MONOTONIC" 4772.IX Item "EV_USE_MONOTONIC"
4335If defined to be \f(CW1\fR, libev will try to detect the availability of the 4773If 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 4774monotonic clock option at both compile time and runtime. Otherwise no
4337use of the monotonic clock option will be attempted. If you enable this, 4775use 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). 4799higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR).
4362.IP "\s-1EV_USE_NANOSLEEP\s0" 4 4800.IP "\s-1EV_USE_NANOSLEEP\s0" 4
4363.IX Item "EV_USE_NANOSLEEP" 4801.IX Item "EV_USE_NANOSLEEP"
4364If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available 4802If 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. 4803and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
4804.IP "\s-1EV_USE_EVENTFD\s0" 4
4805.IX Item "EV_USE_EVENTFD"
4806If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4807available and will probe for kernel support at runtime. This will improve
4808\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4809If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
48102.7 or newer, otherwise disabled.
4811.IP "\s-1EV_USE_SIGNALFD\s0" 4
4812.IX Item "EV_USE_SIGNALFD"
4813If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`signalfd ()\*(C'\fR is
4814available and will probe for kernel support at runtime. This enables
4815the use of \s-1EVFLAG_SIGNALFD\s0 for faster and simpler signal handling. If
4816undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
48172.7 or newer, otherwise disabled.
4818.IP "\s-1EV_USE_TIMERFD\s0" 4
4819.IX Item "EV_USE_TIMERFD"
4820If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`timerfd ()\*(C'\fR is
4821available and will probe for kernel support at runtime. This allows
4822libev to detect time jumps accurately. If undefined, it will be enabled
4823if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4824\&\f(CW\*(C`TFD_TIMER_CANCEL_ON_SET\*(C'\fR, otherwise disabled.
4366.IP "\s-1EV_USE_EVENTFD\s0" 4 4825.IP "\s-1EV_USE_EVENTFD\s0" 4
4367.IX Item "EV_USE_EVENTFD" 4826.IX Item "EV_USE_EVENTFD"
4368If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is 4827If 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 4828available 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. 4829\&\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)" 4870.IX Item "EV_WIN32_CLOSE_FD(fd)"
4412If programs implement their own fd to handle mapping on win32, then this 4871If 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 4872macro 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 4873file descriptors again. Note that the replacement function has to close
4415the underlying \s-1OS\s0 handle. 4874the underlying \s-1OS\s0 handle.
4875.IP "\s-1EV_USE_WSASOCKET\s0" 4
4876.IX Item "EV_USE_WSASOCKET"
4877If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4878communication socket, which works better in some environments. Otherwise,
4879the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4880environments.
4416.IP "\s-1EV_USE_POLL\s0" 4 4881.IP "\s-1EV_USE_POLL\s0" 4
4417.IX Item "EV_USE_POLL" 4882.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) 4883If 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 4884backend. Otherwise it will be enabled on non\-win32 platforms. It
4420takes precedence over select. 4885takes precedence over select.
4423If defined to be \f(CW1\fR, libev will compile in support for the Linux 4888If 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, 4889\&\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 4890otherwise another method will be used as fallback. This is the preferred
4426backend for GNU/Linux systems. If undefined, it will be enabled if the 4891backend for GNU/Linux systems. If undefined, it will be enabled if the
4427headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4892headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4893.IP "\s-1EV_USE_LINUXAIO\s0" 4
4894.IX Item "EV_USE_LINUXAIO"
4895If defined to be \f(CW1\fR, libev will compile in support for the Linux aio
4896backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). If undefined, it will be
4897enabled on linux, otherwise disabled.
4898.IP "\s-1EV_USE_IOURING\s0" 4
4899.IX Item "EV_USE_IOURING"
4900If defined to be \f(CW1\fR, libev will compile in support for the Linux
4901io_uring backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). Due to it's
4902current limitations it has to be requested explicitly. If undefined, it
4903will be enabled on linux, otherwise disabled.
4428.IP "\s-1EV_USE_KQUEUE\s0" 4 4904.IP "\s-1EV_USE_KQUEUE\s0" 4
4429.IX Item "EV_USE_KQUEUE" 4905.IX Item "EV_USE_KQUEUE"
4430If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4906If 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, 4907\&\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 4908otherwise another method will be used as fallback. This is the preferred
4449.IX Item "EV_USE_INOTIFY" 4925.IX Item "EV_USE_INOTIFY"
4450If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 4926If 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 4927interface 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 4928be detected at runtime. If undefined, it will be enabled if the headers
4453indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4929indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4930.IP "\s-1EV_NO_SMP\s0" 4
4931.IX Item "EV_NO_SMP"
4932If defined to be \f(CW1\fR, libev will assume that memory is always coherent
4933between threads, that is, threads can be used, but threads never run on
4934different cpus (or different cpu cores). This reduces dependencies
4935and makes libev faster.
4936.IP "\s-1EV_NO_THREADS\s0" 4
4937.IX Item "EV_NO_THREADS"
4938If defined to be \f(CW1\fR, libev will assume that it will never be called from
4939different threads (that includes signal handlers), which is a stronger
4940assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4941libev faster.
4454.IP "\s-1EV_ATOMIC_T\s0" 4 4942.IP "\s-1EV_ATOMIC_T\s0" 4
4455.IX Item "EV_ATOMIC_T" 4943.IX Item "EV_ATOMIC_T"
4456Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4944Libev 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 4945access 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 4946such 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" 4947type 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. 4948handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4949watchers.
4461.Sp 4950.Sp
4462In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4951In 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. 4952(from \fIsignal.h\fR), which is usually good enough on most platforms.
4464.IP "\s-1EV_H\s0 (h)" 4 4953.IP "\s-1EV_H\s0 (h)" 4
4465.IX Item "EV_H (h)" 4954.IX Item "EV_H (h)"
4486If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 4975If 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 4976will 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 4977additional independent event loops. Otherwise there will be no support
4489for multiple event loops and there is no first event loop pointer 4978for multiple event loops and there is no first event loop pointer
4490argument. Instead, all functions act on the single default loop. 4979argument. Instead, all functions act on the single default loop.
4980.Sp
4981Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a
4982default loop when multiplicity is switched off \- you always have to
4983initialise the loop manually in this case.
4491.IP "\s-1EV_MINPRI\s0" 4 4984.IP "\s-1EV_MINPRI\s0" 4
4492.IX Item "EV_MINPRI" 4985.IX Item "EV_MINPRI"
4493.PD 0 4986.PD 0
4494.IP "\s-1EV_MAXPRI\s0" 4 4987.IP "\s-1EV_MAXPRI\s0" 4
4495.IX Item "EV_MAXPRI" 4988.IX Item "EV_MAXPRI"
4503all the priorities, so having many of them (hundreds) uses a lot of space 4996all 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 4997and time, so using the defaults of five priorities (\-2 .. +2) is usually
4505fine. 4998fine.
4506.Sp 4999.Sp
4507If your embedding application does not need any priorities, defining these 5000If your embedding application does not need any priorities, defining these
4508both to \f(CW0\fR will save some memory and \s-1CPU\s0. 5001both 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 5002.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." 5003.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 5004If 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 5005the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4513is not. Disabling watcher types mainly saves code size. 5006is not. Disabling watcher types mainly saves code size.
4514.IP "\s-1EV_FEATURES\s0" 4 5007.IP "\s-1EV_FEATURES\s0" 4
4531\& #define EV_CHILD_ENABLE 1 5024\& #define EV_CHILD_ENABLE 1
4532\& #define EV_ASYNC_ENABLE 1 5025\& #define EV_ASYNC_ENABLE 1
4533.Ve 5026.Ve
4534.Sp 5027.Sp
4535The actual value is a bitset, it can be a combination of the following 5028The actual value is a bitset, it can be a combination of the following
4536values: 5029values (by default, all of these are enabled):
4537.RS 4 5030.RS 4
4538.ie n .IP "1 \- faster/larger code" 4 5031.ie n .IP "1 \- faster/larger code" 4
4539.el .IP "\f(CW1\fR \- faster/larger code" 4 5032.el .IP "\f(CW1\fR \- faster/larger code" 4
4540.IX Item "1 - faster/larger code" 5033.IX Item "1 - faster/larger code"
4541Use larger code to speed up some operations. 5034Use larger code to speed up some operations.
4544code size by roughly 30% on amd64). 5037code size by roughly 30% on amd64).
4545.Sp 5038.Sp
4546When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with 5039When 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 5040gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4548assertions. 5041assertions.
5042.Sp
5043The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
5044(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4549.ie n .IP "2 \- faster/larger data structures" 4 5045.ie n .IP "2 \- faster/larger data structures" 4
4550.el .IP "\f(CW2\fR \- faster/larger data structures" 4 5046.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4551.IX Item "2 - faster/larger data structures" 5047.IX Item "2 - faster/larger data structures"
4552Replaces the small 2\-heap for timer management by a faster 4\-heap, larger 5048Replaces 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 5049hash 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 5050and can additionally have an effect on the size of data structures at
4555runtime. 5051runtime.
5052.Sp
5053The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
5054(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4556.ie n .IP "4 \- full \s-1API\s0 configuration" 4 5055.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4557.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 5056.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4558.IX Item "4 - full API configuration" 5057.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 5058This 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). 5059enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4592With an intelligent-enough linker (gcc+binutils are intelligent enough 5091With 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 5092when 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 5093your program might be left out as well \- a binary starting a timer and an
4595I/O watcher then might come out at only 5Kb. 5094I/O watcher then might come out at only 5Kb.
4596.RE 5095.RE
5096.IP "\s-1EV_API_STATIC\s0" 4
5097.IX Item "EV_API_STATIC"
5098If this symbol is defined (by default it is not), then all identifiers
5099will have static linkage. This means that libev will not export any
5100identifiers, and you cannot link against libev anymore. This can be useful
5101when you embed libev, only want to use libev functions in a single file,
5102and do not want its identifiers to be visible.
5103.Sp
5104To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that
5105wants to use libev.
5106.Sp
5107This option only works when libev is compiled with a C compiler, as \*(C+
5108doesn't support the required declaration syntax.
4597.IP "\s-1EV_AVOID_STDIO\s0" 4 5109.IP "\s-1EV_AVOID_STDIO\s0" 4
4598.IX Item "EV_AVOID_STDIO" 5110.IX Item "EV_AVOID_STDIO"
4599If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio 5111If 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 5112functions (printf, scanf, perror etc.). This will increase the code size
4601somewhat, but if your program doesn't otherwise depend on stdio and your 5113somewhat, 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 5165called. 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 5166called 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 5167verification code will be called very frequently, which will slow down
4656libev considerably. 5168libev considerably.
4657.Sp 5169.Sp
5170Verification errors are reported via C's \f(CW\*(C`assert\*(C'\fR mechanism, so if you
5171disable that (e.g. by defining \f(CW\*(C`NDEBUG\*(C'\fR) then no errors will be reported.
5172.Sp
4658The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it 5173The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4659will be \f(CW0\fR. 5174will be \f(CW0\fR.
4660.IP "\s-1EV_COMMON\s0" 4 5175.IP "\s-1EV_COMMON\s0" 4
4661.IX Item "EV_COMMON" 5176.IX Item "EV_COMMON"
4662By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 5177By 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 5198and 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 5199definition and a statement, respectively. See the \fIev.h\fR header file for
4685their default definitions. One possible use for overriding these is to 5200their 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 5201avoid 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+. 5202method calls instead of plain function calls in \*(C+.
4688.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5203.SS "\s-1EXPORTED API SYMBOLS\s0"
4689.IX Subsection "EXPORTED API SYMBOLS" 5204.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 5205If 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 5206exported symbols, you can use the provided \fISymbol.*\fR files which list
4692all public symbols, one per line: 5207all public symbols, one per line:
4693.PP 5208.PP
4747\& #include "ev_cpp.h" 5262\& #include "ev_cpp.h"
4748\& #include "ev.c" 5263\& #include "ev.c"
4749.Ve 5264.Ve
4750.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5265.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4751.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5266.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4752.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5267.SS "\s-1THREADS AND COROUTINES\s0"
4753.IX Subsection "THREADS AND COROUTINES" 5268.IX Subsection "THREADS AND COROUTINES"
4754\fI\s-1THREADS\s0\fR 5269\fI\s-1THREADS\s0\fR
4755.IX Subsection "THREADS" 5270.IX Subsection "THREADS"
4756.PP 5271.PP
4757All libev functions are reentrant and thread-safe unless explicitly 5272All libev functions are reentrant and thread-safe unless explicitly
4803An example use would be to communicate signals or other events that only 5318An example use would be to communicate signals or other events that only
4804work in the default loop by registering the signal watcher with the 5319work 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 5320default 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. 5321watcher callback into the event loop interested in the signal.
4807.PP 5322.PP
4808See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R". 5323See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
4809.PP 5324.PP
4810\fI\s-1COROUTINES\s0\fR 5325\fI\s-1COROUTINES\s0\fR
4811.IX Subsection "COROUTINES" 5326.IX Subsection "COROUTINES"
4812.PP 5327.PP
4813Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5328Libev 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. 5333that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
4819.PP 5334.PP
4820Care has been taken to ensure that libev does not keep local state inside 5335Care 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 5336\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
4822they do not call any callbacks. 5337they do not call any callbacks.
4823.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5338.SS "\s-1COMPILER WARNINGS\s0"
4824.IX Subsection "COMPILER WARNINGS" 5339.IX Subsection "COMPILER WARNINGS"
4825Depending on your compiler and compiler settings, you might get no or a 5340Depending on your compiler and compiler settings, you might get no or a
4826lot of warnings when compiling libev code. Some people are apparently 5341lot of warnings when compiling libev code. Some people are apparently
4827scared by this. 5342scared by this.
4828.PP 5343.PP
4880.PP 5395.PP
4881If you need, for some reason, empty reports from valgrind for your project 5396If you need, for some reason, empty reports from valgrind for your project
4882I suggest using suppression lists. 5397I suggest using suppression lists.
4883.SH "PORTABILITY NOTES" 5398.SH "PORTABILITY NOTES"
4884.IX Header "PORTABILITY NOTES" 5399.IX Header "PORTABILITY NOTES"
4885.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" 5400.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
4886.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" 5401.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
4887GNU/Linux is the only common platform that supports 64 bit file/large file 5402GNU/Linux is the only common platform that supports 64 bit file/large file
4888interfaces but \fIdisables\fR them by default. 5403interfaces but \fIdisables\fR them by default.
4889.PP 5404.PP
4890That means that libev compiled in the default environment doesn't support 5405That 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. 5406files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
4892.PP 5407.PP
4893Unfortunately, many programs try to work around this GNU/Linux issue 5408Unfortunately, many programs try to work around this GNU/Linux issue
4894by enabling the large file \s-1API\s0, which makes them incompatible with the 5409by enabling the large file \s-1API,\s0 which makes them incompatible with the
4895standard libev compiled for their system. 5410standard libev compiled for their system.
4896.PP 5411.PP
4897Likewise, libev cannot enable the large file \s-1API\s0 itself as this would 5412Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
4898suddenly make it incompatible to the default compile time environment, 5413suddenly make it incompatible to the default compile time environment,
4899i.e. all programs not using special compile switches. 5414i.e. all programs not using special compile switches.
4900.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" 5415.SS "\s-1OS/X AND DARWIN BUGS\s0"
4901.IX Subsection "OS/X AND DARWIN BUGS" 5416.IX Subsection "OS/X AND DARWIN BUGS"
4902The whole thing is a bug if you ask me \- basically any system interface 5417The 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 5418you touch is broken, whether it is locales, poll, kqueue or even the
4904OpenGL drivers. 5419OpenGL drivers.
4905.PP 5420.PP
4927.PP 5442.PP
4928\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5443\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
4929.IX Subsection "select is buggy" 5444.IX Subsection "select is buggy"
4930.PP 5445.PP
4931All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5446All 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 5447one 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 5448descriptors you can pass in to 1024 \- your program suddenly crashes when
4934you use more. 5449you use more.
4935.PP 5450.PP
4936There is an undocumented \*(L"workaround\*(R" for this \- defining 5451There 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 5452\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
4938work on \s-1OS/X\s0. 5453work on \s-1OS/X.\s0
4939.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5454.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
4940.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" 5455.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
4941\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR 5456\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
4942.IX Subsection "errno reentrancy" 5457.IX Subsection "errno reentrancy"
4943.PP 5458.PP
4944The default compile environment on Solaris is unfortunately so 5459The default compile environment on Solaris is unfortunately so
4961great. 5476great.
4962.PP 5477.PP
4963If you can't get it to work, you can try running the program by setting 5478If 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 5479the 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. 5480\&\f(CW\*(C`select\*(C'\fR backends.
4966.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" 5481.SS "\s-1AIX POLL BUG\s0"
4967.IX Subsection "AIX POLL BUG" 5482.IX Subsection "AIX POLL BUG"
4968\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around 5483\&\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 5484this 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 5485compiled 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. 5486with 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" 5487.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
4973.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5488.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
4974\fIGeneral issues\fR 5489\fIGeneral issues\fR
4975.IX Subsection "General issues" 5490.IX Subsection "General issues"
4976.PP 5491.PP
4977Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5492Win32 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 5493requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
4979model. Libev still offers limited functionality on this platform in 5494model. 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 5495the 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 5496descriptors. This only applies when using Win32 natively, not when using
4982e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5497e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4983as every compielr comes with a slightly differently broken/incompatible 5498as every compiler comes with a slightly differently broken/incompatible
4984environment. 5499environment.
4985.PP 5500.PP
4986Lifting these limitations would basically require the full 5501Lifting these limitations would basically require the full
4987re-implementation of the I/O system. If you are into this kind of thing, 5502re-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 5503then note that glib does exactly that for you in a very portable way (note
5046\& #define EV_USE_SELECT 1 5561\& #define EV_USE_SELECT 1
5047\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5562\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5048.Ve 5563.Ve
5049.PP 5564.PP
5050Note that winsockets handling of fd sets is O(n), so you can easily get a 5565Note 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. 5566complexity in the O(nX) range when using win32.
5052.PP 5567.PP
5053\fILimited number of file descriptors\fR 5568\fILimited number of file descriptors\fR
5054.IX Subsection "Limited number of file descriptors" 5569.IX Subsection "Limited number of file descriptors"
5055.PP 5570.PP
5056Windows has numerous arbitrary (and low) limits on things. 5571Windows 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 5587by 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 5588(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 5589runtime 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, 5590(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 5591you 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. 5592the cost of calling select (O(nX)) will likely make this unworkable.
5078.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5593.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5079.IX Subsection "PORTABILITY REQUIREMENTS" 5594.IX Subsection "PORTABILITY REQUIREMENTS"
5080In addition to a working ISO-C implementation and of course the 5595In addition to a working ISO-C implementation and of course the
5081backend-specific APIs, libev relies on a few additional extensions: 5596backend-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 5597.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 5598.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 *." 5599.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 5600Libev 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 5601structure (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 5602assumes that the same (machine) code can be used to call any watcher
5088callback: The watcher callbacks have different type signatures, but libev 5603callback: The watcher callbacks have different type signatures, but libev
5089calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5604calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5605.IP "null pointers and integer zero are represented by 0 bytes" 4
5606.IX Item "null pointers and integer zero are represented by 0 bytes"
5607Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5608relies on this setting pointers and integers to null.
5090.IP "pointer accesses must be thread-atomic" 4 5609.IP "pointer accesses must be thread-atomic" 4
5091.IX Item "pointer accesses must be thread-atomic" 5610.IX Item "pointer accesses must be thread-atomic"
5092Accessing a pointer value must be atomic, it must both be readable and 5611Accessing a pointer value must be atomic, it must both be readable and
5093writable in one piece \- this is the case on all current architectures. 5612writable 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 5613.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 5626thread\*(R" or will block signals process-wide, both behaviours would
5108be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5627be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5109\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5628\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5110.Sp 5629.Sp
5111The most portable way to handle signals is to block signals in all threads 5630The 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 5631except the initial one, and run the signal handling loop in the initial
5113well. 5632thread as well.
5114.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5633.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 5634.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" 5635.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 5636To 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 5637instead 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 5638systems (Microsoft...) this might be unexpectedly low, but is still at
5120least 31 bits everywhere, which is enough for hundreds of millions of 5639least 31 bits everywhere, which is enough for hundreds of millions of
5121watchers. 5640watchers.
5122.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5641.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" 5643.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 5644The 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 5645have 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 5646good enough for at least into the year 4000 with millisecond accuracy
5128(the design goal for libev). This requirement is overfulfilled by 5647(the design goal for libev). This requirement is overfulfilled by
5129implementations using \s-1IEEE\s0 754, which is basically all existing ones. With 5648implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5649.Sp
5130\&\s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least 2200. 5650With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5651year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5652is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5653something like that, just kidding).
5131.PP 5654.PP
5132If you know of other additional requirements drop me a note. 5655If you know of other additional requirements drop me a note.
5133.SH "ALGORITHMIC COMPLEXITIES" 5656.SH "ALGORITHMIC COMPLEXITIES"
5134.IX Header "ALGORITHMIC COMPLEXITIES" 5657.IX Header "ALGORITHMIC COMPLEXITIES"
5135In this section the complexities of (many of) the algorithms used inside 5658In this section the complexities of (many of) the algorithms used inside
5189.IX Item "Processing ev_async_send: O(number_of_async_watchers)" 5712.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
5190.IP "Processing signals: O(max_signal_number)" 4 5713.IP "Processing signals: O(max_signal_number)" 4
5191.IX Item "Processing signals: O(max_signal_number)" 5714.IX Item "Processing signals: O(max_signal_number)"
5192.PD 5715.PD
5193Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 5716Sending 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 5717calls in the current loop iteration and the loop is currently
5718blocked. Checking for async and signal events involves iterating over all
5195involves iterating over all running async watchers or all signal numbers. 5719running async watchers or all signal numbers.
5196.SH "PORTING FROM LIBEV 3.X TO 4.X" 5720.SH "PORTING FROM LIBEV 3.X TO 4.X"
5197.IX Header "PORTING FROM LIBEV 3.X TO 4.X" 5721.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5198The major version 4 introduced some incompatible changes to the \s-1API\s0. 5722The major version 4 introduced some incompatible changes to the \s-1API.\s0
5199.PP 5723.PP
5200At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions 5724At 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 5725for all changes, so most programs should still compile. The compatibility
5202layer might be removed in later versions of libev, so better update to the 5726layer might be removed in later versions of libev, so better update to the
5203new \s-1API\s0 early than late. 5727new \s-1API\s0 early than late.
5204.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 5728.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5205.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 5729.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5206.IX Item "EV_COMPAT3 backwards compatibility mechanism" 5730.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5207The backward compatibility mechanism can be controlled by 5731The 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 5732\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5209section. 5733section.
5210.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 5734.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 5735.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" 5736.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: 5737These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5253.SH "GLOSSARY" 5777.SH "GLOSSARY"
5254.IX Header "GLOSSARY" 5778.IX Header "GLOSSARY"
5255.IP "active" 4 5779.IP "active" 4
5256.IX Item "active" 5780.IX Item "active"
5257A watcher is active as long as it has been started and not yet stopped. 5781A 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. 5782See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5259.IP "application" 4 5783.IP "application" 4
5260.IX Item "application" 5784.IX Item "application"
5261In this document, an application is whatever is using libev. 5785In this document, an application is whatever is using libev.
5262.IP "backend" 4 5786.IP "backend" 4
5263.IX Item "backend" 5787.IX Item "backend"
5290The model used to describe how an event loop handles and processes 5814The model used to describe how an event loop handles and processes
5291watchers and events. 5815watchers and events.
5292.IP "pending" 4 5816.IP "pending" 4
5293.IX Item "pending" 5817.IX Item "pending"
5294A watcher is pending as soon as the corresponding event has been 5818A watcher is pending as soon as the corresponding event has been
5295detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5819detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5296.IP "real time" 4 5820.IP "real time" 4
5297.IX Item "real time" 5821.IX Item "real time"
5298The physical time that is observed. It is apparently strictly monotonic :) 5822The physical time that is observed. It is apparently strictly monotonic :)
5299.IP "wall-clock time" 4 5823.IP "wall-clock time" 4
5300.IX Item "wall-clock time" 5824.IX Item "wall-clock time"
5301The time and date as shown on clocks. Unlike real time, it can actually 5825The 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 5826be wrong and jump forwards and backwards, e.g. when you adjust your
5303clock. 5827clock.
5304.IP "watcher" 4 5828.IP "watcher" 4
5305.IX Item "watcher" 5829.IX Item "watcher"
5306A data structure that describes interest in certain events. Watchers need 5830A data structure that describes interest in certain events. Watchers need
5307to be started (attached to an event loop) before they can receive events. 5831to be started (attached to an event loop) before they can receive events.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines