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

Comparing libev/ev.3 (file contents):
Revision 1.84 by root, Fri Nov 5 22:28:54 2010 UTC vs.
Revision 1.112 by root, Sun Jun 23 23:27:34 2019 UTC

1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) 1.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
36.el\{\ 36.el\{\
37. ds -- \|\(em\| 37. ds -- \|\(em\|
38. ds PI \(*p 38. ds PI \(*p
39. ds L" `` 39. ds L" ``
40. ds R" '' 40. ds R" ''
41. ds C`
42. ds C'
41'br\} 43'br\}
42.\" 44.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
45.el .ds Aq ' 47.el .ds Aq '
46.\" 48.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is >0, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
51.ie \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
52. de IX 55.de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54.. 56..
55. nr % 0 57.nr rF 0
56. rr F 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{\
60. if \nF \{\
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
63..
64. if !\nF==2 \{\
65. nr % 0
66. nr F 2
67. \}
68. \}
57.\} 69.\}
58.el \{\ 70.rr rF
59. de IX
60..
61.\}
62.\" 71.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
66.if n \{\ 75.if n \{\
122.\} 131.\}
123.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
124.\" ======================================================================== 133.\" ========================================================================
125.\" 134.\"
126.IX Title "LIBEV 3" 135.IX Title "LIBEV 3"
127.TH LIBEV 3 "2010-11-03" "libev-4.01" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2019-06-23" "libev-4.25" "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\&
189\& ev_timer_start (loop, &timeout_watcher); 198\& ev_timer_start (loop, &timeout_watcher);
190\& 199\&
191\& // now wait for events to arrive 200\& // now wait for events to arrive
192\& ev_run (loop, 0); 201\& ev_run (loop, 0);
193\& 202\&
194\& // unloop was called, so exit 203\& // break was called, so exit
195\& return 0; 204\& return 0;
196\& } 205\& }
197.Ve 206.Ve
198.SH "ABOUT THIS DOCUMENT" 207.SH "ABOUT THIS DOCUMENT"
199.IX Header "ABOUT THIS DOCUMENT" 208.IX Header "ABOUT THIS DOCUMENT"
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
294.IP "ev_tstamp ev_time ()" 4 303.IP "ev_tstamp ev_time ()" 4
295.IX Item "ev_tstamp ev_time ()" 304.IX Item "ev_tstamp ev_time ()"
296Returns the current time as libev would use it. Please note that the 305Returns 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 306\&\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 307you 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. 308\&\f(CW\*(C`ev_now_update\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR.
300.IP "ev_sleep (ev_tstamp interval)" 4 309.IP "ev_sleep (ev_tstamp interval)" 4
301.IX Item "ev_sleep (ev_tstamp interval)" 310.IX Item "ev_sleep (ev_tstamp interval)"
302Sleep for the given interval: The current thread will be blocked until 311Sleep for the given interval: The current thread will be blocked
303either it is interrupted or the given time interval has passed. Basically 312until either it is interrupted or the given time interval has
313passed (approximately \- it might return a bit earlier even if not
314interrupted). Returns immediately if \f(CW\*(C`interval <= 0\*(C'\fR.
315.Sp
304this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR. 316Basically this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR.
317.Sp
318The range of the \f(CW\*(C`interval\*(C'\fR is limited \- libev only guarantees to work
319with sleep times of up to one day (\f(CW\*(C`interval <= 86400\*(C'\fR).
305.IP "int ev_version_major ()" 4 320.IP "int ev_version_major ()" 4
306.IX Item "int ev_version_major ()" 321.IX Item "int ev_version_major ()"
307.PD 0 322.PD 0
308.IP "int ev_version_minor ()" 4 323.IP "int ev_version_minor ()" 4
309.IX Item "int ev_version_minor ()" 324.IX Item "int ev_version_minor ()"
361current system. To find which embeddable backends might be supported on 376current 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 () 377the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
363& ev_supported_backends ()\*(C'\fR, likewise for recommended ones. 378& ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
364.Sp 379.Sp
365See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 380See 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 381.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4
367.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 382.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())"
368Sets the allocation function to use (the prototype is similar \- the 383Sets 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 384semantics 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 385used 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 386when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
372or take some potentially destructive action. 387or take some potentially destructive action.
377.Sp 392.Sp
378You could override this function in high-availability programs to, say, 393You could override this function in high-availability programs to, say,
379free some memory if it cannot allocate memory, to use a special allocator, 394free 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. 395or even to sleep a while and retry until some memory is available.
381.Sp 396.Sp
397Example: The following is the \f(CW\*(C`realloc\*(C'\fR function that libev itself uses
398which should work with \f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions of all kinds and
399is probably a good basis for your own implementation.
400.Sp
401.Vb 5
402\& static void *
403\& ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
404\& {
405\& if (size)
406\& return realloc (ptr, size);
407\&
408\& free (ptr);
409\& return 0;
410\& }
411.Ve
412.Sp
382Example: Replace the libev allocator with one that waits a bit and then 413Example: Replace the libev allocator with one that waits a bit and then
383retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). 414retries.
384.Sp 415.Sp
385.Vb 6 416.Vb 8
386\& static void * 417\& static void *
387\& persistent_realloc (void *ptr, size_t size) 418\& persistent_realloc (void *ptr, size_t size)
388\& { 419\& {
420\& if (!size)
421\& {
422\& free (ptr);
423\& return 0;
424\& }
425\&
389\& for (;;) 426\& for (;;)
390\& { 427\& {
391\& void *newptr = realloc (ptr, size); 428\& void *newptr = realloc (ptr, size);
392\& 429\&
393\& if (newptr) 430\& if (newptr)
398\& } 435\& }
399\& 436\&
400\& ... 437\& ...
401\& ev_set_allocator (persistent_realloc); 438\& ev_set_allocator (persistent_realloc);
402.Ve 439.Ve
403.IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4 440.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
404.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))" 441.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 442Set the callback function to call on a retryable system call error (such
406as failed select, poll, epoll_wait). The message is a printable string 443as failed select, poll, epoll_wait). The message is a printable string
407indicating the system call or subsystem causing the problem. If this 444indicating the system call or subsystem causing the problem. If this
408callback is set, then libev will expect it to remedy the situation, no 445callback is set, then libev will expect it to remedy the situation, no
409matter what, when it returns. That is, libev will generally retry the 446matter what, when it returns. That is, libev will generally retry the
421\& } 458\& }
422\& 459\&
423\& ... 460\& ...
424\& ev_set_syserr_cb (fatal_error); 461\& ev_set_syserr_cb (fatal_error);
425.Ve 462.Ve
463.IP "ev_feed_signal (int signum)" 4
464.IX Item "ev_feed_signal (int signum)"
465This function can be used to \*(L"simulate\*(R" a signal receive. It is completely
466safe to call this function at any time, from any context, including signal
467handlers or random threads.
468.Sp
469Its main use is to customise signal handling in your process, especially
470in the presence of threads. For example, you could block signals
471by default in all threads (and specifying \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when
472creating any loops), and in one thread, use \f(CW\*(C`sigwait\*(C'\fR or any other
473mechanism to wait for signals, then \*(L"deliver\*(R" them to libev by calling
474\&\f(CW\*(C`ev_feed_signal\*(C'\fR.
426.SH "FUNCTIONS CONTROLLING EVENT LOOPS" 475.SH "FUNCTIONS CONTROLLING EVENT LOOPS"
427.IX Header "FUNCTIONS CONTROLLING EVENT LOOPS" 476.IX Header "FUNCTIONS CONTROLLING EVENT LOOPS"
428An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR is 477An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR is
429\&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as 478\&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as
430libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name). 479libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name).
475.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 524.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
476.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" 525.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
477This will create and initialise a new event loop object. If the loop 526This will create and initialise a new event loop object. If the loop
478could not be initialised, returns false. 527could not be initialised, returns false.
479.Sp 528.Sp
480Note that this function \fIis\fR thread-safe, and one common way to use 529This function is thread-safe, and one common way to use libev with
481libev with threads is indeed to create one loop per thread, and using the 530threads is indeed to create one loop per thread, and using the default
482default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread. 531loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
483.Sp 532.Sp
484The flags argument can be used to specify special behaviour or specific 533The flags argument can be used to specify special behaviour or specific
485backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). 534backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
486.Sp 535.Sp
487The following flags are supported: 536The following flags are supported:
496.IX Item "EVFLAG_NOENV" 545.IX Item "EVFLAG_NOENV"
497If this flag bit is or'ed into the flag value (or the program runs setuid 546If this flag bit is or'ed into the flag value (or the program runs setuid
498or setgid) then libev will \fInot\fR look at the environment variable 547or setgid) then libev will \fInot\fR look at the environment variable
499\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 548\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
500override the flags completely if it is found in the environment. This is 549override the flags completely if it is found in the environment. This is
501useful to try out specific backends to test their performance, or to work 550useful to try out specific backends to test their performance, to work
502around bugs. 551around bugs, or to make libev threadsafe (accessing environment variables
552cannot be done in a threadsafe way, but usually it works if no other
553thread modifies them).
503.ie n .IP """EVFLAG_FORKCHECK""" 4 554.ie n .IP """EVFLAG_FORKCHECK""" 4
504.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 555.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
505.IX Item "EVFLAG_FORKCHECK" 556.IX Item "EVFLAG_FORKCHECK"
506Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also 557Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
507make libev check for a fork in each iteration by enabling this flag. 558make libev check for a fork in each iteration by enabling this flag.
508.Sp 559.Sp
509This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 560This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
510and thus this might slow down your event loop if you do a lot of loop 561and thus this might slow down your event loop if you do a lot of loop
511iterations and little real work, but is usually not noticeable (on my 562iterations and little real work, but is usually not noticeable (on my
512GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 563GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn
513without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has 564sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux
514\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 565system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc
566versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again).
515.Sp 567.Sp
516The big advantage of this flag is that you can forget about fork (and 568The big advantage of this flag is that you can forget about fork (and
517forget about forgetting to tell libev about forking) when you use this 569forget about forgetting to tell libev about forking, although you still
518flag. 570have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
519.Sp 571.Sp
520This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 572This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
521environment variable. 573environment variable.
522.ie n .IP """EVFLAG_NOINOTIFY""" 4 574.ie n .IP """EVFLAG_NOINOTIFY""" 4
523.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 575.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
537threads that are not interested in handling them. 589threads that are not interested in handling them.
538.Sp 590.Sp
539Signalfd will not be used by default as this changes your signal mask, and 591Signalfd will not be used by default as this changes your signal mask, and
540there are a lot of shoddy libraries and programs (glib's threadpool for 592there are a lot of shoddy libraries and programs (glib's threadpool for
541example) that can't properly initialise their signal masks. 593example) that can't properly initialise their signal masks.
594.ie n .IP """EVFLAG_NOSIGMASK""" 4
595.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
596.IX Item "EVFLAG_NOSIGMASK"
597When this flag is specified, then libev will avoid to modify the signal
598mask. Specifically, this means you have to make sure signals are unblocked
599when you want to receive them.
600.Sp
601This behaviour is useful when you want to do your own signal handling, or
602want to handle signals only in specific threads and want to avoid libev
603unblocking the signals.
604.Sp
605It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
606\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
607.Sp
608This flag's behaviour will become the default in future versions of libev.
542.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 609.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
543.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 610.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
544.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 611.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
545This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 612This is your standard \fBselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
546libev tries to roll its own fd_set with no limits on the number of fds, 613libev tries to roll its own fd_set with no limits on the number of fds,
547but if that fails, expect a fairly low limit on the number of fds when 614but if that fails, expect a fairly low limit on the number of fds when
548using this backend. It doesn't scale too well (O(highest_fd)), but its 615using this backend. It doesn't scale too well (O(highest_fd)), but its
549usually the fastest backend for a low number of (low-numbered :) fds. 616usually the fastest backend for a low number of (low-numbered :) fds.
550.Sp 617.Sp
558This 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 625This 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
559\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the 626\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
560\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). 627\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
561.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 628.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
562.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 629.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
563.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 630.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
564And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 631And this is your standard \fBpoll\fR\|(2) backend. It's more complicated
565than select, but handles sparse fds better and has no artificial 632than select, but handles sparse fds better and has no artificial
566limit on the number of fds you can use (except it will slow down 633limit on the number of fds you can use (except it will slow down
567considerably with a lot of inactive fds). It scales similarly to select, 634considerably with a lot of inactive fds). It scales similarly to select,
568i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for 635i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
569performance tips. 636performance tips.
570.Sp 637.Sp
571This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 638This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
572\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 639\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
573.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 640.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
574.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 641.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
575.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 642.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
576Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 643Use the linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
577kernels). 644kernels).
578.Sp 645.Sp
579For few fds, this backend is a bit little slower than poll and select, 646For few fds, this backend is a bit little slower than poll and select, but
580but it scales phenomenally better. While poll and select usually scale 647it scales phenomenally better. While poll and select usually scale like
581like O(total_fds) where n is the total number of fds (or the highest fd), 648O(total_fds) where total_fds is the total number of fds (or the highest
582epoll scales either O(1) or O(active_fds). 649fd), epoll scales either O(1) or O(active_fds).
583.Sp 650.Sp
584The epoll mechanism deserves honorable mention as the most misdesigned 651The epoll mechanism deserves honorable mention as the most misdesigned
585of the more advanced event mechanisms: mere annoyances include silently 652of the more advanced event mechanisms: mere annoyances include silently
586dropping file descriptors, requiring a system call per change per file 653dropping file descriptors, requiring a system call per change per file
587descriptor (and unnecessary guessing of parameters), problems with dup, 654descriptor (and unnecessary guessing of parameters), problems with dup,
5900.1ms) and so on. The biggest issue is fork races, however \- if a program 6570.1ms) and so on. The biggest issue is fork races, however \- if a program
591forks then \fIboth\fR parent and child process have to recreate the epoll 658forks then \fIboth\fR parent and child process have to recreate the epoll
592set, which can take considerable time (one syscall per file descriptor) 659set, which can take considerable time (one syscall per file descriptor)
593and is of course hard to detect. 660and is of course hard to detect.
594.Sp 661.Sp
595Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but 662Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work,
596of course \fIdoesn't\fR, and epoll just loves to report events for totally 663but of course \fIdoesn't\fR, and epoll just loves to report events for
597\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot 664totally \fIdifferent\fR file descriptors (even already closed ones, so
598even remove them from the set) than registered in the set (especially 665one cannot even remove them from the set) than registered in the set
599on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by 666(especially on \s-1SMP\s0 systems). Libev tries to counter these spurious
600employing an additional generation counter and comparing that against the 667notifications by employing an additional generation counter and comparing
601events to filter out spurious ones, recreating the set when required. Last 668that against the events to filter out spurious ones, recreating the set
669when required. Epoll also erroneously rounds down timeouts, but gives you
670no way to know when and by how much, so sometimes you have to busy-wait
671because epoll returns immediately despite a nonzero timeout. And last
602not least, it also refuses to work with some file descriptors which work 672not least, it also refuses to work with some file descriptors which work
603perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...). 673perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...).
604.Sp 674.Sp
605Epoll is truly the train wreck analog among event poll mechanisms. 675Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
676cobbled together in a hurry, no thought to design or interaction with
677others. Oh, the pain, will it ever stop...
606.Sp 678.Sp
607While stopping, setting and starting an I/O watcher in the same iteration 679While stopping, setting and starting an I/O watcher in the same iteration
608will result in some caching, there is still a system call per such 680will result in some caching, there is still a system call per such
609incident (because the same \fIfile descriptor\fR could point to a different 681incident (because the same \fIfile descriptor\fR could point to a different
610\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed 682\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
622All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or 694All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
623faster than epoll for maybe up to a hundred file descriptors, depending on 695faster than epoll for maybe up to a hundred file descriptors, depending on
624the usage. So sad. 696the usage. So sad.
625.Sp 697.Sp
626While nominally embeddable in other event loops, this feature is broken in 698While nominally embeddable in other event loops, this feature is broken in
627all kernel versions tested so far. 699a lot of kernel revisions, but probably(!) works in current versions.
700.Sp
701This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
702\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
703.ie n .IP """EVBACKEND_LINUXAIO"" (value 64, Linux)" 4
704.el .IP "\f(CWEVBACKEND_LINUXAIO\fR (value 64, Linux)" 4
705.IX Item "EVBACKEND_LINUXAIO (value 64, Linux)"
706Use the linux-specific linux aio (\fInot\fR \f(CWaio(7)\fR but \f(CWio_submit(2)\fR) event interface available in post\-4.18 kernels.
707.Sp
708If this backend works for you (as of this writing, it was very
709experimental), it is the best event interface available on linux and might
710be well worth enabling it \- if it isn't available in your kernel this will
711be detected and this backend will be skipped.
712.Sp
713This backend can batch oneshot requests and supports a user-space ring
714buffer to receive events. It also doesn't suffer from most of the design
715problems of epoll (such as not being able to remove event sources from
716the epoll set), and generally sounds too good to be true. Because, this
717being the linux kernel, of course it suffers from a whole new set of
718limitations.
719.Sp
720For one, it is not easily embeddable (but probably could be done using
721an event fd at some extra overhead). It also is subject to a system wide
722limit that can be configured in \fI/proc/sys/fs/aio\-max\-nr\fR \- each loop
723currently requires \f(CW61\fR of this number. If no aio requests are left, this
724backend will be skipped during initialisation.
725.Sp
726Most problematic in practise, however, is that not all file descriptors
727work with it. For example, in linux 5.1, tcp sockets, pipes, event fds,
728files, \fI/dev/null\fR and a few others are supported, but ttys do not work
729(probably because of a bug), so this is not (yet?) a generic event polling
730interface.
731.Sp
732To work around this latter problem, the current version of libev uses
733epoll as a fallback for file deescriptor types that do not work. Epoll
734is used in, kind of, slow mode that hopefully avoids most of its design
735problems and requires 1\-3 extra syscalls per active fd every iteration.
628.Sp 736.Sp
629This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 737This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
630\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 738\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
631.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 739.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
632.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 740.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
633.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 741.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
634Kqueue deserves special mention, as at the time of this writing, it 742Kqueue deserves special mention, as at the time of this writing, it
635was broken on all BSDs except NetBSD (usually it doesn't work reliably 743was broken on all BSDs except NetBSD (usually it doesn't work reliably
636with anything but sockets and pipes, except on Darwin, where of course 744with anything but sockets and pipes, except on Darwin, where of course
637it's completely useless). Unlike epoll, however, whose brokenness 745it's completely useless). Unlike epoll, however, whose brokenness
638is by design, these kqueue bugs can (and eventually will) be fixed 746is by design, these kqueue bugs can (and eventually will) be fixed
647.Sp 755.Sp
648It scales in the same way as the epoll backend, but the interface to the 756It scales in the same way as the epoll backend, but the interface to the
649kernel is more efficient (which says nothing about its actual speed, of 757kernel is more efficient (which says nothing about its actual speed, of
650course). While stopping, setting and starting an I/O watcher does never 758course). While stopping, setting and starting an I/O watcher does never
651cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 759cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
652two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but 760two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
653sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 761might have to leak fd's on fork, but it's more sane than epoll) and it
654cases 762drops fds silently in similarly hard-to-detect cases.
655.Sp 763.Sp
656This backend usually performs well under most conditions. 764This backend usually performs well under most conditions.
657.Sp 765.Sp
658While nominally embeddable in other event loops, this doesn't work 766While nominally embeddable in other event loops, this doesn't work
659everywhere, so you might need to test for this. And since it is broken 767everywhere, so you might need to test for this. And since it is broken
660almost everywhere, you should only use it when you have a lot of sockets 768almost everywhere, you should only use it when you have a lot of sockets
661(for which it usually works), by embedding it into another event loop 769(for which it usually works), by embedding it into another event loop
662(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 770(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
663also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. 771also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
664.Sp 772.Sp
665This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 773This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
666\&\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 774\&\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
667\&\f(CW\*(C`NOTE_EOF\*(C'\fR. 775\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
668.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 776.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
672implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets 780implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
673and is not embeddable, which would limit the usefulness of this backend 781and is not embeddable, which would limit the usefulness of this backend
674immensely. 782immensely.
675.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 783.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
676.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 784.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
677.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 785.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
678This uses the Solaris 10 event port mechanism. As with everything on Solaris, 786This uses the Solaris 10 event port mechanism. As with everything on Solaris,
679it's really slow, but it still scales very well (O(active_fds)). 787it's really slow, but it still scales very well (O(active_fds)).
680.Sp
681Please note that Solaris event ports can deliver a lot of spurious
682notifications, so you need to use non-blocking I/O or other means to avoid
683blocking when no data (or space) is available.
684.Sp 788.Sp
685While this backend scales well, it requires one system call per active 789While this backend scales well, it requires one system call per active
686file descriptor per loop iteration. For small and medium numbers of file 790file descriptor per loop iteration. For small and medium numbers of file
687descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend 791descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
688might perform better. 792might perform better.
689.Sp 793.Sp
690On the positive side, with the exception of the spurious readiness 794On the positive side, this backend actually performed fully to
691notifications, this backend actually performed fully to specification
692in all tests and is fully embeddable, which is a rare feat among the 795specification in all tests and is fully embeddable, which is a rare feat
693OS-specific backends (I vastly prefer correctness over speed hacks). 796among the OS-specific backends (I vastly prefer correctness over speed
797hacks).
798.Sp
799On the negative side, the interface is \fIbizarre\fR \- so bizarre that
800even sun itself gets it wrong in their code examples: The event polling
801function sometimes returns events to the caller even though an error
802occurred, but with no indication whether it has done so or not (yes, it's
803even documented that way) \- deadly for edge-triggered interfaces where you
804absolutely have to know whether an event occurred or not because you have
805to re-arm the watcher.
806.Sp
807Fortunately libev seems to be able to work around these idiocies.
694.Sp 808.Sp
695This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 809This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
696\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 810\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
697.ie n .IP """EVBACKEND_ALL""" 4 811.ie n .IP """EVBACKEND_ALL""" 4
698.el .IP "\f(CWEVBACKEND_ALL\fR" 4 812.el .IP "\f(CWEVBACKEND_ALL\fR" 4
699.IX Item "EVBACKEND_ALL" 813.IX Item "EVBACKEND_ALL"
700Try all backends (even potentially broken ones that wouldn't be tried 814Try all backends (even potentially broken ones that wouldn't be tried
701with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 815with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
702\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. 816\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.
703.Sp 817.Sp
704It is definitely not recommended to use this flag. 818It is definitely not recommended to use this flag, use whatever
819\&\f(CW\*(C`ev_recommended_backends ()\*(C'\fR returns, or simply do not specify a backend
820at all.
821.ie n .IP """EVBACKEND_MASK""" 4
822.el .IP "\f(CWEVBACKEND_MASK\fR" 4
823.IX Item "EVBACKEND_MASK"
824Not a backend at all, but a mask to select all backend bits from a
825\&\f(CW\*(C`flags\*(C'\fR value, in case you want to mask out any backends from a flags
826value (e.g. when modifying the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR environment variable).
705.RE 827.RE
706.RS 4 828.RS 4
707.Sp 829.Sp
708If one or more of the backend flags are or'ed into the flags value, 830If one or more of the backend flags are or'ed into the flags value,
709then only these backends will be tried (in the reverse order as listed 831then only these backends will be tried (in the reverse order as listed
721Example: Use whatever libev has to offer, but make sure that kqueue is 843Example: Use whatever libev has to offer, but make sure that kqueue is
722used if available. 844used if available.
723.Sp 845.Sp
724.Vb 1 846.Vb 1
725\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 847\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
848.Ve
849.Sp
850Example: Similarly, on linux, you mgiht want to take advantage of the
851linux aio backend if possible, but fall back to something else if that
852isn't available.
853.Sp
854.Vb 1
855\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
726.Ve 856.Ve
727.RE 857.RE
728.IP "ev_loop_destroy (loop)" 4 858.IP "ev_loop_destroy (loop)" 4
729.IX Item "ev_loop_destroy (loop)" 859.IX Item "ev_loop_destroy (loop)"
730Destroys an event loop object (frees all memory and kernel state 860Destroys an event loop object (frees all memory and kernel state
747except in the rare occasion where you really need to free its resources. 877except in the rare occasion where you really need to free its resources.
748If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR 878If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
749and \f(CW\*(C`ev_loop_destroy\*(C'\fR. 879and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
750.IP "ev_loop_fork (loop)" 4 880.IP "ev_loop_fork (loop)" 4
751.IX Item "ev_loop_fork (loop)" 881.IX Item "ev_loop_fork (loop)"
752This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to 882This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations
753reinitialise the kernel state for backends that have one. Despite the 883to reinitialise the kernel state for backends that have one. Despite
754name, you can call it anytime, but it makes most sense after forking, in 884the name, you can call it anytime you are allowed to start or stop
755the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the 885watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most
756child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. 886sense after forking, in the child process. You \fImust\fR call it (or use
887\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
757.Sp 888.Sp
889In addition, if you want to reuse a loop (via this function or
890\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR.
891.Sp
758Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after 892Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
759a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is 893a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
760because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things 894because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
761during fork. 895during fork.
762.Sp 896.Sp
763On the other hand, you only need to call this function in the child 897On the other hand, you only need to call this function in the child
798\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the 932\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the
799prepare and check phases. 933prepare and check phases.
800.IP "unsigned int ev_depth (loop)" 4 934.IP "unsigned int ev_depth (loop)" 4
801.IX Item "unsigned int ev_depth (loop)" 935.IX Item "unsigned int ev_depth (loop)"
802Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of 936Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of
803times \f(CW\*(C`ev_run\*(C'\fR was exited, in other words, the recursion depth. 937times \f(CW\*(C`ev_run\*(C'\fR was exited normally, in other words, the recursion depth.
804.Sp 938.Sp
805Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is 939Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is
806\&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread), 940\&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread),
807in which case it is higher. 941in which case it is higher.
808.Sp 942.Sp
809Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread 943Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread,
810etc.), doesn't count as \*(L"exit\*(R" \- consider this as a hint to avoid such 944throwing an exception etc.), doesn't count as \*(L"exit\*(R" \- consider this
811ungentleman-like behaviour unless it's really convenient. 945as a hint to avoid such ungentleman-like behaviour unless it's really
946convenient, in which case it is fully supported.
812.IP "unsigned int ev_backend (loop)" 4 947.IP "unsigned int ev_backend (loop)" 4
813.IX Item "unsigned int ev_backend (loop)" 948.IX Item "unsigned int ev_backend (loop)"
814Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 949Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
815use. 950use.
816.IP "ev_tstamp ev_now (loop)" 4 951.IP "ev_tstamp ev_now (loop)" 4
856given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR 991given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
857without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR. 992without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
858.Sp 993.Sp
859Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the 994Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
860event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR). 995event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
861.IP "ev_run (loop, int flags)" 4 996.IP "bool ev_run (loop, int flags)" 4
862.IX Item "ev_run (loop, int flags)" 997.IX Item "bool ev_run (loop, int flags)"
863Finally, this is it, the event handler. This function usually is called 998Finally, this is it, the event handler. This function usually is called
864after you have initialised all your watchers and you want to start 999after you have initialised all your watchers and you want to start
865handling events. It will ask the operating system for any new events, call 1000handling events. It will ask the operating system for any new events, call
866the watcher callbacks, an then repeat the whole process indefinitely: This 1001the watcher callbacks, and then repeat the whole process indefinitely: This
867is why event loops are called \fIloops\fR. 1002is why event loops are called \fIloops\fR.
868.Sp 1003.Sp
869If the flags argument is specified as \f(CW0\fR, it will keep handling events 1004If the flags argument is specified as \f(CW0\fR, it will keep handling events
870until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was 1005until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
871called. 1006called.
1007.Sp
1008The return value is false if there are no more active watchers (which
1009usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
1010(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
872.Sp 1011.Sp
873Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than 1012Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
874relying on all watchers to be stopped when deciding when a program has 1013relying on all watchers to be stopped when deciding when a program has
875finished (especially in interactive programs), but having a program 1014finished (especially in interactive programs), but having a program
876that automatically loops as long as it has to and no longer by virtue 1015that automatically loops as long as it has to and no longer by virtue
877of relying on its watchers stopping correctly, that is truly a thing of 1016of relying on its watchers stopping correctly, that is truly a thing of
878beauty. 1017beauty.
879.Sp 1018.Sp
1019This function is \fImostly\fR exception-safe \- you can break out of a
1020\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
1021exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
1022will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
1023.Sp
880A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle 1024A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
881those events and any already outstanding ones, but will not wait and 1025those events and any already outstanding ones, but will not wait and
882block your process in case there are no events and will return after one 1026block your process in case there are no events and will return after one
883iteration of the loop. This is sometimes useful to poll and handle new 1027iteration of the loop. This is sometimes useful to poll and handle new
884events while doing lengthy calculations, to keep the program responsive. 1028events while doing lengthy calculations, to keep the program responsive.
893This is useful if you are waiting for some external event in conjunction 1037This is useful if you are waiting for some external event in conjunction
894with something not expressible using other libev watchers (i.e. "roll your 1038with something not expressible using other libev watchers (i.e. "roll your
895own \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 1039own \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
896usually a better approach for this kind of thing. 1040usually a better approach for this kind of thing.
897.Sp 1041.Sp
898Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does: 1042Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does (this is for your
1043understanding, not a guarantee that things will work exactly like this in
1044future versions):
899.Sp 1045.Sp
900.Vb 10 1046.Vb 10
901\& \- Increment loop depth. 1047\& \- Increment loop depth.
902\& \- Reset the ev_break status. 1048\& \- Reset the ev_break status.
903\& \- Before the first iteration, call any pending watchers. 1049\& \- Before the first iteration, call any pending watchers.
939.Sp 1085.Sp
940.Vb 4 1086.Vb 4
941\& ... queue jobs here, make sure they register event watchers as long 1087\& ... queue jobs here, make sure they register event watchers as long
942\& ... as they still have work to do (even an idle watcher will do..) 1088\& ... as they still have work to do (even an idle watcher will do..)
943\& ev_run (my_loop, 0); 1089\& ev_run (my_loop, 0);
944\& ... jobs done or somebody called unloop. yeah! 1090\& ... jobs done or somebody called break. yeah!
945.Ve 1091.Ve
946.IP "ev_break (loop, how)" 4 1092.IP "ev_break (loop, how)" 4
947.IX Item "ev_break (loop, how)" 1093.IX Item "ev_break (loop, how)"
948Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it 1094Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it
949has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 1095has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
950\&\f(CW\*(C`EVBREAK_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_run\*(C'\fR call return, or 1096\&\f(CW\*(C`EVBREAK_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_run\*(C'\fR call return, or
951\&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return. 1097\&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return.
952.Sp 1098.Sp
953This \*(L"break state\*(R" will be cleared when entering \f(CW\*(C`ev_run\*(C'\fR again. 1099This \*(L"break state\*(R" will be cleared on the next call to \f(CW\*(C`ev_run\*(C'\fR.
954.Sp 1100.Sp
955It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too. 1101It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too, in
1102which case it will have no effect.
956.IP "ev_ref (loop)" 4 1103.IP "ev_ref (loop)" 4
957.IX Item "ev_ref (loop)" 1104.IX Item "ev_ref (loop)"
958.PD 0 1105.PD 0
959.IP "ev_unref (loop)" 4 1106.IP "ev_unref (loop)" 4
960.IX Item "ev_unref (loop)" 1107.IX Item "ev_unref (loop)"
983.Sp 1130.Sp
984.Vb 4 1131.Vb 4
985\& ev_signal exitsig; 1132\& ev_signal exitsig;
986\& ev_signal_init (&exitsig, sig_cb, SIGINT); 1133\& ev_signal_init (&exitsig, sig_cb, SIGINT);
987\& ev_signal_start (loop, &exitsig); 1134\& ev_signal_start (loop, &exitsig);
988\& evf_unref (loop); 1135\& ev_unref (loop);
989.Ve 1136.Ve
990.Sp 1137.Sp
991Example: For some weird reason, unregister the above signal handler again. 1138Example: For some weird reason, unregister the above signal handler again.
992.Sp 1139.Sp
993.Vb 2 1140.Vb 2
1017overhead for the actual polling but can deliver many events at once. 1164overhead for the actual polling but can deliver many events at once.
1018.Sp 1165.Sp
1019By setting a higher \fIio collect interval\fR you allow libev to spend more 1166By setting a higher \fIio collect interval\fR you allow libev to spend more
1020time collecting I/O events, so you can handle more events per iteration, 1167time collecting I/O events, so you can handle more events per iteration,
1021at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and 1168at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
1022\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will 1169\&\f(CW\*(C`ev_timer\*(C'\fR) will not be affected. Setting this to a non-null value will
1023introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The 1170introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
1024sleep time ensures that libev will not poll for I/O events more often then 1171sleep time ensures that libev will not poll for I/O events more often then
1025once per this interval, on average. 1172once per this interval, on average (as long as the host time resolution is
1173good enough).
1026.Sp 1174.Sp
1027Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 1175Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
1028to spend more time collecting timeouts, at the expense of increased 1176to spend more time collecting timeouts, at the expense of increased
1029latency/jitter/inexactness (the watcher callback will be called 1177latency/jitter/inexactness (the watcher callback will be called
1030later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null 1178later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
1074this callback instead. This is useful, for example, when you want to 1222this callback instead. This is useful, for example, when you want to
1075invoke the actual watchers inside another context (another thread etc.). 1223invoke the actual watchers inside another context (another thread etc.).
1076.Sp 1224.Sp
1077If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new 1225If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1078callback. 1226callback.
1079.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4 1227.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
1080.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))" 1228.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
1081Sometimes you want to share the same loop between multiple threads. This 1229Sometimes you want to share the same loop between multiple threads. This
1082can be done relatively simply by putting mutex_lock/unlock calls around 1230can be done relatively simply by putting mutex_lock/unlock calls around
1083each call to a libev function. 1231each call to a libev function.
1084.Sp 1232.Sp
1085However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible 1233However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1086to wait for it to return. One way around this is to wake up the event 1234to wait for it to return. One way around this is to wake up the event
1087loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`av_async_send\*(C'\fR, another way is to set these 1235loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`ev_async_send\*(C'\fR, another way is to set these
1088\&\fIrelease\fR and \fIacquire\fR callbacks on the loop. 1236\&\fIrelease\fR and \fIacquire\fR callbacks on the loop.
1089.Sp 1237.Sp
1090When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is 1238When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1091suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just 1239suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1092afterwards. 1240afterwards.
1107See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this 1255See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this
1108document. 1256document.
1109.IP "ev_set_userdata (loop, void *data)" 4 1257.IP "ev_set_userdata (loop, void *data)" 4
1110.IX Item "ev_set_userdata (loop, void *data)" 1258.IX Item "ev_set_userdata (loop, void *data)"
1111.PD 0 1259.PD 0
1112.IP "ev_userdata (loop)" 4 1260.IP "void *ev_userdata (loop)" 4
1113.IX Item "ev_userdata (loop)" 1261.IX Item "void *ev_userdata (loop)"
1114.PD 1262.PD
1115Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When 1263Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When
1116\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns 1264\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns
1117\&\f(CW0.\fR 1265\&\f(CW0\fR.
1118.Sp 1266.Sp
1119These two functions can be used to associate arbitrary data with a loop, 1267These two functions can be used to associate arbitrary data with a loop,
1120and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and 1268and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and
1121\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for 1269\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for
1122any other purpose as well. 1270any other purpose as well.
1233.PD 0 1381.PD 0
1234.ie n .IP """EV_CHECK""" 4 1382.ie n .IP """EV_CHECK""" 4
1235.el .IP "\f(CWEV_CHECK\fR" 4 1383.el .IP "\f(CWEV_CHECK\fR" 4
1236.IX Item "EV_CHECK" 1384.IX Item "EV_CHECK"
1237.PD 1385.PD
1238All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts 1386All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
1239to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1387gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
1240\&\f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it invokes any callbacks for any 1388just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1389for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1390watchers invoked before the event loop sleeps or polls for new events, and
1391\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1392or lower priority within an event loop iteration.
1393.Sp
1241received events. Callbacks of both watcher types can start and stop as 1394Callbacks of both watcher types can start and stop as many watchers as
1242many watchers as they want, and all of them will be taken into account 1395they want, and all of them will be taken into account (for example, a
1243(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1396\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
1244\&\f(CW\*(C`ev_run\*(C'\fR from blocking). 1397blocking).
1245.ie n .IP """EV_EMBED""" 4 1398.ie n .IP """EV_EMBED""" 4
1246.el .IP "\f(CWEV_EMBED\fR" 4 1399.el .IP "\f(CWEV_EMBED\fR" 4
1247.IX Item "EV_EMBED" 1400.IX Item "EV_EMBED"
1248The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1401The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1249.ie n .IP """EV_FORK""" 4 1402.ie n .IP """EV_FORK""" 4
1278bug in your program. 1431bug in your program.
1279.Sp 1432.Sp
1280Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1433Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
1281example it might indicate that a fd is readable or writable, and if your 1434example it might indicate that a fd is readable or writable, and if your
1282callbacks is well-written it can just attempt the operation and cope with 1435callbacks is well-written it can just attempt the operation and cope with
1283the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1436the error from \fBread()\fR or \fBwrite()\fR. This will not work in multi-threaded
1284programs, though, as the fd could already be closed and reused for another 1437programs, though, as the fd could already be closed and reused for another
1285thing, so beware. 1438thing, so beware.
1286.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1439.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1287.IX Subsection "GENERIC WATCHER FUNCTIONS" 1440.IX Subsection "GENERIC WATCHER FUNCTIONS"
1288.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1441.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1289.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1442.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1290.IX Item "ev_init (ev_TYPE *watcher, callback)" 1443.IX Item "ev_init (ev_TYPE *watcher, callback)"
1291This macro initialises the generic portion of a watcher. The contents 1444This macro initialises the generic portion of a watcher. The contents
1370make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR 1523make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1371it). 1524it).
1372.IP "callback ev_cb (ev_TYPE *watcher)" 4 1525.IP "callback ev_cb (ev_TYPE *watcher)" 4
1373.IX Item "callback ev_cb (ev_TYPE *watcher)" 1526.IX Item "callback ev_cb (ev_TYPE *watcher)"
1374Returns the callback currently set on the watcher. 1527Returns the callback currently set on the watcher.
1375.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1528.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
1376.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1529.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
1377Change the callback. You can change the callback at virtually any time 1530Change the callback. You can change the callback at virtually any time
1378(modulo threads). 1531(modulo threads).
1379.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 1532.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1380.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" 1533.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1381.PD 0 1534.PD 0
1399or might not have been clamped to the valid range. 1552or might not have been clamped to the valid range.
1400.Sp 1553.Sp
1401The default priority used by watchers when no priority has been set is 1554The default priority used by watchers when no priority has been set is
1402always \f(CW0\fR, which is supposed to not be too high and not be too low :). 1555always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1403.Sp 1556.Sp
1404See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1557See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1405priorities. 1558priorities.
1406.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1559.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1407.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1560.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1408Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1561Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1409\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1562\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1428\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was 1581\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was
1429not started in the first place. 1582not started in the first place.
1430.Sp 1583.Sp
1431See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related 1584See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1432functions that do not need a watcher. 1585functions that do not need a watcher.
1433.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
1434.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
1435Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
1436and read at any time: libev will completely ignore it. This can be used
1437to associate arbitrary data with your watcher. If you need more data and
1438don't want to allocate memory and store a pointer to it in that data
1439member, you can also \*(L"subclass\*(R" the watcher type and provide your own
1440data:
1441.PP 1586.PP
1442.Vb 7 1587See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1443\& struct my_io 1588OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1444\& {
1445\& ev_io io;
1446\& int otherfd;
1447\& void *somedata;
1448\& struct whatever *mostinteresting;
1449\& };
1450\&
1451\& ...
1452\& struct my_io w;
1453\& ev_io_init (&w.io, my_cb, fd, EV_READ);
1454.Ve
1455.PP
1456And since your callback will be called with a pointer to the watcher, you
1457can cast it back to your own type:
1458.PP
1459.Vb 5
1460\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1461\& {
1462\& struct my_io *w = (struct my_io *)w_;
1463\& ...
1464\& }
1465.Ve
1466.PP
1467More interesting and less C\-conformant ways of casting your callback type
1468instead have been omitted.
1469.PP
1470Another common scenario is to use some data structure with multiple
1471embedded watchers:
1472.PP
1473.Vb 6
1474\& struct my_biggy
1475\& {
1476\& int some_data;
1477\& ev_timer t1;
1478\& ev_timer t2;
1479\& }
1480.Ve
1481.PP
1482In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
1483complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct
1484in the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies), or you need to use
1485some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for real
1486programmers):
1487.PP
1488.Vb 1
1489\& #include <stddef.h>
1490\&
1491\& static void
1492\& t1_cb (EV_P_ ev_timer *w, int revents)
1493\& {
1494\& struct my_biggy big = (struct my_biggy *)
1495\& (((char *)w) \- offsetof (struct my_biggy, t1));
1496\& }
1497\&
1498\& static void
1499\& t2_cb (EV_P_ ev_timer *w, int revents)
1500\& {
1501\& struct my_biggy big = (struct my_biggy *)
1502\& (((char *)w) \- offsetof (struct my_biggy, t2));
1503\& }
1504.Ve
1505.SS "\s-1WATCHER\s0 \s-1STATES\s0" 1589.SS "\s-1WATCHER STATES\s0"
1506.IX Subsection "WATCHER STATES" 1590.IX Subsection "WATCHER STATES"
1507There are various watcher states mentioned throughout this manual \- 1591There are various watcher states mentioned throughout this manual \-
1508active, pending and so on. In this section these states and the rules to 1592active, pending and so on. In this section these states and the rules to
1509transition between them will be described in more detail \- and while these 1593transition between them will be described in more detail \- and while these
1510rules might look complicated, they usually do \*(L"the right thing\*(R". 1594rules might look complicated, they usually do \*(L"the right thing\*(R".
1511.IP "initialiased" 4 1595.IP "initialised" 4
1512.IX Item "initialiased" 1596.IX Item "initialised"
1513Before a watcher can be registered with the event looop it has to be 1597Before a watcher can be registered with the event loop it has to be
1514initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to 1598initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1515\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function. 1599\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1516.Sp 1600.Sp
1517In this state it is simply some block of memory that is suitable for use 1601In this state it is simply some block of memory that is suitable for
1518in an event loop. It can be moved around, freed, reused etc. at will. 1602use in an event loop. It can be moved around, freed, reused etc. at
1603will \- as long as you either keep the memory contents intact, or call
1604\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again.
1519.IP "started/running/active" 4 1605.IP "started/running/active" 4
1520.IX Item "started/running/active" 1606.IX Item "started/running/active"
1521Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes 1607Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1522property of the event loop, and is actively waiting for events. While in 1608property of the event loop, and is actively waiting for events. While in
1523this state it cannot be accessed (except in a few documented ways), moved, 1609this state it cannot be accessed (except in a few documented ways), moved,
1548latter will clear any pending state the watcher might be in, regardless 1634latter will clear any pending state the watcher might be in, regardless
1549of whether it was active or not, so stopping a watcher explicitly before 1635of whether it was active or not, so stopping a watcher explicitly before
1550freeing it is often a good idea. 1636freeing it is often a good idea.
1551.Sp 1637.Sp
1552While stopped (and not pending) the watcher is essentially in the 1638While stopped (and not pending) the watcher is essentially in the
1553initialised state, that is it can be reused, moved, modified in any way 1639initialised state, that is, it can be reused, moved, modified in any way
1554you wish. 1640you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1641it again).
1555.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1642.SS "\s-1WATCHER PRIORITY MODELS\s0"
1556.IX Subsection "WATCHER PRIORITY MODELS" 1643.IX Subsection "WATCHER PRIORITY MODELS"
1557Many event loops support \fIwatcher priorities\fR, which are usually small 1644Many event loops support \fIwatcher priorities\fR, which are usually small
1558integers that influence the ordering of event callback invocation 1645integers that influence the ordering of event callback invocation
1559between watchers in some way, all else being equal. 1646between watchers in some way, all else being equal.
1560.PP 1647.PP
1684In general you can register as many read and/or write event watchers per 1771In general you can register as many read and/or write event watchers per
1685fd as you want (as long as you don't confuse yourself). Setting all file 1772fd as you want (as long as you don't confuse yourself). Setting all file
1686descriptors to non-blocking mode is also usually a good idea (but not 1773descriptors to non-blocking mode is also usually a good idea (but not
1687required if you know what you are doing). 1774required if you know what you are doing).
1688.PP 1775.PP
1689If you cannot use non-blocking mode, then force the use of a
1690known-to-be-good backend (at the time of this writing, this includes only
1691\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR). The same applies to file
1692descriptors for which non-blocking operation makes no sense (such as
1693files) \- libev doesn't guarantee any specific behaviour in that case.
1694.PP
1695Another thing you have to watch out for is that it is quite easy to 1776Another thing you have to watch out for is that it is quite easy to
1696receive \*(L"spurious\*(R" readiness notifications, that is your callback might 1777receive \*(L"spurious\*(R" readiness notifications, that is, your callback might
1697be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block 1778be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
1698because there is no data. Not only are some backends known to create a 1779because there is no data. It is very easy to get into this situation even
1699lot of those (for example Solaris ports), it is very easy to get into 1780with a relatively standard program structure. Thus it is best to always
1700this situation even with a relatively standard program structure. Thus 1781use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning \f(CW\*(C`EAGAIN\*(C'\fR is far
1701it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
1702\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. 1782preferable to a program hanging until some data arrives.
1703.PP 1783.PP
1704If you cannot run the fd in non-blocking mode (for example you should 1784If you cannot run the fd in non-blocking mode (for example you should
1705not play around with an Xlib connection), then you have to separately 1785not play around with an Xlib connection), then you have to separately
1706re-test whether a file descriptor is really ready with a known-to-be good 1786re-test whether a file descriptor is really ready with a known-to-be good
1707interface such as poll (fortunately in our Xlib example, Xlib already 1787interface such as poll (fortunately in the case of Xlib, it already does
1708does this on its own, so its quite safe to use). Some people additionally 1788this on its own, so its quite safe to use). Some people additionally
1709use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block 1789use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block
1710indefinitely. 1790indefinitely.
1711.PP 1791.PP
1712But really, best use non-blocking mode. 1792But really, best use non-blocking mode.
1713.PP 1793.PP
1714\fIThe special problem of disappearing file descriptors\fR 1794\fIThe special problem of disappearing file descriptors\fR
1715.IX Subsection "The special problem of disappearing file descriptors" 1795.IX Subsection "The special problem of disappearing file descriptors"
1716.PP 1796.PP
1717Some backends (e.g. kqueue, epoll) need to be told about closing a file 1797Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1718descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means, 1798a file descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other
1719such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file 1799means, such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some
1720descriptor, but when it goes away, the operating system will silently drop 1800file descriptor, but when it goes away, the operating system will silently
1721this interest. If another file descriptor with the same number then is 1801drop this interest. If another file descriptor with the same number then
1722registered with libev, there is no efficient way to see that this is, in 1802is registered with libev, there is no efficient way to see that this is,
1723fact, a different file descriptor. 1803in fact, a different file descriptor.
1724.PP 1804.PP
1725To avoid having to explicitly tell libev about such cases, libev follows 1805To avoid having to explicitly tell libev about such cases, libev follows
1726the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev 1806the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1727will assume that this is potentially a new file descriptor, otherwise 1807will assume that this is potentially a new file descriptor, otherwise
1728it is assumed that the file descriptor stays the same. That means that 1808it is assumed that the file descriptor stays the same. That means that
1743.PP 1823.PP
1744There is no workaround possible except not registering events 1824There is no workaround possible except not registering events
1745for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to 1825for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1746\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1826\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1747.PP 1827.PP
1828\fIThe special problem of files\fR
1829.IX Subsection "The special problem of files"
1830.PP
1831Many people try to use \f(CW\*(C`select\*(C'\fR (or libev) on file descriptors
1832representing files, and expect it to become ready when their program
1833doesn't block on disk accesses (which can take a long time on their own).
1834.PP
1835However, this cannot ever work in the \*(L"expected\*(R" way \- you get a readiness
1836notification as soon as the kernel knows whether and how much data is
1837there, and in the case of open files, that's always the case, so you
1838always get a readiness notification instantly, and your read (or possibly
1839write) will still block on the disk I/O.
1840.PP
1841Another way to view it is that in the case of sockets, pipes, character
1842devices and so on, there is another party (the sender) that delivers data
1843on its own, but in the case of files, there is no such thing: the disk
1844will not send data on its own, simply because it doesn't know what you
1845wish to read \- you would first have to request some data.
1846.PP
1847Since files are typically not-so-well supported by advanced notification
1848mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1849to files, even though you should not use it. The reason for this is
1850convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1851usually a tty, often a pipe, but also sometimes files or special devices
1852(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1853\&\fI/dev/urandom\fR), and even though the file might better be served with
1854asynchronous I/O instead of with non-blocking I/O, it is still useful when
1855it \*(L"just works\*(R" instead of freezing.
1856.PP
1857So avoid file descriptors pointing to files when you know it (e.g. use
1858libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1859when you rarely read from a file instead of from a socket, and want to
1860reuse the same code path.
1861.PP
1748\fIThe special problem of fork\fR 1862\fIThe special problem of fork\fR
1749.IX Subsection "The special problem of fork" 1863.IX Subsection "The special problem of fork"
1750.PP 1864.PP
1751Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1865Some backends (epoll, kqueue, probably linuxaio) do not support \f(CW\*(C`fork ()\*(C'\fR
1752useless behaviour. Libev fully supports fork, but needs to be told about 1866at all or exhibit useless behaviour. Libev fully supports fork, but needs
1753it in the child. 1867to be told about it in the child if you want to continue to use it in the
1868child.
1754.PP 1869.PP
1755To support fork in your programs, you either have to call 1870To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1756\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, 1871()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1757enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or 1872\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1758\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1759.PP 1873.PP
1760\fIThe special problem of \s-1SIGPIPE\s0\fR 1874\fIThe special problem of \s-1SIGPIPE\s0\fR
1761.IX Subsection "The special problem of SIGPIPE" 1875.IX Subsection "The special problem of SIGPIPE"
1762.PP 1876.PP
1763While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1877While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1764when writing to a pipe whose other end has been closed, your program gets 1878when writing to a pipe whose other end has been closed, your program gets
1765sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs 1879sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1766this is sensible behaviour, for daemons, this is usually undesirable. 1880this is sensible behaviour, for daemons, this is usually undesirable.
1767.PP 1881.PP
1768So when you encounter spurious, unexplained daemon exits, make sure you 1882So when you encounter spurious, unexplained daemon exits, make sure you
1769ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon 1883ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1770somewhere, as that would have given you a big clue). 1884somewhere, as that would have given you a big clue).
1771.PP 1885.PP
1772\fIThe special problem of \fIaccept()\fIing when you can't\fR 1886\fIThe special problem of \f(BIaccept()\fIing when you can't\fR
1773.IX Subsection "The special problem of accept()ing when you can't" 1887.IX Subsection "The special problem of accept()ing when you can't"
1774.PP 1888.PP
1775Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, 1889Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
1776found in post\-2004 Linux) have the peculiar behaviour of not removing a 1890found in post\-2004 Linux) have the peculiar behaviour of not removing a
1777connection from the pending queue in all error cases. 1891connection from the pending queue in all error cases.
1861detecting time jumps is hard, and some inaccuracies are unavoidable (the 1975detecting time jumps is hard, and some inaccuracies are unavoidable (the
1862monotonic clock option helps a lot here). 1976monotonic clock option helps a lot here).
1863.PP 1977.PP
1864The callback is guaranteed to be invoked only \fIafter\fR its timeout has 1978The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1865passed (not \fIat\fR, so on systems with very low-resolution clocks this 1979passed (not \fIat\fR, so on systems with very low-resolution clocks this
1866might introduce a small delay). If multiple timers become ready during the 1980might introduce a small delay, see \*(L"the special problem of being too
1981early\*(R", below). If multiple timers become ready during the same loop
1867same loop iteration then the ones with earlier time-out values are invoked 1982iteration then the ones with earlier time-out values are invoked before
1868before ones of the same priority with later time-out values (but this is 1983ones of the same priority with later time-out values (but this is no
1869no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively). 1984longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1870.PP 1985.PP
1871\fIBe smart about timeouts\fR 1986\fIBe smart about timeouts\fR
1872.IX Subsection "Be smart about timeouts" 1987.IX Subsection "Be smart about timeouts"
1873.PP 1988.PP
1874Many real-world problems involve some kind of timeout, usually for error 1989Many real-world problems involve some kind of timeout, usually for error
1956.Sp 2071.Sp
1957In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, 2072In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
1958but remember the time of last activity, and check for a real timeout only 2073but remember the time of last activity, and check for a real timeout only
1959within the callback: 2074within the callback:
1960.Sp 2075.Sp
1961.Vb 1 2076.Vb 3
2077\& ev_tstamp timeout = 60.;
1962\& ev_tstamp last_activity; // time of last activity 2078\& ev_tstamp last_activity; // time of last activity
2079\& ev_timer timer;
1963\& 2080\&
1964\& static void 2081\& static void
1965\& callback (EV_P_ ev_timer *w, int revents) 2082\& callback (EV_P_ ev_timer *w, int revents)
1966\& { 2083\& {
1967\& ev_tstamp now = ev_now (EV_A); 2084\& // calculate when the timeout would happen
1968\& ev_tstamp timeout = last_activity + 60.; 2085\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
1969\& 2086\&
1970\& // if last_activity + 60. is older than now, we did time out 2087\& // if negative, it means we the timeout already occurred
1971\& if (timeout < now) 2088\& if (after < 0.)
1972\& { 2089\& {
1973\& // timeout occurred, take action 2090\& // timeout occurred, take action
1974\& } 2091\& }
1975\& else 2092\& else
1976\& { 2093\& {
1977\& // callback was invoked, but there was some activity, re\-arm 2094\& // callback was invoked, but there was some recent
1978\& // the watcher to fire in last_activity + 60, which is 2095\& // activity. simply restart the timer to time out
1979\& // guaranteed to be in the future, so "again" is positive: 2096\& // after "after" seconds, which is the earliest time
1980\& w\->repeat = timeout \- now; 2097\& // the timeout can occur.
2098\& ev_timer_set (w, after, 0.);
1981\& ev_timer_again (EV_A_ w); 2099\& ev_timer_start (EV_A_ w);
1982\& } 2100\& }
1983\& } 2101\& }
1984.Ve 2102.Ve
1985.Sp 2103.Sp
1986To summarise the callback: first calculate the real timeout (defined 2104To summarise the callback: first calculate in how many seconds the
1987as \*(L"60 seconds after the last activity\*(R"), then check if that time has 2105timeout will occur (by calculating the absolute time when it would occur,
1988been reached, which means something \fIdid\fR, in fact, time out. Otherwise 2106\&\f(CW\*(C`last_activity + timeout\*(C'\fR, and subtracting the current time, \f(CW\*(C`ev_now
1989the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so 2107(EV_A)\*(C'\fR from that).
1990re-schedule the timer to fire at that future time, to see if maybe we have
1991a timeout then.
1992.Sp 2108.Sp
1993Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the 2109If this value is negative, then we are already past the timeout, i.e. we
1994\&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running. 2110timed out, and need to do whatever is needed in this case.
2111.Sp
2112Otherwise, we now the earliest time at which the timeout would trigger,
2113and simply start the timer with this timeout value.
2114.Sp
2115In other words, each time the callback is invoked it will check whether
2116the timeout occurred. If not, it will simply reschedule itself to check
2117again at the earliest time it could time out. Rinse. Repeat.
1995.Sp 2118.Sp
1996This scheme causes more callback invocations (about one every 60 seconds 2119This scheme causes more callback invocations (about one every 60 seconds
1997minus half the average time between activity), but virtually no calls to 2120minus half the average time between activity), but virtually no calls to
1998libev to change the timeout. 2121libev to change the timeout.
1999.Sp 2122.Sp
2000To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR 2123To start the machinery, simply initialise the watcher and set
2001to the current time (meaning we just have some activity :), then call the 2124\&\f(CW\*(C`last_activity\*(C'\fR to the current time (meaning there was some activity just
2002callback, which will \*(L"do the right thing\*(R" and start the timer: 2125now), then call the callback, which will \*(L"do the right thing\*(R" and start
2126the timer:
2003.Sp 2127.Sp
2004.Vb 3 2128.Vb 3
2129\& last_activity = ev_now (EV_A);
2005\& ev_init (timer, callback); 2130\& ev_init (&timer, callback);
2006\& last_activity = ev_now (loop); 2131\& callback (EV_A_ &timer, 0);
2007\& callback (loop, timer, EV_TIMER);
2008.Ve 2132.Ve
2009.Sp 2133.Sp
2010And when there is some activity, simply store the current time in 2134When there is some activity, simply store the current time in
2011\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: 2135\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
2012.Sp 2136.Sp
2013.Vb 1 2137.Vb 2
2138\& if (activity detected)
2014\& last_activity = ev_now (loop); 2139\& last_activity = ev_now (EV_A);
2140.Ve
2141.Sp
2142When your timeout value changes, then the timeout can be changed by simply
2143providing a new value, stopping the timer and calling the callback, which
2144will again do the right thing (for example, time out immediately :).
2145.Sp
2146.Vb 3
2147\& timeout = new_value;
2148\& ev_timer_stop (EV_A_ &timer);
2149\& callback (EV_A_ &timer, 0);
2015.Ve 2150.Ve
2016.Sp 2151.Sp
2017This technique is slightly more complex, but in most cases where the 2152This technique is slightly more complex, but in most cases where the
2018time-out is unlikely to be triggered, much more efficient. 2153time-out is unlikely to be triggered, much more efficient.
2019.Sp
2020Changing the timeout is trivial as well (if it isn't hard-coded in the
2021callback :) \- just change the timeout and invoke the callback, which will
2022fix things for you.
2023.IP "4. Wee, just use a double-linked list for your timeouts." 4 2154.IP "4. Wee, just use a double-linked list for your timeouts." 4
2024.IX Item "4. Wee, just use a double-linked list for your timeouts." 2155.IX Item "4. Wee, just use a double-linked list for your timeouts."
2025If there is not one request, but many thousands (millions...), all 2156If there is not one request, but many thousands (millions...), all
2026employing some kind of timeout with the same timeout value, then one can 2157employing some kind of timeout with the same timeout value, then one can
2027do even better: 2158do even better:
2051Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2182Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
2052rather complicated, but extremely efficient, something that really pays 2183rather complicated, but extremely efficient, something that really pays
2053off after the first million or so of active timers, i.e. it's usually 2184off after the first million or so of active timers, i.e. it's usually
2054overkill :) 2185overkill :)
2055.PP 2186.PP
2187\fIThe special problem of being too early\fR
2188.IX Subsection "The special problem of being too early"
2189.PP
2190If you ask a timer to call your callback after three seconds, then
2191you expect it to be invoked after three seconds \- but of course, this
2192cannot be guaranteed to infinite precision. Less obviously, it cannot be
2193guaranteed to any precision by libev \- imagine somebody suspending the
2194process with a \s-1STOP\s0 signal for a few hours for example.
2195.PP
2196So, libev tries to invoke your callback as soon as possible \fIafter\fR the
2197delay has occurred, but cannot guarantee this.
2198.PP
2199A less obvious failure mode is calling your callback too early: many event
2200loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but
2201this can cause your callback to be invoked much earlier than you would
2202expect.
2203.PP
2204To see why, imagine a system with a clock that only offers full second
2205resolution (think windows if you can't come up with a broken enough \s-1OS\s0
2206yourself). If you schedule a one-second timer at the time 500.9, then the
2207event loop will schedule your timeout to elapse at a system time of 500
2208(500.9 truncated to the resolution) + 1, or 501.
2209.PP
2210If an event library looks at the timeout 0.1s later, it will see \*(L"501 >=
2211501\*(R" and invoke the callback 0.1s after it was started, even though a
2212one-second delay was requested \- this is being \*(L"too early\*(R", despite best
2213intentions.
2214.PP
2215This is the reason why libev will never invoke the callback if the elapsed
2216delay equals the requested delay, but only when the elapsed delay is
2217larger than the requested delay. In the example above, libev would only invoke
2218the callback at system time 502, or 1.1s after the timer was started.
2219.PP
2220So, while libev cannot guarantee that your callback will be invoked
2221exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested
2222delay has actually elapsed, or in other words, it always errs on the \*(L"too
2223late\*(R" side of things.
2224.PP
2056\fIThe special problem of time updates\fR 2225\fIThe special problem of time updates\fR
2057.IX Subsection "The special problem of time updates" 2226.IX Subsection "The special problem of time updates"
2058.PP 2227.PP
2059Establishing the current time is a costly operation (it usually takes at 2228Establishing the current time is a costly operation (it usually takes
2060least two system calls): \s-1EV\s0 therefore updates its idea of the current 2229at least one system call): \s-1EV\s0 therefore updates its idea of the current
2061time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a 2230time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a
2062growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling 2231growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
2063lots of events in one iteration. 2232lots of events in one iteration.
2064.PP 2233.PP
2065The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2234The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
2066time. This is usually the right thing as this timestamp refers to the time 2235time. This is usually the right thing as this timestamp refers to the time
2067of the event triggering whatever timeout you are modifying/starting. If 2236of the event triggering whatever timeout you are modifying/starting. If
2068you suspect event processing to be delayed and you \fIneed\fR to base the 2237you suspect event processing to be delayed and you \fIneed\fR to base the
2069timeout on the current time, use something like this to adjust for this: 2238timeout on the current time, use something like the following to adjust
2239for it:
2070.PP 2240.PP
2071.Vb 1 2241.Vb 1
2072\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 2242\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
2073.Ve 2243.Ve
2074.PP 2244.PP
2075If the event loop is suspended for a long time, you can also force an 2245If the event loop is suspended for a long time, you can also force an
2076update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 2246update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
2077()\*(C'\fR. 2247()\*(C'\fR, although that will push the event time of all outstanding events
2248further into the future.
2249.PP
2250\fIThe special problem of unsynchronised clocks\fR
2251.IX Subsection "The special problem of unsynchronised clocks"
2252.PP
2253Modern systems have a variety of clocks \- libev itself uses the normal
2254\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time
2255jumps).
2256.PP
2257Neither of these clocks is synchronised with each other or any other clock
2258on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time
2259than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example,
2260a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher
2261than a directly following call to \f(CW\*(C`time\*(C'\fR.
2262.PP
2263The moral of this is to only compare libev-related timestamps with
2264\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than
2265a second or so.
2266.PP
2267One more problem arises due to this lack of synchronisation: if libev uses
2268the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR
2269or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is
2270invoked, you will find that sometimes the callback is a bit \*(L"early\*(R".
2271.PP
2272This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so
2273libev makes sure your callback is not invoked before the delay happened,
2274\&\fImeasured according to the real time\fR, not the system clock.
2275.PP
2276If your timeouts are based on a physical timescale (e.g. \*(L"time out this
2277connection after 100 seconds\*(R") then this shouldn't bother you as it is
2278exactly the right behaviour.
2279.PP
2280If you want to compare wall clock/system timestamps to your timers, then
2281you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock
2282time, where your comparisons will always generate correct results.
2078.PP 2283.PP
2079\fIThe special problems of suspended animation\fR 2284\fIThe special problems of suspended animation\fR
2080.IX Subsection "The special problems of suspended animation" 2285.IX Subsection "The special problems of suspended animation"
2081.PP 2286.PP
2082When you leave the server world it is quite customary to hit machines that 2287When you leave the server world it is quite customary to hit machines that
2113.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2318.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
2114.PD 0 2319.PD 0
2115.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2320.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
2116.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 2321.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
2117.PD 2322.PD
2118Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR 2323Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds (fractional and
2119is \f(CW0.\fR, then it will automatically be stopped once the timeout is 2324negative values are supported). If \f(CW\*(C`repeat\*(C'\fR is \f(CW0.\fR, then it will
2120reached. If it is positive, then the timer will automatically be 2325automatically be stopped once the timeout is reached. If it is positive,
2121configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, 2326then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
2122until stopped manually. 2327seconds later, again, and again, until stopped manually.
2123.Sp 2328.Sp
2124The timer itself will do a best-effort at avoiding drift, that is, if 2329The timer itself will do a best-effort at avoiding drift, that is, if
2125you configure a timer to trigger every 10 seconds, then it will normally 2330you configure a timer to trigger every 10 seconds, then it will normally
2126trigger at exactly 10 second intervals. If, however, your program cannot 2331trigger at exactly 10 second intervals. If, however, your program cannot
2127keep up with the timer (because it takes longer than those 10 seconds to 2332keep up with the timer (because it takes longer than those 10 seconds to
2128do stuff) the timer will not fire more than once per event loop iteration. 2333do stuff) the timer will not fire more than once per event loop iteration.
2129.IP "ev_timer_again (loop, ev_timer *)" 4 2334.IP "ev_timer_again (loop, ev_timer *)" 4
2130.IX Item "ev_timer_again (loop, ev_timer *)" 2335.IX Item "ev_timer_again (loop, ev_timer *)"
2131This will act as if the timer timed out and restart it again if it is 2336This will act as if the timer timed out, and restarts it again if it is
2132repeating. The exact semantics are: 2337repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the
2338timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR.
2133.Sp 2339.Sp
2340The exact semantics are as in the following rules, all of which will be
2341applied to the watcher:
2342.RS 4
2134If the timer is pending, its pending status is cleared. 2343.IP "If the timer is pending, the pending status is always cleared." 4
2135.Sp 2344.IX Item "If the timer is pending, the pending status is always cleared."
2345.PD 0
2136If the timer is started but non-repeating, stop it (as if it timed out). 2346.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4
2137.Sp 2347.IX Item "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)."
2138If the timer is repeating, either start it if necessary (with the 2348.ie n .IP "If the timer is repeating, make the ""repeat"" value the new timeout and start the timer, if necessary." 4
2139\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 2349.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4
2350.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary."
2351.RE
2352.RS 4
2353.PD
2140.Sp 2354.Sp
2141This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a 2355This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
2142usage example. 2356usage example.
2357.RE
2143.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4 2358.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
2144.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 2359.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
2145Returns the remaining time until a timer fires. If the timer is active, 2360Returns the remaining time until a timer fires. If the timer is active,
2146then this time is relative to the current event loop time, otherwise it's 2361then this time is relative to the current event loop time, otherwise it's
2147the timeout value currently configured. 2362the timeout value currently configured.
2199Periodic watchers are also timers of a kind, but they are very versatile 2414Periodic watchers are also timers of a kind, but they are very versatile
2200(and unfortunately a bit complex). 2415(and unfortunately a bit complex).
2201.PP 2416.PP
2202Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or 2417Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
2203relative time, the physical time that passes) but on wall clock time 2418relative time, the physical time that passes) but on wall clock time
2204(absolute time, the thing you can read on your calender or clock). The 2419(absolute time, the thing you can read on your calendar or clock). The
2205difference is that wall clock time can run faster or slower than real 2420difference is that wall clock time can run faster or slower than real
2206time, and time jumps are not uncommon (e.g. when you adjust your 2421time, and time jumps are not uncommon (e.g. when you adjust your
2207wrist-watch). 2422wrist-watch).
2208.PP 2423.PP
2209You can tell a periodic watcher to trigger after some specific point 2424You can tell a periodic watcher to trigger after some specific point
2214\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting 2429\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2215it, as it uses a relative timeout). 2430it, as it uses a relative timeout).
2216.PP 2431.PP
2217\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex 2432\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
2218timers, such as triggering an event on each \*(L"midnight, local time\*(R", or 2433timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
2219other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as 2434other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2220those cannot react to time jumps. 2435watchers, as those cannot react to time jumps.
2221.PP 2436.PP
2222As with timers, the callback is guaranteed to be invoked only when the 2437As with timers, the callback is guaranteed to be invoked only when the
2223point in time where it is supposed to trigger has passed. If multiple 2438point in time where it is supposed to trigger has passed. If multiple
2224timers become ready during the same loop iteration then the ones with 2439timers become ready during the same loop iteration then the ones with
2225earlier time-out values are invoked before ones with later time-out values 2440earlier time-out values are invoked before ones with later time-out values
2267.Sp 2482.Sp
2268Another way to think about it (for the mathematically inclined) is that 2483Another way to think about it (for the mathematically inclined) is that
2269\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2484\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
2270time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps. 2485time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
2271.Sp 2486.Sp
2272For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near 2487The \f(CW\*(C`interval\*(C'\fR \fI\s-1MUST\s0\fR be positive, and for numerical stability, the
2273\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 2488interval value should be higher than \f(CW\*(C`1/8192\*(C'\fR (which is around 100
2274this value, and in fact is often specified as zero. 2489microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have
2490at most a similar magnitude as the current time (say, within a factor of
2491ten). Typical values for offset are, in fact, \f(CW0\fR or something between
2492\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range.
2275.Sp 2493.Sp
2276Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 2494Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
2277speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability 2495speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
2278will of course deteriorate. Libev itself tries to be exact to be about one 2496will of course deteriorate. Libev itself tries to be exact to be about one
2279millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). 2497millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
2283In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being 2501In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
2284ignored. Instead, each time the periodic watcher gets scheduled, the 2502ignored. Instead, each time the periodic watcher gets scheduled, the
2285reschedule callback will be called with the watcher as first, and the 2503reschedule callback will be called with the watcher as first, and the
2286current time as second argument. 2504current time as second argument.
2287.Sp 2505.Sp
2288\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2506\&\s-1NOTE:\s0 \fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
2289or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly 2507or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2290allowed by documentation here\fR. 2508allowed by documentation here\fR.
2291.Sp 2509.Sp
2292If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2510If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2293it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2511it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2311.Sp 2529.Sp
2312\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2530\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
2313equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. 2531equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2314.Sp 2532.Sp
2315This can be used to create very complex timers, such as a timer that 2533This can be used to create very complex timers, such as a timer that
2316triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the 2534triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate
2317next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2535the next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for
2318you do this is, again, up to you (but it is not trivial, which is the main 2536this. Here is a (completely untested, no error checking) example on how to
2319reason I omitted it as an example). 2537do this:
2538.Sp
2539.Vb 1
2540\& #include <time.h>
2541\&
2542\& static ev_tstamp
2543\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2544\& {
2545\& time_t tnow = (time_t)now;
2546\& struct tm tm;
2547\& localtime_r (&tnow, &tm);
2548\&
2549\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2550\& ++tm.tm_mday; // midnight next day
2551\&
2552\& return mktime (&tm);
2553\& }
2554.Ve
2555.Sp
2556Note: this code might run into trouble on days that have more then two
2557midnights (beginning and end).
2320.RE 2558.RE
2321.RS 4 2559.RS 4
2322.RE 2560.RE
2323.IP "ev_periodic_again (loop, ev_periodic *)" 4 2561.IP "ev_periodic_again (loop, ev_periodic *)" 4
2324.IX Item "ev_periodic_again (loop, ev_periodic *)" 2562.IX Item "ev_periodic_again (loop, ev_periodic *)"
2409only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your 2647only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
2410default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for 2648default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
2411\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At 2649\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
2412the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop. 2650the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2413.PP 2651.PP
2414When the first watcher gets started will libev actually register something 2652Only after the first watcher for a signal is started will libev actually
2415with the kernel (thus it coexists with your own signal handlers as long as 2653register something with the kernel. It thus coexists with your own signal
2416you don't register any with libev for the same signal). 2654handlers as long as you don't register any with libev for the same signal.
2417.PP 2655.PP
2418If possible and supported, libev will install its handlers with 2656If possible and supported, libev will install its handlers with
2419\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should 2657\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
2420not be unduly interrupted. If you have a problem with system calls getting 2658not be unduly interrupted. If you have a problem with system calls getting
2421interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher 2659interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2425.IX Subsection "The special problem of inheritance over fork/execve/pthread_create" 2663.IX Subsection "The special problem of inheritance over fork/execve/pthread_create"
2426.PP 2664.PP
2427Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition 2665Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition
2428(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after 2666(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after
2429stopping it again), that is, libev might or might not block the signal, 2667stopping it again), that is, libev might or might not block the signal,
2430and might or might not set or restore the installed signal handler. 2668and might or might not set or restore the installed signal handler (but
2669see \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR).
2431.PP 2670.PP
2432While this does not matter for the signal disposition (libev never 2671While this does not matter for the signal disposition (libev never
2433sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on 2672sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on
2434\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect 2673\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect
2435certain signals to be blocked. 2674certain signals to be blocked.
2448\&\fIhas\fR to modify the signal mask, at least temporarily. 2687\&\fIhas\fR to modify the signal mask, at least temporarily.
2449.PP 2688.PP
2450So I can't stress this enough: \fIIf you do not reset your signal mask when 2689So I can't stress this enough: \fIIf you do not reset your signal mask when
2451you expect it to be empty, you have a race condition in your code\fR. This 2690you expect it to be empty, you have a race condition in your code\fR. This
2452is not a libev-specific thing, this is true for most event libraries. 2691is not a libev-specific thing, this is true for most event libraries.
2692.PP
2693\fIThe special problem of threads signal handling\fR
2694.IX Subsection "The special problem of threads signal handling"
2695.PP
2696\&\s-1POSIX\s0 threads has problematic signal handling semantics, specifically,
2697a lot of functionality (sigfd, sigwait etc.) only really works if all
2698threads in a process block signals, which is hard to achieve.
2699.PP
2700When you want to use sigwait (or mix libev signal handling with your own
2701for the same signals), you can tackle this problem by globally blocking
2702all signals before creating any threads (or creating them with a fully set
2703sigprocmask) and also specifying the \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when creating
2704loops. Then designate one thread as \*(L"signal receiver thread\*(R" which handles
2705these signals. You can pass on any signals that libev might be interested
2706in by calling \f(CW\*(C`ev_feed_signal\*(C'\fR.
2453.PP 2707.PP
2454\fIWatcher-Specific Functions and Data Members\fR 2708\fIWatcher-Specific Functions and Data Members\fR
2455.IX Subsection "Watcher-Specific Functions and Data Members" 2709.IX Subsection "Watcher-Specific Functions and Data Members"
2456.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 2710.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
2457.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 2711.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
2466The signal the watcher watches out for. 2720The signal the watcher watches out for.
2467.PP 2721.PP
2468\fIExamples\fR 2722\fIExamples\fR
2469.IX Subsection "Examples" 2723.IX Subsection "Examples"
2470.PP 2724.PP
2471Example: Try to exit cleanly on \s-1SIGINT\s0. 2725Example: Try to exit cleanly on \s-1SIGINT.\s0
2472.PP 2726.PP
2473.Vb 5 2727.Vb 5
2474\& static void 2728\& static void
2475\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2729\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2476\& { 2730\& {
2591.ie n .SS """ev_stat"" \- did the file attributes just change?" 2845.ie n .SS """ev_stat"" \- did the file attributes just change?"
2592.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2846.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2593.IX Subsection "ev_stat - did the file attributes just change?" 2847.IX Subsection "ev_stat - did the file attributes just change?"
2594This watches a file system path for attribute changes. That is, it calls 2848This watches a file system path for attribute changes. That is, it calls
2595\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) 2849\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2596and sees if it changed compared to the last time, invoking the callback if 2850and sees if it changed compared to the last time, invoking the callback
2597it did. 2851if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2852happen after the watcher has been started will be reported.
2598.PP 2853.PP
2599The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2854The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
2600not exist\*(R" is a status change like any other. The condition \*(L"path does not 2855not exist\*(R" is a status change like any other. The condition \*(L"path does not
2601exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the 2856exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
2602\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at 2857\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
2632compilation environment, which means that on systems with large file 2887compilation environment, which means that on systems with large file
2633support disabled by default, you get the 32 bit version of the stat 2888support disabled by default, you get the 32 bit version of the stat
2634structure. When using the library from programs that change the \s-1ABI\s0 to 2889structure. When using the library from programs that change the \s-1ABI\s0 to
2635use 64 bit file offsets the programs will fail. In that case you have to 2890use 64 bit file offsets the programs will fail. In that case you have to
2636compile libev with the same flags to get binary compatibility. This is 2891compile libev with the same flags to get binary compatibility. This is
2637obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2892obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2638most noticeably displayed with ev_stat and large file support. 2893most noticeably displayed with ev_stat and large file support.
2639.PP 2894.PP
2640The solution for this is to lobby your distribution maker to make large 2895The solution for this is to lobby your distribution maker to make large
2641file interfaces available by default (as e.g. FreeBSD does) and not 2896file interfaces available by default (as e.g. FreeBSD does) and not
2642optional. Libev cannot simply switch on large file support because it has 2897optional. Libev cannot simply switch on large file support because it has
2833Apart from keeping your process non-blocking (which is a useful 3088Apart from keeping your process non-blocking (which is a useful
2834effect on its own sometimes), idle watchers are a good place to do 3089effect on its own sometimes), idle watchers are a good place to do
2835\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the 3090\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2836event loop has handled all outstanding events. 3091event loop has handled all outstanding events.
2837.PP 3092.PP
3093\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3094.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3095.PP
3096As long as there is at least one active idle watcher, libev will never
3097sleep unnecessarily. Or in other words, it will loop as fast as possible.
3098For this to work, the idle watcher doesn't need to be invoked at all \- the
3099lowest priority will do.
3100.PP
3101This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3102to do something on each event loop iteration \- for example to balance load
3103between different connections.
3104.PP
3105See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3106example.
3107.PP
2838\fIWatcher-Specific Functions and Data Members\fR 3108\fIWatcher-Specific Functions and Data Members\fR
2839.IX Subsection "Watcher-Specific Functions and Data Members" 3109.IX Subsection "Watcher-Specific Functions and Data Members"
2840.IP "ev_idle_init (ev_idle *, callback)" 4 3110.IP "ev_idle_init (ev_idle *, callback)" 4
2841.IX Item "ev_idle_init (ev_idle *, callback)" 3111.IX Item "ev_idle_init (ev_idle *, callback)"
2842Initialises and configures the idle watcher \- it has no parameters of any 3112Initialises and configures the idle watcher \- it has no parameters of any
2847.IX Subsection "Examples" 3117.IX Subsection "Examples"
2848.PP 3118.PP
2849Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 3119Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
2850callback, free it. Also, use no error checking, as usual. 3120callback, free it. Also, use no error checking, as usual.
2851.PP 3121.PP
2852.Vb 7 3122.Vb 5
2853\& static void 3123\& static void
2854\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3124\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2855\& { 3125\& {
3126\& // stop the watcher
3127\& ev_idle_stop (loop, w);
3128\&
3129\& // now we can free it
2856\& free (w); 3130\& free (w);
3131\&
2857\& // now do something you wanted to do when the program has 3132\& // now do something you wanted to do when the program has
2858\& // no longer anything immediate to do. 3133\& // no longer anything immediate to do.
2859\& } 3134\& }
2860\& 3135\&
2861\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3136\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2863\& ev_idle_start (loop, idle_watcher); 3138\& ev_idle_start (loop, idle_watcher);
2864.Ve 3139.Ve
2865.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" 3140.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
2866.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 3141.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
2867.IX Subsection "ev_prepare and ev_check - customise your event loop!" 3142.IX Subsection "ev_prepare and ev_check - customise your event loop!"
2868Prepare and check watchers are usually (but not always) used in pairs: 3143Prepare and check watchers are often (but not always) used in pairs:
2869prepare watchers get invoked before the process blocks and check watchers 3144prepare watchers get invoked before the process blocks and check watchers
2870afterwards. 3145afterwards.
2871.PP 3146.PP
2872You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter 3147You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the
2873the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 3148current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or
2874watchers. Other loops than the current one are fine, however. The 3149\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine,
2875rationale behind this is that you do not need to check for recursion in 3150however. The rationale behind this is that you do not need to check
2876those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 3151for recursion in those watchers, i.e. the sequence will always be
2877\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 3152\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each
2878called in pairs bracketing the blocking call. 3153kind they will always be called in pairs bracketing the blocking call.
2879.PP 3154.PP
2880Their main purpose is to integrate other event mechanisms into libev and 3155Their main purpose is to integrate other event mechanisms into libev and
2881their use is somewhat advanced. They could be used, for example, to track 3156their use is somewhat advanced. They could be used, for example, to track
2882variable changes, implement your own watchers, integrate net-snmp or a 3157variable changes, implement your own watchers, integrate net-snmp or a
2883coroutine library and lots more. They are also occasionally useful if 3158coroutine library and lots more. They are also occasionally useful if
2901with priority higher than or equal to the event loop and one coroutine 3176with priority higher than or equal to the event loop and one coroutine
2902of lower priority, but only once, using idle watchers to keep the event 3177of lower priority, but only once, using idle watchers to keep the event
2903loop from blocking if lower-priority coroutines are active, thus mapping 3178loop from blocking if lower-priority coroutines are active, thus mapping
2904low-priority coroutines to idle/background tasks). 3179low-priority coroutines to idle/background tasks).
2905.PP 3180.PP
2906It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 3181When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
2907priority, to ensure that they are being run before any other watchers 3182highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
2908after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers). 3183any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3184watchers).
2909.PP 3185.PP
2910Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not 3186Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
2911activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they 3187activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
2912might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As 3188might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
2913\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event 3189\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
2914loops those other event loops might be in an unusable state until their 3190loops those other event loops might be in an unusable state until their
2915\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with 3191\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
2916others). 3192others).
3193.PP
3194\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3195.IX Subsection "Abusing an ev_check watcher for its side-effect"
3196.PP
3197\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3198useful because they are called once per event loop iteration. For
3199example, if you want to handle a large number of connections fairly, you
3200normally only do a bit of work for each active connection, and if there
3201is more work to do, you wait for the next event loop iteration, so other
3202connections have a chance of making progress.
3203.PP
3204Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3205next event loop iteration. However, that isn't as soon as possible \-
3206without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3207.PP
3208This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3209single global idle watcher that is active as long as you have one active
3210\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3211will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3212invoked. Neither watcher alone can do that.
2917.PP 3213.PP
2918\fIWatcher-Specific Functions and Data Members\fR 3214\fIWatcher-Specific Functions and Data Members\fR
2919.IX Subsection "Watcher-Specific Functions and Data Members" 3215.IX Subsection "Watcher-Specific Functions and Data Members"
2920.IP "ev_prepare_init (ev_prepare *, callback)" 4 3216.IP "ev_prepare_init (ev_prepare *, callback)" 4
2921.IX Item "ev_prepare_init (ev_prepare *, callback)" 3217.IX Item "ev_prepare_init (ev_prepare *, callback)"
3032.Ve 3328.Ve
3033.PP 3329.PP
3034Method 4: Do not use a prepare or check watcher because the module you 3330Method 4: Do not use a prepare or check watcher because the module you
3035want to embed is not flexible enough to support it. Instead, you can 3331want to embed is not flexible enough to support it. Instead, you can
3036override their poll function. The drawback with this solution is that the 3332override their poll function. The drawback with this solution is that the
3037main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses 3333main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
3038this approach, effectively embedding \s-1EV\s0 as a client into the horrible 3334this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3039libglib event loop. 3335libglib event loop.
3040.PP 3336.PP
3041.Vb 4 3337.Vb 4
3042\& static gint 3338\& static gint
3126\fIWatcher-Specific Functions and Data Members\fR 3422\fIWatcher-Specific Functions and Data Members\fR
3127.IX Subsection "Watcher-Specific Functions and Data Members" 3423.IX Subsection "Watcher-Specific Functions and Data Members"
3128.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3424.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
3129.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3425.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
3130.PD 0 3426.PD 0
3131.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3427.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
3132.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3428.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
3133.PD 3429.PD
3134Configures the watcher to embed the given loop, which must be 3430Configures the watcher to embed the given loop, which must be
3135embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3431embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
3136invoked automatically, otherwise it is the responsibility of the callback 3432invoked automatically, otherwise it is the responsibility of the callback
3137to invoke it (it will continue to be called until the sweep has been done, 3433to invoke it (it will continue to be called until the sweep has been done,
3156.PP 3452.PP
3157.Vb 3 3453.Vb 3
3158\& struct ev_loop *loop_hi = ev_default_init (0); 3454\& struct ev_loop *loop_hi = ev_default_init (0);
3159\& struct ev_loop *loop_lo = 0; 3455\& struct ev_loop *loop_lo = 0;
3160\& ev_embed embed; 3456\& ev_embed embed;
3161\& 3457\&
3162\& // see if there is a chance of getting one that works 3458\& // see if there is a chance of getting one that works
3163\& // (remember that a flags value of 0 means autodetection) 3459\& // (remember that a flags value of 0 means autodetection)
3164\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3460\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3165\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3461\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3166\& : 0; 3462\& : 0;
3182.PP 3478.PP
3183.Vb 3 3479.Vb 3
3184\& struct ev_loop *loop = ev_default_init (0); 3480\& struct ev_loop *loop = ev_default_init (0);
3185\& struct ev_loop *loop_socket = 0; 3481\& struct ev_loop *loop_socket = 0;
3186\& ev_embed embed; 3482\& ev_embed embed;
3187\& 3483\&
3188\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3484\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3189\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3485\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3190\& { 3486\& {
3191\& ev_embed_init (&embed, 0, loop_socket); 3487\& ev_embed_init (&embed, 0, loop_socket);
3192\& ev_embed_start (loop, &embed); 3488\& ev_embed_start (loop, &embed);
3200.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3496.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
3201.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 3497.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
3202.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 3498.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
3203Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 3499Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
3204whoever is a good citizen cared to tell libev about it by calling 3500whoever is a good citizen cared to tell libev about it by calling
3205\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 3501\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
3206event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 3502and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
3207and only in the child after the fork. If whoever good citizen calling 3503after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
3208\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 3504and calls it in the wrong process, the fork handlers will be invoked, too,
3209handlers will be invoked, too, of course. 3505of course.
3210.PP 3506.PP
3211\fIThe special problem of life after fork \- how is it possible?\fR 3507\fIThe special problem of life after fork \- how is it possible?\fR
3212.IX Subsection "The special problem of life after fork - how is it possible?" 3508.IX Subsection "The special problem of life after fork - how is it possible?"
3213.PP 3509.PP
3214Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set 3510Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set
3215up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This 3511up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3216sequence should be handled by libev without any problems. 3512sequence should be handled by libev without any problems.
3217.PP 3513.PP
3218This changes when the application actually wants to do event handling 3514This changes when the application actually wants to do event handling
3219in the child, or both parent in child, in effect \*(L"continuing\*(R" after the 3515in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3288\& atexit (program_exits); 3584\& atexit (program_exits);
3289.Ve 3585.Ve
3290.ie n .SS """ev_async"" \- how to wake up an event loop" 3586.ie n .SS """ev_async"" \- how to wake up an event loop"
3291.el .SS "\f(CWev_async\fP \- how to wake up an event loop" 3587.el .SS "\f(CWev_async\fP \- how to wake up an event loop"
3292.IX Subsection "ev_async - how to wake up an event loop" 3588.IX Subsection "ev_async - how to wake up an event loop"
3293In general, you cannot use an \f(CW\*(C`ev_run\*(C'\fR from multiple threads or other 3589In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
3294asynchronous sources such as signal handlers (as opposed to multiple event 3590asynchronous sources such as signal handlers (as opposed to multiple event
3295loops \- those are of course safe to use in different threads). 3591loops \- those are of course safe to use in different threads).
3296.PP 3592.PP
3297Sometimes, however, you need to wake up an event loop you do not control, 3593Sometimes, however, you need to wake up an event loop you do not control,
3298for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR 3594for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR
3300it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe. 3596it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3301.PP 3597.PP
3302This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3598This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
3303too, are asynchronous in nature, and signals, too, will be compressed 3599too, are asynchronous in nature, and signals, too, will be compressed
3304(i.e. the number of callback invocations may be less than the number of 3600(i.e. the number of callback invocations may be less than the number of
3305\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). 3601\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
3306.PP 3602of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3307Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not 3603signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3308just the default loop. 3604even without knowing which loop owns the signal.
3309.PP 3605.PP
3310\fIQueueing\fR 3606\fIQueueing\fR
3311.IX Subsection "Queueing" 3607.IX Subsection "Queueing"
3312.PP 3608.PP
3313\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason 3609\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
3400kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless, 3696kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless,
3401trust me. 3697trust me.
3402.IP "ev_async_send (loop, ev_async *)" 4 3698.IP "ev_async_send (loop, ev_async *)" 4
3403.IX Item "ev_async_send (loop, ev_async *)" 3699.IX Item "ev_async_send (loop, ev_async *)"
3404Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds 3700Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
3405an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike 3701an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop, and instantly
3702returns.
3703.Sp
3406\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or 3704Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads,
3407similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding 3705signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the
3408section below on what exactly this means). 3706embedding section below on what exactly this means).
3409.Sp 3707.Sp
3410Note that, as with other watchers in libev, multiple events might get 3708Note that, as with other watchers in libev, multiple events might get
3411compressed into a single callback invocation (another way to look at this 3709compressed into a single callback invocation (another way to look at
3412is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered, set on \f(CW\*(C`ev_async_send\*(C'\fR, 3710this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on
3413reset when the event loop detects that). 3711\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that).
3414.Sp 3712.Sp
3415This call incurs the overhead of a system call only once per event loop 3713This call incurs the overhead of at most one extra system call per event
3416iteration, so while the overhead might be noticeable, it doesn't apply to 3714loop iteration, if the event loop is blocked, and no syscall at all if
3417repeated calls to \f(CW\*(C`ev_async_send\*(C'\fR for the same event loop. 3715the event loop (or your program) is processing events. That means that
3716repeated calls are basically free (there is no need to avoid calls for
3717performance reasons) and that the overhead becomes smaller (typically
3718zero) under load.
3418.IP "bool = ev_async_pending (ev_async *)" 4 3719.IP "bool = ev_async_pending (ev_async *)" 4
3419.IX Item "bool = ev_async_pending (ev_async *)" 3720.IX Item "bool = ev_async_pending (ev_async *)"
3420Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 3721Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
3421watcher but the event has not yet been processed (or even noted) by the 3722watcher but the event has not yet been processed (or even noted) by the
3422event loop. 3723event loop.
3431is a time window between the event loop checking and resetting the async 3732is a time window between the event loop checking and resetting the async
3432notification, and the callback being invoked. 3733notification, and the callback being invoked.
3433.SH "OTHER FUNCTIONS" 3734.SH "OTHER FUNCTIONS"
3434.IX Header "OTHER FUNCTIONS" 3735.IX Header "OTHER FUNCTIONS"
3435There are some other functions of possible interest. Described. Here. Now. 3736There are some other functions of possible interest. Described. Here. Now.
3436.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3737.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" 4
3437.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3738.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)"
3438This function combines a simple timer and an I/O watcher, calls your 3739This function combines a simple timer and an I/O watcher, calls your
3439callback on whichever event happens first and automatically stops both 3740callback on whichever event happens first and automatically stops both
3440watchers. This is useful if you want to wait for a single event on an fd 3741watchers. This is useful if you want to wait for a single event on an fd
3441or timeout without having to allocate/configure/start/stop/free one or 3742or timeout without having to allocate/configure/start/stop/free one or
3442more watchers yourself. 3743more watchers yourself.
3454\&\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 3755\&\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
3455value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR 3756value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3456a timeout and an io event at the same time \- you probably should give io 3757a timeout and an io event at the same time \- you probably should give io
3457events precedence. 3758events precedence.
3458.Sp 3759.Sp
3459Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3760Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3460.Sp 3761.Sp
3461.Vb 7 3762.Vb 7
3462\& static void stdin_ready (int revents, void *arg) 3763\& static void stdin_ready (int revents, void *arg)
3463\& { 3764\& {
3464\& if (revents & EV_READ) 3765\& if (revents & EV_READ)
3470\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3771\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3471.Ve 3772.Ve
3472.IP "ev_feed_fd_event (loop, int fd, int revents)" 4 3773.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
3473.IX Item "ev_feed_fd_event (loop, int fd, int revents)" 3774.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
3474Feed an event on the given fd, as if a file descriptor backend detected 3775Feed an event on the given fd, as if a file descriptor backend detected
3475the given events it. 3776the given events.
3476.IP "ev_feed_signal_event (loop, int signum)" 4 3777.IP "ev_feed_signal_event (loop, int signum)" 4
3477.IX Item "ev_feed_signal_event (loop, int signum)" 3778.IX Item "ev_feed_signal_event (loop, int signum)"
3478Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default 3779Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
3479loop!). 3780which is async-safe.
3781.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3782.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3783This section explains some common idioms that are not immediately
3784obvious. Note that examples are sprinkled over the whole manual, and this
3785section only contains stuff that wouldn't fit anywhere else.
3786.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3787.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3788Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3789or modify at any time: libev will completely ignore it. This can be used
3790to associate arbitrary data with your watcher. If you need more data and
3791don't want to allocate memory separately and store a pointer to it in that
3792data member, you can also \*(L"subclass\*(R" the watcher type and provide your own
3793data:
3794.PP
3795.Vb 7
3796\& struct my_io
3797\& {
3798\& ev_io io;
3799\& int otherfd;
3800\& void *somedata;
3801\& struct whatever *mostinteresting;
3802\& };
3803\&
3804\& ...
3805\& struct my_io w;
3806\& ev_io_init (&w.io, my_cb, fd, EV_READ);
3807.Ve
3808.PP
3809And since your callback will be called with a pointer to the watcher, you
3810can cast it back to your own type:
3811.PP
3812.Vb 5
3813\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
3814\& {
3815\& struct my_io *w = (struct my_io *)w_;
3816\& ...
3817\& }
3818.Ve
3819.PP
3820More interesting and less C\-conformant ways of casting your callback
3821function type instead have been omitted.
3822.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3823.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3824Another common scenario is to use some data structure with multiple
3825embedded watchers, in effect creating your own watcher that combines
3826multiple libev event sources into one \*(L"super-watcher\*(R":
3827.PP
3828.Vb 6
3829\& struct my_biggy
3830\& {
3831\& int some_data;
3832\& ev_timer t1;
3833\& ev_timer t2;
3834\& }
3835.Ve
3836.PP
3837In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
3838complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct in
3839the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies or \*(C+ coders), or you need
3840to use some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for
3841real programmers):
3842.PP
3843.Vb 1
3844\& #include <stddef.h>
3845\&
3846\& static void
3847\& t1_cb (EV_P_ ev_timer *w, int revents)
3848\& {
3849\& struct my_biggy big = (struct my_biggy *)
3850\& (((char *)w) \- offsetof (struct my_biggy, t1));
3851\& }
3852\&
3853\& static void
3854\& t2_cb (EV_P_ ev_timer *w, int revents)
3855\& {
3856\& struct my_biggy big = (struct my_biggy *)
3857\& (((char *)w) \- offsetof (struct my_biggy, t2));
3858\& }
3859.Ve
3860.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3861.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3862Often you have structures like this in event-based programs:
3863.PP
3864.Vb 4
3865\& callback ()
3866\& {
3867\& free (request);
3868\& }
3869\&
3870\& request = start_new_request (..., callback);
3871.Ve
3872.PP
3873The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be
3874used to cancel the operation, or do other things with it.
3875.PP
3876It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that
3877immediately invoke the callback, for example, to report errors. Or you add
3878some caching layer that finds that it can skip the lengthy aspects of the
3879operation and simply invoke the callback with the result.
3880.PP
3881The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR
3882has returned, so \f(CW\*(C`request\*(C'\fR is not set.
3883.PP
3884Even if you pass the request by some safer means to the callback, you
3885might want to do something to the request after starting it, such as
3886canceling it, which probably isn't working so well when the callback has
3887already been invoked.
3888.PP
3889A common way around all these issues is to make sure that
3890\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3891\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3892delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3893example, or more sneakily, by reusing an existing (stopped) watcher and
3894pushing it into the pending queue:
3895.PP
3896.Vb 2
3897\& ev_set_cb (watcher, callback);
3898\& ev_feed_event (EV_A_ watcher, 0);
3899.Ve
3900.PP
3901This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3902invoked, while not delaying callback invocation too much.
3903.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3904.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3905Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3906\&\fImodal\fR interaction, which is most easily implemented by recursively
3907invoking \f(CW\*(C`ev_run\*(C'\fR.
3908.PP
3909This brings the problem of exiting \- a callback might want to finish the
3910main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
3911a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
3912and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3913other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3914.PP
3915The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3916invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3917triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3918.PP
3919.Vb 2
3920\& // main loop
3921\& int exit_main_loop = 0;
3922\&
3923\& while (!exit_main_loop)
3924\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3925\&
3926\& // in a modal watcher
3927\& int exit_nested_loop = 0;
3928\&
3929\& while (!exit_nested_loop)
3930\& ev_run (EV_A_ EVRUN_ONCE);
3931.Ve
3932.PP
3933To exit from any of these loops, just set the corresponding exit variable:
3934.PP
3935.Vb 2
3936\& // exit modal loop
3937\& exit_nested_loop = 1;
3938\&
3939\& // exit main program, after modal loop is finished
3940\& exit_main_loop = 1;
3941\&
3942\& // exit both
3943\& exit_main_loop = exit_nested_loop = 1;
3944.Ve
3945.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3946.IX Subsection "THREAD LOCKING EXAMPLE"
3947Here is a fictitious example of how to run an event loop in a different
3948thread from where callbacks are being invoked and watchers are
3949created/added/removed.
3950.PP
3951For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
3952which uses exactly this technique (which is suited for many high-level
3953languages).
3954.PP
3955The example uses a pthread mutex to protect the loop data, a condition
3956variable to wait for callback invocations, an async watcher to notify the
3957event loop thread and an unspecified mechanism to wake up the main thread.
3958.PP
3959First, you need to associate some data with the event loop:
3960.PP
3961.Vb 6
3962\& typedef struct {
3963\& mutex_t lock; /* global loop lock */
3964\& ev_async async_w;
3965\& thread_t tid;
3966\& cond_t invoke_cv;
3967\& } userdata;
3968\&
3969\& void prepare_loop (EV_P)
3970\& {
3971\& // for simplicity, we use a static userdata struct.
3972\& static userdata u;
3973\&
3974\& ev_async_init (&u\->async_w, async_cb);
3975\& ev_async_start (EV_A_ &u\->async_w);
3976\&
3977\& pthread_mutex_init (&u\->lock, 0);
3978\& pthread_cond_init (&u\->invoke_cv, 0);
3979\&
3980\& // now associate this with the loop
3981\& ev_set_userdata (EV_A_ u);
3982\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3983\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3984\&
3985\& // then create the thread running ev_run
3986\& pthread_create (&u\->tid, 0, l_run, EV_A);
3987\& }
3988.Ve
3989.PP
3990The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3991solely to wake up the event loop so it takes notice of any new watchers
3992that might have been added:
3993.PP
3994.Vb 5
3995\& static void
3996\& async_cb (EV_P_ ev_async *w, int revents)
3997\& {
3998\& // just used for the side effects
3999\& }
4000.Ve
4001.PP
4002The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
4003protecting the loop data, respectively.
4004.PP
4005.Vb 6
4006\& static void
4007\& l_release (EV_P)
4008\& {
4009\& userdata *u = ev_userdata (EV_A);
4010\& pthread_mutex_unlock (&u\->lock);
4011\& }
4012\&
4013\& static void
4014\& l_acquire (EV_P)
4015\& {
4016\& userdata *u = ev_userdata (EV_A);
4017\& pthread_mutex_lock (&u\->lock);
4018\& }
4019.Ve
4020.PP
4021The event loop thread first acquires the mutex, and then jumps straight
4022into \f(CW\*(C`ev_run\*(C'\fR:
4023.PP
4024.Vb 4
4025\& void *
4026\& l_run (void *thr_arg)
4027\& {
4028\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
4029\&
4030\& l_acquire (EV_A);
4031\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4032\& ev_run (EV_A_ 0);
4033\& l_release (EV_A);
4034\&
4035\& return 0;
4036\& }
4037.Ve
4038.PP
4039Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
4040signal the main thread via some unspecified mechanism (signals? pipe
4041writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
4042have been called (in a while loop because a) spurious wakeups are possible
4043and b) skipping inter-thread-communication when there are no pending
4044watchers is very beneficial):
4045.PP
4046.Vb 4
4047\& static void
4048\& l_invoke (EV_P)
4049\& {
4050\& userdata *u = ev_userdata (EV_A);
4051\&
4052\& while (ev_pending_count (EV_A))
4053\& {
4054\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4055\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
4056\& }
4057\& }
4058.Ve
4059.PP
4060Now, whenever the main thread gets told to invoke pending watchers, it
4061will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
4062thread to continue:
4063.PP
4064.Vb 4
4065\& static void
4066\& real_invoke_pending (EV_P)
4067\& {
4068\& userdata *u = ev_userdata (EV_A);
4069\&
4070\& pthread_mutex_lock (&u\->lock);
4071\& ev_invoke_pending (EV_A);
4072\& pthread_cond_signal (&u\->invoke_cv);
4073\& pthread_mutex_unlock (&u\->lock);
4074\& }
4075.Ve
4076.PP
4077Whenever you want to start/stop a watcher or do other modifications to an
4078event loop, you will now have to lock:
4079.PP
4080.Vb 2
4081\& ev_timer timeout_watcher;
4082\& userdata *u = ev_userdata (EV_A);
4083\&
4084\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4085\&
4086\& pthread_mutex_lock (&u\->lock);
4087\& ev_timer_start (EV_A_ &timeout_watcher);
4088\& ev_async_send (EV_A_ &u\->async_w);
4089\& pthread_mutex_unlock (&u\->lock);
4090.Ve
4091.PP
4092Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
4093an event loop currently blocking in the kernel will have no knowledge
4094about the newly added timer. By waking up the loop it will pick up any new
4095watchers in the next event loop iteration.
4096.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
4097.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
4098While the overhead of a callback that e.g. schedules a thread is small, it
4099is still an overhead. If you embed libev, and your main usage is with some
4100kind of threads or coroutines, you might want to customise libev so that
4101doesn't need callbacks anymore.
4102.PP
4103Imagine you have coroutines that you can switch to using a function
4104\&\f(CW\*(C`switch_to (coro)\*(C'\fR, that libev runs in a coroutine called \f(CW\*(C`libev_coro\*(C'\fR
4105and that due to some magic, the currently active coroutine is stored in a
4106global called \f(CW\*(C`current_coro\*(C'\fR. Then you can build your own \*(L"wait for libev
4107event\*(R" primitive by changing \f(CW\*(C`EV_CB_DECLARE\*(C'\fR and \f(CW\*(C`EV_CB_INVOKE\*(C'\fR (note
4108the differing \f(CW\*(C`;\*(C'\fR conventions):
4109.PP
4110.Vb 2
4111\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4112\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4113.Ve
4114.PP
4115That means instead of having a C callback function, you store the
4116coroutine to switch to in each watcher, and instead of having libev call
4117your callback, you instead have it switch to that coroutine.
4118.PP
4119A coroutine might now wait for an event with a function called
4120\&\f(CW\*(C`wait_for_event\*(C'\fR. (the watcher needs to be started, as always, but it doesn't
4121matter when, or whether the watcher is active or not when this function is
4122called):
4123.PP
4124.Vb 6
4125\& void
4126\& wait_for_event (ev_watcher *w)
4127\& {
4128\& ev_set_cb (w, current_coro);
4129\& switch_to (libev_coro);
4130\& }
4131.Ve
4132.PP
4133That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
4134continues the libev coroutine, which, when appropriate, switches back to
4135this or any other coroutine.
4136.PP
4137You can do similar tricks if you have, say, threads with an event queue \-
4138instead of storing a coroutine, you store the queue object and instead of
4139switching to a coroutine, you push the watcher onto the queue and notify
4140any waiters.
4141.PP
4142To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
4143files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
4144.PP
4145.Vb 4
4146\& // my_ev.h
4147\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4148\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4149\& #include "../libev/ev.h"
4150\&
4151\& // my_ev.c
4152\& #define EV_H "my_ev.h"
4153\& #include "../libev/ev.c"
4154.Ve
4155.PP
4156And then use \fImy_ev.h\fR when you would normally use \fIev.h\fR, and compile
4157\&\fImy_ev.c\fR into your project. When properly specifying include paths, you
4158can even use \fIev.h\fR as header file name directly.
3480.SH "LIBEVENT EMULATION" 4159.SH "LIBEVENT EMULATION"
3481.IX Header "LIBEVENT EMULATION" 4160.IX Header "LIBEVENT EMULATION"
3482Libev offers a compatibility emulation layer for libevent. It cannot 4161Libev offers a compatibility emulation layer for libevent. It cannot
3483emulate the internals of libevent, so here are some usage hints: 4162emulate the internals of libevent, so here are some usage hints:
4163.IP "\(bu" 4
4164Only the libevent\-1.4.1\-beta \s-1API\s0 is being emulated.
4165.Sp
4166This was the newest libevent version available when libev was implemented,
4167and is still mostly unchanged in 2010.
3484.IP "\(bu" 4 4168.IP "\(bu" 4
3485Use it by including <event.h>, as usual. 4169Use it by including <event.h>, as usual.
3486.IP "\(bu" 4 4170.IP "\(bu" 4
3487The following members are fully supported: ev_base, ev_callback, 4171The following members are fully supported: ev_base, ev_callback,
3488ev_arg, ev_fd, ev_res, ev_events. 4172ev_arg, ev_fd, ev_res, ev_events.
3494Priorities are not currently supported. Initialising priorities 4178Priorities are not currently supported. Initialising priorities
3495will fail and all watchers will have the same priority, even though there 4179will fail and all watchers will have the same priority, even though there
3496is an ev_pri field. 4180is an ev_pri field.
3497.IP "\(bu" 4 4181.IP "\(bu" 4
3498In libevent, the last base created gets the signals, in libev, the 4182In libevent, the last base created gets the signals, in libev, the
3499first base created (== the default loop) gets the signals. 4183base that registered the signal gets the signals.
3500.IP "\(bu" 4 4184.IP "\(bu" 4
3501Other members are not supported. 4185Other members are not supported.
3502.IP "\(bu" 4 4186.IP "\(bu" 4
3503The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 4187The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
3504to use the libev header file and library. 4188to use the libev header file and library.
3505.SH "\*(C+ SUPPORT" 4189.SH "\*(C+ SUPPORT"
3506.IX Header " SUPPORT" 4190.IX Header " SUPPORT"
4191.SS "C \s-1API\s0"
4192.IX Subsection "C API"
4193The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4194libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4195will work fine.
4196.PP
4197Proper exception specifications might have to be added to callbacks passed
4198to libev: exceptions may be thrown only from watcher callbacks, all other
4199callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4200callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4201specification. If you have code that needs to be compiled as both C and
4202\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4203.PP
4204.Vb 6
4205\& static void
4206\& fatal_error (const char *msg) EV_NOEXCEPT
4207\& {
4208\& perror (msg);
4209\& abort ();
4210\& }
4211\&
4212\& ...
4213\& ev_set_syserr_cb (fatal_error);
4214.Ve
4215.PP
4216The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4217\&\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
4218because it runs cleanup watchers).
4219.PP
4220Throwing exceptions in watcher callbacks is only supported if libev itself
4221is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4222throwing exceptions through C libraries (most do).
4223.SS "\*(C+ \s-1API\s0"
4224.IX Subsection " API"
3507Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4225Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
3508you to use some convenience methods to start/stop watchers and also change 4226you to use some convenience methods to start/stop watchers and also change
3509the callback model to a model using method callbacks on objects. 4227the callback model to a model using method callbacks on objects.
3510.PP 4228.PP
3511To use it, 4229To use it,
3522Care has been taken to keep the overhead low. The only data member the \*(C+ 4240Care has been taken to keep the overhead low. The only data member the \*(C+
3523classes add (compared to plain C\-style watchers) is the event loop pointer 4241classes add (compared to plain C\-style watchers) is the event loop pointer
3524that the watcher is associated with (or no additional members at all if 4242that the watcher is associated with (or no additional members at all if
3525you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). 4243you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
3526.PP 4244.PP
3527Currently, functions, and static and non-static member functions can be 4245Currently, functions, static and non-static member functions and classes
3528used as callbacks. Other types should be easy to add as long as they only 4246with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
3529need one additional pointer for context. If you need support for other 4247to add as long as they only need one additional pointer for context. If
3530types of functors please contact the author (preferably after implementing 4248you need support for other types of functors please contact the author
3531it). 4249(preferably after implementing it).
4250.PP
4251For all this to work, your \*(C+ compiler either has to use the same calling
4252conventions as your C compiler (for static member functions), or you have
4253to embed libev and compile libev itself as \*(C+.
3532.PP 4254.PP
3533Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4255Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
3534.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4 4256.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
3535.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4257.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
3536.IX Item "ev::READ, ev::WRITE etc." 4258.IX Item "ev::READ, ev::WRITE etc."
3544.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 4266.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
3545.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 4267.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
3546For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 4268For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
3547the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 4269the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
3548which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 4270which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
3549defines by many implementations. 4271defined by many implementations.
3550.Sp 4272.Sp
3551All of those classes have these methods: 4273All of those classes have these methods:
3552.RS 4 4274.RS 4
3553.IP "ev::TYPE::TYPE ()" 4 4275.IP "ev::TYPE::TYPE ()" 4
3554.IX Item "ev::TYPE::TYPE ()" 4276.IX Item "ev::TYPE::TYPE ()"
3617\& void operator() (ev::io &w, int revents) 4339\& void operator() (ev::io &w, int revents)
3618\& { 4340\& {
3619\& ... 4341\& ...
3620\& } 4342\& }
3621\& } 4343\& }
3622\& 4344\&
3623\& myfunctor f; 4345\& myfunctor f;
3624\& 4346\&
3625\& ev::io w; 4347\& ev::io w;
3626\& w.set (&f); 4348\& w.set (&f);
3627.Ve 4349.Ve
3645.IX Item "w->set (loop)" 4367.IX Item "w->set (loop)"
3646Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4368Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
3647do this when the watcher is inactive (and not pending either). 4369do this when the watcher is inactive (and not pending either).
3648.IP "w\->set ([arguments])" 4 4370.IP "w\->set ([arguments])" 4
3649.IX Item "w->set ([arguments])" 4371.IX Item "w->set ([arguments])"
3650Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this 4372Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
3651method or a suitable start method must be called at least once. Unlike the 4373with the same arguments. Either this method or a suitable start method
3652C counterpart, an active watcher gets automatically stopped and restarted 4374must be called at least once. Unlike the C counterpart, an active watcher
3653when reconfiguring it with this method. 4375gets automatically stopped and restarted when reconfiguring it with this
4376method.
4377.Sp
4378For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4379clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
3654.IP "w\->start ()" 4 4380.IP "w\->start ()" 4
3655.IX Item "w->start ()" 4381.IX Item "w->start ()"
3656Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4382Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
3657constructor already stores the event loop. 4383constructor already stores the event loop.
3658.IP "w\->start ([arguments])" 4 4384.IP "w\->start ([arguments])" 4
3685.PP 4411.PP
3686.Vb 5 4412.Vb 5
3687\& class myclass 4413\& class myclass
3688\& { 4414\& {
3689\& ev::io io ; void io_cb (ev::io &w, int revents); 4415\& ev::io io ; void io_cb (ev::io &w, int revents);
3690\& ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4416\& ev::io io2 ; void io2_cb (ev::io &w, int revents);
3691\& ev::idle idle; void idle_cb (ev::idle &w, int revents); 4417\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
3692\& 4418\&
3693\& myclass (int fd) 4419\& myclass (int fd)
3694\& { 4420\& {
3695\& io .set <myclass, &myclass::io_cb > (this); 4421\& io .set <myclass, &myclass::io_cb > (this);
3716there are additional modules that implement libev-compatible interfaces 4442there are additional modules that implement libev-compatible interfaces
3717to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), 4443to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
3718\&\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 4444\&\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
3719and \f(CW\*(C`EV::Glib\*(C'\fR). 4445and \f(CW\*(C`EV::Glib\*(C'\fR).
3720.Sp 4446.Sp
3721It can be found and installed via \s-1CPAN\s0, its homepage is at 4447It can be found and installed via \s-1CPAN,\s0 its homepage is at
3722<http://software.schmorp.de/pkg/EV>. 4448<http://software.schmorp.de/pkg/EV>.
3723.IP "Python" 4 4449.IP "Python" 4
3724.IX Item "Python" 4450.IX Item "Python"
3725Python bindings can be found at <http://code.google.com/p/pyev/>. It 4451Python bindings can be found at <http://code.google.com/p/pyev/>. It
3726seems to be quite complete and well-documented. 4452seems to be quite complete and well-documented.
3738A haskell binding to libev is available at 4464A haskell binding to libev is available at
3739<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>. 4465<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
3740.IP "D" 4 4466.IP "D" 4
3741.IX Item "D" 4467.IX Item "D"
3742Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4468Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
3743be found at <http://proj.llucax.com.ar/wiki/evd>. 4469be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
3744.IP "Ocaml" 4 4470.IP "Ocaml" 4
3745.IX Item "Ocaml" 4471.IX Item "Ocaml"
3746Erkki Seppala has written Ocaml bindings for libev, to be found at 4472Erkki Seppala has written Ocaml bindings for libev, to be found at
3747<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. 4473<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
3748.IP "Lua" 4 4474.IP "Lua" 4
3749.IX Item "Lua" 4475.IX Item "Lua"
3750Brian Maher has written a partial interface to libev for lua (at the 4476Brian Maher has written a partial interface to libev for lua (at the
3751time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at 4477time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
3752<http://github.com/brimworks/lua\-ev>. 4478<http://github.com/brimworks/lua\-ev>.
4479.IP "Javascript" 4
4480.IX Item "Javascript"
4481Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4482.IP "Others" 4
4483.IX Item "Others"
4484There are others, and I stopped counting.
3753.SH "MACRO MAGIC" 4485.SH "MACRO MAGIC"
3754.IX Header "MACRO MAGIC" 4486.IX Header "MACRO MAGIC"
3755Libev can be compiled with a variety of options, the most fundamental 4487Libev can be compiled with a variety of options, the most fundamental
3756of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 4488of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
3757functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 4489functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
3792suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 4524suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
3793.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4 4525.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
3794.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 4526.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
3795.IX Item "EV_DEFAULT, EV_DEFAULT_" 4527.IX Item "EV_DEFAULT, EV_DEFAULT_"
3796Similar to the other two macros, this gives you the value of the default 4528Similar to the other two macros, this gives you the value of the default
3797loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 4529loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop
4530will be initialised if it isn't already initialised.
4531.Sp
4532For non-multiplicity builds, these macros do nothing, so you always have
4533to initialise the loop somewhere.
3798.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4 4534.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
3799.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 4535.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
3800.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" 4536.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
3801Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the 4537Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
3802default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour 4538default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
3836.SS "\s-1FILESETS\s0" 4572.SS "\s-1FILESETS\s0"
3837.IX Subsection "FILESETS" 4573.IX Subsection "FILESETS"
3838Depending on what features you need you need to include one or more sets of files 4574Depending on what features you need you need to include one or more sets of files
3839in your application. 4575in your application.
3840.PP 4576.PP
3841\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4577\fI\s-1CORE EVENT LOOP\s0\fR
3842.IX Subsection "CORE EVENT LOOP" 4578.IX Subsection "CORE EVENT LOOP"
3843.PP 4579.PP
3844To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4580To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
3845configuration (no autoconf): 4581configuration (no autoconf):
3846.PP 4582.PP
3873\& ev_vars.h 4609\& ev_vars.h
3874\& ev_wrap.h 4610\& ev_wrap.h
3875\& 4611\&
3876\& ev_win32.c required on win32 platforms only 4612\& ev_win32.c required on win32 platforms only
3877\& 4613\&
3878\& ev_select.c only when select backend is enabled (which is enabled by default) 4614\& ev_select.c only when select backend is enabled
3879\& ev_poll.c only when poll backend is enabled (disabled by default) 4615\& ev_poll.c only when poll backend is enabled
3880\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4616\& ev_epoll.c only when the epoll backend is enabled
4617\& ev_linuxaio.c only when the linux aio backend is enabled
3881\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4618\& ev_kqueue.c only when the kqueue backend is enabled
3882\& ev_port.c only when the solaris port backend is enabled (disabled by default) 4619\& ev_port.c only when the solaris port backend is enabled
3883.Ve 4620.Ve
3884.PP 4621.PP
3885\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4622\&\fIev.c\fR includes the backend files directly when enabled, so you only need
3886to compile this single file. 4623to compile this single file.
3887.PP 4624.PP
3888\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4625\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
3889.IX Subsection "LIBEVENT COMPATIBILITY API" 4626.IX Subsection "LIBEVENT COMPATIBILITY API"
3890.PP 4627.PP
3891To include the libevent compatibility \s-1API\s0, also include: 4628To include the libevent compatibility \s-1API,\s0 also include:
3892.PP 4629.PP
3893.Vb 1 4630.Vb 1
3894\& #include "event.c" 4631\& #include "event.c"
3895.Ve 4632.Ve
3896.PP 4633.PP
3898.PP 4635.PP
3899.Vb 1 4636.Vb 1
3900\& #include "event.h" 4637\& #include "event.h"
3901.Ve 4638.Ve
3902.PP 4639.PP
3903in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4640in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
3904.PP 4641.PP
3905You need the following additional files for this: 4642You need the following additional files for this:
3906.PP 4643.PP
3907.Vb 2 4644.Vb 2
3908\& event.h 4645\& event.h
3909\& event.c 4646\& event.c
3910.Ve 4647.Ve
3911.PP 4648.PP
3912\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4649\fI\s-1AUTOCONF SUPPORT\s0\fR
3913.IX Subsection "AUTOCONF SUPPORT" 4650.IX Subsection "AUTOCONF SUPPORT"
3914.PP 4651.PP
3915Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4652Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
3916whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4653whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
3917\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4654\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
3920For this of course you need the m4 file: 4657For this of course you need the m4 file:
3921.PP 4658.PP
3922.Vb 1 4659.Vb 1
3923\& libev.m4 4660\& libev.m4
3924.Ve 4661.Ve
3925.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4662.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
3926.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4663.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
3927Libev can be configured via a variety of preprocessor symbols you have to 4664Libev can be configured via a variety of preprocessor symbols you have to
3928define before including (or compiling) any of its files. The default in 4665define before including (or compiling) any of its files. The default in
3929the absence of autoconf is documented for every option. 4666the absence of autoconf is documented for every option.
3930.PP 4667.PP
3931Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different 4668Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
3932values when compiling libev vs. including \fIev.h\fR, so it is permissible 4669values when compiling libev vs. including \fIev.h\fR, so it is permissible
3933to redefine them before including \fIev.h\fR without breaking compatibility 4670to redefine them before including \fIev.h\fR without breaking compatibility
3934to a compiled library. All other symbols change the \s-1ABI\s0, which means all 4671to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
3935users of libev and the libev code itself must be compiled with compatible 4672users of libev and the libev code itself must be compiled with compatible
3936settings. 4673settings.
3937.IP "\s-1EV_COMPAT3\s0 (h)" 4 4674.IP "\s-1EV_COMPAT3\s0 (h)" 4
3938.IX Item "EV_COMPAT3 (h)" 4675.IX Item "EV_COMPAT3 (h)"
3939Backwards compatibility is a major concern for libev. This is why this 4676Backwards compatibility is a major concern for libev. This is why this
3957supported). It will also not define any of the structs usually found in 4694supported). It will also not define any of the structs usually found in
3958\&\fIevent.h\fR that are not directly supported by the libev core alone. 4695\&\fIevent.h\fR that are not directly supported by the libev core alone.
3959.Sp 4696.Sp
3960In standalone mode, libev will still try to automatically deduce the 4697In standalone mode, libev will still try to automatically deduce the
3961configuration, but has to be more conservative. 4698configuration, but has to be more conservative.
4699.IP "\s-1EV_USE_FLOOR\s0" 4
4700.IX Item "EV_USE_FLOOR"
4701If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its
4702periodic reschedule calculations, otherwise libev will fall back on a
4703portable (slower) implementation. If you enable this, you usually have to
4704link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR
4705function is not available will fail, so the safe default is to not enable
4706this.
3962.IP "\s-1EV_USE_MONOTONIC\s0" 4 4707.IP "\s-1EV_USE_MONOTONIC\s0" 4
3963.IX Item "EV_USE_MONOTONIC" 4708.IX Item "EV_USE_MONOTONIC"
3964If defined to be \f(CW1\fR, libev will try to detect the availability of the 4709If defined to be \f(CW1\fR, libev will try to detect the availability of the
3965monotonic clock option at both compile time and runtime. Otherwise no 4710monotonic clock option at both compile time and runtime. Otherwise no
3966use of the monotonic clock option will be attempted. If you enable this, 4711use of the monotonic clock option will be attempted. If you enable this,
4040.IX Item "EV_WIN32_CLOSE_FD(fd)" 4785.IX Item "EV_WIN32_CLOSE_FD(fd)"
4041If programs implement their own fd to handle mapping on win32, then this 4786If programs implement their own fd to handle mapping on win32, then this
4042macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister 4787macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4043file descriptors again. Note that the replacement function has to close 4788file descriptors again. Note that the replacement function has to close
4044the underlying \s-1OS\s0 handle. 4789the underlying \s-1OS\s0 handle.
4790.IP "\s-1EV_USE_WSASOCKET\s0" 4
4791.IX Item "EV_USE_WSASOCKET"
4792If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4793communication socket, which works better in some environments. Otherwise,
4794the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4795environments.
4045.IP "\s-1EV_USE_POLL\s0" 4 4796.IP "\s-1EV_USE_POLL\s0" 4
4046.IX Item "EV_USE_POLL" 4797.IX Item "EV_USE_POLL"
4047If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4798If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
4048backend. Otherwise it will be enabled on non\-win32 platforms. It 4799backend. Otherwise it will be enabled on non\-win32 platforms. It
4049takes precedence over select. 4800takes precedence over select.
4052If defined to be \f(CW1\fR, libev will compile in support for the Linux 4803If defined to be \f(CW1\fR, libev will compile in support for the Linux
4053\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 4804\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
4054otherwise another method will be used as fallback. This is the preferred 4805otherwise another method will be used as fallback. This is the preferred
4055backend for GNU/Linux systems. If undefined, it will be enabled if the 4806backend for GNU/Linux systems. If undefined, it will be enabled if the
4056headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4807headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4808.IP "\s-1EV_USE_LINUXAIO\s0" 4
4809.IX Item "EV_USE_LINUXAIO"
4810If defined to be \f(CW1\fR, libev will compile in support for the Linux
4811aio backend. Due to it's currenbt limitations it has to be requested
4812explicitly. If undefined, it will be enabled on linux, otherwise
4813disabled.
4057.IP "\s-1EV_USE_KQUEUE\s0" 4 4814.IP "\s-1EV_USE_KQUEUE\s0" 4
4058.IX Item "EV_USE_KQUEUE" 4815.IX Item "EV_USE_KQUEUE"
4059If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4816If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
4060\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 4817\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
4061otherwise another method will be used as fallback. This is the preferred 4818otherwise another method will be used as fallback. This is the preferred
4078.IX Item "EV_USE_INOTIFY" 4835.IX Item "EV_USE_INOTIFY"
4079If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 4836If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
4080interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 4837interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
4081be detected at runtime. If undefined, it will be enabled if the headers 4838be detected at runtime. If undefined, it will be enabled if the headers
4082indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4839indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4840.IP "\s-1EV_NO_SMP\s0" 4
4841.IX Item "EV_NO_SMP"
4842If defined to be \f(CW1\fR, libev will assume that memory is always coherent
4843between threads, that is, threads can be used, but threads never run on
4844different cpus (or different cpu cores). This reduces dependencies
4845and makes libev faster.
4846.IP "\s-1EV_NO_THREADS\s0" 4
4847.IX Item "EV_NO_THREADS"
4848If defined to be \f(CW1\fR, libev will assume that it will never be called from
4849different threads (that includes signal handlers), which is a stronger
4850assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4851libev faster.
4083.IP "\s-1EV_ATOMIC_T\s0" 4 4852.IP "\s-1EV_ATOMIC_T\s0" 4
4084.IX Item "EV_ATOMIC_T" 4853.IX Item "EV_ATOMIC_T"
4085Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4854Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4086access is atomic with respect to other threads or signal contexts. No such 4855access is atomic with respect to other threads or signal contexts. No
4087type is easily found in the C language, so you can provide your own type 4856such type is easily found in the C language, so you can provide your own
4088that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" 4857type that you know is safe for your purposes. It is used both for signal
4089as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. 4858handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4859watchers.
4090.Sp 4860.Sp
4091In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4861In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4092(from \fIsignal.h\fR), which is usually good enough on most platforms. 4862(from \fIsignal.h\fR), which is usually good enough on most platforms.
4093.IP "\s-1EV_H\s0 (h)" 4 4863.IP "\s-1EV_H\s0 (h)" 4
4094.IX Item "EV_H (h)" 4864.IX Item "EV_H (h)"
4115If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 4885If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
4116will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 4886will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
4117additional independent event loops. Otherwise there will be no support 4887additional independent event loops. Otherwise there will be no support
4118for multiple event loops and there is no first event loop pointer 4888for multiple event loops and there is no first event loop pointer
4119argument. Instead, all functions act on the single default loop. 4889argument. Instead, all functions act on the single default loop.
4890.Sp
4891Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a
4892default loop when multiplicity is switched off \- you always have to
4893initialise the loop manually in this case.
4120.IP "\s-1EV_MINPRI\s0" 4 4894.IP "\s-1EV_MINPRI\s0" 4
4121.IX Item "EV_MINPRI" 4895.IX Item "EV_MINPRI"
4122.PD 0 4896.PD 0
4123.IP "\s-1EV_MAXPRI\s0" 4 4897.IP "\s-1EV_MAXPRI\s0" 4
4124.IX Item "EV_MAXPRI" 4898.IX Item "EV_MAXPRI"
4132all the priorities, so having many of them (hundreds) uses a lot of space 4906all the priorities, so having many of them (hundreds) uses a lot of space
4133and time, so using the defaults of five priorities (\-2 .. +2) is usually 4907and time, so using the defaults of five priorities (\-2 .. +2) is usually
4134fine. 4908fine.
4135.Sp 4909.Sp
4136If your embedding application does not need any priorities, defining these 4910If your embedding application does not need any priorities, defining these
4137both to \f(CW0\fR will save some memory and \s-1CPU\s0. 4911both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4138.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 4912.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
4139.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." 4913.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."
4140If undefined or defined to be \f(CW1\fR (and the platform supports it), then 4914If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4141the respective watcher type is supported. If defined to be \f(CW0\fR, then it 4915the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4142is not. Disabling watcher types mainly saves code size. 4916is not. Disabling watcher types mainly saves code size.
4143.IP "\s-1EV_FEATURES\s0" 4 4917.IP "\s-1EV_FEATURES\s0" 4
4160\& #define EV_CHILD_ENABLE 1 4934\& #define EV_CHILD_ENABLE 1
4161\& #define EV_ASYNC_ENABLE 1 4935\& #define EV_ASYNC_ENABLE 1
4162.Ve 4936.Ve
4163.Sp 4937.Sp
4164The actual value is a bitset, it can be a combination of the following 4938The actual value is a bitset, it can be a combination of the following
4165values: 4939values (by default, all of these are enabled):
4166.RS 4 4940.RS 4
4167.ie n .IP "1 \- faster/larger code" 4 4941.ie n .IP "1 \- faster/larger code" 4
4168.el .IP "\f(CW1\fR \- faster/larger code" 4 4942.el .IP "\f(CW1\fR \- faster/larger code" 4
4169.IX Item "1 - faster/larger code" 4943.IX Item "1 - faster/larger code"
4170Use larger code to speed up some operations. 4944Use larger code to speed up some operations.
4173code size by roughly 30% on amd64). 4947code size by roughly 30% on amd64).
4174.Sp 4948.Sp
4175When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with 4949When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4176gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of 4950gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4177assertions. 4951assertions.
4952.Sp
4953The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4954(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4178.ie n .IP "2 \- faster/larger data structures" 4 4955.ie n .IP "2 \- faster/larger data structures" 4
4179.el .IP "\f(CW2\fR \- faster/larger data structures" 4 4956.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4180.IX Item "2 - faster/larger data structures" 4957.IX Item "2 - faster/larger data structures"
4181Replaces the small 2\-heap for timer management by a faster 4\-heap, larger 4958Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4182hash table sizes and so on. This will usually further increase code size 4959hash table sizes and so on. This will usually further increase code size
4183and can additionally have an effect on the size of data structures at 4960and can additionally have an effect on the size of data structures at
4184runtime. 4961runtime.
4962.Sp
4963The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4964(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4185.ie n .IP "4 \- full \s-1API\s0 configuration" 4 4965.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4186.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 4966.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4187.IX Item "4 - full API configuration" 4967.IX Item "4 - full API configuration"
4188This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and 4968This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4189enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1). 4969enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4221With an intelligent-enough linker (gcc+binutils are intelligent enough 5001With an intelligent-enough linker (gcc+binutils are intelligent enough
4222when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by 5002when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by
4223your program might be left out as well \- a binary starting a timer and an 5003your program might be left out as well \- a binary starting a timer and an
4224I/O watcher then might come out at only 5Kb. 5004I/O watcher then might come out at only 5Kb.
4225.RE 5005.RE
5006.IP "\s-1EV_API_STATIC\s0" 4
5007.IX Item "EV_API_STATIC"
5008If this symbol is defined (by default it is not), then all identifiers
5009will have static linkage. This means that libev will not export any
5010identifiers, and you cannot link against libev anymore. This can be useful
5011when you embed libev, only want to use libev functions in a single file,
5012and do not want its identifiers to be visible.
5013.Sp
5014To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that
5015wants to use libev.
5016.Sp
5017This option only works when libev is compiled with a C compiler, as \*(C+
5018doesn't support the required declaration syntax.
4226.IP "\s-1EV_AVOID_STDIO\s0" 4 5019.IP "\s-1EV_AVOID_STDIO\s0" 4
4227.IX Item "EV_AVOID_STDIO" 5020.IX Item "EV_AVOID_STDIO"
4228If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio 5021If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio
4229functions (printf, scanf, perror etc.). This will increase the code size 5022functions (printf, scanf, perror etc.). This will increase the code size
4230somewhat, but if your program doesn't otherwise depend on stdio and your 5023somewhat, but if your program doesn't otherwise depend on stdio and your
4312and the way callbacks are invoked and set. Must expand to a struct member 5105and the way callbacks are invoked and set. Must expand to a struct member
4313definition and a statement, respectively. See the \fIev.h\fR header file for 5106definition and a statement, respectively. See the \fIev.h\fR header file for
4314their default definitions. One possible use for overriding these is to 5107their default definitions. One possible use for overriding these is to
4315avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5108avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
4316method calls instead of plain function calls in \*(C+. 5109method calls instead of plain function calls in \*(C+.
4317.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5110.SS "\s-1EXPORTED API SYMBOLS\s0"
4318.IX Subsection "EXPORTED API SYMBOLS" 5111.IX Subsection "EXPORTED API SYMBOLS"
4319If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 5112If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
4320exported symbols, you can use the provided \fISymbol.*\fR files which list 5113exported symbols, you can use the provided \fISymbol.*\fR files which list
4321all public symbols, one per line: 5114all public symbols, one per line:
4322.PP 5115.PP
4374.PP 5167.PP
4375.Vb 2 5168.Vb 2
4376\& #include "ev_cpp.h" 5169\& #include "ev_cpp.h"
4377\& #include "ev.c" 5170\& #include "ev.c"
4378.Ve 5171.Ve
4379.SH "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" 5172.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4380.IX Header "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" 5173.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4381.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5174.SS "\s-1THREADS AND COROUTINES\s0"
4382.IX Subsection "THREADS AND COROUTINES" 5175.IX Subsection "THREADS AND COROUTINES"
4383\fI\s-1THREADS\s0\fR 5176\fI\s-1THREADS\s0\fR
4384.IX Subsection "THREADS" 5177.IX Subsection "THREADS"
4385.PP 5178.PP
4386All libev functions are reentrant and thread-safe unless explicitly 5179All libev functions are reentrant and thread-safe unless explicitly
4432An example use would be to communicate signals or other events that only 5225An example use would be to communicate signals or other events that only
4433work in the default loop by registering the signal watcher with the 5226work in the default loop by registering the signal watcher with the
4434default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 5227default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
4435watcher callback into the event loop interested in the signal. 5228watcher callback into the event loop interested in the signal.
4436.PP 5229.PP
4437\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0 5230See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
4438.IX Subsection "THREAD LOCKING EXAMPLE"
4439.PP
4440Here is a fictitious example of how to run an event loop in a different
4441thread than where callbacks are being invoked and watchers are
4442created/added/removed.
4443.PP
4444For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
4445which uses exactly this technique (which is suited for many high-level
4446languages).
4447.PP
4448The example uses a pthread mutex to protect the loop data, a condition
4449variable to wait for callback invocations, an async watcher to notify the
4450event loop thread and an unspecified mechanism to wake up the main thread.
4451.PP
4452First, you need to associate some data with the event loop:
4453.PP
4454.Vb 6
4455\& typedef struct {
4456\& mutex_t lock; /* global loop lock */
4457\& ev_async async_w;
4458\& thread_t tid;
4459\& cond_t invoke_cv;
4460\& } userdata;
4461\&
4462\& void prepare_loop (EV_P)
4463\& {
4464\& // for simplicity, we use a static userdata struct.
4465\& static userdata u;
4466\&
4467\& ev_async_init (&u\->async_w, async_cb);
4468\& ev_async_start (EV_A_ &u\->async_w);
4469\&
4470\& pthread_mutex_init (&u\->lock, 0);
4471\& pthread_cond_init (&u\->invoke_cv, 0);
4472\&
4473\& // now associate this with the loop
4474\& ev_set_userdata (EV_A_ u);
4475\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
4476\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4477\&
4478\& // then create the thread running ev_loop
4479\& pthread_create (&u\->tid, 0, l_run, EV_A);
4480\& }
4481.Ve
4482.PP
4483The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
4484solely to wake up the event loop so it takes notice of any new watchers
4485that might have been added:
4486.PP
4487.Vb 5
4488\& static void
4489\& async_cb (EV_P_ ev_async *w, int revents)
4490\& {
4491\& // just used for the side effects
4492\& }
4493.Ve
4494.PP
4495The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
4496protecting the loop data, respectively.
4497.PP
4498.Vb 6
4499\& static void
4500\& l_release (EV_P)
4501\& {
4502\& userdata *u = ev_userdata (EV_A);
4503\& pthread_mutex_unlock (&u\->lock);
4504\& }
4505\&
4506\& static void
4507\& l_acquire (EV_P)
4508\& {
4509\& userdata *u = ev_userdata (EV_A);
4510\& pthread_mutex_lock (&u\->lock);
4511\& }
4512.Ve
4513.PP
4514The event loop thread first acquires the mutex, and then jumps straight
4515into \f(CW\*(C`ev_run\*(C'\fR:
4516.PP
4517.Vb 4
4518\& void *
4519\& l_run (void *thr_arg)
4520\& {
4521\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
4522\&
4523\& l_acquire (EV_A);
4524\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4525\& ev_run (EV_A_ 0);
4526\& l_release (EV_A);
4527\&
4528\& return 0;
4529\& }
4530.Ve
4531.PP
4532Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
4533signal the main thread via some unspecified mechanism (signals? pipe
4534writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
4535have been called (in a while loop because a) spurious wakeups are possible
4536and b) skipping inter-thread-communication when there are no pending
4537watchers is very beneficial):
4538.PP
4539.Vb 4
4540\& static void
4541\& l_invoke (EV_P)
4542\& {
4543\& userdata *u = ev_userdata (EV_A);
4544\&
4545\& while (ev_pending_count (EV_A))
4546\& {
4547\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4548\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
4549\& }
4550\& }
4551.Ve
4552.PP
4553Now, whenever the main thread gets told to invoke pending watchers, it
4554will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
4555thread to continue:
4556.PP
4557.Vb 4
4558\& static void
4559\& real_invoke_pending (EV_P)
4560\& {
4561\& userdata *u = ev_userdata (EV_A);
4562\&
4563\& pthread_mutex_lock (&u\->lock);
4564\& ev_invoke_pending (EV_A);
4565\& pthread_cond_signal (&u\->invoke_cv);
4566\& pthread_mutex_unlock (&u\->lock);
4567\& }
4568.Ve
4569.PP
4570Whenever you want to start/stop a watcher or do other modifications to an
4571event loop, you will now have to lock:
4572.PP
4573.Vb 2
4574\& ev_timer timeout_watcher;
4575\& userdata *u = ev_userdata (EV_A);
4576\&
4577\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4578\&
4579\& pthread_mutex_lock (&u\->lock);
4580\& ev_timer_start (EV_A_ &timeout_watcher);
4581\& ev_async_send (EV_A_ &u\->async_w);
4582\& pthread_mutex_unlock (&u\->lock);
4583.Ve
4584.PP
4585Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
4586an event loop currently blocking in the kernel will have no knowledge
4587about the newly added timer. By waking up the loop it will pick up any new
4588watchers in the next event loop iteration.
4589.PP 5231.PP
4590\fI\s-1COROUTINES\s0\fR 5232\fI\s-1COROUTINES\s0\fR
4591.IX Subsection "COROUTINES" 5233.IX Subsection "COROUTINES"
4592.PP 5234.PP
4593Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5235Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
4598that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 5240that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
4599.PP 5241.PP
4600Care has been taken to ensure that libev does not keep local state inside 5242Care has been taken to ensure that libev does not keep local state inside
4601\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as 5243\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
4602they do not call any callbacks. 5244they do not call any callbacks.
4603.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5245.SS "\s-1COMPILER WARNINGS\s0"
4604.IX Subsection "COMPILER WARNINGS" 5246.IX Subsection "COMPILER WARNINGS"
4605Depending on your compiler and compiler settings, you might get no or a 5247Depending on your compiler and compiler settings, you might get no or a
4606lot of warnings when compiling libev code. Some people are apparently 5248lot of warnings when compiling libev code. Some people are apparently
4607scared by this. 5249scared by this.
4608.PP 5250.PP
4660.PP 5302.PP
4661If you need, for some reason, empty reports from valgrind for your project 5303If you need, for some reason, empty reports from valgrind for your project
4662I suggest using suppression lists. 5304I suggest using suppression lists.
4663.SH "PORTABILITY NOTES" 5305.SH "PORTABILITY NOTES"
4664.IX Header "PORTABILITY NOTES" 5306.IX Header "PORTABILITY NOTES"
4665.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" 5307.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
4666.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" 5308.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
4667GNU/Linux is the only common platform that supports 64 bit file/large file 5309GNU/Linux is the only common platform that supports 64 bit file/large file
4668interfaces but \fIdisables\fR them by default. 5310interfaces but \fIdisables\fR them by default.
4669.PP 5311.PP
4670That means that libev compiled in the default environment doesn't support 5312That means that libev compiled in the default environment doesn't support
4671files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. 5313files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
4672.PP 5314.PP
4673Unfortunately, many programs try to work around this GNU/Linux issue 5315Unfortunately, many programs try to work around this GNU/Linux issue
4674by enabling the large file \s-1API\s0, which makes them incompatible with the 5316by enabling the large file \s-1API,\s0 which makes them incompatible with the
4675standard libev compiled for their system. 5317standard libev compiled for their system.
4676.PP 5318.PP
4677Likewise, libev cannot enable the large file \s-1API\s0 itself as this would 5319Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
4678suddenly make it incompatible to the default compile time environment, 5320suddenly make it incompatible to the default compile time environment,
4679i.e. all programs not using special compile switches. 5321i.e. all programs not using special compile switches.
4680.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" 5322.SS "\s-1OS/X AND DARWIN BUGS\s0"
4681.IX Subsection "OS/X AND DARWIN BUGS" 5323.IX Subsection "OS/X AND DARWIN BUGS"
4682The whole thing is a bug if you ask me \- basically any system interface 5324The whole thing is a bug if you ask me \- basically any system interface
4683you touch is broken, whether it is locales, poll, kqueue or even the 5325you touch is broken, whether it is locales, poll, kqueue or even the
4684OpenGL drivers. 5326OpenGL drivers.
4685.PP 5327.PP
4707.PP 5349.PP
4708\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5350\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
4709.IX Subsection "select is buggy" 5351.IX Subsection "select is buggy"
4710.PP 5352.PP
4711All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5353All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
4712one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file 5354one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file
4713descriptors you can pass in to 1024 \- your program suddenly crashes when 5355descriptors you can pass in to 1024 \- your program suddenly crashes when
4714you use more. 5356you use more.
4715.PP 5357.PP
4716There is an undocumented \*(L"workaround\*(R" for this \- defining 5358There is an undocumented \*(L"workaround\*(R" for this \- defining
4717\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR 5359\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
4718work on \s-1OS/X\s0. 5360work on \s-1OS/X.\s0
4719.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5361.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
4720.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" 5362.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
4721\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR 5363\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
4722.IX Subsection "errno reentrancy" 5364.IX Subsection "errno reentrancy"
4723.PP 5365.PP
4724The default compile environment on Solaris is unfortunately so 5366The default compile environment on Solaris is unfortunately so
4741great. 5383great.
4742.PP 5384.PP
4743If you can't get it to work, you can try running the program by setting 5385If you can't get it to work, you can try running the program by setting
4744the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and 5386the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
4745\&\f(CW\*(C`select\*(C'\fR backends. 5387\&\f(CW\*(C`select\*(C'\fR backends.
4746.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" 5388.SS "\s-1AIX POLL BUG\s0"
4747.IX Subsection "AIX POLL BUG" 5389.IX Subsection "AIX POLL BUG"
4748\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around 5390\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
4749this by trying to avoid the poll backend altogether (i.e. it's not even 5391this by trying to avoid the poll backend altogether (i.e. it's not even
4750compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine 5392compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
4751with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway. 5393with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
4752.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5394.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
4753.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5395.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
4754\fIGeneral issues\fR 5396\fIGeneral issues\fR
4755.IX Subsection "General issues" 5397.IX Subsection "General issues"
4756.PP 5398.PP
4757Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5399Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
4758requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 5400requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
4759model. Libev still offers limited functionality on this platform in 5401model. Libev still offers limited functionality on this platform in
4760the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 5402the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
4761descriptors. This only applies when using Win32 natively, not when using 5403descriptors. This only applies when using Win32 natively, not when using
4762e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5404e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4763as every compielr comes with a slightly differently broken/incompatible 5405as every compiler comes with a slightly differently broken/incompatible
4764environment. 5406environment.
4765.PP 5407.PP
4766Lifting these limitations would basically require the full 5408Lifting these limitations would basically require the full
4767re-implementation of the I/O system. If you are into this kind of thing, 5409re-implementation of the I/O system. If you are into this kind of thing,
4768then note that glib does exactly that for you in a very portable way (note 5410then note that glib does exactly that for you in a very portable way (note
4826\& #define EV_USE_SELECT 1 5468\& #define EV_USE_SELECT 1
4827\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5469\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4828.Ve 5470.Ve
4829.PP 5471.PP
4830Note that winsockets handling of fd sets is O(n), so you can easily get a 5472Note that winsockets handling of fd sets is O(n), so you can easily get a
4831complexity in the O(nA\*^X) range when using win32. 5473complexity in the O(nX) range when using win32.
4832.PP 5474.PP
4833\fILimited number of file descriptors\fR 5475\fILimited number of file descriptors\fR
4834.IX Subsection "Limited number of file descriptors" 5476.IX Subsection "Limited number of file descriptors"
4835.PP 5477.PP
4836Windows has numerous arbitrary (and low) limits on things. 5478Windows has numerous arbitrary (and low) limits on things.
4852by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR 5494by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
4853(another arbitrary limit), but is broken in many versions of the Microsoft 5495(another arbitrary limit), but is broken in many versions of the Microsoft
4854runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets 5496runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
4855(depending on windows version and/or the phase of the moon). To get more, 5497(depending on windows version and/or the phase of the moon). To get more,
4856you need to wrap all I/O functions and provide your own fd management, but 5498you need to wrap all I/O functions and provide your own fd management, but
4857the cost of calling select (O(nA\*^X)) will likely make this unworkable. 5499the cost of calling select (O(nX)) will likely make this unworkable.
4858.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5500.SS "\s-1PORTABILITY REQUIREMENTS\s0"
4859.IX Subsection "PORTABILITY REQUIREMENTS" 5501.IX Subsection "PORTABILITY REQUIREMENTS"
4860In addition to a working ISO-C implementation and of course the 5502In addition to a working ISO-C implementation and of course the
4861backend-specific APIs, libev relies on a few additional extensions: 5503backend-specific APIs, libev relies on a few additional extensions:
4862.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 5504.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
4863.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5505.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
4864.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5506.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
4865Libev assumes not only that all watcher pointers have the same internal 5507Libev assumes not only that all watcher pointers have the same internal
4866structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5508structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
4867assumes that the same (machine) code can be used to call any watcher 5509assumes that the same (machine) code can be used to call any watcher
4868callback: The watcher callbacks have different type signatures, but libev 5510callback: The watcher callbacks have different type signatures, but libev
4869calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5511calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5512.IP "null pointers and integer zero are represented by 0 bytes" 4
5513.IX Item "null pointers and integer zero are represented by 0 bytes"
5514Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5515relies on this setting pointers and integers to null.
4870.IP "pointer accesses must be thread-atomic" 4 5516.IP "pointer accesses must be thread-atomic" 4
4871.IX Item "pointer accesses must be thread-atomic" 5517.IX Item "pointer accesses must be thread-atomic"
4872Accessing a pointer value must be atomic, it must both be readable and 5518Accessing a pointer value must be atomic, it must both be readable and
4873writable in one piece \- this is the case on all current architectures. 5519writable in one piece \- this is the case on all current architectures.
4874.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5520.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
4887thread\*(R" or will block signals process-wide, both behaviours would 5533thread\*(R" or will block signals process-wide, both behaviours would
4888be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5534be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
4889\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5535\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
4890.Sp 5536.Sp
4891The most portable way to handle signals is to block signals in all threads 5537The most portable way to handle signals is to block signals in all threads
4892except the initial one, and run the default loop in the initial thread as 5538except the initial one, and run the signal handling loop in the initial
4893well. 5539thread as well.
4894.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5540.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
4895.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 5541.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
4896.IX Item "long must be large enough for common memory allocation sizes" 5542.IX Item "long must be large enough for common memory allocation sizes"
4897To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally 5543To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
4898instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX 5544instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
4899systems (Microsoft...) this might be unexpectedly low, but is still at 5545systems (Microsoft...) this might be unexpectedly low, but is still at
4900least 31 bits everywhere, which is enough for hundreds of millions of 5546least 31 bits everywhere, which is enough for hundreds of millions of
4901watchers. 5547watchers.
4902.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5548.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
4904.IX Item "double must hold a time value in seconds with enough accuracy" 5550.IX Item "double must hold a time value in seconds with enough accuracy"
4905The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5551The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
4906have at least 51 bits of mantissa (and 9 bits of exponent), which is 5552have at least 51 bits of mantissa (and 9 bits of exponent), which is
4907good enough for at least into the year 4000 with millisecond accuracy 5553good enough for at least into the year 4000 with millisecond accuracy
4908(the design goal for libev). This requirement is overfulfilled by 5554(the design goal for libev). This requirement is overfulfilled by
4909implementations using \s-1IEEE\s0 754, which is basically all existing ones. With 5555implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5556.Sp
4910\&\s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least 2200. 5557With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5558year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5559is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5560something like that, just kidding).
4911.PP 5561.PP
4912If you know of other additional requirements drop me a note. 5562If you know of other additional requirements drop me a note.
4913.SH "ALGORITHMIC COMPLEXITIES" 5563.SH "ALGORITHMIC COMPLEXITIES"
4914.IX Header "ALGORITHMIC COMPLEXITIES" 5564.IX Header "ALGORITHMIC COMPLEXITIES"
4915In this section the complexities of (many of) the algorithms used inside 5565In this section the complexities of (many of) the algorithms used inside
4969.IX Item "Processing ev_async_send: O(number_of_async_watchers)" 5619.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
4970.IP "Processing signals: O(max_signal_number)" 4 5620.IP "Processing signals: O(max_signal_number)" 4
4971.IX Item "Processing signals: O(max_signal_number)" 5621.IX Item "Processing signals: O(max_signal_number)"
4972.PD 5622.PD
4973Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 5623Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
4974calls in the current loop iteration. Checking for async and signal events 5624calls in the current loop iteration and the loop is currently
5625blocked. Checking for async and signal events involves iterating over all
4975involves iterating over all running async watchers or all signal numbers. 5626running async watchers or all signal numbers.
4976.SH "PORTING FROM LIBEV 3.X TO 4.X" 5627.SH "PORTING FROM LIBEV 3.X TO 4.X"
4977.IX Header "PORTING FROM LIBEV 3.X TO 4.X" 5628.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
4978The major version 4 introduced some incompatible changes to the \s-1API\s0. 5629The major version 4 introduced some incompatible changes to the \s-1API.\s0
4979.PP 5630.PP
4980At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions 5631At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
4981for all changes, so most programs should still compile. The compatibility 5632for all changes, so most programs should still compile. The compatibility
4982layer might be removed in later versions of libev, so better update to the 5633layer might be removed in later versions of libev, so better update to the
4983new \s-1API\s0 early than late. 5634new \s-1API\s0 early than late.
4984.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 5635.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
4985.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 5636.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
4986.IX Item "EV_COMPAT3 backwards compatibility mechanism" 5637.IX Item "EV_COMPAT3 backwards compatibility mechanism"
4987The backward compatibility mechanism can be controlled by 5638The backward compatibility mechanism can be controlled by
4988\&\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 5639\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
4989section. 5640section.
4990.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 5641.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
4991.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 5642.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
4992.IX Item "ev_default_destroy and ev_default_fork have been removed" 5643.IX Item "ev_default_destroy and ev_default_fork have been removed"
4993These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: 5644These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5033.SH "GLOSSARY" 5684.SH "GLOSSARY"
5034.IX Header "GLOSSARY" 5685.IX Header "GLOSSARY"
5035.IP "active" 4 5686.IP "active" 4
5036.IX Item "active" 5687.IX Item "active"
5037A watcher is active as long as it has been started and not yet stopped. 5688A watcher is active as long as it has been started and not yet stopped.
5038See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5689See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5039.IP "application" 4 5690.IP "application" 4
5040.IX Item "application" 5691.IX Item "application"
5041In this document, an application is whatever is using libev. 5692In this document, an application is whatever is using libev.
5042.IP "backend" 4 5693.IP "backend" 4
5043.IX Item "backend" 5694.IX Item "backend"
5070The model used to describe how an event loop handles and processes 5721The model used to describe how an event loop handles and processes
5071watchers and events. 5722watchers and events.
5072.IP "pending" 4 5723.IP "pending" 4
5073.IX Item "pending" 5724.IX Item "pending"
5074A watcher is pending as soon as the corresponding event has been 5725A watcher is pending as soon as the corresponding event has been
5075detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5726detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5076.IP "real time" 4 5727.IP "real time" 4
5077.IX Item "real time" 5728.IX Item "real time"
5078The physical time that is observed. It is apparently strictly monotonic :) 5729The physical time that is observed. It is apparently strictly monotonic :)
5079.IP "wall-clock time" 4 5730.IP "wall-clock time" 4
5080.IX Item "wall-clock time" 5731.IX Item "wall-clock time"
5081The time and date as shown on clocks. Unlike real time, it can actually 5732The time and date as shown on clocks. Unlike real time, it can actually
5082be wrong and jump forwards and backwards, e.g. when the you adjust your 5733be wrong and jump forwards and backwards, e.g. when you adjust your
5083clock. 5734clock.
5084.IP "watcher" 4 5735.IP "watcher" 4
5085.IX Item "watcher" 5736.IX Item "watcher"
5086A data structure that describes interest in certain events. Watchers need 5737A data structure that describes interest in certain events. Watchers need
5087to be started (attached to an event loop) before they can receive events. 5738to be started (attached to an event loop) before they can receive events.
5088.SH "AUTHOR" 5739.SH "AUTHOR"
5089.IX Header "AUTHOR" 5740.IX Header "AUTHOR"
5090Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael 5741Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5091Magnusson and Emanuele Giaquinta. 5742Magnusson and Emanuele Giaquinta, and minor corrections by many others.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines