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

Comparing libev/ev.3 (file contents):
Revision 1.85 by root, Tue Jan 11 13:45:28 2011 UTC vs.
Revision 1.100 by root, Tue Oct 29 12:13:37 2013 UTC

1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) 1.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
51.ie \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
52. de IX 55.de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54.. 56..
55. nr % 0 57.nr rF 0
56. rr F 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
60. if \nF \{
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
63..
64. if !\nF==2 \{
65. nr % 0
66. nr F 2
67. \}
68. \}
57.\} 69.\}
58.el \{\ 70.rr rF
59. de IX
60..
61.\}
62.\" 71.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
66.if n \{\ 75.if n \{\
122.\} 131.\}
123.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
124.\" ======================================================================== 133.\" ========================================================================
125.\" 134.\"
126.IX Title "LIBEV 3" 135.IX Title "LIBEV 3"
127.TH LIBEV 3 "2011-01-11" "libev-4.03" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2013-10-29" "libev-4.15" "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.
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.
398\& } 413\& }
399\& 414\&
400\& ... 415\& ...
401\& ev_set_allocator (persistent_realloc); 416\& ev_set_allocator (persistent_realloc);
402.Ve 417.Ve
403.IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4 418.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
404.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))" 419.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 420Set the callback function to call on a retryable system call error (such
406as failed select, poll, epoll_wait). The message is a printable string 421as failed select, poll, epoll_wait). The message is a printable string
407indicating the system call or subsystem causing the problem. If this 422indicating the system call or subsystem causing the problem. If this
408callback is set, then libev will expect it to remedy the situation, no 423callback is set, then libev will expect it to remedy the situation, no
409matter what, when it returns. That is, libev will generally retry the 424matter what, when it returns. That is, libev will generally retry the
508.IX Item "EVFLAG_NOENV" 523.IX Item "EVFLAG_NOENV"
509If this flag bit is or'ed into the flag value (or the program runs setuid 524If this flag bit is or'ed into the flag value (or the program runs setuid
510or setgid) then libev will \fInot\fR look at the environment variable 525or setgid) then libev will \fInot\fR look at the environment variable
511\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 526\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
512override the flags completely if it is found in the environment. This is 527override the flags completely if it is found in the environment. This is
513useful to try out specific backends to test their performance, or to work 528useful to try out specific backends to test their performance, to work
514around bugs. 529around bugs, or to make libev threadsafe (accessing environment variables
530cannot be done in a threadsafe way, but usually it works if no other
531thread modifies them).
515.ie n .IP """EVFLAG_FORKCHECK""" 4 532.ie n .IP """EVFLAG_FORKCHECK""" 4
516.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 533.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
517.IX Item "EVFLAG_FORKCHECK" 534.IX Item "EVFLAG_FORKCHECK"
518Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also 535Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
519make libev check for a fork in each iteration by enabling this flag. 536make libev check for a fork in each iteration by enabling this flag.
553example) that can't properly initialise their signal masks. 570example) that can't properly initialise their signal masks.
554.ie n .IP """EVFLAG_NOSIGMASK""" 4 571.ie n .IP """EVFLAG_NOSIGMASK""" 4
555.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4 572.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
556.IX Item "EVFLAG_NOSIGMASK" 573.IX Item "EVFLAG_NOSIGMASK"
557When this flag is specified, then libev will avoid to modify the signal 574When this flag is specified, then libev will avoid to modify the signal
558mask. Specifically, this means you ahve to make sure signals are unblocked 575mask. Specifically, this means you have to make sure signals are unblocked
559when you want to receive them. 576when you want to receive them.
560.Sp 577.Sp
561This behaviour is useful when you want to do your own signal handling, or 578This behaviour is useful when you want to do your own signal handling, or
562want to handle signals only in specific threads and want to avoid libev 579want to handle signals only in specific threads and want to avoid libev
563unblocking the signals. 580unblocking the signals.
564.Sp 581.Sp
582It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
583\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
584.Sp
565This flag's behaviour will become the default in future versions of libev. 585This flag's behaviour will become the default in future versions of libev.
566.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 586.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
567.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 587.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
568.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 588.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
569This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 589This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
570libev tries to roll its own fd_set with no limits on the number of fds, 590libev tries to roll its own fd_set with no limits on the number of fds,
571but if that fails, expect a fairly low limit on the number of fds when 591but if that fails, expect a fairly low limit on the number of fds when
572using this backend. It doesn't scale too well (O(highest_fd)), but its 592using this backend. It doesn't scale too well (O(highest_fd)), but its
573usually the fastest backend for a low number of (low-numbered :) fds. 593usually the fastest backend for a low number of (low-numbered :) fds.
582This 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 602This 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
583\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the 603\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
584\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). 604\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
585.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 605.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
586.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 606.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
587.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 607.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
588And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 608And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
589than select, but handles sparse fds better and has no artificial 609than select, but handles sparse fds better and has no artificial
590limit on the number of fds you can use (except it will slow down 610limit on the number of fds you can use (except it will slow down
591considerably with a lot of inactive fds). It scales similarly to select, 611considerably with a lot of inactive fds). It scales similarly to select,
592i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for 612i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
594.Sp 614.Sp
595This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 615This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
596\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 616\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
597.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 617.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
598.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 618.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
599.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 619.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
600Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 620Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
601kernels). 621kernels).
602.Sp 622.Sp
603For few fds, this backend is a bit little slower than poll and select, 623For few fds, this backend is a bit little slower than poll and select, but
604but it scales phenomenally better. While poll and select usually scale 624it scales phenomenally better. While poll and select usually scale like
605like O(total_fds) where n is the total number of fds (or the highest fd), 625O(total_fds) where total_fds is the total number of fds (or the highest
606epoll scales either O(1) or O(active_fds). 626fd), epoll scales either O(1) or O(active_fds).
607.Sp 627.Sp
608The epoll mechanism deserves honorable mention as the most misdesigned 628The epoll mechanism deserves honorable mention as the most misdesigned
609of the more advanced event mechanisms: mere annoyances include silently 629of the more advanced event mechanisms: mere annoyances include silently
610dropping file descriptors, requiring a system call per change per file 630dropping file descriptors, requiring a system call per change per file
611descriptor (and unnecessary guessing of parameters), problems with dup, 631descriptor (and unnecessary guessing of parameters), problems with dup,
6140.1ms) and so on. The biggest issue is fork races, however \- if a program 6340.1ms) and so on. The biggest issue is fork races, however \- if a program
615forks then \fIboth\fR parent and child process have to recreate the epoll 635forks then \fIboth\fR parent and child process have to recreate the epoll
616set, which can take considerable time (one syscall per file descriptor) 636set, which can take considerable time (one syscall per file descriptor)
617and is of course hard to detect. 637and is of course hard to detect.
618.Sp 638.Sp
619Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but 639Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work,
620of course \fIdoesn't\fR, and epoll just loves to report events for totally 640but of course \fIdoesn't\fR, and epoll just loves to report events for
621\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot 641totally \fIdifferent\fR file descriptors (even already closed ones, so
622even remove them from the set) than registered in the set (especially 642one cannot even remove them from the set) than registered in the set
623on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by 643(especially on \s-1SMP\s0 systems). Libev tries to counter these spurious
624employing an additional generation counter and comparing that against the 644notifications by employing an additional generation counter and comparing
625events to filter out spurious ones, recreating the set when required. Last 645that against the events to filter out spurious ones, recreating the set
646when required. Epoll also erroneously rounds down timeouts, but gives you
647no way to know when and by how much, so sometimes you have to busy-wait
648because epoll returns immediately despite a nonzero timeout. And last
626not least, it also refuses to work with some file descriptors which work 649not least, it also refuses to work with some file descriptors which work
627perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...). 650perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...).
628.Sp 651.Sp
629Epoll is truly the train wreck analog among event poll mechanisms, 652Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
630a frankenpoll, cobbled together in a hurry, no thought to design or 653cobbled together in a hurry, no thought to design or interaction with
631interaction with others. 654others. Oh, the pain, will it ever stop...
632.Sp 655.Sp
633While stopping, setting and starting an I/O watcher in the same iteration 656While stopping, setting and starting an I/O watcher in the same iteration
634will result in some caching, there is still a system call per such 657will result in some caching, there is still a system call per such
635incident (because the same \fIfile descriptor\fR could point to a different 658incident (because the same \fIfile descriptor\fR could point to a different
636\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed 659\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
654.Sp 677.Sp
655This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 678This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
656\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 679\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
657.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 680.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
658.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 681.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
659.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 682.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
660Kqueue deserves special mention, as at the time of this writing, it 683Kqueue deserves special mention, as at the time of this writing, it
661was broken on all BSDs except NetBSD (usually it doesn't work reliably 684was broken on all BSDs except NetBSD (usually it doesn't work reliably
662with anything but sockets and pipes, except on Darwin, where of course 685with anything but sockets and pipes, except on Darwin, where of course
663it's completely useless). Unlike epoll, however, whose brokenness 686it's completely useless). Unlike epoll, however, whose brokenness
664is by design, these kqueue bugs can (and eventually will) be fixed 687is by design, these kqueue bugs can (and eventually will) be fixed
673.Sp 696.Sp
674It scales in the same way as the epoll backend, but the interface to the 697It scales in the same way as the epoll backend, but the interface to the
675kernel is more efficient (which says nothing about its actual speed, of 698kernel is more efficient (which says nothing about its actual speed, of
676course). While stopping, setting and starting an I/O watcher does never 699course). While stopping, setting and starting an I/O watcher does never
677cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 700cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
678two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but 701two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
679sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 702might have to leak fd's on fork, but it's more sane than epoll) and it
680cases 703drops fds silently in similarly hard-to-detect cases.
681.Sp 704.Sp
682This backend usually performs well under most conditions. 705This backend usually performs well under most conditions.
683.Sp 706.Sp
684While nominally embeddable in other event loops, this doesn't work 707While nominally embeddable in other event loops, this doesn't work
685everywhere, so you might need to test for this. And since it is broken 708everywhere, so you might need to test for this. And since it is broken
686almost everywhere, you should only use it when you have a lot of sockets 709almost everywhere, you should only use it when you have a lot of sockets
687(for which it usually works), by embedding it into another event loop 710(for which it usually works), by embedding it into another event loop
688(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 711(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
689also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. 712also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
690.Sp 713.Sp
691This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 714This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
692\&\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 715\&\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
693\&\f(CW\*(C`NOTE_EOF\*(C'\fR. 716\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
694.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 717.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
698implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets 721implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
699and is not embeddable, which would limit the usefulness of this backend 722and is not embeddable, which would limit the usefulness of this backend
700immensely. 723immensely.
701.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 724.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
702.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 725.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
703.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 726.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
704This uses the Solaris 10 event port mechanism. As with everything on Solaris, 727This uses the Solaris 10 event port mechanism. As with everything on Solaris,
705it's really slow, but it still scales very well (O(active_fds)). 728it's really slow, but it still scales very well (O(active_fds)).
706.Sp 729.Sp
707While this backend scales well, it requires one system call per active 730While this backend scales well, it requires one system call per active
708file descriptor per loop iteration. For small and medium numbers of file 731file descriptor per loop iteration. For small and medium numbers of file
714among the OS-specific backends (I vastly prefer correctness over speed 737among the OS-specific backends (I vastly prefer correctness over speed
715hacks). 738hacks).
716.Sp 739.Sp
717On the negative side, the interface is \fIbizarre\fR \- so bizarre that 740On the negative side, the interface is \fIbizarre\fR \- so bizarre that
718even sun itself gets it wrong in their code examples: The event polling 741even sun itself gets it wrong in their code examples: The event polling
719function sometimes returning events to the caller even though an error 742function sometimes returns events to the caller even though an error
720occurred, but with no indication whether it has done so or not (yes, it's 743occurred, but with no indication whether it has done so or not (yes, it's
721even documented that way) \- deadly for edge-triggered interfaces where 744even documented that way) \- deadly for edge-triggered interfaces where you
722you absolutely have to know whether an event occurred or not because you 745absolutely have to know whether an event occurred or not because you have
723have to re-arm the watcher. 746to re-arm the watcher.
724.Sp 747.Sp
725Fortunately libev seems to be able to work around these idiocies. 748Fortunately libev seems to be able to work around these idiocies.
726.Sp 749.Sp
727This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 750This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
728\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 751\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
793reinitialise the kernel state for backends that have one. Despite the 816reinitialise the kernel state for backends that have one. Despite the
794name, you can call it anytime, but it makes most sense after forking, in 817name, you can call it anytime, but it makes most sense after forking, in
795the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the 818the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the
796child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. 819child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
797.Sp 820.Sp
798Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after 821Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
799a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is 822a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
800because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things 823because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
801during fork. 824during fork.
802.Sp 825.Sp
803On the other hand, you only need to call this function in the child 826On the other hand, you only need to call this function in the child
897given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR 920given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
898without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR. 921without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
899.Sp 922.Sp
900Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the 923Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
901event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR). 924event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
902.IP "ev_run (loop, int flags)" 4 925.IP "bool ev_run (loop, int flags)" 4
903.IX Item "ev_run (loop, int flags)" 926.IX Item "bool ev_run (loop, int flags)"
904Finally, this is it, the event handler. This function usually is called 927Finally, this is it, the event handler. This function usually is called
905after you have initialised all your watchers and you want to start 928after you have initialised all your watchers and you want to start
906handling events. It will ask the operating system for any new events, call 929handling events. It will ask the operating system for any new events, call
907the watcher callbacks, an then repeat the whole process indefinitely: This 930the watcher callbacks, and then repeat the whole process indefinitely: This
908is why event loops are called \fIloops\fR. 931is why event loops are called \fIloops\fR.
909.Sp 932.Sp
910If the flags argument is specified as \f(CW0\fR, it will keep handling events 933If the flags argument is specified as \f(CW0\fR, it will keep handling events
911until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was 934until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
912called. 935called.
936.Sp
937The return value is false if there are no more active watchers (which
938usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
939(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
913.Sp 940.Sp
914Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than 941Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
915relying on all watchers to be stopped when deciding when a program has 942relying on all watchers to be stopped when deciding when a program has
916finished (especially in interactive programs), but having a program 943finished (especially in interactive programs), but having a program
917that automatically loops as long as it has to and no longer by virtue 944that automatically loops as long as it has to and no longer by virtue
918of relying on its watchers stopping correctly, that is truly a thing of 945of relying on its watchers stopping correctly, that is truly a thing of
919beauty. 946beauty.
920.Sp 947.Sp
921This function is also \fImostly\fR exception-safe \- you can break out of 948This function is \fImostly\fR exception-safe \- you can break out of a
922a \f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+ 949\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
923exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor 950exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
924will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks. 951will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
925.Sp 952.Sp
926A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle 953A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
927those events and any already outstanding ones, but will not wait and 954those events and any already outstanding ones, but will not wait and
939This is useful if you are waiting for some external event in conjunction 966This is useful if you are waiting for some external event in conjunction
940with something not expressible using other libev watchers (i.e. "roll your 967with something not expressible using other libev watchers (i.e. "roll your
941own \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 968own \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
942usually a better approach for this kind of thing. 969usually a better approach for this kind of thing.
943.Sp 970.Sp
944Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does: 971Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does (this is for your
972understanding, not a guarantee that things will work exactly like this in
973future versions):
945.Sp 974.Sp
946.Vb 10 975.Vb 10
947\& \- Increment loop depth. 976\& \- Increment loop depth.
948\& \- Reset the ev_break status. 977\& \- Reset the ev_break status.
949\& \- Before the first iteration, call any pending watchers. 978\& \- Before the first iteration, call any pending watchers.
985.Sp 1014.Sp
986.Vb 4 1015.Vb 4
987\& ... queue jobs here, make sure they register event watchers as long 1016\& ... queue jobs here, make sure they register event watchers as long
988\& ... as they still have work to do (even an idle watcher will do..) 1017\& ... as they still have work to do (even an idle watcher will do..)
989\& ev_run (my_loop, 0); 1018\& ev_run (my_loop, 0);
990\& ... jobs done or somebody called unloop. yeah! 1019\& ... jobs done or somebody called break. yeah!
991.Ve 1020.Ve
992.IP "ev_break (loop, how)" 4 1021.IP "ev_break (loop, how)" 4
993.IX Item "ev_break (loop, how)" 1022.IX Item "ev_break (loop, how)"
994Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it 1023Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it
995has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 1024has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
1064overhead for the actual polling but can deliver many events at once. 1093overhead for the actual polling but can deliver many events at once.
1065.Sp 1094.Sp
1066By setting a higher \fIio collect interval\fR you allow libev to spend more 1095By setting a higher \fIio collect interval\fR you allow libev to spend more
1067time collecting I/O events, so you can handle more events per iteration, 1096time collecting I/O events, so you can handle more events per iteration,
1068at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and 1097at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
1069\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will 1098\&\f(CW\*(C`ev_timer\*(C'\fR) will not be affected. Setting this to a non-null value will
1070introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The 1099introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
1071sleep time ensures that libev will not poll for I/O events more often then 1100sleep time ensures that libev will not poll for I/O events more often then
1072once per this interval, on average. 1101once per this interval, on average (as long as the host time resolution is
1102good enough).
1073.Sp 1103.Sp
1074Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 1104Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
1075to spend more time collecting timeouts, at the expense of increased 1105to spend more time collecting timeouts, at the expense of increased
1076latency/jitter/inexactness (the watcher callback will be called 1106latency/jitter/inexactness (the watcher callback will be called
1077later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null 1107later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
1121this callback instead. This is useful, for example, when you want to 1151this callback instead. This is useful, for example, when you want to
1122invoke the actual watchers inside another context (another thread etc.). 1152invoke the actual watchers inside another context (another thread etc.).
1123.Sp 1153.Sp
1124If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new 1154If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1125callback. 1155callback.
1126.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4 1156.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
1127.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))" 1157.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
1128Sometimes you want to share the same loop between multiple threads. This 1158Sometimes you want to share the same loop between multiple threads. This
1129can be done relatively simply by putting mutex_lock/unlock calls around 1159can be done relatively simply by putting mutex_lock/unlock calls around
1130each call to a libev function. 1160each call to a libev function.
1131.Sp 1161.Sp
1132However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible 1162However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1133to wait for it to return. One way around this is to wake up the event 1163to wait for it to return. One way around this is to wake up the event
1134loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`av_async_send\*(C'\fR, another way is to set these 1164loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`ev_async_send\*(C'\fR, another way is to set these
1135\&\fIrelease\fR and \fIacquire\fR callbacks on the loop. 1165\&\fIrelease\fR and \fIacquire\fR callbacks on the loop.
1136.Sp 1166.Sp
1137When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is 1167When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1138suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just 1168suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1139afterwards. 1169afterwards.
1280.PD 0 1310.PD 0
1281.ie n .IP """EV_CHECK""" 4 1311.ie n .IP """EV_CHECK""" 4
1282.el .IP "\f(CWEV_CHECK\fR" 4 1312.el .IP "\f(CWEV_CHECK\fR" 4
1283.IX Item "EV_CHECK" 1313.IX Item "EV_CHECK"
1284.PD 1314.PD
1285All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts 1315All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
1286to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1316gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
1287\&\f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it invokes any callbacks for any 1317just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1318for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1319watchers invoked before the event loop sleeps or polls for new events, and
1320\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1321or lower priority within an event loop iteration.
1322.Sp
1288received events. Callbacks of both watcher types can start and stop as 1323Callbacks of both watcher types can start and stop as many watchers as
1289many watchers as they want, and all of them will be taken into account 1324they want, and all of them will be taken into account (for example, a
1290(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1325\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
1291\&\f(CW\*(C`ev_run\*(C'\fR from blocking). 1326blocking).
1292.ie n .IP """EV_EMBED""" 4 1327.ie n .IP """EV_EMBED""" 4
1293.el .IP "\f(CWEV_EMBED\fR" 4 1328.el .IP "\f(CWEV_EMBED\fR" 4
1294.IX Item "EV_EMBED" 1329.IX Item "EV_EMBED"
1295The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1330The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1296.ie n .IP """EV_FORK""" 4 1331.ie n .IP """EV_FORK""" 4
1328example it might indicate that a fd is readable or writable, and if your 1363example it might indicate that a fd is readable or writable, and if your
1329callbacks is well-written it can just attempt the operation and cope with 1364callbacks is well-written it can just attempt the operation and cope with
1330the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1365the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
1331programs, though, as the fd could already be closed and reused for another 1366programs, though, as the fd could already be closed and reused for another
1332thing, so beware. 1367thing, so beware.
1333.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1368.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1334.IX Subsection "GENERIC WATCHER FUNCTIONS" 1369.IX Subsection "GENERIC WATCHER FUNCTIONS"
1335.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1370.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1336.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1371.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1337.IX Item "ev_init (ev_TYPE *watcher, callback)" 1372.IX Item "ev_init (ev_TYPE *watcher, callback)"
1338This macro initialises the generic portion of a watcher. The contents 1373This macro initialises the generic portion of a watcher. The contents
1417make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR 1452make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1418it). 1453it).
1419.IP "callback ev_cb (ev_TYPE *watcher)" 4 1454.IP "callback ev_cb (ev_TYPE *watcher)" 4
1420.IX Item "callback ev_cb (ev_TYPE *watcher)" 1455.IX Item "callback ev_cb (ev_TYPE *watcher)"
1421Returns the callback currently set on the watcher. 1456Returns the callback currently set on the watcher.
1422.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1457.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
1423.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1458.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
1424Change the callback. You can change the callback at virtually any time 1459Change the callback. You can change the callback at virtually any time
1425(modulo threads). 1460(modulo threads).
1426.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 1461.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1427.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" 1462.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1428.PD 0 1463.PD 0
1446or might not have been clamped to the valid range. 1481or might not have been clamped to the valid range.
1447.Sp 1482.Sp
1448The default priority used by watchers when no priority has been set is 1483The default priority used by watchers when no priority has been set is
1449always \f(CW0\fR, which is supposed to not be too high and not be too low :). 1484always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1450.Sp 1485.Sp
1451See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1486See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1452priorities. 1487priorities.
1453.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1488.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1454.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1489.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1455Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1490Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1456\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1491\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1476not started in the first place. 1511not started in the first place.
1477.Sp 1512.Sp
1478See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related 1513See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1479functions that do not need a watcher. 1514functions that do not need a watcher.
1480.PP 1515.PP
1481See also the \*(L"\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0\*(R" and \*(L"\s-1BUILDING\s0 \s-1YOUR\s0 1516See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1482\&\s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0\*(R" idioms. 1517OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1483.SS "\s-1WATCHER\s0 \s-1STATES\s0" 1518.SS "\s-1WATCHER STATES\s0"
1484.IX Subsection "WATCHER STATES" 1519.IX Subsection "WATCHER STATES"
1485There are various watcher states mentioned throughout this manual \- 1520There are various watcher states mentioned throughout this manual \-
1486active, pending and so on. In this section these states and the rules to 1521active, pending and so on. In this section these states and the rules to
1487transition between them will be described in more detail \- and while these 1522transition between them will be described in more detail \- and while these
1488rules might look complicated, they usually do \*(L"the right thing\*(R". 1523rules might look complicated, they usually do \*(L"the right thing\*(R".
1489.IP "initialiased" 4 1524.IP "initialised" 4
1490.IX Item "initialiased" 1525.IX Item "initialised"
1491Before a watcher can be registered with the event looop it has to be 1526Before a watcher can be registered with the event loop it has to be
1492initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to 1527initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1493\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function. 1528\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1494.Sp 1529.Sp
1495In this state it is simply some block of memory that is suitable for use 1530In this state it is simply some block of memory that is suitable for
1496in an event loop. It can be moved around, freed, reused etc. at will. 1531use in an event loop. It can be moved around, freed, reused etc. at
1532will \- as long as you either keep the memory contents intact, or call
1533\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again.
1497.IP "started/running/active" 4 1534.IP "started/running/active" 4
1498.IX Item "started/running/active" 1535.IX Item "started/running/active"
1499Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes 1536Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1500property of the event loop, and is actively waiting for events. While in 1537property of the event loop, and is actively waiting for events. While in
1501this state it cannot be accessed (except in a few documented ways), moved, 1538this state it cannot be accessed (except in a few documented ways), moved,
1526latter will clear any pending state the watcher might be in, regardless 1563latter will clear any pending state the watcher might be in, regardless
1527of whether it was active or not, so stopping a watcher explicitly before 1564of whether it was active or not, so stopping a watcher explicitly before
1528freeing it is often a good idea. 1565freeing it is often a good idea.
1529.Sp 1566.Sp
1530While stopped (and not pending) the watcher is essentially in the 1567While stopped (and not pending) the watcher is essentially in the
1531initialised state, that is it can be reused, moved, modified in any way 1568initialised state, that is, it can be reused, moved, modified in any way
1532you wish. 1569you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1570it again).
1533.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1571.SS "\s-1WATCHER PRIORITY MODELS\s0"
1534.IX Subsection "WATCHER PRIORITY MODELS" 1572.IX Subsection "WATCHER PRIORITY MODELS"
1535Many event loops support \fIwatcher priorities\fR, which are usually small 1573Many event loops support \fIwatcher priorities\fR, which are usually small
1536integers that influence the ordering of event callback invocation 1574integers that influence the ordering of event callback invocation
1537between watchers in some way, all else being equal. 1575between watchers in some way, all else being equal.
1538.PP 1576.PP
1736wish to read \- you would first have to request some data. 1774wish to read \- you would first have to request some data.
1737.PP 1775.PP
1738Since files are typically not-so-well supported by advanced notification 1776Since files are typically not-so-well supported by advanced notification
1739mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect 1777mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1740to files, even though you should not use it. The reason for this is 1778to files, even though you should not use it. The reason for this is
1741convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT\s0, which is 1779convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1742usually a tty, often a pipe, but also sometimes files or special devices 1780usually a tty, often a pipe, but also sometimes files or special devices
1743(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with 1781(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1744\&\fI/dev/urandom\fR), and even though the file might better be served with 1782\&\fI/dev/urandom\fR), and even though the file might better be served with
1745asynchronous I/O instead of with non-blocking I/O, it is still useful when 1783asynchronous I/O instead of with non-blocking I/O, it is still useful when
1746it \*(L"just works\*(R" instead of freezing. 1784it \*(L"just works\*(R" instead of freezing.
1747.PP 1785.PP
1748So avoid file descriptors pointing to files when you know it (e.g. use 1786So avoid file descriptors pointing to files when you know it (e.g. use
1749libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT\s0, or 1787libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1750when you rarely read from a file instead of from a socket, and want to 1788when you rarely read from a file instead of from a socket, and want to
1751reuse the same code path. 1789reuse the same code path.
1752.PP 1790.PP
1753\fIThe special problem of fork\fR 1791\fIThe special problem of fork\fR
1754.IX Subsection "The special problem of fork" 1792.IX Subsection "The special problem of fork"
1764\fIThe special problem of \s-1SIGPIPE\s0\fR 1802\fIThe special problem of \s-1SIGPIPE\s0\fR
1765.IX Subsection "The special problem of SIGPIPE" 1803.IX Subsection "The special problem of SIGPIPE"
1766.PP 1804.PP
1767While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1805While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1768when writing to a pipe whose other end has been closed, your program gets 1806when writing to a pipe whose other end has been closed, your program gets
1769sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs 1807sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1770this is sensible behaviour, for daemons, this is usually undesirable. 1808this is sensible behaviour, for daemons, this is usually undesirable.
1771.PP 1809.PP
1772So when you encounter spurious, unexplained daemon exits, make sure you 1810So when you encounter spurious, unexplained daemon exits, make sure you
1773ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon 1811ignore \s-1SIGPIPE \s0(and maybe make sure you log the exit status of your daemon
1774somewhere, as that would have given you a big clue). 1812somewhere, as that would have given you a big clue).
1775.PP 1813.PP
1776\fIThe special problem of \fIaccept()\fIing when you can't\fR 1814\fIThe special problem of \fIaccept()\fIing when you can't\fR
1777.IX Subsection "The special problem of accept()ing when you can't" 1815.IX Subsection "The special problem of accept()ing when you can't"
1778.PP 1816.PP
1779Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, 1817Many implementations of the \s-1POSIX \s0\f(CW\*(C`accept\*(C'\fR function (for example,
1780found in post\-2004 Linux) have the peculiar behaviour of not removing a 1818found in post\-2004 Linux) have the peculiar behaviour of not removing a
1781connection from the pending queue in all error cases. 1819connection from the pending queue in all error cases.
1782.PP 1820.PP
1783For example, larger servers often run out of file descriptors (because 1821For example, larger servers often run out of file descriptors (because
1784of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not 1822of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not
1865detecting time jumps is hard, and some inaccuracies are unavoidable (the 1903detecting time jumps is hard, and some inaccuracies are unavoidable (the
1866monotonic clock option helps a lot here). 1904monotonic clock option helps a lot here).
1867.PP 1905.PP
1868The callback is guaranteed to be invoked only \fIafter\fR its timeout has 1906The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1869passed (not \fIat\fR, so on systems with very low-resolution clocks this 1907passed (not \fIat\fR, so on systems with very low-resolution clocks this
1870might introduce a small delay). If multiple timers become ready during the 1908might introduce a small delay, see \*(L"the special problem of being too
1909early\*(R", below). If multiple timers become ready during the same loop
1871same loop iteration then the ones with earlier time-out values are invoked 1910iteration then the ones with earlier time-out values are invoked before
1872before ones of the same priority with later time-out values (but this is 1911ones of the same priority with later time-out values (but this is no
1873no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively). 1912longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1874.PP 1913.PP
1875\fIBe smart about timeouts\fR 1914\fIBe smart about timeouts\fR
1876.IX Subsection "Be smart about timeouts" 1915.IX Subsection "Be smart about timeouts"
1877.PP 1916.PP
1878Many real-world problems involve some kind of timeout, usually for error 1917Many real-world problems involve some kind of timeout, usually for error
1960.Sp 1999.Sp
1961In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, 2000In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
1962but remember the time of last activity, and check for a real timeout only 2001but remember the time of last activity, and check for a real timeout only
1963within the callback: 2002within the callback:
1964.Sp 2003.Sp
1965.Vb 1 2004.Vb 3
2005\& ev_tstamp timeout = 60.;
1966\& ev_tstamp last_activity; // time of last activity 2006\& ev_tstamp last_activity; // time of last activity
2007\& ev_timer timer;
1967\& 2008\&
1968\& static void 2009\& static void
1969\& callback (EV_P_ ev_timer *w, int revents) 2010\& callback (EV_P_ ev_timer *w, int revents)
1970\& { 2011\& {
1971\& ev_tstamp now = ev_now (EV_A); 2012\& // calculate when the timeout would happen
1972\& ev_tstamp timeout = last_activity + 60.; 2013\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
1973\& 2014\&
1974\& // if last_activity + 60. is older than now, we did time out 2015\& // if negative, it means we the timeout already occurred
1975\& if (timeout < now) 2016\& if (after < 0.)
1976\& { 2017\& {
1977\& // timeout occurred, take action 2018\& // timeout occurred, take action
1978\& } 2019\& }
1979\& else 2020\& else
1980\& { 2021\& {
1981\& // callback was invoked, but there was some activity, re\-arm 2022\& // callback was invoked, but there was some recent
1982\& // the watcher to fire in last_activity + 60, which is 2023\& // activity. simply restart the timer to time out
1983\& // guaranteed to be in the future, so "again" is positive: 2024\& // after "after" seconds, which is the earliest time
1984\& w\->repeat = timeout \- now; 2025\& // the timeout can occur.
2026\& ev_timer_set (w, after, 0.);
1985\& ev_timer_again (EV_A_ w); 2027\& ev_timer_start (EV_A_ w);
1986\& } 2028\& }
1987\& } 2029\& }
1988.Ve 2030.Ve
1989.Sp 2031.Sp
1990To summarise the callback: first calculate the real timeout (defined 2032To summarise the callback: first calculate in how many seconds the
1991as \*(L"60 seconds after the last activity\*(R"), then check if that time has 2033timeout will occur (by calculating the absolute time when it would occur,
1992been reached, which means something \fIdid\fR, in fact, time out. Otherwise 2034\&\f(CW\*(C`last_activity + timeout\*(C'\fR, and subtracting the current time, \f(CW\*(C`ev_now
1993the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so 2035(EV_A)\*(C'\fR from that).
1994re-schedule the timer to fire at that future time, to see if maybe we have
1995a timeout then.
1996.Sp 2036.Sp
1997Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the 2037If this value is negative, then we are already past the timeout, i.e. we
1998\&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running. 2038timed out, and need to do whatever is needed in this case.
2039.Sp
2040Otherwise, we now the earliest time at which the timeout would trigger,
2041and simply start the timer with this timeout value.
2042.Sp
2043In other words, each time the callback is invoked it will check whether
2044the timeout occurred. If not, it will simply reschedule itself to check
2045again at the earliest time it could time out. Rinse. Repeat.
1999.Sp 2046.Sp
2000This scheme causes more callback invocations (about one every 60 seconds 2047This scheme causes more callback invocations (about one every 60 seconds
2001minus half the average time between activity), but virtually no calls to 2048minus half the average time between activity), but virtually no calls to
2002libev to change the timeout. 2049libev to change the timeout.
2003.Sp 2050.Sp
2004To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR 2051To start the machinery, simply initialise the watcher and set
2005to the current time (meaning we just have some activity :), then call the 2052\&\f(CW\*(C`last_activity\*(C'\fR to the current time (meaning there was some activity just
2006callback, which will \*(L"do the right thing\*(R" and start the timer: 2053now), then call the callback, which will \*(L"do the right thing\*(R" and start
2054the timer:
2007.Sp 2055.Sp
2008.Vb 3 2056.Vb 3
2057\& last_activity = ev_now (EV_A);
2009\& ev_init (timer, callback); 2058\& ev_init (&timer, callback);
2010\& last_activity = ev_now (loop); 2059\& callback (EV_A_ &timer, 0);
2011\& callback (loop, timer, EV_TIMER);
2012.Ve 2060.Ve
2013.Sp 2061.Sp
2014And when there is some activity, simply store the current time in 2062When there is some activity, simply store the current time in
2015\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: 2063\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
2016.Sp 2064.Sp
2017.Vb 1 2065.Vb 2
2066\& if (activity detected)
2018\& last_activity = ev_now (loop); 2067\& last_activity = ev_now (EV_A);
2068.Ve
2069.Sp
2070When your timeout value changes, then the timeout can be changed by simply
2071providing a new value, stopping the timer and calling the callback, which
2072will again do the right thing (for example, time out immediately :).
2073.Sp
2074.Vb 3
2075\& timeout = new_value;
2076\& ev_timer_stop (EV_A_ &timer);
2077\& callback (EV_A_ &timer, 0);
2019.Ve 2078.Ve
2020.Sp 2079.Sp
2021This technique is slightly more complex, but in most cases where the 2080This technique is slightly more complex, but in most cases where the
2022time-out is unlikely to be triggered, much more efficient. 2081time-out is unlikely to be triggered, much more efficient.
2023.Sp
2024Changing the timeout is trivial as well (if it isn't hard-coded in the
2025callback :) \- just change the timeout and invoke the callback, which will
2026fix things for you.
2027.IP "4. Wee, just use a double-linked list for your timeouts." 4 2082.IP "4. Wee, just use a double-linked list for your timeouts." 4
2028.IX Item "4. Wee, just use a double-linked list for your timeouts." 2083.IX Item "4. Wee, just use a double-linked list for your timeouts."
2029If there is not one request, but many thousands (millions...), all 2084If there is not one request, but many thousands (millions...), all
2030employing some kind of timeout with the same timeout value, then one can 2085employing some kind of timeout with the same timeout value, then one can
2031do even better: 2086do even better:
2055Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2110Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
2056rather complicated, but extremely efficient, something that really pays 2111rather complicated, but extremely efficient, something that really pays
2057off after the first million or so of active timers, i.e. it's usually 2112off after the first million or so of active timers, i.e. it's usually
2058overkill :) 2113overkill :)
2059.PP 2114.PP
2115\fIThe special problem of being too early\fR
2116.IX Subsection "The special problem of being too early"
2117.PP
2118If you ask a timer to call your callback after three seconds, then
2119you expect it to be invoked after three seconds \- but of course, this
2120cannot be guaranteed to infinite precision. Less obviously, it cannot be
2121guaranteed to any precision by libev \- imagine somebody suspending the
2122process with a \s-1STOP\s0 signal for a few hours for example.
2123.PP
2124So, libev tries to invoke your callback as soon as possible \fIafter\fR the
2125delay has occurred, but cannot guarantee this.
2126.PP
2127A less obvious failure mode is calling your callback too early: many event
2128loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but
2129this can cause your callback to be invoked much earlier than you would
2130expect.
2131.PP
2132To see why, imagine a system with a clock that only offers full second
2133resolution (think windows if you can't come up with a broken enough \s-1OS\s0
2134yourself). If you schedule a one-second timer at the time 500.9, then the
2135event loop will schedule your timeout to elapse at a system time of 500
2136(500.9 truncated to the resolution) + 1, or 501.
2137.PP
2138If an event library looks at the timeout 0.1s later, it will see \*(L"501 >=
2139501\*(R" and invoke the callback 0.1s after it was started, even though a
2140one-second delay was requested \- this is being \*(L"too early\*(R", despite best
2141intentions.
2142.PP
2143This is the reason why libev will never invoke the callback if the elapsed
2144delay equals the requested delay, but only when the elapsed delay is
2145larger than the requested delay. In the example above, libev would only invoke
2146the callback at system time 502, or 1.1s after the timer was started.
2147.PP
2148So, while libev cannot guarantee that your callback will be invoked
2149exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested
2150delay has actually elapsed, or in other words, it always errs on the \*(L"too
2151late\*(R" side of things.
2152.PP
2060\fIThe special problem of time updates\fR 2153\fIThe special problem of time updates\fR
2061.IX Subsection "The special problem of time updates" 2154.IX Subsection "The special problem of time updates"
2062.PP 2155.PP
2063Establishing the current time is a costly operation (it usually takes at 2156Establishing the current time is a costly operation (it usually takes
2064least two system calls): \s-1EV\s0 therefore updates its idea of the current 2157at least one system call): \s-1EV\s0 therefore updates its idea of the current
2065time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a 2158time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a
2066growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling 2159growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
2067lots of events in one iteration. 2160lots of events in one iteration.
2068.PP 2161.PP
2069The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2162The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
2077.Ve 2170.Ve
2078.PP 2171.PP
2079If the event loop is suspended for a long time, you can also force an 2172If the event loop is suspended for a long time, you can also force an
2080update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 2173update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
2081()\*(C'\fR. 2174()\*(C'\fR.
2175.PP
2176\fIThe special problem of unsynchronised clocks\fR
2177.IX Subsection "The special problem of unsynchronised clocks"
2178.PP
2179Modern systems have a variety of clocks \- libev itself uses the normal
2180\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time
2181jumps).
2182.PP
2183Neither of these clocks is synchronised with each other or any other clock
2184on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time
2185than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example,
2186a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher
2187than a directly following call to \f(CW\*(C`time\*(C'\fR.
2188.PP
2189The moral of this is to only compare libev-related timestamps with
2190\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than
2191a second or so.
2192.PP
2193One more problem arises due to this lack of synchronisation: if libev uses
2194the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR
2195or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is
2196invoked, you will find that sometimes the callback is a bit \*(L"early\*(R".
2197.PP
2198This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so
2199libev makes sure your callback is not invoked before the delay happened,
2200\&\fImeasured according to the real time\fR, not the system clock.
2201.PP
2202If your timeouts are based on a physical timescale (e.g. \*(L"time out this
2203connection after 100 seconds\*(R") then this shouldn't bother you as it is
2204exactly the right behaviour.
2205.PP
2206If you want to compare wall clock/system timestamps to your timers, then
2207you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock
2208time, where your comparisons will always generate correct results.
2082.PP 2209.PP
2083\fIThe special problems of suspended animation\fR 2210\fIThe special problems of suspended animation\fR
2084.IX Subsection "The special problems of suspended animation" 2211.IX Subsection "The special problems of suspended animation"
2085.PP 2212.PP
2086When you leave the server world it is quite customary to hit machines that 2213When you leave the server world it is quite customary to hit machines that
2130trigger at exactly 10 second intervals. If, however, your program cannot 2257trigger at exactly 10 second intervals. If, however, your program cannot
2131keep up with the timer (because it takes longer than those 10 seconds to 2258keep up with the timer (because it takes longer than those 10 seconds to
2132do stuff) the timer will not fire more than once per event loop iteration. 2259do stuff) the timer will not fire more than once per event loop iteration.
2133.IP "ev_timer_again (loop, ev_timer *)" 4 2260.IP "ev_timer_again (loop, ev_timer *)" 4
2134.IX Item "ev_timer_again (loop, ev_timer *)" 2261.IX Item "ev_timer_again (loop, ev_timer *)"
2135This will act as if the timer timed out and restart it again if it is 2262This will act as if the timer timed out, and restarts it again if it is
2136repeating. The exact semantics are: 2263repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the
2264timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR.
2137.Sp 2265.Sp
2266The exact semantics are as in the following rules, all of which will be
2267applied to the watcher:
2268.RS 4
2138If the timer is pending, its pending status is cleared. 2269.IP "If the timer is pending, the pending status is always cleared." 4
2139.Sp 2270.IX Item "If the timer is pending, the pending status is always cleared."
2271.PD 0
2140If the timer is started but non-repeating, stop it (as if it timed out). 2272.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4
2141.Sp 2273.IX Item "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)."
2142If the timer is repeating, either start it if necessary (with the 2274.ie n .IP "If the timer is repeating, make the ""repeat"" value the new timeout and start the timer, if necessary." 4
2143\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 2275.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4
2276.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary."
2277.RE
2278.RS 4
2279.PD
2144.Sp 2280.Sp
2145This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a 2281This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
2146usage example. 2282usage example.
2283.RE
2147.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4 2284.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
2148.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 2285.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
2149Returns the remaining time until a timer fires. If the timer is active, 2286Returns the remaining time until a timer fires. If the timer is active,
2150then this time is relative to the current event loop time, otherwise it's 2287then this time is relative to the current event loop time, otherwise it's
2151the timeout value currently configured. 2288the timeout value currently configured.
2271.Sp 2408.Sp
2272Another way to think about it (for the mathematically inclined) is that 2409Another way to think about it (for the mathematically inclined) is that
2273\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2410\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
2274time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps. 2411time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
2275.Sp 2412.Sp
2276For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near 2413The \f(CW\*(C`interval\*(C'\fR \fI\s-1MUST\s0\fR be positive, and for numerical stability, the
2277\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 2414interval value should be higher than \f(CW\*(C`1/8192\*(C'\fR (which is around 100
2278this value, and in fact is often specified as zero. 2415microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have
2416at most a similar magnitude as the current time (say, within a factor of
2417ten). Typical values for offset are, in fact, \f(CW0\fR or something between
2418\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range.
2279.Sp 2419.Sp
2280Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 2420Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
2281speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability 2421speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
2282will of course deteriorate. Libev itself tries to be exact to be about one 2422will of course deteriorate. Libev itself tries to be exact to be about one
2283millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). 2423millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
2287In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being 2427In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
2288ignored. Instead, each time the periodic watcher gets scheduled, the 2428ignored. Instead, each time the periodic watcher gets scheduled, the
2289reschedule callback will be called with the watcher as first, and the 2429reschedule callback will be called with the watcher as first, and the
2290current time as second argument. 2430current time as second argument.
2291.Sp 2431.Sp
2292\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2432\&\s-1NOTE: \s0\fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
2293or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly 2433or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2294allowed by documentation here\fR. 2434allowed by documentation here\fR.
2295.Sp 2435.Sp
2296If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2436If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2297it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2437it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2311It must return the next time to trigger, based on the passed time value 2451It must return the next time to trigger, based on the passed time value
2312(that is, the lowest time value larger than to the second argument). It 2452(that is, the lowest time value larger than to the second argument). It
2313will usually be called just before the callback will be triggered, but 2453will usually be called just before the callback will be triggered, but
2314might be called at other times, too. 2454might be called at other times, too.
2315.Sp 2455.Sp
2316\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2456\&\s-1NOTE: \s0\fIThis callback must always return a time that is higher than or
2317equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. 2457equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2318.Sp 2458.Sp
2319This can be used to create very complex timers, such as a timer that 2459This can be used to create very complex timers, such as a timer that
2320triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the 2460triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the
2321next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2461next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How
2429.IX Subsection "The special problem of inheritance over fork/execve/pthread_create" 2569.IX Subsection "The special problem of inheritance over fork/execve/pthread_create"
2430.PP 2570.PP
2431Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition 2571Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition
2432(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after 2572(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after
2433stopping it again), that is, libev might or might not block the signal, 2573stopping it again), that is, libev might or might not block the signal,
2434and might or might not set or restore the installed signal handler. 2574and might or might not set or restore the installed signal handler (but
2575see \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR).
2435.PP 2576.PP
2436While this does not matter for the signal disposition (libev never 2577While this does not matter for the signal disposition (libev never
2437sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on 2578sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on
2438\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect 2579\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect
2439certain signals to be blocked. 2580certain signals to be blocked.
2445The simplest way to ensure that the signal mask is reset in the child is 2586The simplest way to ensure that the signal mask is reset in the child is
2446to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will 2587to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will
2447catch fork calls done by libraries (such as the libc) as well. 2588catch fork calls done by libraries (such as the libc) as well.
2448.PP 2589.PP
2449In current versions of libev, the signal will not be blocked indefinitely 2590In current versions of libev, the signal will not be blocked indefinitely
2450unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API\s0 (\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces 2591unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API \s0(\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
2451the window of opportunity for problems, it will not go away, as libev 2592the window of opportunity for problems, it will not go away, as libev
2452\&\fIhas\fR to modify the signal mask, at least temporarily. 2593\&\fIhas\fR to modify the signal mask, at least temporarily.
2453.PP 2594.PP
2454So I can't stress this enough: \fIIf you do not reset your signal mask when 2595So I can't stress this enough: \fIIf you do not reset your signal mask when
2455you expect it to be empty, you have a race condition in your code\fR. This 2596you expect it to be empty, you have a race condition in your code\fR. This
2485The signal the watcher watches out for. 2626The signal the watcher watches out for.
2486.PP 2627.PP
2487\fIExamples\fR 2628\fIExamples\fR
2488.IX Subsection "Examples" 2629.IX Subsection "Examples"
2489.PP 2630.PP
2490Example: Try to exit cleanly on \s-1SIGINT\s0. 2631Example: Try to exit cleanly on \s-1SIGINT.\s0
2491.PP 2632.PP
2492.Vb 5 2633.Vb 5
2493\& static void 2634\& static void
2494\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2635\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2495\& { 2636\& {
2610.ie n .SS """ev_stat"" \- did the file attributes just change?" 2751.ie n .SS """ev_stat"" \- did the file attributes just change?"
2611.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2752.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2612.IX Subsection "ev_stat - did the file attributes just change?" 2753.IX Subsection "ev_stat - did the file attributes just change?"
2613This watches a file system path for attribute changes. That is, it calls 2754This watches a file system path for attribute changes. That is, it calls
2614\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) 2755\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2615and sees if it changed compared to the last time, invoking the callback if 2756and sees if it changed compared to the last time, invoking the callback
2616it did. 2757if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2758happen after the watcher has been started will be reported.
2617.PP 2759.PP
2618The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2760The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
2619not exist\*(R" is a status change like any other. The condition \*(L"path does not 2761not exist\*(R" is a status change like any other. The condition \*(L"path does not
2620exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the 2762exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
2621\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at 2763\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
2651compilation environment, which means that on systems with large file 2793compilation environment, which means that on systems with large file
2652support disabled by default, you get the 32 bit version of the stat 2794support disabled by default, you get the 32 bit version of the stat
2653structure. When using the library from programs that change the \s-1ABI\s0 to 2795structure. When using the library from programs that change the \s-1ABI\s0 to
2654use 64 bit file offsets the programs will fail. In that case you have to 2796use 64 bit file offsets the programs will fail. In that case you have to
2655compile libev with the same flags to get binary compatibility. This is 2797compile libev with the same flags to get binary compatibility. This is
2656obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2798obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2657most noticeably displayed with ev_stat and large file support. 2799most noticeably displayed with ev_stat and large file support.
2658.PP 2800.PP
2659The solution for this is to lobby your distribution maker to make large 2801The solution for this is to lobby your distribution maker to make large
2660file interfaces available by default (as e.g. FreeBSD does) and not 2802file interfaces available by default (as e.g. FreeBSD does) and not
2661optional. Libev cannot simply switch on large file support because it has 2803optional. Libev cannot simply switch on large file support because it has
2852Apart from keeping your process non-blocking (which is a useful 2994Apart from keeping your process non-blocking (which is a useful
2853effect on its own sometimes), idle watchers are a good place to do 2995effect on its own sometimes), idle watchers are a good place to do
2854\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the 2996\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2855event loop has handled all outstanding events. 2997event loop has handled all outstanding events.
2856.PP 2998.PP
2999\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3000.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3001.PP
3002As long as there is at least one active idle watcher, libev will never
3003sleep unnecessarily. Or in other words, it will loop as fast as possible.
3004For this to work, the idle watcher doesn't need to be invoked at all \- the
3005lowest priority will do.
3006.PP
3007This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3008to do something on each event loop iteration \- for example to balance load
3009between different connections.
3010.PP
3011See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3012example.
3013.PP
2857\fIWatcher-Specific Functions and Data Members\fR 3014\fIWatcher-Specific Functions and Data Members\fR
2858.IX Subsection "Watcher-Specific Functions and Data Members" 3015.IX Subsection "Watcher-Specific Functions and Data Members"
2859.IP "ev_idle_init (ev_idle *, callback)" 4 3016.IP "ev_idle_init (ev_idle *, callback)" 4
2860.IX Item "ev_idle_init (ev_idle *, callback)" 3017.IX Item "ev_idle_init (ev_idle *, callback)"
2861Initialises and configures the idle watcher \- it has no parameters of any 3018Initialises and configures the idle watcher \- it has no parameters of any
2866.IX Subsection "Examples" 3023.IX Subsection "Examples"
2867.PP 3024.PP
2868Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 3025Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
2869callback, free it. Also, use no error checking, as usual. 3026callback, free it. Also, use no error checking, as usual.
2870.PP 3027.PP
2871.Vb 7 3028.Vb 5
2872\& static void 3029\& static void
2873\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3030\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2874\& { 3031\& {
3032\& // stop the watcher
3033\& ev_idle_stop (loop, w);
3034\&
3035\& // now we can free it
2875\& free (w); 3036\& free (w);
3037\&
2876\& // now do something you wanted to do when the program has 3038\& // now do something you wanted to do when the program has
2877\& // no longer anything immediate to do. 3039\& // no longer anything immediate to do.
2878\& } 3040\& }
2879\& 3041\&
2880\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3042\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2882\& ev_idle_start (loop, idle_watcher); 3044\& ev_idle_start (loop, idle_watcher);
2883.Ve 3045.Ve
2884.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" 3046.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
2885.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 3047.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
2886.IX Subsection "ev_prepare and ev_check - customise your event loop!" 3048.IX Subsection "ev_prepare and ev_check - customise your event loop!"
2887Prepare and check watchers are usually (but not always) used in pairs: 3049Prepare and check watchers are often (but not always) used in pairs:
2888prepare watchers get invoked before the process blocks and check watchers 3050prepare watchers get invoked before the process blocks and check watchers
2889afterwards. 3051afterwards.
2890.PP 3052.PP
2891You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter 3053You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter
2892the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 3054the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
2920with priority higher than or equal to the event loop and one coroutine 3082with priority higher than or equal to the event loop and one coroutine
2921of lower priority, but only once, using idle watchers to keep the event 3083of lower priority, but only once, using idle watchers to keep the event
2922loop from blocking if lower-priority coroutines are active, thus mapping 3084loop from blocking if lower-priority coroutines are active, thus mapping
2923low-priority coroutines to idle/background tasks). 3085low-priority coroutines to idle/background tasks).
2924.PP 3086.PP
2925It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 3087When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
2926priority, to ensure that they are being run before any other watchers 3088highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
2927after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers). 3089any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3090watchers).
2928.PP 3091.PP
2929Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not 3092Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
2930activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they 3093activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
2931might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As 3094might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
2932\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event 3095\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
2933loops those other event loops might be in an unusable state until their 3096loops those other event loops might be in an unusable state until their
2934\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with 3097\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
2935others). 3098others).
3099.PP
3100\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3101.IX Subsection "Abusing an ev_check watcher for its side-effect"
3102.PP
3103\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3104useful because they are called once per event loop iteration. For
3105example, if you want to handle a large number of connections fairly, you
3106normally only do a bit of work for each active connection, and if there
3107is more work to do, you wait for the next event loop iteration, so other
3108connections have a chance of making progress.
3109.PP
3110Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3111next event loop iteration. However, that isn't as soon as possible \-
3112without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3113.PP
3114This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3115single global idle watcher that is active as long as you have one active
3116\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3117will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3118invoked. Neither watcher alone can do that.
2936.PP 3119.PP
2937\fIWatcher-Specific Functions and Data Members\fR 3120\fIWatcher-Specific Functions and Data Members\fR
2938.IX Subsection "Watcher-Specific Functions and Data Members" 3121.IX Subsection "Watcher-Specific Functions and Data Members"
2939.IP "ev_prepare_init (ev_prepare *, callback)" 4 3122.IP "ev_prepare_init (ev_prepare *, callback)" 4
2940.IX Item "ev_prepare_init (ev_prepare *, callback)" 3123.IX Item "ev_prepare_init (ev_prepare *, callback)"
3051.Ve 3234.Ve
3052.PP 3235.PP
3053Method 4: Do not use a prepare or check watcher because the module you 3236Method 4: Do not use a prepare or check watcher because the module you
3054want to embed is not flexible enough to support it. Instead, you can 3237want to embed is not flexible enough to support it. Instead, you can
3055override their poll function. The drawback with this solution is that the 3238override their poll function. The drawback with this solution is that the
3056main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses 3239main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
3057this approach, effectively embedding \s-1EV\s0 as a client into the horrible 3240this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3058libglib event loop. 3241libglib event loop.
3059.PP 3242.PP
3060.Vb 4 3243.Vb 4
3061\& static gint 3244\& static gint
3145\fIWatcher-Specific Functions and Data Members\fR 3328\fIWatcher-Specific Functions and Data Members\fR
3146.IX Subsection "Watcher-Specific Functions and Data Members" 3329.IX Subsection "Watcher-Specific Functions and Data Members"
3147.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3330.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
3148.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3331.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
3149.PD 0 3332.PD 0
3150.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3333.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
3151.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3334.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
3152.PD 3335.PD
3153Configures the watcher to embed the given loop, which must be 3336Configures the watcher to embed the given loop, which must be
3154embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3337embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
3155invoked automatically, otherwise it is the responsibility of the callback 3338invoked automatically, otherwise it is the responsibility of the callback
3156to invoke it (it will continue to be called until the sweep has been done, 3339to invoke it (it will continue to be called until the sweep has been done,
3219.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3402.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
3220.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 3403.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
3221.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 3404.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
3222Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 3405Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
3223whoever is a good citizen cared to tell libev about it by calling 3406whoever is a good citizen cared to tell libev about it by calling
3224\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 3407\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
3225event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 3408and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
3226and only in the child after the fork. If whoever good citizen calling 3409after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
3227\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 3410and calls it in the wrong process, the fork handlers will be invoked, too,
3228handlers will be invoked, too, of course. 3411of course.
3229.PP 3412.PP
3230\fIThe special problem of life after fork \- how is it possible?\fR 3413\fIThe special problem of life after fork \- how is it possible?\fR
3231.IX Subsection "The special problem of life after fork - how is it possible?" 3414.IX Subsection "The special problem of life after fork - how is it possible?"
3232.PP 3415.PP
3233Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set 3416Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set
3307\& atexit (program_exits); 3490\& atexit (program_exits);
3308.Ve 3491.Ve
3309.ie n .SS """ev_async"" \- how to wake up an event loop" 3492.ie n .SS """ev_async"" \- how to wake up an event loop"
3310.el .SS "\f(CWev_async\fP \- how to wake up an event loop" 3493.el .SS "\f(CWev_async\fP \- how to wake up an event loop"
3311.IX Subsection "ev_async - how to wake up an event loop" 3494.IX Subsection "ev_async - how to wake up an event loop"
3312In general, you cannot use an \f(CW\*(C`ev_run\*(C'\fR from multiple threads or other 3495In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
3313asynchronous sources such as signal handlers (as opposed to multiple event 3496asynchronous sources such as signal handlers (as opposed to multiple event
3314loops \- those are of course safe to use in different threads). 3497loops \- those are of course safe to use in different threads).
3315.PP 3498.PP
3316Sometimes, however, you need to wake up an event loop you do not control, 3499Sometimes, however, you need to wake up an event loop you do not control,
3317for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR 3500for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR
3319it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe. 3502it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3320.PP 3503.PP
3321This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3504This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
3322too, are asynchronous in nature, and signals, too, will be compressed 3505too, are asynchronous in nature, and signals, too, will be compressed
3323(i.e. the number of callback invocations may be less than the number of 3506(i.e. the number of callback invocations may be less than the number of
3324\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). In fact, you could use signal watchers as a kind 3507\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
3325of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused 3508of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3326signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread, 3509signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3327even without knowing which loop owns the signal. 3510even without knowing which loop owns the signal.
3328.PP
3329Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not
3330just the default loop.
3331.PP 3511.PP
3332\fIQueueing\fR 3512\fIQueueing\fR
3333.IX Subsection "Queueing" 3513.IX Subsection "Queueing"
3334.PP 3514.PP
3335\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason 3515\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
3422kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless, 3602kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless,
3423trust me. 3603trust me.
3424.IP "ev_async_send (loop, ev_async *)" 4 3604.IP "ev_async_send (loop, ev_async *)" 4
3425.IX Item "ev_async_send (loop, ev_async *)" 3605.IX Item "ev_async_send (loop, ev_async *)"
3426Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds 3606Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
3427an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike 3607an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop, and instantly
3608returns.
3609.Sp
3428\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or 3610Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads,
3429similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding 3611signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the
3430section below on what exactly this means). 3612embedding section below on what exactly this means).
3431.Sp 3613.Sp
3432Note that, as with other watchers in libev, multiple events might get 3614Note that, as with other watchers in libev, multiple events might get
3433compressed into a single callback invocation (another way to look at this 3615compressed into a single callback invocation (another way to look at
3434is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered, set on \f(CW\*(C`ev_async_send\*(C'\fR, 3616this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on
3435reset when the event loop detects that). 3617\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that).
3436.Sp 3618.Sp
3437This call incurs the overhead of a system call only once per event loop 3619This call incurs the overhead of at most one extra system call per event
3438iteration, so while the overhead might be noticeable, it doesn't apply to 3620loop iteration, if the event loop is blocked, and no syscall at all if
3439repeated calls to \f(CW\*(C`ev_async_send\*(C'\fR for the same event loop. 3621the event loop (or your program) is processing events. That means that
3622repeated calls are basically free (there is no need to avoid calls for
3623performance reasons) and that the overhead becomes smaller (typically
3624zero) under load.
3440.IP "bool = ev_async_pending (ev_async *)" 4 3625.IP "bool = ev_async_pending (ev_async *)" 4
3441.IX Item "bool = ev_async_pending (ev_async *)" 3626.IX Item "bool = ev_async_pending (ev_async *)"
3442Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 3627Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
3443watcher but the event has not yet been processed (or even noted) by the 3628watcher but the event has not yet been processed (or even noted) by the
3444event loop. 3629event loop.
3476\&\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 3661\&\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
3477value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR 3662value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3478a timeout and an io event at the same time \- you probably should give io 3663a timeout and an io event at the same time \- you probably should give io
3479events precedence. 3664events precedence.
3480.Sp 3665.Sp
3481Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3666Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3482.Sp 3667.Sp
3483.Vb 7 3668.Vb 7
3484\& static void stdin_ready (int revents, void *arg) 3669\& static void stdin_ready (int revents, void *arg)
3485\& { 3670\& {
3486\& if (revents & EV_READ) 3671\& if (revents & EV_READ)
3492\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3677\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3493.Ve 3678.Ve
3494.IP "ev_feed_fd_event (loop, int fd, int revents)" 4 3679.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
3495.IX Item "ev_feed_fd_event (loop, int fd, int revents)" 3680.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
3496Feed an event on the given fd, as if a file descriptor backend detected 3681Feed an event on the given fd, as if a file descriptor backend detected
3497the given events it. 3682the given events.
3498.IP "ev_feed_signal_event (loop, int signum)" 4 3683.IP "ev_feed_signal_event (loop, int signum)" 4
3499.IX Item "ev_feed_signal_event (loop, int signum)" 3684.IX Item "ev_feed_signal_event (loop, int signum)"
3500Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR, 3685Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
3501which is async-safe. 3686which is async-safe.
3502.SH "COMMON OR USEFUL IDIOMS (OR BOTH)" 3687.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3503.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)" 3688.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3504This section explains some common idioms that are not immediately 3689This section explains some common idioms that are not immediately
3505obvious. Note that examples are sprinkled over the whole manual, and this 3690obvious. Note that examples are sprinkled over the whole manual, and this
3506section only contains stuff that wouldn't fit anywhere else. 3691section only contains stuff that wouldn't fit anywhere else.
3507.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 3692.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3508.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 3693.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3509Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read 3694Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3510or modify at any time: libev will completely ignore it. This can be used 3695or modify at any time: libev will completely ignore it. This can be used
3511to associate arbitrary data with your watcher. If you need more data and 3696to associate arbitrary data with your watcher. If you need more data and
3512don't want to allocate memory separately and store a pointer to it in that 3697don't want to allocate memory separately and store a pointer to it in that
3538\& } 3723\& }
3539.Ve 3724.Ve
3540.PP 3725.PP
3541More interesting and less C\-conformant ways of casting your callback 3726More interesting and less C\-conformant ways of casting your callback
3542function type instead have been omitted. 3727function type instead have been omitted.
3543.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0" 3728.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3544.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS" 3729.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3545Another common scenario is to use some data structure with multiple 3730Another common scenario is to use some data structure with multiple
3546embedded watchers, in effect creating your own watcher that combines 3731embedded watchers, in effect creating your own watcher that combines
3547multiple libev event sources into one \*(L"super-watcher\*(R": 3732multiple libev event sources into one \*(L"super-watcher\*(R":
3548.PP 3733.PP
3576\& { 3761\& {
3577\& struct my_biggy big = (struct my_biggy *) 3762\& struct my_biggy big = (struct my_biggy *)
3578\& (((char *)w) \- offsetof (struct my_biggy, t2)); 3763\& (((char *)w) \- offsetof (struct my_biggy, t2));
3579\& } 3764\& }
3580.Ve 3765.Ve
3581.SS "\s-1MODEL/NESTED\s0 \s-1EVENT\s0 \s-1LOOP\s0 \s-1INVOCATIONS\s0 \s-1AND\s0 \s-1EXIT\s0 \s-1CONDITIONS\s0" 3766.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3767.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3768Often you have structures like this in event-based programs:
3769.PP
3770.Vb 4
3771\& callback ()
3772\& {
3773\& free (request);
3774\& }
3775\&
3776\& request = start_new_request (..., callback);
3777.Ve
3778.PP
3779The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be
3780used to cancel the operation, or do other things with it.
3781.PP
3782It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that
3783immediately invoke the callback, for example, to report errors. Or you add
3784some caching layer that finds that it can skip the lengthy aspects of the
3785operation and simply invoke the callback with the result.
3786.PP
3787The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR
3788has returned, so \f(CW\*(C`request\*(C'\fR is not set.
3789.PP
3790Even if you pass the request by some safer means to the callback, you
3791might want to do something to the request after starting it, such as
3792canceling it, which probably isn't working so well when the callback has
3793already been invoked.
3794.PP
3795A common way around all these issues is to make sure that
3796\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3797\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3798delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3799example, or more sneakily, by reusing an existing (stopped) watcher and
3800pushing it into the pending queue:
3801.PP
3802.Vb 2
3803\& ev_set_cb (watcher, callback);
3804\& ev_feed_event (EV_A_ watcher, 0);
3805.Ve
3806.PP
3807This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3808invoked, while not delaying callback invocation too much.
3809.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3582.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS" 3810.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3583Often (especially in \s-1GUI\s0 toolkits) there are places where you have 3811Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3584\&\fImodal\fR interaction, which is most easily implemented by recursively 3812\&\fImodal\fR interaction, which is most easily implemented by recursively
3585invoking \f(CW\*(C`ev_run\*(C'\fR. 3813invoking \f(CW\*(C`ev_run\*(C'\fR.
3586.PP 3814.PP
3587This brings the problem of exiting \- a callback might want to finish the 3815This brings the problem of exiting \- a callback might want to finish the
3588main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but 3816main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
3589a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one 3817a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
3590and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some 3818and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3591other combination: In these cases, \f(CW\*(C`ev_break\*(C'\fR will not work alone. 3819other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3592.PP 3820.PP
3593The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR 3821The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3594invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is 3822invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3595triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR: 3823triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3596.PP 3824.PP
3599\& int exit_main_loop = 0; 3827\& int exit_main_loop = 0;
3600\& 3828\&
3601\& while (!exit_main_loop) 3829\& while (!exit_main_loop)
3602\& ev_run (EV_DEFAULT_ EVRUN_ONCE); 3830\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3603\& 3831\&
3604\& // in a model watcher 3832\& // in a modal watcher
3605\& int exit_nested_loop = 0; 3833\& int exit_nested_loop = 0;
3606\& 3834\&
3607\& while (!exit_nested_loop) 3835\& while (!exit_nested_loop)
3608\& ev_run (EV_A_ EVRUN_ONCE); 3836\& ev_run (EV_A_ EVRUN_ONCE);
3609.Ve 3837.Ve
3618\& exit_main_loop = 1; 3846\& exit_main_loop = 1;
3619\& 3847\&
3620\& // exit both 3848\& // exit both
3621\& exit_main_loop = exit_nested_loop = 1; 3849\& exit_main_loop = exit_nested_loop = 1;
3622.Ve 3850.Ve
3623.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0" 3851.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3624.IX Subsection "THREAD LOCKING EXAMPLE" 3852.IX Subsection "THREAD LOCKING EXAMPLE"
3625Here is a fictitious example of how to run an event loop in a different 3853Here is a fictitious example of how to run an event loop in a different
3626thread from where callbacks are being invoked and watchers are 3854thread from where callbacks are being invoked and watchers are
3627created/added/removed. 3855created/added/removed.
3628.PP 3856.PP
3658\& // now associate this with the loop 3886\& // now associate this with the loop
3659\& ev_set_userdata (EV_A_ u); 3887\& ev_set_userdata (EV_A_ u);
3660\& ev_set_invoke_pending_cb (EV_A_ l_invoke); 3888\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3661\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 3889\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3662\& 3890\&
3663\& // then create the thread running ev_loop 3891\& // then create the thread running ev_run
3664\& pthread_create (&u\->tid, 0, l_run, EV_A); 3892\& pthread_create (&u\->tid, 0, l_run, EV_A);
3665\& } 3893\& }
3666.Ve 3894.Ve
3667.PP 3895.PP
3668The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used 3896The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3769.PP 3997.PP
3770Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise 3998Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
3771an event loop currently blocking in the kernel will have no knowledge 3999an event loop currently blocking in the kernel will have no knowledge
3772about the newly added timer. By waking up the loop it will pick up any new 4000about the newly added timer. By waking up the loop it will pick up any new
3773watchers in the next event loop iteration. 4001watchers in the next event loop iteration.
3774.SS "\s-1THREADS\s0, \s-1COROUTINES\s0, \s-1CONTINUATIONS\s0, \s-1QUEUES\s0... \s-1INSTEAD\s0 \s-1OF\s0 \s-1CALLBACKS\s0" 4002.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
3775.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS" 4003.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
3776While the overhead of a callback that e.g. schedules a thread is small, it 4004While the overhead of a callback that e.g. schedules a thread is small, it
3777is still an overhead. If you embed libev, and your main usage is with some 4005is still an overhead. If you embed libev, and your main usage is with some
3778kind of threads or coroutines, you might want to customise libev so that 4006kind of threads or coroutines, you might want to customise libev so that
3779doesn't need callbacks anymore. 4007doesn't need callbacks anymore.
3801.PP 4029.PP
3802.Vb 6 4030.Vb 6
3803\& void 4031\& void
3804\& wait_for_event (ev_watcher *w) 4032\& wait_for_event (ev_watcher *w)
3805\& { 4033\& {
3806\& ev_cb_set (w) = current_coro; 4034\& ev_set_cb (w, current_coro);
3807\& switch_to (libev_coro); 4035\& switch_to (libev_coro);
3808\& } 4036\& }
3809.Ve 4037.Ve
3810.PP 4038.PP
3811That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and 4039That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
3812continues the libev coroutine, which, when appropriate, switches back to 4040continues the libev coroutine, which, when appropriate, switches back to
3813this or any other coroutine. I am sure if you sue this your own :) 4041this or any other coroutine.
3814.PP 4042.PP
3815You can do similar tricks if you have, say, threads with an event queue \- 4043You can do similar tricks if you have, say, threads with an event queue \-
3816instead of storing a coroutine, you store the queue object and instead of 4044instead of storing a coroutine, you store the queue object and instead of
3817switching to a coroutine, you push the watcher onto the queue and notify 4045switching to a coroutine, you push the watcher onto the queue and notify
3818any waiters. 4046any waiters.
3819.PP 4047.PP
3820To embed libev, see \s-1EMBEDDING\s0, but in short, it's easiest to create two 4048To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
3821files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files: 4049files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
3822.PP 4050.PP
3823.Vb 4 4051.Vb 4
3824\& // my_ev.h 4052\& // my_ev.h
3825\& #define EV_CB_DECLARE(type) struct my_coro *cb; 4053\& #define EV_CB_DECLARE(type) struct my_coro *cb;
3864.IP "\(bu" 4 4092.IP "\(bu" 4
3865The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 4093The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
3866to use the libev header file and library. 4094to use the libev header file and library.
3867.SH "\*(C+ SUPPORT" 4095.SH "\*(C+ SUPPORT"
3868.IX Header " SUPPORT" 4096.IX Header " SUPPORT"
4097.SS "C \s-1API\s0"
4098.IX Subsection "C API"
4099The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4100libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4101will work fine.
4102.PP
4103Proper exception specifications might have to be added to callbacks passed
4104to libev: exceptions may be thrown only from watcher callbacks, all
4105other callbacks (allocator, syserr, loop acquire/release and periodic
4106reschedule callbacks) must not throw exceptions, and might need a \f(CW\*(C`throw
4107()\*(C'\fR specification. If you have code that needs to be compiled as both C
4108and \*(C+ you can use the \f(CW\*(C`EV_THROW\*(C'\fR macro for this:
4109.PP
4110.Vb 6
4111\& static void
4112\& fatal_error (const char *msg) EV_THROW
4113\& {
4114\& perror (msg);
4115\& abort ();
4116\& }
4117\&
4118\& ...
4119\& ev_set_syserr_cb (fatal_error);
4120.Ve
4121.PP
4122The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4123\&\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
4124because it runs cleanup watchers).
4125.PP
4126Throwing exceptions in watcher callbacks is only supported if libev itself
4127is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4128throwing exceptions through C libraries (most do).
4129.SS "\*(C+ \s-1API\s0"
4130.IX Subsection " API"
3869Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4131Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
3870you to use some convenience methods to start/stop watchers and also change 4132you to use some convenience methods to start/stop watchers and also change
3871the callback model to a model using method callbacks on objects. 4133the callback model to a model using method callbacks on objects.
3872.PP 4134.PP
3873To use it, 4135To use it,
3889Currently, functions, static and non-static member functions and classes 4151Currently, functions, static and non-static member functions and classes
3890with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy 4152with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
3891to add as long as they only need one additional pointer for context. If 4153to add as long as they only need one additional pointer for context. If
3892you need support for other types of functors please contact the author 4154you need support for other types of functors please contact the author
3893(preferably after implementing it). 4155(preferably after implementing it).
4156.PP
4157For all this to work, your \*(C+ compiler either has to use the same calling
4158conventions as your C compiler (for static member functions), or you have
4159to embed libev and compile libev itself as \*(C+.
3894.PP 4160.PP
3895Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4161Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
3896.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4 4162.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
3897.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4163.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
3898.IX Item "ev::READ, ev::WRITE etc." 4164.IX Item "ev::READ, ev::WRITE etc."
3906.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 4172.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
3907.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 4173.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
3908For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 4174For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
3909the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 4175the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
3910which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 4176which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
3911defines by many implementations. 4177defined by many implementations.
3912.Sp 4178.Sp
3913All of those classes have these methods: 4179All of those classes have these methods:
3914.RS 4 4180.RS 4
3915.IP "ev::TYPE::TYPE ()" 4 4181.IP "ev::TYPE::TYPE ()" 4
3916.IX Item "ev::TYPE::TYPE ()" 4182.IX Item "ev::TYPE::TYPE ()"
4007.IX Item "w->set (loop)" 4273.IX Item "w->set (loop)"
4008Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4274Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
4009do this when the watcher is inactive (and not pending either). 4275do this when the watcher is inactive (and not pending either).
4010.IP "w\->set ([arguments])" 4 4276.IP "w\->set ([arguments])" 4
4011.IX Item "w->set ([arguments])" 4277.IX Item "w->set ([arguments])"
4012Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this 4278Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4013method or a suitable start method must be called at least once. Unlike the 4279with the same arguments. Either this method or a suitable start method
4014C counterpart, an active watcher gets automatically stopped and restarted 4280must be called at least once. Unlike the C counterpart, an active watcher
4015when reconfiguring it with this method. 4281gets automatically stopped and restarted when reconfiguring it with this
4282method.
4283.Sp
4284For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4285clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
4016.IP "w\->start ()" 4 4286.IP "w\->start ()" 4
4017.IX Item "w->start ()" 4287.IX Item "w->start ()"
4018Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4288Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
4019constructor already stores the event loop. 4289constructor already stores the event loop.
4020.IP "w\->start ([arguments])" 4 4290.IP "w\->start ([arguments])" 4
4047.PP 4317.PP
4048.Vb 5 4318.Vb 5
4049\& class myclass 4319\& class myclass
4050\& { 4320\& {
4051\& ev::io io ; void io_cb (ev::io &w, int revents); 4321\& ev::io io ; void io_cb (ev::io &w, int revents);
4052\& ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4322\& ev::io io2 ; void io2_cb (ev::io &w, int revents);
4053\& ev::idle idle; void idle_cb (ev::idle &w, int revents); 4323\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
4054\& 4324\&
4055\& myclass (int fd) 4325\& myclass (int fd)
4056\& { 4326\& {
4057\& io .set <myclass, &myclass::io_cb > (this); 4327\& io .set <myclass, &myclass::io_cb > (this);
4078there are additional modules that implement libev-compatible interfaces 4348there are additional modules that implement libev-compatible interfaces
4079to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), 4349to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
4080\&\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 4350\&\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
4081and \f(CW\*(C`EV::Glib\*(C'\fR). 4351and \f(CW\*(C`EV::Glib\*(C'\fR).
4082.Sp 4352.Sp
4083It can be found and installed via \s-1CPAN\s0, its homepage is at 4353It can be found and installed via \s-1CPAN,\s0 its homepage is at
4084<http://software.schmorp.de/pkg/EV>. 4354<http://software.schmorp.de/pkg/EV>.
4085.IP "Python" 4 4355.IP "Python" 4
4086.IX Item "Python" 4356.IX Item "Python"
4087Python bindings can be found at <http://code.google.com/p/pyev/>. It 4357Python bindings can be found at <http://code.google.com/p/pyev/>. It
4088seems to be quite complete and well-documented. 4358seems to be quite complete and well-documented.
4100A haskell binding to libev is available at 4370A haskell binding to libev is available at
4101<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>. 4371<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4102.IP "D" 4 4372.IP "D" 4
4103.IX Item "D" 4373.IX Item "D"
4104Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4374Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4105be found at <http://proj.llucax.com.ar/wiki/evd>. 4375be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4106.IP "Ocaml" 4 4376.IP "Ocaml" 4
4107.IX Item "Ocaml" 4377.IX Item "Ocaml"
4108Erkki Seppala has written Ocaml bindings for libev, to be found at 4378Erkki Seppala has written Ocaml bindings for libev, to be found at
4109<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. 4379<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4110.IP "Lua" 4 4380.IP "Lua" 4
4111.IX Item "Lua" 4381.IX Item "Lua"
4112Brian Maher has written a partial interface to libev for lua (at the 4382Brian Maher has written a partial interface to libev for lua (at the
4113time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at 4383time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4114<http://github.com/brimworks/lua\-ev>. 4384<http://github.com/brimworks/lua\-ev>.
4385.IP "Javascript" 4
4386.IX Item "Javascript"
4387Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4388.IP "Others" 4
4389.IX Item "Others"
4390There are others, and I stopped counting.
4115.SH "MACRO MAGIC" 4391.SH "MACRO MAGIC"
4116.IX Header "MACRO MAGIC" 4392.IX Header "MACRO MAGIC"
4117Libev can be compiled with a variety of options, the most fundamental 4393Libev can be compiled with a variety of options, the most fundamental
4118of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 4394of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
4119functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 4395functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
4154suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 4430suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
4155.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4 4431.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
4156.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 4432.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
4157.IX Item "EV_DEFAULT, EV_DEFAULT_" 4433.IX Item "EV_DEFAULT, EV_DEFAULT_"
4158Similar to the other two macros, this gives you the value of the default 4434Similar to the other two macros, this gives you the value of the default
4159loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 4435loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop
4436will be initialised if it isn't already initialised.
4437.Sp
4438For non-multiplicity builds, these macros do nothing, so you always have
4439to initialise the loop somewhere.
4160.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4 4440.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
4161.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 4441.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
4162.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" 4442.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
4163Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the 4443Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
4164default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour 4444default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
4198.SS "\s-1FILESETS\s0" 4478.SS "\s-1FILESETS\s0"
4199.IX Subsection "FILESETS" 4479.IX Subsection "FILESETS"
4200Depending on what features you need you need to include one or more sets of files 4480Depending on what features you need you need to include one or more sets of files
4201in your application. 4481in your application.
4202.PP 4482.PP
4203\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4483\fI\s-1CORE EVENT LOOP\s0\fR
4204.IX Subsection "CORE EVENT LOOP" 4484.IX Subsection "CORE EVENT LOOP"
4205.PP 4485.PP
4206To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4486To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
4207configuration (no autoconf): 4487configuration (no autoconf):
4208.PP 4488.PP
4211\& #include "ev.c" 4491\& #include "ev.c"
4212.Ve 4492.Ve
4213.PP 4493.PP
4214This will automatically include \fIev.h\fR, too, and should be done in a 4494This will automatically include \fIev.h\fR, too, and should be done in a
4215single C source file only to provide the function implementations. To use 4495single C source file only to provide the function implementations. To use
4216it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best 4496it, do the same for \fIev.h\fR in all files wishing to use this \s-1API \s0(best
4217done by writing a wrapper around \fIev.h\fR that you can include instead and 4497done by writing a wrapper around \fIev.h\fR that you can include instead and
4218where you can put other configuration options): 4498where you can put other configuration options):
4219.PP 4499.PP
4220.Vb 2 4500.Vb 2
4221\& #define EV_STANDALONE 1 4501\& #define EV_STANDALONE 1
4245.Ve 4525.Ve
4246.PP 4526.PP
4247\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4527\&\fIev.c\fR includes the backend files directly when enabled, so you only need
4248to compile this single file. 4528to compile this single file.
4249.PP 4529.PP
4250\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4530\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
4251.IX Subsection "LIBEVENT COMPATIBILITY API" 4531.IX Subsection "LIBEVENT COMPATIBILITY API"
4252.PP 4532.PP
4253To include the libevent compatibility \s-1API\s0, also include: 4533To include the libevent compatibility \s-1API,\s0 also include:
4254.PP 4534.PP
4255.Vb 1 4535.Vb 1
4256\& #include "event.c" 4536\& #include "event.c"
4257.Ve 4537.Ve
4258.PP 4538.PP
4260.PP 4540.PP
4261.Vb 1 4541.Vb 1
4262\& #include "event.h" 4542\& #include "event.h"
4263.Ve 4543.Ve
4264.PP 4544.PP
4265in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4545in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
4266.PP 4546.PP
4267You need the following additional files for this: 4547You need the following additional files for this:
4268.PP 4548.PP
4269.Vb 2 4549.Vb 2
4270\& event.h 4550\& event.h
4271\& event.c 4551\& event.c
4272.Ve 4552.Ve
4273.PP 4553.PP
4274\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4554\fI\s-1AUTOCONF SUPPORT\s0\fR
4275.IX Subsection "AUTOCONF SUPPORT" 4555.IX Subsection "AUTOCONF SUPPORT"
4276.PP 4556.PP
4277Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4557Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
4278whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4558whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
4279\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4559\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
4282For this of course you need the m4 file: 4562For this of course you need the m4 file:
4283.PP 4563.PP
4284.Vb 1 4564.Vb 1
4285\& libev.m4 4565\& libev.m4
4286.Ve 4566.Ve
4287.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4567.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
4288.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4568.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
4289Libev can be configured via a variety of preprocessor symbols you have to 4569Libev can be configured via a variety of preprocessor symbols you have to
4290define before including (or compiling) any of its files. The default in 4570define before including (or compiling) any of its files. The default in
4291the absence of autoconf is documented for every option. 4571the absence of autoconf is documented for every option.
4292.PP 4572.PP
4293Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different 4573Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4294values when compiling libev vs. including \fIev.h\fR, so it is permissible 4574values when compiling libev vs. including \fIev.h\fR, so it is permissible
4295to redefine them before including \fIev.h\fR without breaking compatibility 4575to redefine them before including \fIev.h\fR without breaking compatibility
4296to a compiled library. All other symbols change the \s-1ABI\s0, which means all 4576to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4297users of libev and the libev code itself must be compiled with compatible 4577users of libev and the libev code itself must be compiled with compatible
4298settings. 4578settings.
4299.IP "\s-1EV_COMPAT3\s0 (h)" 4 4579.IP "\s-1EV_COMPAT3 \s0(h)" 4
4300.IX Item "EV_COMPAT3 (h)" 4580.IX Item "EV_COMPAT3 (h)"
4301Backwards compatibility is a major concern for libev. This is why this 4581Backwards compatibility is a major concern for libev. This is why this
4302release of libev comes with wrappers for the functions and symbols that 4582release of libev comes with wrappers for the functions and symbols that
4303have been renamed between libev version 3 and 4. 4583have been renamed between libev version 3 and 4.
4304.Sp 4584.Sp
4309typedef in that case. 4589typedef in that case.
4310.Sp 4590.Sp
4311In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR, 4591In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR,
4312and in some even more future version the compatibility code will be 4592and in some even more future version the compatibility code will be
4313removed completely. 4593removed completely.
4314.IP "\s-1EV_STANDALONE\s0 (h)" 4 4594.IP "\s-1EV_STANDALONE \s0(h)" 4
4315.IX Item "EV_STANDALONE (h)" 4595.IX Item "EV_STANDALONE (h)"
4316Must always be \f(CW1\fR if you do not use autoconf configuration, which 4596Must always be \f(CW1\fR if you do not use autoconf configuration, which
4317keeps libev from including \fIconfig.h\fR, and it also defines dummy 4597keeps libev from including \fIconfig.h\fR, and it also defines dummy
4318implementations for some libevent functions (such as logging, which is not 4598implementations for some libevent functions (such as logging, which is not
4319supported). It will also not define any of the structs usually found in 4599supported). It will also not define any of the structs usually found in
4320\&\fIevent.h\fR that are not directly supported by the libev core alone. 4600\&\fIevent.h\fR that are not directly supported by the libev core alone.
4321.Sp 4601.Sp
4322In standalone mode, libev will still try to automatically deduce the 4602In standalone mode, libev will still try to automatically deduce the
4323configuration, but has to be more conservative. 4603configuration, but has to be more conservative.
4604.IP "\s-1EV_USE_FLOOR\s0" 4
4605.IX Item "EV_USE_FLOOR"
4606If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its
4607periodic reschedule calculations, otherwise libev will fall back on a
4608portable (slower) implementation. If you enable this, you usually have to
4609link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR
4610function is not available will fail, so the safe default is to not enable
4611this.
4324.IP "\s-1EV_USE_MONOTONIC\s0" 4 4612.IP "\s-1EV_USE_MONOTONIC\s0" 4
4325.IX Item "EV_USE_MONOTONIC" 4613.IX Item "EV_USE_MONOTONIC"
4326If defined to be \f(CW1\fR, libev will try to detect the availability of the 4614If defined to be \f(CW1\fR, libev will try to detect the availability of the
4327monotonic clock option at both compile time and runtime. Otherwise no 4615monotonic clock option at both compile time and runtime. Otherwise no
4328use of the monotonic clock option will be attempted. If you enable this, 4616use of the monotonic clock option will be attempted. If you enable this,
4402.IX Item "EV_WIN32_CLOSE_FD(fd)" 4690.IX Item "EV_WIN32_CLOSE_FD(fd)"
4403If programs implement their own fd to handle mapping on win32, then this 4691If programs implement their own fd to handle mapping on win32, then this
4404macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister 4692macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4405file descriptors again. Note that the replacement function has to close 4693file descriptors again. Note that the replacement function has to close
4406the underlying \s-1OS\s0 handle. 4694the underlying \s-1OS\s0 handle.
4695.IP "\s-1EV_USE_WSASOCKET\s0" 4
4696.IX Item "EV_USE_WSASOCKET"
4697If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4698communication socket, which works better in some environments. Otherwise,
4699the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4700environments.
4407.IP "\s-1EV_USE_POLL\s0" 4 4701.IP "\s-1EV_USE_POLL\s0" 4
4408.IX Item "EV_USE_POLL" 4702.IX Item "EV_USE_POLL"
4409If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4703If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
4410backend. Otherwise it will be enabled on non\-win32 platforms. It 4704backend. Otherwise it will be enabled on non\-win32 platforms. It
4411takes precedence over select. 4705takes precedence over select.
4440.IX Item "EV_USE_INOTIFY" 4734.IX Item "EV_USE_INOTIFY"
4441If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 4735If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
4442interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 4736interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
4443be detected at runtime. If undefined, it will be enabled if the headers 4737be detected at runtime. If undefined, it will be enabled if the headers
4444indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4738indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4739.IP "\s-1EV_NO_SMP\s0" 4
4740.IX Item "EV_NO_SMP"
4741If defined to be \f(CW1\fR, libev will assume that memory is always coherent
4742between threads, that is, threads can be used, but threads never run on
4743different cpus (or different cpu cores). This reduces dependencies
4744and makes libev faster.
4745.IP "\s-1EV_NO_THREADS\s0" 4
4746.IX Item "EV_NO_THREADS"
4747If defined to be \f(CW1\fR, libev will assume that it will never be called from
4748different threads (that includes signal handlers), which is a stronger
4749assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4750libev faster.
4445.IP "\s-1EV_ATOMIC_T\s0" 4 4751.IP "\s-1EV_ATOMIC_T\s0" 4
4446.IX Item "EV_ATOMIC_T" 4752.IX Item "EV_ATOMIC_T"
4447Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4753Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4448access is atomic with respect to other threads or signal contexts. No such 4754access is atomic with respect to other threads or signal contexts. No
4449type is easily found in the C language, so you can provide your own type 4755such type is easily found in the C language, so you can provide your own
4450that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" 4756type that you know is safe for your purposes. It is used both for signal
4451as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. 4757handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4758watchers.
4452.Sp 4759.Sp
4453In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4760In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4454(from \fIsignal.h\fR), which is usually good enough on most platforms. 4761(from \fIsignal.h\fR), which is usually good enough on most platforms.
4455.IP "\s-1EV_H\s0 (h)" 4 4762.IP "\s-1EV_H \s0(h)" 4
4456.IX Item "EV_H (h)" 4763.IX Item "EV_H (h)"
4457The name of the \fIev.h\fR header file used to include it. The default if 4764The name of the \fIev.h\fR header file used to include it. The default if
4458undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 4765undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
4459used to virtually rename the \fIev.h\fR header file in case of conflicts. 4766used to virtually rename the \fIev.h\fR header file in case of conflicts.
4460.IP "\s-1EV_CONFIG_H\s0 (h)" 4 4767.IP "\s-1EV_CONFIG_H \s0(h)" 4
4461.IX Item "EV_CONFIG_H (h)" 4768.IX Item "EV_CONFIG_H (h)"
4462If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 4769If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
4463\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 4770\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
4464\&\f(CW\*(C`EV_H\*(C'\fR, above. 4771\&\f(CW\*(C`EV_H\*(C'\fR, above.
4465.IP "\s-1EV_EVENT_H\s0 (h)" 4 4772.IP "\s-1EV_EVENT_H \s0(h)" 4
4466.IX Item "EV_EVENT_H (h)" 4773.IX Item "EV_EVENT_H (h)"
4467Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 4774Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
4468of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR. 4775of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
4469.IP "\s-1EV_PROTOTYPES\s0 (h)" 4 4776.IP "\s-1EV_PROTOTYPES \s0(h)" 4
4470.IX Item "EV_PROTOTYPES (h)" 4777.IX Item "EV_PROTOTYPES (h)"
4471If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 4778If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
4472prototypes, but still define all the structs and other symbols. This is 4779prototypes, but still define all the structs and other symbols. This is
4473occasionally useful if you want to provide your own wrapper functions 4780occasionally useful if you want to provide your own wrapper functions
4474around libev functions. 4781around libev functions.
4477If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 4784If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
4478will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 4785will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
4479additional independent event loops. Otherwise there will be no support 4786additional independent event loops. Otherwise there will be no support
4480for multiple event loops and there is no first event loop pointer 4787for multiple event loops and there is no first event loop pointer
4481argument. Instead, all functions act on the single default loop. 4788argument. Instead, all functions act on the single default loop.
4789.Sp
4790Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a
4791default loop when multiplicity is switched off \- you always have to
4792initialise the loop manually in this case.
4482.IP "\s-1EV_MINPRI\s0" 4 4793.IP "\s-1EV_MINPRI\s0" 4
4483.IX Item "EV_MINPRI" 4794.IX Item "EV_MINPRI"
4484.PD 0 4795.PD 0
4485.IP "\s-1EV_MAXPRI\s0" 4 4796.IP "\s-1EV_MAXPRI\s0" 4
4486.IX Item "EV_MAXPRI" 4797.IX Item "EV_MAXPRI"
4494all the priorities, so having many of them (hundreds) uses a lot of space 4805all the priorities, so having many of them (hundreds) uses a lot of space
4495and time, so using the defaults of five priorities (\-2 .. +2) is usually 4806and time, so using the defaults of five priorities (\-2 .. +2) is usually
4496fine. 4807fine.
4497.Sp 4808.Sp
4498If your embedding application does not need any priorities, defining these 4809If your embedding application does not need any priorities, defining these
4499both to \f(CW0\fR will save some memory and \s-1CPU\s0. 4810both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4500.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 4811.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
4501.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." 4812.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."
4502If undefined or defined to be \f(CW1\fR (and the platform supports it), then 4813If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4503the respective watcher type is supported. If defined to be \f(CW0\fR, then it 4814the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4504is not. Disabling watcher types mainly saves code size. 4815is not. Disabling watcher types mainly saves code size.
4505.IP "\s-1EV_FEATURES\s0" 4 4816.IP "\s-1EV_FEATURES\s0" 4
4522\& #define EV_CHILD_ENABLE 1 4833\& #define EV_CHILD_ENABLE 1
4523\& #define EV_ASYNC_ENABLE 1 4834\& #define EV_ASYNC_ENABLE 1
4524.Ve 4835.Ve
4525.Sp 4836.Sp
4526The actual value is a bitset, it can be a combination of the following 4837The actual value is a bitset, it can be a combination of the following
4527values: 4838values (by default, all of these are enabled):
4528.RS 4 4839.RS 4
4529.ie n .IP "1 \- faster/larger code" 4 4840.ie n .IP "1 \- faster/larger code" 4
4530.el .IP "\f(CW1\fR \- faster/larger code" 4 4841.el .IP "\f(CW1\fR \- faster/larger code" 4
4531.IX Item "1 - faster/larger code" 4842.IX Item "1 - faster/larger code"
4532Use larger code to speed up some operations. 4843Use larger code to speed up some operations.
4535code size by roughly 30% on amd64). 4846code size by roughly 30% on amd64).
4536.Sp 4847.Sp
4537When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with 4848When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4538gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of 4849gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4539assertions. 4850assertions.
4851.Sp
4852The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4853(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4540.ie n .IP "2 \- faster/larger data structures" 4 4854.ie n .IP "2 \- faster/larger data structures" 4
4541.el .IP "\f(CW2\fR \- faster/larger data structures" 4 4855.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4542.IX Item "2 - faster/larger data structures" 4856.IX Item "2 - faster/larger data structures"
4543Replaces the small 2\-heap for timer management by a faster 4\-heap, larger 4857Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4544hash table sizes and so on. This will usually further increase code size 4858hash table sizes and so on. This will usually further increase code size
4545and can additionally have an effect on the size of data structures at 4859and can additionally have an effect on the size of data structures at
4546runtime. 4860runtime.
4861.Sp
4862The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4863(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4547.ie n .IP "4 \- full \s-1API\s0 configuration" 4 4864.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4548.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 4865.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4549.IX Item "4 - full API configuration" 4866.IX Item "4 - full API configuration"
4550This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and 4867This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4551enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1). 4868enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4583With an intelligent-enough linker (gcc+binutils are intelligent enough 4900With an intelligent-enough linker (gcc+binutils are intelligent enough
4584when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by 4901when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by
4585your program might be left out as well \- a binary starting a timer and an 4902your program might be left out as well \- a binary starting a timer and an
4586I/O watcher then might come out at only 5Kb. 4903I/O watcher then might come out at only 5Kb.
4587.RE 4904.RE
4905.IP "\s-1EV_API_STATIC\s0" 4
4906.IX Item "EV_API_STATIC"
4907If this symbol is defined (by default it is not), then all identifiers
4908will have static linkage. This means that libev will not export any
4909identifiers, and you cannot link against libev anymore. This can be useful
4910when you embed libev, only want to use libev functions in a single file,
4911and do not want its identifiers to be visible.
4912.Sp
4913To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that
4914wants to use libev.
4915.Sp
4916This option only works when libev is compiled with a C compiler, as \*(C+
4917doesn't support the required declaration syntax.
4588.IP "\s-1EV_AVOID_STDIO\s0" 4 4918.IP "\s-1EV_AVOID_STDIO\s0" 4
4589.IX Item "EV_AVOID_STDIO" 4919.IX Item "EV_AVOID_STDIO"
4590If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio 4920If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio
4591functions (printf, scanf, perror etc.). This will increase the code size 4921functions (printf, scanf, perror etc.). This will increase the code size
4592somewhat, but if your program doesn't otherwise depend on stdio and your 4922somewhat, but if your program doesn't otherwise depend on stdio and your
4660.Vb 3 4990.Vb 3
4661\& #define EV_COMMON \e 4991\& #define EV_COMMON \e
4662\& SV *self; /* contains this struct */ \e 4992\& SV *self; /* contains this struct */ \e
4663\& SV *cb_sv, *fh /* note no trailing ";" */ 4993\& SV *cb_sv, *fh /* note no trailing ";" */
4664.Ve 4994.Ve
4665.IP "\s-1EV_CB_DECLARE\s0 (type)" 4 4995.IP "\s-1EV_CB_DECLARE \s0(type)" 4
4666.IX Item "EV_CB_DECLARE (type)" 4996.IX Item "EV_CB_DECLARE (type)"
4667.PD 0 4997.PD 0
4668.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 4998.IP "\s-1EV_CB_INVOKE \s0(watcher, revents)" 4
4669.IX Item "EV_CB_INVOKE (watcher, revents)" 4999.IX Item "EV_CB_INVOKE (watcher, revents)"
4670.IP "ev_set_cb (ev, cb)" 4 5000.IP "ev_set_cb (ev, cb)" 4
4671.IX Item "ev_set_cb (ev, cb)" 5001.IX Item "ev_set_cb (ev, cb)"
4672.PD 5002.PD
4673Can be used to change the callback member declaration in each watcher, 5003Can be used to change the callback member declaration in each watcher,
4674and the way callbacks are invoked and set. Must expand to a struct member 5004and the way callbacks are invoked and set. Must expand to a struct member
4675definition and a statement, respectively. See the \fIev.h\fR header file for 5005definition and a statement, respectively. See the \fIev.h\fR header file for
4676their default definitions. One possible use for overriding these is to 5006their default definitions. One possible use for overriding these is to
4677avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5007avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
4678method calls instead of plain function calls in \*(C+. 5008method calls instead of plain function calls in \*(C+.
4679.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5009.SS "\s-1EXPORTED API SYMBOLS\s0"
4680.IX Subsection "EXPORTED API SYMBOLS" 5010.IX Subsection "EXPORTED API SYMBOLS"
4681If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 5011If you need to re-export the \s-1API \s0(e.g. via a \s-1DLL\s0) and you need a list of
4682exported symbols, you can use the provided \fISymbol.*\fR files which list 5012exported symbols, you can use the provided \fISymbol.*\fR files which list
4683all public symbols, one per line: 5013all public symbols, one per line:
4684.PP 5014.PP
4685.Vb 2 5015.Vb 2
4686\& Symbols.ev for libev proper 5016\& Symbols.ev for libev proper
4738\& #include "ev_cpp.h" 5068\& #include "ev_cpp.h"
4739\& #include "ev.c" 5069\& #include "ev.c"
4740.Ve 5070.Ve
4741.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5071.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4742.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5072.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4743.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5073.SS "\s-1THREADS AND COROUTINES\s0"
4744.IX Subsection "THREADS AND COROUTINES" 5074.IX Subsection "THREADS AND COROUTINES"
4745\fI\s-1THREADS\s0\fR 5075\fI\s-1THREADS\s0\fR
4746.IX Subsection "THREADS" 5076.IX Subsection "THREADS"
4747.PP 5077.PP
4748All libev functions are reentrant and thread-safe unless explicitly 5078All libev functions are reentrant and thread-safe unless explicitly
4794An example use would be to communicate signals or other events that only 5124An example use would be to communicate signals or other events that only
4795work in the default loop by registering the signal watcher with the 5125work in the default loop by registering the signal watcher with the
4796default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 5126default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
4797watcher callback into the event loop interested in the signal. 5127watcher callback into the event loop interested in the signal.
4798.PP 5128.PP
4799See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R". 5129See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
4800.PP 5130.PP
4801\fI\s-1COROUTINES\s0\fR 5131\fI\s-1COROUTINES\s0\fR
4802.IX Subsection "COROUTINES" 5132.IX Subsection "COROUTINES"
4803.PP 5133.PP
4804Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5134Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
4809that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 5139that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
4810.PP 5140.PP
4811Care has been taken to ensure that libev does not keep local state inside 5141Care has been taken to ensure that libev does not keep local state inside
4812\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as 5142\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
4813they do not call any callbacks. 5143they do not call any callbacks.
4814.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5144.SS "\s-1COMPILER WARNINGS\s0"
4815.IX Subsection "COMPILER WARNINGS" 5145.IX Subsection "COMPILER WARNINGS"
4816Depending on your compiler and compiler settings, you might get no or a 5146Depending on your compiler and compiler settings, you might get no or a
4817lot of warnings when compiling libev code. Some people are apparently 5147lot of warnings when compiling libev code. Some people are apparently
4818scared by this. 5148scared by this.
4819.PP 5149.PP
4871.PP 5201.PP
4872If you need, for some reason, empty reports from valgrind for your project 5202If you need, for some reason, empty reports from valgrind for your project
4873I suggest using suppression lists. 5203I suggest using suppression lists.
4874.SH "PORTABILITY NOTES" 5204.SH "PORTABILITY NOTES"
4875.IX Header "PORTABILITY NOTES" 5205.IX Header "PORTABILITY NOTES"
4876.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" 5206.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
4877.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" 5207.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
4878GNU/Linux is the only common platform that supports 64 bit file/large file 5208GNU/Linux is the only common platform that supports 64 bit file/large file
4879interfaces but \fIdisables\fR them by default. 5209interfaces but \fIdisables\fR them by default.
4880.PP 5210.PP
4881That means that libev compiled in the default environment doesn't support 5211That means that libev compiled in the default environment doesn't support
4882files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. 5212files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
4883.PP 5213.PP
4884Unfortunately, many programs try to work around this GNU/Linux issue 5214Unfortunately, many programs try to work around this GNU/Linux issue
4885by enabling the large file \s-1API\s0, which makes them incompatible with the 5215by enabling the large file \s-1API,\s0 which makes them incompatible with the
4886standard libev compiled for their system. 5216standard libev compiled for their system.
4887.PP 5217.PP
4888Likewise, libev cannot enable the large file \s-1API\s0 itself as this would 5218Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
4889suddenly make it incompatible to the default compile time environment, 5219suddenly make it incompatible to the default compile time environment,
4890i.e. all programs not using special compile switches. 5220i.e. all programs not using special compile switches.
4891.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" 5221.SS "\s-1OS/X AND DARWIN BUGS\s0"
4892.IX Subsection "OS/X AND DARWIN BUGS" 5222.IX Subsection "OS/X AND DARWIN BUGS"
4893The whole thing is a bug if you ask me \- basically any system interface 5223The whole thing is a bug if you ask me \- basically any system interface
4894you touch is broken, whether it is locales, poll, kqueue or even the 5224you touch is broken, whether it is locales, poll, kqueue or even the
4895OpenGL drivers. 5225OpenGL drivers.
4896.PP 5226.PP
4918.PP 5248.PP
4919\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5249\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
4920.IX Subsection "select is buggy" 5250.IX Subsection "select is buggy"
4921.PP 5251.PP
4922All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5252All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
4923one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file 5253one up as well: On \s-1OS/X, \s0\f(CW\*(C`select\*(C'\fR actively limits the number of file
4924descriptors you can pass in to 1024 \- your program suddenly crashes when 5254descriptors you can pass in to 1024 \- your program suddenly crashes when
4925you use more. 5255you use more.
4926.PP 5256.PP
4927There is an undocumented \*(L"workaround\*(R" for this \- defining 5257There is an undocumented \*(L"workaround\*(R" for this \- defining
4928\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR 5258\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
4929work on \s-1OS/X\s0. 5259work on \s-1OS/X.\s0
4930.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5260.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
4931.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" 5261.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
4932\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR 5262\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
4933.IX Subsection "errno reentrancy" 5263.IX Subsection "errno reentrancy"
4934.PP 5264.PP
4935The default compile environment on Solaris is unfortunately so 5265The default compile environment on Solaris is unfortunately so
4952great. 5282great.
4953.PP 5283.PP
4954If you can't get it to work, you can try running the program by setting 5284If you can't get it to work, you can try running the program by setting
4955the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and 5285the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
4956\&\f(CW\*(C`select\*(C'\fR backends. 5286\&\f(CW\*(C`select\*(C'\fR backends.
4957.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" 5287.SS "\s-1AIX POLL BUG\s0"
4958.IX Subsection "AIX POLL BUG" 5288.IX Subsection "AIX POLL BUG"
4959\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around 5289\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
4960this by trying to avoid the poll backend altogether (i.e. it's not even 5290this by trying to avoid the poll backend altogether (i.e. it's not even
4961compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine 5291compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
4962with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway. 5292with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
4963.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5293.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
4964.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5294.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
4965\fIGeneral issues\fR 5295\fIGeneral issues\fR
4966.IX Subsection "General issues" 5296.IX Subsection "General issues"
4967.PP 5297.PP
4968Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5298Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
4969requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 5299requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
4970model. Libev still offers limited functionality on this platform in 5300model. Libev still offers limited functionality on this platform in
4971the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 5301the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
4972descriptors. This only applies when using Win32 natively, not when using 5302descriptors. This only applies when using Win32 natively, not when using
4973e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5303e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4974as every compielr comes with a slightly differently broken/incompatible 5304as every compiler comes with a slightly differently broken/incompatible
4975environment. 5305environment.
4976.PP 5306.PP
4977Lifting these limitations would basically require the full 5307Lifting these limitations would basically require the full
4978re-implementation of the I/O system. If you are into this kind of thing, 5308re-implementation of the I/O system. If you are into this kind of thing,
4979then note that glib does exactly that for you in a very portable way (note 5309then note that glib does exactly that for you in a very portable way (note
5037\& #define EV_USE_SELECT 1 5367\& #define EV_USE_SELECT 1
5038\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5368\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5039.Ve 5369.Ve
5040.PP 5370.PP
5041Note that winsockets handling of fd sets is O(n), so you can easily get a 5371Note that winsockets handling of fd sets is O(n), so you can easily get a
5042complexity in the O(nA\*^X) range when using win32. 5372complexity in the O(nX) range when using win32.
5043.PP 5373.PP
5044\fILimited number of file descriptors\fR 5374\fILimited number of file descriptors\fR
5045.IX Subsection "Limited number of file descriptors" 5375.IX Subsection "Limited number of file descriptors"
5046.PP 5376.PP
5047Windows has numerous arbitrary (and low) limits on things. 5377Windows has numerous arbitrary (and low) limits on things.
5063by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR 5393by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
5064(another arbitrary limit), but is broken in many versions of the Microsoft 5394(another arbitrary limit), but is broken in many versions of the Microsoft
5065runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets 5395runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
5066(depending on windows version and/or the phase of the moon). To get more, 5396(depending on windows version and/or the phase of the moon). To get more,
5067you need to wrap all I/O functions and provide your own fd management, but 5397you need to wrap all I/O functions and provide your own fd management, but
5068the cost of calling select (O(nA\*^X)) will likely make this unworkable. 5398the cost of calling select (O(nX)) will likely make this unworkable.
5069.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5399.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5070.IX Subsection "PORTABILITY REQUIREMENTS" 5400.IX Subsection "PORTABILITY REQUIREMENTS"
5071In addition to a working ISO-C implementation and of course the 5401In addition to a working ISO-C implementation and of course the
5072backend-specific APIs, libev relies on a few additional extensions: 5402backend-specific APIs, libev relies on a few additional extensions:
5073.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 5403.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
5074.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5404.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
5075.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5405.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
5076Libev assumes not only that all watcher pointers have the same internal 5406Libev assumes not only that all watcher pointers have the same internal
5077structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5407structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5078assumes that the same (machine) code can be used to call any watcher 5408assumes that the same (machine) code can be used to call any watcher
5079callback: The watcher callbacks have different type signatures, but libev 5409callback: The watcher callbacks have different type signatures, but libev
5080calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5410calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5081.IP "pointer accesses must be thread-atomic" 4 5411.IP "pointer accesses must be thread-atomic" 4
5082.IX Item "pointer accesses must be thread-atomic" 5412.IX Item "pointer accesses must be thread-atomic"
5098thread\*(R" or will block signals process-wide, both behaviours would 5428thread\*(R" or will block signals process-wide, both behaviours would
5099be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5429be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5100\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5430\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5101.Sp 5431.Sp
5102The most portable way to handle signals is to block signals in all threads 5432The most portable way to handle signals is to block signals in all threads
5103except the initial one, and run the default loop in the initial thread as 5433except the initial one, and run the signal handling loop in the initial
5104well. 5434thread as well.
5105.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5435.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
5106.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 5436.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
5107.IX Item "long must be large enough for common memory allocation sizes" 5437.IX Item "long must be large enough for common memory allocation sizes"
5108To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally 5438To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
5109instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX 5439instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
5110systems (Microsoft...) this might be unexpectedly low, but is still at 5440systems (Microsoft...) this might be unexpectedly low, but is still at
5111least 31 bits everywhere, which is enough for hundreds of millions of 5441least 31 bits everywhere, which is enough for hundreds of millions of
5112watchers. 5442watchers.
5113.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5443.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
5115.IX Item "double must hold a time value in seconds with enough accuracy" 5445.IX Item "double must hold a time value in seconds with enough accuracy"
5116The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5446The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
5117have at least 51 bits of mantissa (and 9 bits of exponent), which is 5447have at least 51 bits of mantissa (and 9 bits of exponent), which is
5118good enough for at least into the year 4000 with millisecond accuracy 5448good enough for at least into the year 4000 with millisecond accuracy
5119(the design goal for libev). This requirement is overfulfilled by 5449(the design goal for libev). This requirement is overfulfilled by
5120implementations using \s-1IEEE\s0 754, which is basically all existing ones. With 5450implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5451.Sp
5121\&\s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least 2200. 5452With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5453year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5454is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5455something like that, just kidding).
5122.PP 5456.PP
5123If you know of other additional requirements drop me a note. 5457If you know of other additional requirements drop me a note.
5124.SH "ALGORITHMIC COMPLEXITIES" 5458.SH "ALGORITHMIC COMPLEXITIES"
5125.IX Header "ALGORITHMIC COMPLEXITIES" 5459.IX Header "ALGORITHMIC COMPLEXITIES"
5126In this section the complexities of (many of) the algorithms used inside 5460In this section the complexities of (many of) the algorithms used inside
5180.IX Item "Processing ev_async_send: O(number_of_async_watchers)" 5514.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
5181.IP "Processing signals: O(max_signal_number)" 4 5515.IP "Processing signals: O(max_signal_number)" 4
5182.IX Item "Processing signals: O(max_signal_number)" 5516.IX Item "Processing signals: O(max_signal_number)"
5183.PD 5517.PD
5184Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 5518Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
5185calls in the current loop iteration. Checking for async and signal events 5519calls in the current loop iteration and the loop is currently
5520blocked. Checking for async and signal events involves iterating over all
5186involves iterating over all running async watchers or all signal numbers. 5521running async watchers or all signal numbers.
5187.SH "PORTING FROM LIBEV 3.X TO 4.X" 5522.SH "PORTING FROM LIBEV 3.X TO 4.X"
5188.IX Header "PORTING FROM LIBEV 3.X TO 4.X" 5523.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5189The major version 4 introduced some incompatible changes to the \s-1API\s0. 5524The major version 4 introduced some incompatible changes to the \s-1API.\s0
5190.PP 5525.PP
5191At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions 5526At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5192for all changes, so most programs should still compile. The compatibility 5527for all changes, so most programs should still compile. The compatibility
5193layer might be removed in later versions of libev, so better update to the 5528layer might be removed in later versions of libev, so better update to the
5194new \s-1API\s0 early than late. 5529new \s-1API\s0 early than late.
5195.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 5530.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5196.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 5531.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5197.IX Item "EV_COMPAT3 backwards compatibility mechanism" 5532.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5198The backward compatibility mechanism can be controlled by 5533The backward compatibility mechanism can be controlled by
5199\&\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 5534\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5200section. 5535section.
5201.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 5536.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5202.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 5537.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5203.IX Item "ev_default_destroy and ev_default_fork have been removed" 5538.IX Item "ev_default_destroy and ev_default_fork have been removed"
5204These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: 5539These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5244.SH "GLOSSARY" 5579.SH "GLOSSARY"
5245.IX Header "GLOSSARY" 5580.IX Header "GLOSSARY"
5246.IP "active" 4 5581.IP "active" 4
5247.IX Item "active" 5582.IX Item "active"
5248A watcher is active as long as it has been started and not yet stopped. 5583A watcher is active as long as it has been started and not yet stopped.
5249See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5584See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5250.IP "application" 4 5585.IP "application" 4
5251.IX Item "application" 5586.IX Item "application"
5252In this document, an application is whatever is using libev. 5587In this document, an application is whatever is using libev.
5253.IP "backend" 4 5588.IP "backend" 4
5254.IX Item "backend" 5589.IX Item "backend"
5281The model used to describe how an event loop handles and processes 5616The model used to describe how an event loop handles and processes
5282watchers and events. 5617watchers and events.
5283.IP "pending" 4 5618.IP "pending" 4
5284.IX Item "pending" 5619.IX Item "pending"
5285A watcher is pending as soon as the corresponding event has been 5620A watcher is pending as soon as the corresponding event has been
5286detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5621detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5287.IP "real time" 4 5622.IP "real time" 4
5288.IX Item "real time" 5623.IX Item "real time"
5289The physical time that is observed. It is apparently strictly monotonic :) 5624The physical time that is observed. It is apparently strictly monotonic :)
5290.IP "wall-clock time" 4 5625.IP "wall-clock time" 4
5291.IX Item "wall-clock time" 5626.IX Item "wall-clock time"
5292The time and date as shown on clocks. Unlike real time, it can actually 5627The time and date as shown on clocks. Unlike real time, it can actually
5293be wrong and jump forwards and backwards, e.g. when the you adjust your 5628be wrong and jump forwards and backwards, e.g. when you adjust your
5294clock. 5629clock.
5295.IP "watcher" 4 5630.IP "watcher" 4
5296.IX Item "watcher" 5631.IX Item "watcher"
5297A data structure that describes interest in certain events. Watchers need 5632A data structure that describes interest in certain events. Watchers need
5298to be started (attached to an event loop) before they can receive events. 5633to be started (attached to an event loop) before they can receive events.
5299.SH "AUTHOR" 5634.SH "AUTHOR"
5300.IX Header "AUTHOR" 5635.IX Header "AUTHOR"
5301Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael 5636Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5302Magnusson and Emanuele Giaquinta. 5637Magnusson and Emanuele Giaquinta, and minor corrections by many others.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines