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

Comparing libev/ev.3 (file contents):
Revision 1.14 by root, Sat Nov 24 10:10:26 2007 UTC vs.
Revision 1.112 by root, Sun Jun 23 23:27:34 2019 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 1.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
… …
23.ft R 15.ft R
24.fi 16.fi
25.. 17..
26.\" Set up some character translations and predefined strings. \*(-- will 18.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a 20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 23.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 24.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 26.ie n \{\
35. ds -- \(*W- 27. ds -- \(*W-
36. ds PI pi 28. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
… …
44.el\{\ 36.el\{\
45. ds -- \|\(em\| 37. ds -- \|\(em\|
46. ds PI \(*p 38. ds PI \(*p
47. ds L" `` 39. ds L" ``
48. ds R" '' 40. ds R" ''
41. ds C`
42. ds C'
49'br\} 43'br\}
50.\" 44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el .ds Aq '
48.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is >0, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" 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
54.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
55.if \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
56. de IX 55.de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58.. 56..
59. nr % 0 57.nr rF 0
60. 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. \}
61.\} 69.\}
62.\" 70.rr rF
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\" 71.\"
68.\" 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).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
71.if n \{\ 75.if n \{\
… …
126. ds Ae AE 130. ds Ae AE
127.\} 131.\}
128.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
129.\" ======================================================================== 133.\" ========================================================================
130.\" 134.\"
131.IX Title ""<STANDARD INPUT>" 1" 135.IX Title "LIBEV 3"
132.TH "<STANDARD INPUT>" 1 "2007-11-24" "perl v5.8.8" "User Contributed Perl Documentation" 136.TH LIBEV 3 "2019-06-23" "libev-4.25" "libev - high performance full featured event loop"
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents.
139.if n .ad l
140.nh
133.SH "NAME" 141.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 142libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 143.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 144.IX Header "SYNOPSIS"
137.Vb 1 145.Vb 1
138\& #include <ev.h> 146\& #include <ev.h>
139.Ve 147.Ve
140.SH "DESCRIPTION" 148.SS "\s-1EXAMPLE PROGRAM\s0"
141.IX Header "DESCRIPTION" 149.IX Subsection "EXAMPLE PROGRAM"
150.Vb 2
151\& // a single header file is required
152\& #include <ev.h>
153\&
154\& #include <stdio.h> // for puts
155\&
156\& // every watcher type has its own typedef\*(Aqd struct
157\& // with the name ev_TYPE
158\& ev_io stdin_watcher;
159\& ev_timer timeout_watcher;
160\&
161\& // all watcher callbacks have a similar signature
162\& // this callback is called when data is readable on stdin
163\& static void
164\& stdin_cb (EV_P_ ev_io *w, int revents)
165\& {
166\& puts ("stdin ready");
167\& // for one\-shot events, one must manually stop the watcher
168\& // with its corresponding stop function.
169\& ev_io_stop (EV_A_ w);
170\&
171\& // this causes all nested ev_run\*(Aqs to stop iterating
172\& ev_break (EV_A_ EVBREAK_ALL);
173\& }
174\&
175\& // another callback, this time for a time\-out
176\& static void
177\& timeout_cb (EV_P_ ev_timer *w, int revents)
178\& {
179\& puts ("timeout");
180\& // this causes the innermost ev_run to stop iterating
181\& ev_break (EV_A_ EVBREAK_ONE);
182\& }
183\&
184\& int
185\& main (void)
186\& {
187\& // use the default event loop unless you have special needs
188\& struct ev_loop *loop = EV_DEFAULT;
189\&
190\& // initialise an io watcher, then start it
191\& // this one will watch for stdin to become readable
192\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
193\& ev_io_start (loop, &stdin_watcher);
194\&
195\& // initialise a timer watcher, then start it
196\& // simple non\-repeating 5.5 second timeout
197\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
198\& ev_timer_start (loop, &timeout_watcher);
199\&
200\& // now wait for events to arrive
201\& ev_run (loop, 0);
202\&
203\& // break was called, so exit
204\& return 0;
205\& }
206.Ve
207.SH "ABOUT THIS DOCUMENT"
208.IX Header "ABOUT THIS DOCUMENT"
209This document documents the libev software package.
210.PP
211The newest version of this document is also available as an html-formatted
212web page you might find easier to navigate when reading it for the first
213time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
214.PP
215While this document tries to be as complete as possible in documenting
216libev, its usage and the rationale behind its design, it is not a tutorial
217on event-based programming, nor will it introduce event-based programming
218with libev.
219.PP
220Familiarity with event based programming techniques in general is assumed
221throughout this document.
222.SH "WHAT TO READ WHEN IN A HURRY"
223.IX Header "WHAT TO READ WHEN IN A HURRY"
224This manual tries to be very detailed, but unfortunately, this also makes
225it very long. If you just want to know the basics of libev, I suggest
226reading \*(L"\s-1ANATOMY OF A WATCHER\*(R"\s0, then the \*(L"\s-1EXAMPLE PROGRAM\*(R"\s0 above and
227look up the missing functions in \*(L"\s-1GLOBAL FUNCTIONS\*(R"\s0 and the \f(CW\*(C`ev_io\*(C'\fR and
228\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER TYPES\*(R"\s0.
229.SH "ABOUT LIBEV"
230.IX Header "ABOUT LIBEV"
142Libev 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
143file descriptor being readable or a timeout occuring), and it will manage 232file descriptor being readable or a timeout occurring), and it will manage
144these event sources and provide your program with events. 233these event sources and provide your program with events.
145.PP 234.PP
146To do this, it must take more or less complete control over your process 235To do this, it must take more or less complete control over your process
147(or thread) by executing the \fIevent loop\fR handler, and will then 236(or thread) by executing the \fIevent loop\fR handler, and will then
148communicate events via a callback mechanism. 237communicate events via a callback mechanism.
149.PP 238.PP
150You register interest in certain events by registering so-called \fIevent 239You register interest in certain events by registering so-called \fIevent
151watchers\fR, which are relatively small C structures you initialise with the 240watchers\fR, which are relatively small C structures you initialise with the
152details of the event, and then hand it over to libev by \fIstarting\fR the 241details of the event, and then hand it over to libev by \fIstarting\fR the
153watcher. 242watcher.
154.SH "FEATURES" 243.SS "\s-1FEATURES\s0"
155.IX Header "FEATURES" 244.IX Subsection "FEATURES"
156Libev supports select, poll, the linux-specific epoll and the bsd-specific 245Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific aio and \f(CW\*(C`epoll\*(C'\fR
157kqueue mechanisms for file descriptor events, relative timers, absolute 246interfaces, the BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port
158timers with customised rescheduling, signal events, process status change 247mechanisms for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR
159events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event 248interface (for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner
160loop mechanism itself (idle, prepare and check watchers). It also is quite 249inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative
161fast (see this benchmark comparing 250timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling
162it to libevent for example). 251(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status
252change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event
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
254\&\f(CW\*(C`ev_check\*(C'\fR watchers) as well as file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even
255limited support for fork events (\f(CW\*(C`ev_fork\*(C'\fR).
256.PP
257It also is quite fast (see this
258benchmark <http://libev.schmorp.de/bench.html> comparing it to libevent
259for example).
163.SH "CONVENTIONS" 260.SS "\s-1CONVENTIONS\s0"
164.IX Header "CONVENTIONS" 261.IX Subsection "CONVENTIONS"
165Libev is very configurable. In this manual the default configuration 262Libev is very configurable. In this manual the default (and most common)
166will be described, which supports multiple event loops. For more info 263configuration will be described, which supports multiple event loops. For
167about various configuration options please have a look at the file 264more info about various configuration options please have a look at
168\&\fI\s-1README\s0.embed\fR in the libev distribution. If libev was configured without 265\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
169support for multiple event loops, then all functions taking an initial 266for multiple event loops, then all functions taking an initial argument of
170argument of name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) 267name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
171will not have this argument. 268this argument.
172.SH "TIME REPRESENTATION" 269.SS "\s-1TIME REPRESENTATION\s0"
173.IX Header "TIME REPRESENTATION" 270.IX Subsection "TIME REPRESENTATION"
174Libev represents time as a single floating point number, representing the 271Libev represents time as a single floating point number, representing
175(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 272the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice
176the beginning of 1970, details are complicated, don't ask). This type is 273somewhere near the beginning of 1970, details are complicated, don't
177called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases 274ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use
178to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on 275too. It usually aliases to the \f(CW\*(C`double\*(C'\fR type in C. When you need to do
179it, you should treat it as such. 276any calculations on it, you should treat it as some floating point value.
277.PP
278Unlike the name component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for
279time differences (e.g. delays) throughout libev.
280.SH "ERROR HANDLING"
281.IX Header "ERROR HANDLING"
282Libev knows three classes of errors: operating system errors, usage errors
283and internal errors (bugs).
284.PP
285When libev catches an operating system error it cannot handle (for example
286a system call indicating a condition libev cannot fix), it calls the callback
287set via \f(CW\*(C`ev_set_syserr_cb\*(C'\fR, which is supposed to fix the problem or
288abort. The default is to print a diagnostic message and to call \f(CW\*(C`abort
289()\*(C'\fR.
290.PP
291When libev detects a usage error such as a negative timer interval, then
292it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism,
293so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in
294the libev caller and need to be fixed there.
295.PP
296Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has
297extensive consistency checking code. These do not trigger under normal
298circumstances, as they indicate either a bug in libev or worse.
180.SH "GLOBAL FUNCTIONS" 299.SH "GLOBAL FUNCTIONS"
181.IX Header "GLOBAL FUNCTIONS" 300.IX Header "GLOBAL FUNCTIONS"
182These functions can be called anytime, even before initialising the 301These functions can be called anytime, even before initialising the
183library in any way. 302library in any way.
184.IP "ev_tstamp ev_time ()" 4 303.IP "ev_tstamp ev_time ()" 4
185.IX Item "ev_tstamp ev_time ()" 304.IX Item "ev_tstamp ev_time ()"
186Returns 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
187\&\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
188you actually want to know. 307you actually want to know. Also interesting is the combination of
308\&\f(CW\*(C`ev_now_update\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR.
309.IP "ev_sleep (ev_tstamp interval)" 4
310.IX Item "ev_sleep (ev_tstamp interval)"
311Sleep for the given interval: The current thread will be blocked
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
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).
189.IP "int ev_version_major ()" 4 320.IP "int ev_version_major ()" 4
190.IX Item "int ev_version_major ()" 321.IX Item "int ev_version_major ()"
191.PD 0 322.PD 0
192.IP "int ev_version_minor ()" 4 323.IP "int ev_version_minor ()" 4
193.IX Item "int ev_version_minor ()" 324.IX Item "int ev_version_minor ()"
194.PD 325.PD
195You can find out the major and minor version numbers of the library 326You can find out the major and minor \s-1ABI\s0 version numbers of the library
196you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and 327you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and
197\&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global 328\&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global
198symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the 329symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the
199version of the library your program was compiled against. 330version of the library your program was compiled against.
200.Sp 331.Sp
332These version numbers refer to the \s-1ABI\s0 version of the library, not the
333release version.
334.Sp
201Usually, it's a good idea to terminate if the major versions mismatch, 335Usually, it's a good idea to terminate if the major versions mismatch,
202as this indicates an incompatible change. Minor versions are usually 336as this indicates an incompatible change. Minor versions are usually
203compatible to older versions, so a larger minor version alone is usually 337compatible to older versions, so a larger minor version alone is usually
204not a problem. 338not a problem.
205.Sp 339.Sp
206Example: make sure we haven't accidentally been linked against the wrong 340Example: Make sure we haven't accidentally been linked against the wrong
207version: 341version (note, however, that this will not detect other \s-1ABI\s0 mismatches,
342such as \s-1LFS\s0 or reentrancy).
208.Sp 343.Sp
209.Vb 3 344.Vb 3
210\& assert (("libev version mismatch", 345\& assert (("libev version mismatch",
211\& ev_version_major () == EV_VERSION_MAJOR 346\& ev_version_major () == EV_VERSION_MAJOR
212\& && ev_version_minor () >= EV_VERSION_MINOR)); 347\& && ev_version_minor () >= EV_VERSION_MINOR));
213.Ve 348.Ve
214.IP "unsigned int ev_supported_backends ()" 4 349.IP "unsigned int ev_supported_backends ()" 4
215.IX Item "unsigned int ev_supported_backends ()" 350.IX Item "unsigned int ev_supported_backends ()"
216Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR 351Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR
217value) compiled into this binary of libev (independent of their 352value) compiled into this binary of libev (independent of their
… …
220.Sp 355.Sp
221Example: make sure we have the epoll method, because yeah this is cool and 356Example: make sure we have the epoll method, because yeah this is cool and
222a must have and can we have a torrent of it please!!!11 357a must have and can we have a torrent of it please!!!11
223.Sp 358.Sp
224.Vb 2 359.Vb 2
225\& assert (("sorry, no epoll, no sex", 360\& assert (("sorry, no epoll, no sex",
226\& ev_supported_backends () & EVBACKEND_EPOLL)); 361\& ev_supported_backends () & EVBACKEND_EPOLL));
227.Ve 362.Ve
228.IP "unsigned int ev_recommended_backends ()" 4 363.IP "unsigned int ev_recommended_backends ()" 4
229.IX Item "unsigned int ev_recommended_backends ()" 364.IX Item "unsigned int ev_recommended_backends ()"
230Return the set of all backends compiled into this binary of libev and also 365Return the set of all backends compiled into this binary of libev and
231recommended for this platform. This set is often smaller than the one 366also recommended for this platform, meaning it will work for most file
367descriptor types. This set is often smaller than the one returned by
232returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on 368\&\f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on most BSDs
233most BSDs and will not be autodetected unless you explicitly request it 369and will not be auto-detected unless you explicitly request it (assuming
234(assuming you know what you are doing). This is the set of backends that 370you know what you are doing). This is the set of backends that libev will
235libev will probe for if you specify no backends explicitly. 371probe for if you specify no backends explicitly.
236.IP "unsigned int ev_embeddable_backends ()" 4 372.IP "unsigned int ev_embeddable_backends ()" 4
237.IX Item "unsigned int ev_embeddable_backends ()" 373.IX Item "unsigned int ev_embeddable_backends ()"
238Returns the set of backends that are embeddable in other event loops. This 374Returns the set of backends that are embeddable in other event loops. This
239is the theoretical, all\-platform, value. To find which backends 375value is platform-specific but can include backends not available on the
240might be supported on the current system, you would need to look at 376current system. To find which embeddable backends might be supported on
241\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 377the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
242recommended ones. 378& ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
243.Sp 379.Sp
244See 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.
245.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 381.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4
246.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 382.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())"
247Sets the allocation function to use (the prototype is similar to the 383Sets the allocation function to use (the prototype is similar \- the
248realloc C function, the semantics are identical). It is used to allocate 384semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
249and free memory (no surprises here). If it returns zero when memory 385used to allocate and free memory (no surprises here). If it returns zero
250needs to be allocated, the library might abort or take some potentially 386when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
251destructive action. The default is your system realloc function. 387or take some potentially destructive action.
388.Sp
389Since some systems (at least OpenBSD and Darwin) fail to implement
390correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system
391\&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default.
252.Sp 392.Sp
253You could override this function in high-availability programs to, say, 393You could override this function in high-availability programs to, say,
254free some memory if it cannot allocate memory, to use a special allocator, 394free some memory if it cannot allocate memory, to use a special allocator,
255or even to sleep a while and retry until some memory is available. 395or even to sleep a while and retry until some memory is available.
256.Sp 396.Sp
257Example: replace the libev allocator with one that waits a bit and then 397Example: The following is the \f(CW\*(C`realloc\*(C'\fR function that libev itself uses
258retries: better than mine). 398which should work with \f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions of all kinds and
399is probably a good basis for your own implementation.
259.Sp 400.Sp
260.Vb 6 401.Vb 5
261\& static void * 402\& static void *
262\& persistent_realloc (void *ptr, long size) 403\& ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
263\& { 404\& {
405\& if (size)
406\& return realloc (ptr, size);
407\&
408\& free (ptr);
409\& return 0;
410\& }
411.Ve
412.Sp
413Example: Replace the libev allocator with one that waits a bit and then
414retries.
415.Sp
416.Vb 8
417\& static void *
418\& persistent_realloc (void *ptr, size_t size)
419\& {
420\& if (!size)
421\& {
422\& free (ptr);
423\& return 0;
424\& }
425\&
264\& for (;;) 426\& for (;;)
265\& { 427\& {
266\& void *newptr = realloc (ptr, size); 428\& void *newptr = realloc (ptr, size);
267.Ve 429\&
268.Sp
269.Vb 2
270\& if (newptr) 430\& if (newptr)
271\& return newptr; 431\& return newptr;
272.Ve 432\&
273.Sp
274.Vb 3
275\& sleep (60); 433\& sleep (60);
276\& } 434\& }
277\& } 435\& }
278.Ve 436\&
279.Sp
280.Vb 2
281\& ... 437\& ...
282\& ev_set_allocator (persistent_realloc); 438\& ev_set_allocator (persistent_realloc);
283.Ve 439.Ve
284.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 440.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
285.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" 441.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())"
286Set the callback function to call on a retryable syscall error (such 442Set the callback function to call on a retryable system call error (such
287as failed select, poll, epoll_wait). The message is a printable string 443as failed select, poll, epoll_wait). The message is a printable string
288indicating the system call or subsystem causing the problem. If this 444indicating the system call or subsystem causing the problem. If this
289callback is set, then libev will expect it to remedy the sitution, no 445callback is set, then libev will expect it to remedy the situation, no
290matter what, when it returns. That is, libev will generally retry the 446matter what, when it returns. That is, libev will generally retry the
291requested operation, or, if the condition doesn't go away, do bad stuff 447requested operation, or, if the condition doesn't go away, do bad stuff
292(such as abort). 448(such as abort).
293.Sp 449.Sp
294Example: do the same thing as libev does internally: 450Example: This is basically the same thing that libev does internally, too.
295.Sp 451.Sp
296.Vb 6 452.Vb 6
297\& static void 453\& static void
298\& fatal_error (const char *msg) 454\& fatal_error (const char *msg)
299\& { 455\& {
300\& perror (msg); 456\& perror (msg);
301\& abort (); 457\& abort ();
302\& } 458\& }
303.Ve 459\&
304.Sp
305.Vb 2
306\& ... 460\& ...
307\& ev_set_syserr_cb (fatal_error); 461\& ev_set_syserr_cb (fatal_error);
308.Ve 462.Ve
463.IP "ev_feed_signal (int signum)" 4
464.IX Item "ev_feed_signal (int signum)"
465This function can be used to \*(L"simulate\*(R" a signal receive. It is completely
466safe to call this function at any time, from any context, including signal
467handlers or random threads.
468.Sp
469Its main use is to customise signal handling in your process, especially
470in the presence of threads. For example, you could block signals
471by default in all threads (and specifying \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when
472creating any loops), and in one thread, use \f(CW\*(C`sigwait\*(C'\fR or any other
473mechanism to wait for signals, then \*(L"deliver\*(R" them to libev by calling
474\&\f(CW\*(C`ev_feed_signal\*(C'\fR.
309.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 475.SH "FUNCTIONS CONTROLLING EVENT LOOPS"
310.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 476.IX Header "FUNCTIONS CONTROLLING EVENT LOOPS"
311An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two 477An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR is
312types of such loops, the \fIdefault\fR loop, which supports signals and child 478\&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as
313events, and dynamically created loops which do not. 479libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name).
314.PP 480.PP
315If you use threads, a common model is to run the default event loop 481The library knows two types of such loops, the \fIdefault\fR loop, which
316in your main thread (or in a separate thread) and for each thread you 482supports child process events, and dynamically created event loops which
317create, you also create another event loop. Libev itself does no locking 483do not.
318whatsoever, so if you mix calls to the same event loop in different
319threads, make sure you lock (this is usually a bad idea, though, even if
320done correctly, because it's hideous and inefficient).
321.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 484.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
322.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 485.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
323This will initialise the default event loop if it hasn't been initialised 486This returns the \*(L"default\*(R" event loop object, which is what you should
324yet and return it. If the default loop could not be initialised, returns 487normally use when you just need \*(L"the event loop\*(R". Event loop objects and
325false. If it already was initialised it simply returns it (and ignores the 488the \f(CW\*(C`flags\*(C'\fR parameter are described in more detail in the entry for
326flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). 489\&\f(CW\*(C`ev_loop_new\*(C'\fR.
490.Sp
491If the default loop is already initialised then this function simply
492returns it (and ignores the flags. If that is troubling you, check
493\&\f(CW\*(C`ev_backend ()\*(C'\fR afterwards). Otherwise it will create it with the given
494flags, which should almost always be \f(CW0\fR, unless the caller is also the
495one calling \f(CW\*(C`ev_run\*(C'\fR or otherwise qualifies as \*(L"the main program\*(R".
327.Sp 496.Sp
328If you don't know what event loop to use, use the one returned from this 497If you don't know what event loop to use, use the one returned from this
329function. 498function (or via the \f(CW\*(C`EV_DEFAULT\*(C'\fR macro).
499.Sp
500Note that this function is \fInot\fR thread-safe, so if you want to use it
501from multiple threads, you have to employ some kind of mutex (note also
502that this case is unlikely, as loops cannot be shared easily between
503threads anyway).
504.Sp
505The default loop is the only loop that can handle \f(CW\*(C`ev_child\*(C'\fR watchers,
506and to do this, it always registers a handler for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is
507a problem for your application you can either create a dynamic loop with
508\&\f(CW\*(C`ev_loop_new\*(C'\fR which doesn't do that, or you can simply overwrite the
509\&\f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling \f(CW\*(C`ev_default_init\*(C'\fR.
510.Sp
511Example: This is the most typical usage.
512.Sp
513.Vb 2
514\& if (!ev_default_loop (0))
515\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
516.Ve
517.Sp
518Example: Restrict libev to the select and poll backends, and do not allow
519environment settings to be taken into account:
520.Sp
521.Vb 1
522\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
523.Ve
524.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
525.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
526This will create and initialise a new event loop object. If the loop
527could not be initialised, returns false.
528.Sp
529This function is thread-safe, and one common way to use libev with
530threads is indeed to create one loop per thread, and using the default
531loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
330.Sp 532.Sp
331The flags argument can be used to specify special behaviour or specific 533The flags argument can be used to specify special behaviour or specific
332backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). 534backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
333.Sp 535.Sp
334The following flags are supported: 536The following flags are supported:
… …
339The default flags value. Use this if you have no clue (it's the right 541The default flags value. Use this if you have no clue (it's the right
340thing, believe me). 542thing, believe me).
341.ie n .IP """EVFLAG_NOENV""" 4 543.ie n .IP """EVFLAG_NOENV""" 4
342.el .IP "\f(CWEVFLAG_NOENV\fR" 4 544.el .IP "\f(CWEVFLAG_NOENV\fR" 4
343.IX Item "EVFLAG_NOENV" 545.IX Item "EVFLAG_NOENV"
344If this flag bit is ored into the flag value (or the program runs setuid 546If this flag bit is or'ed into the flag value (or the program runs setuid
345or setgid) then libev will \fInot\fR look at the environment variable 547or setgid) then libev will \fInot\fR look at the environment variable
346\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 548\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
347override the flags completely if it is found in the environment. This is 549override the flags completely if it is found in the environment. This is
348useful to try out specific backends to test their performance, or to work 550useful to try out specific backends to test their performance, to work
349around bugs. 551around bugs, or to make libev threadsafe (accessing environment variables
552cannot be done in a threadsafe way, but usually it works if no other
553thread modifies them).
554.ie n .IP """EVFLAG_FORKCHECK""" 4
555.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
556.IX Item "EVFLAG_FORKCHECK"
557Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
558make libev check for a fork in each iteration by enabling this flag.
559.Sp
560This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
561and thus this might slow down your event loop if you do a lot of loop
562iterations and little real work, but is usually not noticeable (on my
563GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn
564sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux
565system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc
566versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again).
567.Sp
568The big advantage of this flag is that you can forget about fork (and
569forget about forgetting to tell libev about forking, although you still
570have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
571.Sp
572This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
573environment variable.
574.ie n .IP """EVFLAG_NOINOTIFY""" 4
575.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
576.IX Item "EVFLAG_NOINOTIFY"
577When this flag is specified, then libev will not attempt to use the
578\&\fIinotify\fR \s-1API\s0 for its \f(CW\*(C`ev_stat\*(C'\fR watchers. Apart from debugging and
579testing, this flag can be useful to conserve inotify file descriptors, as
580otherwise each loop using \f(CW\*(C`ev_stat\*(C'\fR watchers consumes one inotify handle.
581.ie n .IP """EVFLAG_SIGNALFD""" 4
582.el .IP "\f(CWEVFLAG_SIGNALFD\fR" 4
583.IX Item "EVFLAG_SIGNALFD"
584When this flag is specified, then libev will attempt to use the
585\&\fIsignalfd\fR \s-1API\s0 for its \f(CW\*(C`ev_signal\*(C'\fR (and \f(CW\*(C`ev_child\*(C'\fR) watchers. This \s-1API\s0
586delivers signals synchronously, which makes it both faster and might make
587it possible to get the queued signal data. It can also simplify signal
588handling with threads, as long as you properly block signals in your
589threads that are not interested in handling them.
590.Sp
591Signalfd will not be used by default as this changes your signal mask, and
592there are a lot of shoddy libraries and programs (glib's threadpool for
593example) that can't properly initialise their signal masks.
594.ie n .IP """EVFLAG_NOSIGMASK""" 4
595.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
596.IX Item "EVFLAG_NOSIGMASK"
597When this flag is specified, then libev will avoid to modify the signal
598mask. Specifically, this means you have to make sure signals are unblocked
599when you want to receive them.
600.Sp
601This behaviour is useful when you want to do your own signal handling, or
602want to handle signals only in specific threads and want to avoid libev
603unblocking the signals.
604.Sp
605It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
606\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
607.Sp
608This flag's behaviour will become the default in future versions of libev.
350.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 609.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
351.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 610.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
352.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 611.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
353This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 612This is your standard \fBselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
354libev tries to roll its own fd_set with no limits on the number of fds, 613libev tries to roll its own fd_set with no limits on the number of fds,
355but if that fails, expect a fairly low limit on the number of fds when 614but if that fails, expect a fairly low limit on the number of fds when
356using this backend. It doesn't scale too well (O(highest_fd)), but its usually 615using this backend. It doesn't scale too well (O(highest_fd)), but its
357the fastest backend for a low number of fds. 616usually the fastest backend for a low number of (low-numbered :) fds.
617.Sp
618To get good performance out of this backend you need a high amount of
619parallelism (most of the file descriptors should be busy). If you are
620writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many
621connections as possible during one iteration. You might also want to have
622a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of
623readiness notifications you get per iteration.
624.Sp
625This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the
626\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
627\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
358.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 628.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
359.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 629.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
360.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 630.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
361And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than 631And this is your standard \fBpoll\fR\|(2) backend. It's more complicated
362select, but handles sparse fds better and has no artificial limit on the 632than select, but handles sparse fds better and has no artificial
363number of fds you can use (except it will slow down considerably with a 633limit on the number of fds you can use (except it will slow down
364lot of inactive fds). It scales similarly to select, i.e. O(total_fds). 634considerably with a lot of inactive fds). It scales similarly to select,
635i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
636performance tips.
637.Sp
638This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
639\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
365.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 640.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
366.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 641.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
367.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 642.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
643Use the linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
644kernels).
645.Sp
368For few fds, this backend is a bit little slower than poll and select, 646For few fds, this backend is a bit little slower than poll and select, but
369but it scales phenomenally better. While poll and select usually scale like 647it scales phenomenally better. While poll and select usually scale like
370O(total_fds) where n is the total number of fds (or the highest fd), epoll scales 648O(total_fds) where total_fds is the total number of fds (or the highest
371either O(1) or O(active_fds). 649fd), epoll scales either O(1) or O(active_fds).
372.Sp 650.Sp
651The epoll mechanism deserves honorable mention as the most misdesigned
652of the more advanced event mechanisms: mere annoyances include silently
653dropping file descriptors, requiring a system call per change per file
654descriptor (and unnecessary guessing of parameters), problems with dup,
655returning before the timeout value, resulting in additional iterations
656(and only giving 5ms accuracy while select on the same platform gives
6570.1ms) and so on. The biggest issue is fork races, however \- if a program
658forks then \fIboth\fR parent and child process have to recreate the epoll
659set, which can take considerable time (one syscall per file descriptor)
660and is of course hard to detect.
661.Sp
662Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work,
663but of course \fIdoesn't\fR, and epoll just loves to report events for
664totally \fIdifferent\fR file descriptors (even already closed ones, so
665one cannot even remove them from the set) than registered in the set
666(especially on \s-1SMP\s0 systems). Libev tries to counter these spurious
667notifications by employing an additional generation counter and comparing
668that against the events to filter out spurious ones, recreating the set
669when required. Epoll also erroneously rounds down timeouts, but gives you
670no way to know when and by how much, so sometimes you have to busy-wait
671because epoll returns immediately despite a nonzero timeout. And last
672not least, it also refuses to work with some file descriptors which work
673perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...).
674.Sp
675Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
676cobbled together in a hurry, no thought to design or interaction with
677others. Oh, the pain, will it ever stop...
678.Sp
373While stopping and starting an I/O watcher in the same iteration will 679While stopping, setting and starting an I/O watcher in the same iteration
374result in some caching, there is still a syscall per such incident 680will result in some caching, there is still a system call per such
375(because the fd could point to a different file description now), so its 681incident (because the same \fIfile descriptor\fR could point to a different
376best to avoid that. Also, \fIdup()\fRed file descriptors might not work very 682\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
377well if you register events for both fds. 683file descriptors might not work very well if you register events for both
684file descriptors.
378.Sp 685.Sp
379Please note that epoll sometimes generates spurious notifications, so you 686Best performance from this backend is achieved by not unregistering all
380need to use non-blocking I/O or other means to avoid blocking when no data 687watchers for a file descriptor until it has been closed, if possible,
381(or space) is available. 688i.e. keep at least one watcher active per fd at all times. Stopping and
689starting a watcher (without re-setting it) also usually doesn't cause
690extra overhead. A fork can both result in spurious notifications as well
691as in libev having to destroy and recreate the epoll object, which can
692take considerable time and thus should be avoided.
693.Sp
694All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
695faster than epoll for maybe up to a hundred file descriptors, depending on
696the usage. So sad.
697.Sp
698While nominally embeddable in other event loops, this feature is broken in
699a lot of kernel revisions, but probably(!) works in current versions.
700.Sp
701This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
702\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
703.ie n .IP """EVBACKEND_LINUXAIO"" (value 64, Linux)" 4
704.el .IP "\f(CWEVBACKEND_LINUXAIO\fR (value 64, Linux)" 4
705.IX Item "EVBACKEND_LINUXAIO (value 64, Linux)"
706Use the linux-specific linux aio (\fInot\fR \f(CWaio(7)\fR but \f(CWio_submit(2)\fR) event interface available in post\-4.18 kernels.
707.Sp
708If this backend works for you (as of this writing, it was very
709experimental), it is the best event interface available on linux and might
710be well worth enabling it \- if it isn't available in your kernel this will
711be detected and this backend will be skipped.
712.Sp
713This backend can batch oneshot requests and supports a user-space ring
714buffer to receive events. It also doesn't suffer from most of the design
715problems of epoll (such as not being able to remove event sources from
716the epoll set), and generally sounds too good to be true. Because, this
717being the linux kernel, of course it suffers from a whole new set of
718limitations.
719.Sp
720For one, it is not easily embeddable (but probably could be done using
721an event fd at some extra overhead). It also is subject to a system wide
722limit that can be configured in \fI/proc/sys/fs/aio\-max\-nr\fR \- each loop
723currently requires \f(CW61\fR of this number. If no aio requests are left, this
724backend will be skipped during initialisation.
725.Sp
726Most problematic in practise, however, is that not all file descriptors
727work with it. For example, in linux 5.1, tcp sockets, pipes, event fds,
728files, \fI/dev/null\fR and a few others are supported, but ttys do not work
729(probably because of a bug), so this is not (yet?) a generic event polling
730interface.
731.Sp
732To work around this latter problem, the current version of libev uses
733epoll as a fallback for file deescriptor types that do not work. Epoll
734is used in, kind of, slow mode that hopefully avoids most of its design
735problems and requires 1\-3 extra syscalls per active fd every iteration.
736.Sp
737This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
738\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
382.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 739.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
383.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 740.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
384.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 741.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
385Kqueue deserves special mention, as at the time of this writing, it 742Kqueue deserves special mention, as at the time of this writing, it
386was broken on all BSDs except NetBSD (usually it doesn't work with 743was broken on all BSDs except NetBSD (usually it doesn't work reliably
387anything but sockets and pipes, except on Darwin, where of course its 744with anything but sockets and pipes, except on Darwin, where of course
388completely useless). For this reason its not being \*(L"autodetected\*(R" 745it's completely useless). Unlike epoll, however, whose brokenness
746is by design, these kqueue bugs can (and eventually will) be fixed
747without \s-1API\s0 changes to existing programs. For this reason it's not being
389unless you explicitly specify it explicitly in the flags (i.e. using 748\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using
390\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). 749\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough)
750system like NetBSD.
751.Sp
752You still can embed kqueue into a normal poll or select backend and use it
753only for sockets (after having made sure that sockets work with kqueue on
754the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
391.Sp 755.Sp
392It scales in the same way as the epoll backend, but the interface to the 756It scales in the same way as the epoll backend, but the interface to the
393kernel is more efficient (which says nothing about its actual speed, of 757kernel is more efficient (which says nothing about its actual speed, of
394course). While starting and stopping an I/O watcher does not cause an 758course). While stopping, setting and starting an I/O watcher does never
395extra syscall as with epoll, it still adds up to four event changes per 759cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
396incident, so its best to avoid that. 760two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
761might have to leak fd's on fork, but it's more sane than epoll) and it
762drops fds silently in similarly hard-to-detect cases.
763.Sp
764This backend usually performs well under most conditions.
765.Sp
766While nominally embeddable in other event loops, this doesn't work
767everywhere, so you might need to test for this. And since it is broken
768almost everywhere, you should only use it when you have a lot of sockets
769(for which it usually works), by embedding it into another event loop
770(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course
771also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
772.Sp
773This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
774\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with
775\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
397.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 776.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
398.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 777.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4
399.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" 778.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)"
400This is not implemented yet (and might never be). 779This is not implemented yet (and might never be, unless you send me an
780implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
781and is not embeddable, which would limit the usefulness of this backend
782immensely.
401.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 783.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
402.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 784.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
403.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 785.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
404This uses the Solaris 10 port mechanism. As with everything on Solaris, 786This uses the Solaris 10 event port mechanism. As with everything on Solaris,
405it's really slow, but it still scales very well (O(active_fds)). 787it's really slow, but it still scales very well (O(active_fds)).
406.Sp 788.Sp
407Please note that solaris ports can result in a lot of spurious 789While this backend scales well, it requires one system call per active
408notifications, so you need to use non-blocking I/O or other means to avoid 790file descriptor per loop iteration. For small and medium numbers of file
409blocking when no data (or space) is available. 791descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
792might perform better.
793.Sp
794On the positive side, this backend actually performed fully to
795specification in all tests and is fully embeddable, which is a rare feat
796among the OS-specific backends (I vastly prefer correctness over speed
797hacks).
798.Sp
799On the negative side, the interface is \fIbizarre\fR \- so bizarre that
800even sun itself gets it wrong in their code examples: The event polling
801function sometimes returns events to the caller even though an error
802occurred, but with no indication whether it has done so or not (yes, it's
803even documented that way) \- deadly for edge-triggered interfaces where you
804absolutely have to know whether an event occurred or not because you have
805to re-arm the watcher.
806.Sp
807Fortunately libev seems to be able to work around these idiocies.
808.Sp
809This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
810\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
410.ie n .IP """EVBACKEND_ALL""" 4 811.ie n .IP """EVBACKEND_ALL""" 4
411.el .IP "\f(CWEVBACKEND_ALL\fR" 4 812.el .IP "\f(CWEVBACKEND_ALL\fR" 4
412.IX Item "EVBACKEND_ALL" 813.IX Item "EVBACKEND_ALL"
413Try all backends (even potentially broken ones that wouldn't be tried 814Try all backends (even potentially broken ones that wouldn't be tried
414with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 815with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
415\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. 816\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.
817.Sp
818It is definitely not recommended to use this flag, use whatever
819\&\f(CW\*(C`ev_recommended_backends ()\*(C'\fR returns, or simply do not specify a backend
820at all.
821.ie n .IP """EVBACKEND_MASK""" 4
822.el .IP "\f(CWEVBACKEND_MASK\fR" 4
823.IX Item "EVBACKEND_MASK"
824Not a backend at all, but a mask to select all backend bits from a
825\&\f(CW\*(C`flags\*(C'\fR value, in case you want to mask out any backends from a flags
826value (e.g. when modifying the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR environment variable).
416.RE 827.RE
417.RS 4 828.RS 4
418.Sp 829.Sp
419If one or more of these are ored into the flags value, then only these 830If one or more of the backend flags are or'ed into the flags value,
420backends will be tried (in the reverse order as given here). If none are 831then only these backends will be tried (in the reverse order as listed
421specified, most compiled-in backend will be tried, usually in reverse 832here). If none are specified, all backends in \f(CW\*(C`ev_recommended_backends
422order of their flag values :) 833()\*(C'\fR will be tried.
423.Sp 834.Sp
424The most typical usage is like this: 835Example: Try to create a event loop that uses epoll and nothing else.
425.Sp 836.Sp
426.Vb 2 837.Vb 3
427\& if (!ev_default_loop (0)) 838\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
428\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 839\& if (!epoller)
840\& fatal ("no epoll found here, maybe it hides under your chair");
429.Ve 841.Ve
430.Sp 842.Sp
431Restrict libev to the select and poll backends, and do not allow 843Example: Use whatever libev has to offer, but make sure that kqueue is
432environment settings to be taken into account: 844used if available.
433.Sp 845.Sp
434.Vb 1 846.Vb 1
435\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); 847\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
436.Ve 848.Ve
437.Sp 849.Sp
438Use whatever libev has to offer, but make sure that kqueue is used if 850Example: Similarly, on linux, you mgiht want to take advantage of the
439available (warning, breaks stuff, best use only with your own private 851linux aio backend if possible, but fall back to something else if that
440event loop and only if you know the \s-1OS\s0 supports your types of fds): 852isn't available.
441.Sp 853.Sp
442.Vb 1 854.Vb 1
443\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); 855\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
444.Ve 856.Ve
445.RE 857.RE
446.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
447.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
448Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
449always distinct from the default loop. Unlike the default loop, it cannot
450handle signal and child watchers, and attempts to do so will be greeted by
451undefined behaviour (or a failed assertion if assertions are enabled).
452.Sp
453Example: try to create a event loop that uses epoll and nothing else.
454.Sp
455.Vb 3
456\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
457\& if (!epoller)
458\& fatal ("no epoll found here, maybe it hides under your chair");
459.Ve
460.IP "ev_default_destroy ()" 4 858.IP "ev_loop_destroy (loop)" 4
461.IX Item "ev_default_destroy ()" 859.IX Item "ev_loop_destroy (loop)"
462Destroys the default loop again (frees all memory and kernel state 860Destroys an event loop object (frees all memory and kernel state
463etc.). None of the active event watchers will be stopped in the normal 861etc.). None of the active event watchers will be stopped in the normal
464sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your 862sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your
465responsibility to either stop all watchers cleanly yoursef \fIbefore\fR 863responsibility to either stop all watchers cleanly yourself \fIbefore\fR
466calling this function, or cope with the fact afterwards (which is usually 864calling this function, or cope with the fact afterwards (which is usually
467the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them 865the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
468for example). 866for example).
469.IP "ev_loop_destroy (loop)" 4
470.IX Item "ev_loop_destroy (loop)"
471Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an
472earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR.
473.IP "ev_default_fork ()" 4
474.IX Item "ev_default_fork ()"
475This function reinitialises the kernel state for backends that have
476one. Despite the name, you can call it anytime, but it makes most sense
477after forking, in either the parent or child process (or both, but that
478again makes little sense).
479.Sp 867.Sp
480You \fImust\fR call this function in the child process after forking if and 868Note that certain global state, such as signal state (and installed signal
481only if you want to use the event library in both processes. If you just 869handlers), will not be freed by this function, and related watchers (such
482fork+exec, you don't have to call it. 870as signal and child watchers) would need to be stopped manually.
483.Sp 871.Sp
484The function itself is quite fast and it's usually not a problem to call 872This function is normally used on loop objects allocated by
485it just in case after a fork. To make this easy, the function will fit in 873\&\f(CW\*(C`ev_loop_new\*(C'\fR, but it can also be used on the default loop returned by
486quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR: 874\&\f(CW\*(C`ev_default_loop\*(C'\fR, in which case it is not thread-safe.
487.Sp 875.Sp
488.Vb 1 876Note that it is not advisable to call this function on the default loop
489\& pthread_atfork (0, 0, ev_default_fork); 877except in the rare occasion where you really need to free its resources.
490.Ve 878If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
491.Sp 879and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
492At the moment, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR are safe to use
493without calling this function, so if you force one of those backends you
494do not need to care.
495.IP "ev_loop_fork (loop)" 4 880.IP "ev_loop_fork (loop)" 4
496.IX Item "ev_loop_fork (loop)" 881.IX Item "ev_loop_fork (loop)"
497Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 882This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations
498\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 883to reinitialise the kernel state for backends that have one. Despite
499after fork, and how you do this is entirely your own problem. 884the name, you can call it anytime you are allowed to start or stop
885watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most
886sense after forking, in the child process. You \fImust\fR call it (or use
887\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
888.Sp
889In addition, if you want to reuse a loop (via this function or
890\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR.
891.Sp
892Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
893a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
894because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
895during fork.
896.Sp
897On the other hand, you only need to call this function in the child
898process if and only if you want to use the event loop in the child. If
899you just fork+exec or create a new loop in the child, you don't have to
900call it at all (in fact, \f(CW\*(C`epoll\*(C'\fR is so badly broken that it makes a
901difference, but libev will usually detect this case on its own and do a
902costly reset of the backend).
903.Sp
904The function itself is quite fast and it's usually not a problem to call
905it just in case after a fork.
906.Sp
907Example: Automate calling \f(CW\*(C`ev_loop_fork\*(C'\fR on the default loop when
908using pthreads.
909.Sp
910.Vb 5
911\& static void
912\& post_fork_child (void)
913\& {
914\& ev_loop_fork (EV_DEFAULT);
915\& }
916\&
917\& ...
918\& pthread_atfork (0, 0, post_fork_child);
919.Ve
920.IP "int ev_is_default_loop (loop)" 4
921.IX Item "int ev_is_default_loop (loop)"
922Returns true when the given loop is, in fact, the default loop, and false
923otherwise.
924.IP "unsigned int ev_iteration (loop)" 4
925.IX Item "unsigned int ev_iteration (loop)"
926Returns the current iteration count for the event loop, which is identical
927to the number of times libev did poll for new events. It starts at \f(CW0\fR
928and happily wraps around with enough iterations.
929.Sp
930This value can sometimes be useful as a generation counter of sorts (it
931\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
932\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the
933prepare and check phases.
934.IP "unsigned int ev_depth (loop)" 4
935.IX Item "unsigned int ev_depth (loop)"
936Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of
937times \f(CW\*(C`ev_run\*(C'\fR was exited normally, in other words, the recursion depth.
938.Sp
939Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is
940\&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread),
941in which case it is higher.
942.Sp
943Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread,
944throwing an exception etc.), doesn't count as \*(L"exit\*(R" \- consider this
945as a hint to avoid such ungentleman-like behaviour unless it's really
946convenient, in which case it is fully supported.
500.IP "unsigned int ev_backend (loop)" 4 947.IP "unsigned int ev_backend (loop)" 4
501.IX Item "unsigned int ev_backend (loop)" 948.IX Item "unsigned int ev_backend (loop)"
502Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 949Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
503use. 950use.
504.IP "ev_tstamp ev_now (loop)" 4 951.IP "ev_tstamp ev_now (loop)" 4
505.IX Item "ev_tstamp ev_now (loop)" 952.IX Item "ev_tstamp ev_now (loop)"
506Returns the current \*(L"event loop time\*(R", which is the time the event loop 953Returns the current \*(L"event loop time\*(R", which is the time the event loop
507received events and started processing them. This timestamp does not 954received events and started processing them. This timestamp does not
508change as long as callbacks are being processed, and this is also the base 955change as long as callbacks are being processed, and this is also the base
509time used for relative timers. You can treat it as the timestamp of the 956time used for relative timers. You can treat it as the timestamp of the
510event occuring (or more correctly, libev finding out about it). 957event occurring (or more correctly, libev finding out about it).
958.IP "ev_now_update (loop)" 4
959.IX Item "ev_now_update (loop)"
960Establishes the current time by querying the kernel, updating the time
961returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and
962is usually done automatically within \f(CW\*(C`ev_run ()\*(C'\fR.
963.Sp
964This function is rarely useful, but when some event callback runs for a
965very long time without entering the event loop, updating libev's idea of
966the current time is a good idea.
967.Sp
968See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section.
969.IP "ev_suspend (loop)" 4
970.IX Item "ev_suspend (loop)"
971.PD 0
972.IP "ev_resume (loop)" 4
973.IX Item "ev_resume (loop)"
974.PD
975These two functions suspend and resume an event loop, for use when the
976loop is not used for a while and timeouts should not be processed.
977.Sp
978A typical use case would be an interactive program such as a game: When
979the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it
980would be best to handle timeouts as if no time had actually passed while
981the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR
982in your \f(CW\*(C`SIGTSTP\*(C'\fR handler, sending yourself a \f(CW\*(C`SIGSTOP\*(C'\fR and calling
983\&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing.
984.Sp
985Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend
986between \f(CW\*(C`ev_suspend\*(C'\fR and \f(CW\*(C`ev_resume\*(C'\fR, and all \f(CW\*(C`ev_periodic\*(C'\fR watchers
987will be rescheduled (that is, they will lose any events that would have
988occurred while suspended).
989.Sp
990After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the
991given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
992without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
993.Sp
994Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
995event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
511.IP "ev_loop (loop, int flags)" 4 996.IP "bool ev_run (loop, int flags)" 4
512.IX Item "ev_loop (loop, int flags)" 997.IX Item "bool ev_run (loop, int flags)"
513Finally, this is it, the event handler. This function usually is called 998Finally, this is it, the event handler. This function usually is called
514after you initialised all your watchers and you want to start handling 999after you have initialised all your watchers and you want to start
515events. 1000handling events. It will ask the operating system for any new events, call
1001the watcher callbacks, and then repeat the whole process indefinitely: This
1002is why event loops are called \fIloops\fR.
516.Sp 1003.Sp
517If the flags argument is specified as \f(CW0\fR, it will not return until 1004If the flags argument is specified as \f(CW0\fR, it will keep handling events
518either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. 1005until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
1006called.
519.Sp 1007.Sp
1008The return value is false if there are no more active watchers (which
1009usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
1010(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
1011.Sp
520Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than 1012Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
521relying on all watchers to be stopped when deciding when a program has 1013relying on all watchers to be stopped when deciding when a program has
522finished (especially in interactive programs), but having a program that 1014finished (especially in interactive programs), but having a program
523automatically loops as long as it has to and no longer by virtue of 1015that automatically loops as long as it has to and no longer by virtue
524relying on its watchers stopping correctly is a thing of beauty. 1016of relying on its watchers stopping correctly, that is truly a thing of
1017beauty.
525.Sp 1018.Sp
1019This function is \fImostly\fR exception-safe \- you can break out of a
1020\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
1021exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
1022will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
1023.Sp
526A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle 1024A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
527those events and any outstanding ones, but will not block your process in 1025those events and any already outstanding ones, but will not wait and
528case there are no events and will return after one iteration of the loop. 1026block your process in case there are no events and will return after one
1027iteration of the loop. This is sometimes useful to poll and handle new
1028events while doing lengthy calculations, to keep the program responsive.
529.Sp 1029.Sp
530A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if 1030A flags value of \f(CW\*(C`EVRUN_ONCE\*(C'\fR will look for new events (waiting if
531neccessary) and will handle those and any outstanding ones. It will block 1031necessary) and will handle those and any already outstanding ones. It
532your process until at least one new event arrives, and will return after 1032will block your process until at least one new event arrives (which could
533one iteration of the loop. This is useful if you are waiting for some 1033be an event internal to libev itself, so there is no guarantee that a
534external event in conjunction with something not expressible using other 1034user-registered callback will be called), and will return after one
1035iteration of the loop.
1036.Sp
1037This is useful if you are waiting for some external event in conjunction
1038with something not expressible using other libev watchers (i.e. "roll your
535libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 1039own \f(CW\*(C`ev_run\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
536usually a better approach for this kind of thing. 1040usually a better approach for this kind of thing.
537.Sp 1041.Sp
538Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 1042Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does (this is for your
1043understanding, not a guarantee that things will work exactly like this in
1044future versions):
539.Sp 1045.Sp
540.Vb 18 1046.Vb 10
541\& * If there are no active watchers (reference count is zero), return. 1047\& \- Increment loop depth.
542\& - Queue prepare watchers and then call all outstanding watchers. 1048\& \- Reset the ev_break status.
1049\& \- Before the first iteration, call any pending watchers.
1050\& LOOP:
1051\& \- If EVFLAG_FORKCHECK was used, check for a fork.
1052\& \- If a fork was detected (by any means), queue and call all fork watchers.
1053\& \- Queue and call all prepare watchers.
1054\& \- If ev_break was called, goto FINISH.
543\& - If we have been forked, recreate the kernel state. 1055\& \- If we have been forked, detach and recreate the kernel state
1056\& as to not disturb the other process.
544\& - Update the kernel state with all outstanding changes. 1057\& \- Update the kernel state with all outstanding changes.
545\& - Update the "event loop time". 1058\& \- Update the "event loop time" (ev_now ()).
546\& - Calculate for how long to block. 1059\& \- Calculate for how long to sleep or block, if at all
1060\& (active idle watchers, EVRUN_NOWAIT or not having
1061\& any active watchers at all will result in not sleeping).
1062\& \- Sleep if the I/O and timer collect interval say so.
1063\& \- Increment loop iteration counter.
547\& - Block the process, waiting for any events. 1064\& \- Block the process, waiting for any events.
548\& - Queue all outstanding I/O (fd) events. 1065\& \- Queue all outstanding I/O (fd) events.
549\& - Update the "event loop time" and do time jump handling. 1066\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments.
550\& - Queue all outstanding timers. 1067\& \- Queue all expired timers.
551\& - Queue all outstanding periodics. 1068\& \- Queue all expired periodics.
552\& - If no events are pending now, queue all idle watchers. 1069\& \- Queue all idle watchers with priority higher than that of pending events.
553\& - Queue all check watchers. 1070\& \- Queue all check watchers.
554\& - Call all queued watchers in reverse order (i.e. check watchers first). 1071\& \- Call all queued watchers in reverse order (i.e. check watchers first).
555\& Signals and child watchers are implemented as I/O watchers, and will 1072\& Signals and child watchers are implemented as I/O watchers, and will
556\& be handled here by queueing them when their watcher gets executed. 1073\& be handled here by queueing them when their watcher gets executed.
557\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 1074\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
558\& were used, return, otherwise continue with step *. 1075\& were used, or there are no active watchers, goto FINISH, otherwise
1076\& continue with step LOOP.
1077\& FINISH:
1078\& \- Reset the ev_break status iff it was EVBREAK_ONE.
1079\& \- Decrement the loop depth.
1080\& \- Return.
559.Ve 1081.Ve
560.Sp 1082.Sp
561Example: queue some jobs and then loop until no events are outsanding 1083Example: Queue some jobs and then loop until no events are outstanding
562anymore. 1084anymore.
563.Sp 1085.Sp
564.Vb 4 1086.Vb 4
565\& ... queue jobs here, make sure they register event watchers as long 1087\& ... queue jobs here, make sure they register event watchers as long
566\& ... as they still have work to do (even an idle watcher will do..) 1088\& ... as they still have work to do (even an idle watcher will do..)
567\& ev_loop (my_loop, 0); 1089\& ev_run (my_loop, 0);
568\& ... jobs done. yeah! 1090\& ... jobs done or somebody called break. yeah!
569.Ve 1091.Ve
570.IP "ev_unloop (loop, how)" 4 1092.IP "ev_break (loop, how)" 4
571.IX Item "ev_unloop (loop, how)" 1093.IX Item "ev_break (loop, how)"
572Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it 1094Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it
573has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 1095has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
574\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or 1096\&\f(CW\*(C`EVBREAK_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_run\*(C'\fR call return, or
575\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. 1097\&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return.
1098.Sp
1099This \*(L"break state\*(R" will be cleared on the next call to \f(CW\*(C`ev_run\*(C'\fR.
1100.Sp
1101It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too, in
1102which case it will have no effect.
576.IP "ev_ref (loop)" 4 1103.IP "ev_ref (loop)" 4
577.IX Item "ev_ref (loop)" 1104.IX Item "ev_ref (loop)"
578.PD 0 1105.PD 0
579.IP "ev_unref (loop)" 4 1106.IP "ev_unref (loop)" 4
580.IX Item "ev_unref (loop)" 1107.IX Item "ev_unref (loop)"
581.PD 1108.PD
582Ref/unref can be used to add or remove a reference count on the event 1109Ref/unref can be used to add or remove a reference count on the event
583loop: Every watcher keeps one reference, and as long as the reference 1110loop: Every watcher keeps one reference, and as long as the reference
584count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own. If you have 1111count is nonzero, \f(CW\*(C`ev_run\*(C'\fR will not return on its own.
585a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR from 1112.Sp
586returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For 1113This is useful when you have a watcher that you never intend to
1114unregister, but that nevertheless should not keep \f(CW\*(C`ev_run\*(C'\fR from
1115returning. In such a case, call \f(CW\*(C`ev_unref\*(C'\fR after starting, and \f(CW\*(C`ev_ref\*(C'\fR
1116before stopping it.
1117.Sp
587example, libev itself uses this for its internal signal pipe: It is not 1118As an example, libev itself uses this for its internal signal pipe: It
588visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if 1119is not visible to the libev user and should not keep \f(CW\*(C`ev_run\*(C'\fR from
589no event watchers registered by it are active. It is also an excellent 1120exiting if no event watchers registered by it are active. It is also an
590way to do this for generic recurring timers or from within third-party 1121excellent way to do this for generic recurring timers or from within
591libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. 1122third-party libraries. Just remember to \fIunref after start\fR and \fIref
1123before stop\fR (but only if the watcher wasn't active before, or was active
1124before, respectively. Note also that libev might stop watchers itself
1125(e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR
1126in the callback).
592.Sp 1127.Sp
593Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 1128Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_run\*(C'\fR
594running when nothing else is active. 1129running when nothing else is active.
595.Sp 1130.Sp
596.Vb 4 1131.Vb 4
597\& struct dv_signal exitsig; 1132\& ev_signal exitsig;
598\& ev_signal_init (&exitsig, sig_cb, SIGINT); 1133\& ev_signal_init (&exitsig, sig_cb, SIGINT);
599\& ev_signal_start (myloop, &exitsig); 1134\& ev_signal_start (loop, &exitsig);
600\& evf_unref (myloop); 1135\& ev_unref (loop);
601.Ve 1136.Ve
602.Sp 1137.Sp
603Example: for some weird reason, unregister the above signal handler again. 1138Example: For some weird reason, unregister the above signal handler again.
604.Sp 1139.Sp
605.Vb 2 1140.Vb 2
606\& ev_ref (myloop); 1141\& ev_ref (loop);
607\& ev_signal_stop (myloop, &exitsig); 1142\& ev_signal_stop (loop, &exitsig);
608.Ve 1143.Ve
1144.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4
1145.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)"
1146.PD 0
1147.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4
1148.IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)"
1149.PD
1150These advanced functions influence the time that libev will spend waiting
1151for events. Both time intervals are by default \f(CW0\fR, meaning that libev
1152will try to invoke timer/periodic callbacks and I/O callbacks with minimum
1153latency.
1154.Sp
1155Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR)
1156allows libev to delay invocation of I/O and timer/periodic callbacks
1157to increase efficiency of loop iterations (or to increase power-saving
1158opportunities).
1159.Sp
1160The idea is that sometimes your program runs just fast enough to handle
1161one (or very few) event(s) per loop iteration. While this makes the
1162program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new
1163events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high
1164overhead for the actual polling but can deliver many events at once.
1165.Sp
1166By setting a higher \fIio collect interval\fR you allow libev to spend more
1167time collecting I/O events, so you can handle more events per iteration,
1168at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
1169\&\f(CW\*(C`ev_timer\*(C'\fR) will not be affected. Setting this to a non-null value will
1170introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
1171sleep time ensures that libev will not poll for I/O events more often then
1172once per this interval, on average (as long as the host time resolution is
1173good enough).
1174.Sp
1175Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
1176to spend more time collecting timeouts, at the expense of increased
1177latency/jitter/inexactness (the watcher callback will be called
1178later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
1179value will not introduce any overhead in libev.
1180.Sp
1181Many (busy) programs can usually benefit by setting the I/O collect
1182interval to a value near \f(CW0.1\fR or so, which is often enough for
1183interactive servers (of course not for games), likewise for timeouts. It
1184usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR,
1185as this approaches the timing granularity of most systems. Note that if
1186you do transactions with the outside world and you can't increase the
1187parallelity, then this setting will limit your transaction rate (if you
1188need to poll once per transaction and the I/O collect interval is 0.01,
1189then you can't do more than 100 transactions per second).
1190.Sp
1191Setting the \fItimeout collect interval\fR can improve the opportunity for
1192saving power, as the program will \*(L"bundle\*(R" timer callback invocations that
1193are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of
1194times the process sleeps and wakes up again. Another useful technique to
1195reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure
1196they fire on, say, one-second boundaries only.
1197.Sp
1198Example: we only need 0.1s timeout granularity, and we wish not to poll
1199more often than 100 times per second:
1200.Sp
1201.Vb 2
1202\& ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
1203\& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
1204.Ve
1205.IP "ev_invoke_pending (loop)" 4
1206.IX Item "ev_invoke_pending (loop)"
1207This call will simply invoke all pending watchers while resetting their
1208pending state. Normally, \f(CW\*(C`ev_run\*(C'\fR does this automatically when required,
1209but when overriding the invoke callback this call comes handy. This
1210function can be invoked from a watcher \- this can be useful for example
1211when you want to do some lengthy calculation and want to pass further
1212event handling to another thread (you still have to make sure only one
1213thread executes within \f(CW\*(C`ev_invoke_pending\*(C'\fR or \f(CW\*(C`ev_run\*(C'\fR of course).
1214.IP "int ev_pending_count (loop)" 4
1215.IX Item "int ev_pending_count (loop)"
1216Returns the number of pending watchers \- zero indicates that no watchers
1217are pending.
1218.IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4
1219.IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))"
1220This overrides the invoke pending functionality of the loop: Instead of
1221invoking all pending watchers when there are any, \f(CW\*(C`ev_run\*(C'\fR will call
1222this callback instead. This is useful, for example, when you want to
1223invoke the actual watchers inside another context (another thread etc.).
1224.Sp
1225If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1226callback.
1227.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
1228.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
1229Sometimes you want to share the same loop between multiple threads. This
1230can be done relatively simply by putting mutex_lock/unlock calls around
1231each call to a libev function.
1232.Sp
1233However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1234to wait for it to return. One way around this is to wake up the event
1235loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`ev_async_send\*(C'\fR, another way is to set these
1236\&\fIrelease\fR and \fIacquire\fR callbacks on the loop.
1237.Sp
1238When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1239suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1240afterwards.
1241.Sp
1242Ideally, \f(CW\*(C`release\*(C'\fR will just call your mutex_unlock function, and
1243\&\f(CW\*(C`acquire\*(C'\fR will just call the mutex_lock function again.
1244.Sp
1245While event loop modifications are allowed between invocations of
1246\&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no
1247modifications done will affect the event loop, i.e. adding watchers will
1248have no effect on the set of file descriptors being watched, or the time
1249waited. Use an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_run\*(C'\fR when you want it
1250to take note of any changes you made.
1251.Sp
1252In theory, threads executing \f(CW\*(C`ev_run\*(C'\fR will be async-cancel safe between
1253invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR.
1254.Sp
1255See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this
1256document.
1257.IP "ev_set_userdata (loop, void *data)" 4
1258.IX Item "ev_set_userdata (loop, void *data)"
1259.PD 0
1260.IP "void *ev_userdata (loop)" 4
1261.IX Item "void *ev_userdata (loop)"
1262.PD
1263Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When
1264\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns
1265\&\f(CW0\fR.
1266.Sp
1267These two functions can be used to associate arbitrary data with a loop,
1268and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and
1269\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for
1270any other purpose as well.
1271.IP "ev_verify (loop)" 4
1272.IX Item "ev_verify (loop)"
1273This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been
1274compiled in, which is the default for non-minimal builds. It tries to go
1275through all internal structures and checks them for validity. If anything
1276is found to be inconsistent, it will print an error message to standard
1277error and call \f(CW\*(C`abort ()\*(C'\fR.
1278.Sp
1279This can be used to catch bugs inside libev itself: under normal
1280circumstances, this function will never abort as of course libev keeps its
1281data structures consistent.
609.SH "ANATOMY OF A WATCHER" 1282.SH "ANATOMY OF A WATCHER"
610.IX Header "ANATOMY OF A WATCHER" 1283.IX Header "ANATOMY OF A WATCHER"
1284In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the
1285watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer
1286watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers.
1287.PP
611A watcher is a structure that you create and register to record your 1288A watcher is an opaque structure that you allocate and register to record
612interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 1289your interest in some event. To make a concrete example, imagine you want
613become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: 1290to wait for \s-1STDIN\s0 to become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher
1291for that:
614.PP 1292.PP
615.Vb 5 1293.Vb 5
616\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1294\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
617\& { 1295\& {
618\& ev_io_stop (w); 1296\& ev_io_stop (w);
619\& ev_unloop (loop, EVUNLOOP_ALL); 1297\& ev_break (loop, EVBREAK_ALL);
620\& } 1298\& }
621.Ve 1299\&
622.PP
623.Vb 6
624\& struct ev_loop *loop = ev_default_loop (0); 1300\& struct ev_loop *loop = ev_default_loop (0);
1301\&
625\& struct ev_io stdin_watcher; 1302\& ev_io stdin_watcher;
1303\&
626\& ev_init (&stdin_watcher, my_cb); 1304\& ev_init (&stdin_watcher, my_cb);
627\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 1305\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
628\& ev_io_start (loop, &stdin_watcher); 1306\& ev_io_start (loop, &stdin_watcher);
1307\&
629\& ev_loop (loop, 0); 1308\& ev_run (loop, 0);
630.Ve 1309.Ve
631.PP 1310.PP
632As you can see, you are responsible for allocating the memory for your 1311As you can see, you are responsible for allocating the memory for your
633watcher structures (and it is usually a bad idea to do this on the stack, 1312watcher structures (and it is \fIusually\fR a bad idea to do this on the
634although this can sometimes be quite valid). 1313stack).
635.PP 1314.PP
1315Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR
1316or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs).
1317.PP
636Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init 1318Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init (watcher
637(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This 1319*, callback)\*(C'\fR, which expects a callback to be provided. This callback is
638callback gets invoked each time the event occurs (or, in the case of io 1320invoked each time the event occurs (or, in the case of I/O watchers, each
639watchers, each time the event loop detects that the file descriptor given 1321time the event loop detects that the file descriptor given is readable
640is readable and/or writable). 1322and/or writable).
641.PP 1323.PP
642Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro 1324Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR
643with arguments specific to this watcher type. There is also a macro 1325macro to configure it, with arguments specific to the watcher type. There
644to combine initialisation and setting in one call: \f(CW\*(C`ev_<type>_init 1326is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR.
645(watcher *, callback, ...)\*(C'\fR.
646.PP 1327.PP
647To make the watcher actually watch out for events, you have to start it 1328To make the watcher actually watch out for events, you have to start it
648with a watcher-specific start function (\f(CW\*(C`ev_<type>_start (loop, watcher 1329with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher
649*)\*(C'\fR), and you can stop watching for events at any time by calling the 1330*)\*(C'\fR), and you can stop watching for events at any time by calling the
650corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. 1331corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR.
651.PP 1332.PP
652As long as your watcher is active (has been started but not stopped) you 1333As long as your watcher is active (has been started but not stopped) you
653must not touch the values stored in it. Most specifically you must never 1334must not touch the values stored in it. Most specifically you must never
654reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro. 1335reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro.
655.PP 1336.PP
656Each and every callback receives the event loop pointer as first, the 1337Each and every callback receives the event loop pointer as first, the
657registered watcher structure as second, and a bitset of received events as 1338registered watcher structure as second, and a bitset of received events as
658third argument. 1339third argument.
659.PP 1340.PP
… …
668.el .IP "\f(CWEV_WRITE\fR" 4 1349.el .IP "\f(CWEV_WRITE\fR" 4
669.IX Item "EV_WRITE" 1350.IX Item "EV_WRITE"
670.PD 1351.PD
671The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or 1352The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or
672writable. 1353writable.
673.ie n .IP """EV_TIMEOUT""" 4 1354.ie n .IP """EV_TIMER""" 4
674.el .IP "\f(CWEV_TIMEOUT\fR" 4 1355.el .IP "\f(CWEV_TIMER\fR" 4
675.IX Item "EV_TIMEOUT" 1356.IX Item "EV_TIMER"
676The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out. 1357The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out.
677.ie n .IP """EV_PERIODIC""" 4 1358.ie n .IP """EV_PERIODIC""" 4
678.el .IP "\f(CWEV_PERIODIC\fR" 4 1359.el .IP "\f(CWEV_PERIODIC\fR" 4
679.IX Item "EV_PERIODIC" 1360.IX Item "EV_PERIODIC"
680The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out. 1361The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out.
… …
684The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. 1365The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread.
685.ie n .IP """EV_CHILD""" 4 1366.ie n .IP """EV_CHILD""" 4
686.el .IP "\f(CWEV_CHILD\fR" 4 1367.el .IP "\f(CWEV_CHILD\fR" 4
687.IX Item "EV_CHILD" 1368.IX Item "EV_CHILD"
688The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. 1369The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change.
1370.ie n .IP """EV_STAT""" 4
1371.el .IP "\f(CWEV_STAT\fR" 4
1372.IX Item "EV_STAT"
1373The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow.
689.ie n .IP """EV_IDLE""" 4 1374.ie n .IP """EV_IDLE""" 4
690.el .IP "\f(CWEV_IDLE\fR" 4 1375.el .IP "\f(CWEV_IDLE\fR" 4
691.IX Item "EV_IDLE" 1376.IX Item "EV_IDLE"
692The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. 1377The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do.
693.ie n .IP """EV_PREPARE""" 4 1378.ie n .IP """EV_PREPARE""" 4
… …
696.PD 0 1381.PD 0
697.ie n .IP """EV_CHECK""" 4 1382.ie n .IP """EV_CHECK""" 4
698.el .IP "\f(CWEV_CHECK\fR" 4 1383.el .IP "\f(CWEV_CHECK\fR" 4
699.IX Item "EV_CHECK" 1384.IX Item "EV_CHECK"
700.PD 1385.PD
701All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_loop\*(C'\fR starts 1386All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
702to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1387gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
703\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 1388just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1389for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1390watchers invoked before the event loop sleeps or polls for new events, and
1391\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1392or lower priority within an event loop iteration.
1393.Sp
704received events. Callbacks of both watcher types can start and stop as 1394Callbacks of both watcher types can start and stop as many watchers as
705many watchers as they want, and all of them will be taken into account 1395they want, and all of them will be taken into account (for example, a
706(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1396\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
707\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 1397blocking).
1398.ie n .IP """EV_EMBED""" 4
1399.el .IP "\f(CWEV_EMBED\fR" 4
1400.IX Item "EV_EMBED"
1401The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1402.ie n .IP """EV_FORK""" 4
1403.el .IP "\f(CWEV_FORK\fR" 4
1404.IX Item "EV_FORK"
1405The event loop has been resumed in the child process after fork (see
1406\&\f(CW\*(C`ev_fork\*(C'\fR).
1407.ie n .IP """EV_CLEANUP""" 4
1408.el .IP "\f(CWEV_CLEANUP\fR" 4
1409.IX Item "EV_CLEANUP"
1410The event loop is about to be destroyed (see \f(CW\*(C`ev_cleanup\*(C'\fR).
1411.ie n .IP """EV_ASYNC""" 4
1412.el .IP "\f(CWEV_ASYNC\fR" 4
1413.IX Item "EV_ASYNC"
1414The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
1415.ie n .IP """EV_CUSTOM""" 4
1416.el .IP "\f(CWEV_CUSTOM\fR" 4
1417.IX Item "EV_CUSTOM"
1418Not ever sent (or otherwise used) by libev itself, but can be freely used
1419by libev users to signal watchers (e.g. via \f(CW\*(C`ev_feed_event\*(C'\fR).
708.ie n .IP """EV_ERROR""" 4 1420.ie n .IP """EV_ERROR""" 4
709.el .IP "\f(CWEV_ERROR\fR" 4 1421.el .IP "\f(CWEV_ERROR\fR" 4
710.IX Item "EV_ERROR" 1422.IX Item "EV_ERROR"
711An unspecified error has occured, the watcher has been stopped. This might 1423An unspecified error has occurred, the watcher has been stopped. This might
712happen because the watcher could not be properly started because libev 1424happen because the watcher could not be properly started because libev
713ran out of memory, a file descriptor was found to be closed or any other 1425ran out of memory, a file descriptor was found to be closed or any other
1426problem. Libev considers these application bugs.
1427.Sp
714problem. You best act on it by reporting the problem and somehow coping 1428You best act on it by reporting the problem and somehow coping with the
715with the watcher being stopped. 1429watcher being stopped. Note that well-written programs should not receive
1430an error ever, so when your watcher receives it, this usually indicates a
1431bug in your program.
716.Sp 1432.Sp
717Libev will usually signal a few \*(L"dummy\*(R" events together with an error, 1433Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
718for example it might indicate that a fd is readable or writable, and if 1434example it might indicate that a fd is readable or writable, and if your
719your callbacks is well-written it can just attempt the operation and cope 1435callbacks is well-written it can just attempt the operation and cope with
720with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded 1436the error from \fBread()\fR or \fBwrite()\fR. This will not work in multi-threaded
721programs, though, so beware. 1437programs, though, as the fd could already be closed and reused for another
722.Sh "\s-1SUMMARY\s0 \s-1OF\s0 \s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1438thing, so beware.
1439.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
723.IX Subsection "SUMMARY OF GENERIC WATCHER FUNCTIONS" 1440.IX Subsection "GENERIC WATCHER FUNCTIONS"
724In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type,
725e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers.
726.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1441.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
727.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1442.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
728.IX Item "ev_init (ev_TYPE *watcher, callback)" 1443.IX Item "ev_init (ev_TYPE *watcher, callback)"
729This macro initialises the generic portion of a watcher. The contents 1444This macro initialises the generic portion of a watcher. The contents
730of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only 1445of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only
… …
734which rolls both calls into one. 1449which rolls both calls into one.
735.Sp 1450.Sp
736You can reinitialise a watcher at any time as long as it has been stopped 1451You can reinitialise a watcher at any time as long as it has been stopped
737(or never started) and there are no pending events outstanding. 1452(or never started) and there are no pending events outstanding.
738.Sp 1453.Sp
739The callbakc is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, 1454The callback is always of type \f(CW\*(C`void (*)(struct ev_loop *loop, ev_TYPE *watcher,
740int revents)\*(C'\fR. 1455int revents)\*(C'\fR.
1456.Sp
1457Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps.
1458.Sp
1459.Vb 3
1460\& ev_io w;
1461\& ev_init (&w, my_cb);
1462\& ev_io_set (&w, STDIN_FILENO, EV_READ);
1463.Ve
741.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 1464.ie n .IP """ev_TYPE_set"" (ev_TYPE *watcher, [args])" 4
742.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 1465.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *watcher, [args])" 4
743.IX Item "ev_TYPE_set (ev_TYPE *, [args])" 1466.IX Item "ev_TYPE_set (ev_TYPE *watcher, [args])"
744This macro initialises the type-specific parts of a watcher. You need to 1467This macro initialises the type-specific parts of a watcher. You need to
745call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can 1468call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
746call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this 1469call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this
747macro on a watcher that is active (it can be pending, however, which is a 1470macro on a watcher that is active (it can be pending, however, which is a
748difference to the \f(CW\*(C`ev_init\*(C'\fR macro). 1471difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
749.Sp 1472.Sp
750Although some watcher types do not have type-specific arguments 1473Although some watcher types do not have type-specific arguments
751(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. 1474(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro.
1475.Sp
1476See \f(CW\*(C`ev_init\*(C'\fR, above, for an example.
752.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 1477.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4
753.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 1478.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4
754.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" 1479.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])"
755This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro 1480This convenience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro
756calls into a single call. This is the most convinient method to initialise 1481calls into a single call. This is the most convenient method to initialise
757a watcher. The same limitations apply, of course. 1482a watcher. The same limitations apply, of course.
1483.Sp
1484Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step.
1485.Sp
1486.Vb 1
1487\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1488.Ve
758.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 1489.ie n .IP """ev_TYPE_start"" (loop, ev_TYPE *watcher)" 4
759.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 1490.el .IP "\f(CWev_TYPE_start\fR (loop, ev_TYPE *watcher)" 4
760.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" 1491.IX Item "ev_TYPE_start (loop, ev_TYPE *watcher)"
761Starts (activates) the given watcher. Only active watchers will receive 1492Starts (activates) the given watcher. Only active watchers will receive
762events. If the watcher is already active nothing will happen. 1493events. If the watcher is already active nothing will happen.
1494.Sp
1495Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this
1496whole section.
1497.Sp
1498.Vb 1
1499\& ev_io_start (EV_DEFAULT_UC, &w);
1500.Ve
763.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 1501.ie n .IP """ev_TYPE_stop"" (loop, ev_TYPE *watcher)" 4
764.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 1502.el .IP "\f(CWev_TYPE_stop\fR (loop, ev_TYPE *watcher)" 4
765.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" 1503.IX Item "ev_TYPE_stop (loop, ev_TYPE *watcher)"
766Stops the given watcher again (if active) and clears the pending 1504Stops the given watcher if active, and clears the pending status (whether
1505the watcher was active or not).
1506.Sp
767status. It is possible that stopped watchers are pending (for example, 1507It is possible that stopped watchers are pending \- for example,
768non-repeating timers are being stopped when they become pending), but 1508non-repeating timers are being stopped when they become pending \- but
769\&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If 1509calling \f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor
770you want to free or reuse the memory used by the watcher it is therefore a 1510pending. If you want to free or reuse the memory used by the watcher it is
771good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. 1511therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
772.IP "bool ev_is_active (ev_TYPE *watcher)" 4 1512.IP "bool ev_is_active (ev_TYPE *watcher)" 4
773.IX Item "bool ev_is_active (ev_TYPE *watcher)" 1513.IX Item "bool ev_is_active (ev_TYPE *watcher)"
774Returns a true value iff the watcher is active (i.e. it has been started 1514Returns a true value iff the watcher is active (i.e. it has been started
775and not yet been stopped). As long as a watcher is active you must not modify 1515and not yet been stopped). As long as a watcher is active you must not modify
776it. 1516it.
777.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 1517.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
778.IX Item "bool ev_is_pending (ev_TYPE *watcher)" 1518.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
779Returns a true value iff the watcher is pending, (i.e. it has outstanding 1519Returns a true value iff the watcher is pending, (i.e. it has outstanding
780events but its callback has not yet been invoked). As long as a watcher 1520events but its callback has not yet been invoked). As long as a watcher
781is pending (but not active) you must not call an init function on it (but 1521is pending (but not active) you must not call an init function on it (but
782\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to 1522\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
783libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). 1523make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1524it).
784.IP "callback = ev_cb (ev_TYPE *watcher)" 4 1525.IP "callback ev_cb (ev_TYPE *watcher)" 4
785.IX Item "callback = ev_cb (ev_TYPE *watcher)" 1526.IX Item "callback ev_cb (ev_TYPE *watcher)"
786Returns the callback currently set on the watcher. 1527Returns the callback currently set on the watcher.
787.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1528.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
788.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1529.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
789Change the callback. You can change the callback at virtually any time 1530Change the callback. You can change the callback at virtually any time
790(modulo threads). 1531(modulo threads).
791.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 1532.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
792.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 1533.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
793Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 1534.PD 0
794and read at any time, libev will completely ignore it. This can be used 1535.IP "int ev_priority (ev_TYPE *watcher)" 4
795to associate arbitrary data with your watcher. If you need more data and 1536.IX Item "int ev_priority (ev_TYPE *watcher)"
796don't want to allocate memory and store a pointer to it in that data 1537.PD
797member, you can also \*(L"subclass\*(R" the watcher type and provide your own 1538Set and query the priority of the watcher. The priority is a small
798data: 1539integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
1540(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
1541before watchers with lower priority, but priority will not keep watchers
1542from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
1543.Sp
1544If you need to suppress invocation when higher priority events are pending
1545you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
1546.Sp
1547You \fImust not\fR change the priority of a watcher as long as it is active or
1548pending.
1549.Sp
1550Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
1551fine, as long as you do not mind that the priority value you query might
1552or might not have been clamped to the valid range.
1553.Sp
1554The default priority used by watchers when no priority has been set is
1555always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1556.Sp
1557See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1558priorities.
1559.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1560.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1561Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1562\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1563can deal with that fact, as both are simply passed through to the
1564callback.
1565.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
1566.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
1567If the watcher is pending, this function clears its pending status and
1568returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
1569watcher isn't pending it does nothing and returns \f(CW0\fR.
1570.Sp
1571Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its
1572callback to be invoked, which can be accomplished with this function.
1573.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4
1574.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)"
1575Feeds the given event set into the event loop, as if the specified event
1576had happened for the specified watcher (which must be a pointer to an
1577initialised but not necessarily started event watcher). Obviously you must
1578not free the watcher as long as it has pending events.
1579.Sp
1580Stopping the watcher, letting libev invoke it, or calling
1581\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was
1582not started in the first place.
1583.Sp
1584See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1585functions that do not need a watcher.
799.PP 1586.PP
1587See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1588OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1589.SS "\s-1WATCHER STATES\s0"
1590.IX Subsection "WATCHER STATES"
1591There are various watcher states mentioned throughout this manual \-
1592active, pending and so on. In this section these states and the rules to
1593transition between them will be described in more detail \- and while these
1594rules might look complicated, they usually do \*(L"the right thing\*(R".
1595.IP "initialised" 4
1596.IX Item "initialised"
1597Before a watcher can be registered with the event loop it has to be
1598initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1599\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1600.Sp
1601In this state it is simply some block of memory that is suitable for
1602use in an event loop. It can be moved around, freed, reused etc. at
1603will \- as long as you either keep the memory contents intact, or call
1604\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again.
1605.IP "started/running/active" 4
1606.IX Item "started/running/active"
1607Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1608property of the event loop, and is actively waiting for events. While in
1609this state it cannot be accessed (except in a few documented ways), moved,
1610freed or anything else \- the only legal thing is to keep a pointer to it,
1611and call libev functions on it that are documented to work on active watchers.
1612.IP "pending" 4
1613.IX Item "pending"
1614If a watcher is active and libev determines that an event it is interested
1615in has occurred (such as a timer expiring), it will become pending. It will
1616stay in this pending state until either it is stopped or its callback is
1617about to be invoked, so it is not normally pending inside the watcher
1618callback.
1619.Sp
1620The watcher might or might not be active while it is pending (for example,
1621an expired non-repeating timer can be pending but no longer active). If it
1622is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR),
1623but it is still property of the event loop at this time, so cannot be
1624moved, freed or reused. And if it is active the rules described in the
1625previous item still apply.
1626.Sp
1627It is also possible to feed an event on a watcher that is not active (e.g.
1628via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being
1629active.
1630.IP "stopped" 4
1631.IX Item "stopped"
1632A watcher can be stopped implicitly by libev (in which case it might still
1633be pending), or explicitly by calling its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. The
1634latter will clear any pending state the watcher might be in, regardless
1635of whether it was active or not, so stopping a watcher explicitly before
1636freeing it is often a good idea.
1637.Sp
1638While stopped (and not pending) the watcher is essentially in the
1639initialised state, that is, it can be reused, moved, modified in any way
1640you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1641it again).
1642.SS "\s-1WATCHER PRIORITY MODELS\s0"
1643.IX Subsection "WATCHER PRIORITY MODELS"
1644Many event loops support \fIwatcher priorities\fR, which are usually small
1645integers that influence the ordering of event callback invocation
1646between watchers in some way, all else being equal.
1647.PP
1648In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1649description for the more technical details such as the actual priority
1650range.
1651.PP
1652There are two common ways how these these priorities are being interpreted
1653by event loops:
1654.PP
1655In the more common lock-out model, higher priorities \*(L"lock out\*(R" invocation
1656of lower priority watchers, which means as long as higher priority
1657watchers receive events, lower priority watchers are not being invoked.
1658.PP
1659The less common only-for-ordering model uses priorities solely to order
1660callback invocation within a single event loop iteration: Higher priority
1661watchers are invoked before lower priority ones, but they all get invoked
1662before polling for new events.
1663.PP
1664Libev uses the second (only-for-ordering) model for all its watchers
1665except for idle watchers (which use the lock-out model).
1666.PP
1667The rationale behind this is that implementing the lock-out model for
1668watchers is not well supported by most kernel interfaces, and most event
1669libraries will just poll for the same events again and again as long as
1670their callbacks have not been executed, which is very inefficient in the
1671common case of one high-priority watcher locking out a mass of lower
1672priority ones.
1673.PP
1674Static (ordering) priorities are most useful when you have two or more
1675watchers handling the same resource: a typical usage example is having an
1676\&\f(CW\*(C`ev_io\*(C'\fR watcher to receive data, and an associated \f(CW\*(C`ev_timer\*(C'\fR to handle
1677timeouts. Under load, data might be received while the program handles
1678other jobs, but since timers normally get invoked first, the timeout
1679handler will be executed before checking for data. In that case, giving
1680the timer a lower priority than the I/O watcher ensures that I/O will be
1681handled first even under adverse conditions (which is usually, but not
1682always, what you want).
1683.PP
1684Since idle watchers use the \*(L"lock-out\*(R" model, meaning that idle watchers
1685will only be executed when no same or higher priority watchers have
1686received events, they can be used to implement the \*(L"lock-out\*(R" model when
1687required.
1688.PP
1689For example, to emulate how many other event libraries handle priorities,
1690you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in
1691the normal watcher callback, you just start the idle watcher. The real
1692processing is done in the idle watcher callback. This causes libev to
1693continuously poll and process kernel event data for the watcher, but when
1694the lock-out case is known to be rare (which in turn is rare :), this is
1695workable.
1696.PP
1697Usually, however, the lock-out model implemented that way will perform
1698miserably under the type of load it was designed to handle. In that case,
1699it might be preferable to stop the real watcher before starting the
1700idle watcher, so the kernel will not have to process the event in case
1701the actual processing will be delayed for considerable time.
1702.PP
1703Here is an example of an I/O watcher that should run at a strictly lower
1704priority than the default, and which should only process data when no
1705other events are pending:
1706.PP
800.Vb 7 1707.Vb 2
801\& struct my_io 1708\& ev_idle idle; // actual processing watcher
1709\& ev_io io; // actual event watcher
1710\&
1711\& static void
1712\& io_cb (EV_P_ ev_io *w, int revents)
802\& { 1713\& {
803\& struct ev_io io; 1714\& // stop the I/O watcher, we received the event, but
804\& int otherfd; 1715\& // are not yet ready to handle it.
805\& void *somedata; 1716\& ev_io_stop (EV_A_ w);
806\& struct whatever *mostinteresting; 1717\&
1718\& // start the idle watcher to handle the actual event.
1719\& // it will not be executed as long as other watchers
1720\& // with the default priority are receiving events.
1721\& ev_idle_start (EV_A_ &idle);
807\& } 1722\& }
808.Ve 1723\&
809.PP 1724\& static void
810And since your callback will be called with a pointer to the watcher, you 1725\& idle_cb (EV_P_ ev_idle *w, int revents)
811can cast it back to your own type:
812.PP
813.Vb 5
814\& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
815\& { 1726\& {
816\& struct my_io *w = (struct my_io *)w_; 1727\& // actual processing
817\& ... 1728\& read (STDIN_FILENO, ...);
1729\&
1730\& // have to start the I/O watcher again, as
1731\& // we have handled the event
1732\& ev_io_start (EV_P_ &io);
818\& } 1733\& }
1734\&
1735\& // initialisation
1736\& ev_idle_init (&idle, idle_cb);
1737\& ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1738\& ev_io_start (EV_DEFAULT_ &io);
819.Ve 1739.Ve
820.PP 1740.PP
821More interesting and less C\-conformant ways of catsing your callback type 1741In the \*(L"real\*(R" world, it might also be beneficial to start a timer, so that
822have been omitted.... 1742low-priority connections can not be locked out forever under load. This
1743enables your program to keep a lower latency for important connections
1744during short periods of high load, while not completely locking out less
1745important ones.
823.SH "WATCHER TYPES" 1746.SH "WATCHER TYPES"
824.IX Header "WATCHER TYPES" 1747.IX Header "WATCHER TYPES"
825This section describes each watcher in detail, but will not repeat 1748This section describes each watcher in detail, but will not repeat
826information given in the last section. 1749information given in the last section. Any initialisation/set macros,
1750functions and members specific to the watcher type are explained.
1751.PP
1752Members are additionally marked with either \fI[read\-only]\fR, meaning that,
1753while the watcher is active, you can look at the member and expect some
1754sensible content, but you must not modify it (you can modify it while the
1755watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1756means you can expect it to have some sensible content while the watcher
1757is active, but you can also modify it. Modifying it may not do something
1758sensible or take immediate effect (or do anything at all), but libev will
1759not crash or malfunction in any way.
827.ie n .Sh """ev_io"" \- is this file descriptor readable or writable" 1760.ie n .SS """ev_io"" \- is this file descriptor readable or writable?"
828.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable" 1761.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?"
829.IX Subsection "ev_io - is this file descriptor readable or writable" 1762.IX Subsection "ev_io - is this file descriptor readable or writable?"
830I/O watchers check whether a file descriptor is readable or writable 1763I/O watchers check whether a file descriptor is readable or writable
831in each iteration of the event loop (This behaviour is called 1764in each iteration of the event loop, or, more precisely, when reading
832level-triggering because you keep receiving events as long as the 1765would not block the process and writing would at least be able to write
833condition persists. Remember you can stop the watcher if you don't want to 1766some data. This behaviour is called level-triggering because you keep
834act on the event and neither want to receive future events). 1767receiving events as long as the condition persists. Remember you can stop
1768the watcher if you don't want to act on the event and neither want to
1769receive future events.
835.PP 1770.PP
836In general you can register as many read and/or write event watchers per 1771In general you can register as many read and/or write event watchers per
837fd as you want (as long as you don't confuse yourself). Setting all file 1772fd as you want (as long as you don't confuse yourself). Setting all file
838descriptors to non-blocking mode is also usually a good idea (but not 1773descriptors to non-blocking mode is also usually a good idea (but not
839required if you know what you are doing). 1774required if you know what you are doing).
840.PP 1775.PP
841You have to be careful with dup'ed file descriptors, though. Some backends 1776Another thing you have to watch out for is that it is quite easy to
842(the linux epoll backend is a notable example) cannot handle dup'ed file 1777receive \*(L"spurious\*(R" readiness notifications, that is, your callback might
843descriptors correctly if you register interest in two or more fds pointing 1778be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
844to the same underlying file/socket etc. description (that is, they share 1779because there is no data. It is very easy to get into this situation even
845the same underlying \*(L"file open\*(R"). 1780with a relatively standard program structure. Thus it is best to always
1781use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning \f(CW\*(C`EAGAIN\*(C'\fR is far
1782preferable to a program hanging until some data arrives.
846.PP 1783.PP
847If you must do this, then force the use of a known-to-be-good backend 1784If you cannot run the fd in non-blocking mode (for example you should
848(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and 1785not play around with an Xlib connection), then you have to separately
849\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1786re-test whether a file descriptor is really ready with a known-to-be good
1787interface such as poll (fortunately in the case of Xlib, it already does
1788this on its own, so its quite safe to use). Some people additionally
1789use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block
1790indefinitely.
1791.PP
1792But really, best use non-blocking mode.
1793.PP
1794\fIThe special problem of disappearing file descriptors\fR
1795.IX Subsection "The special problem of disappearing file descriptors"
1796.PP
1797Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1798a file descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other
1799means, such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some
1800file descriptor, but when it goes away, the operating system will silently
1801drop this interest. If another file descriptor with the same number then
1802is registered with libev, there is no efficient way to see that this is,
1803in fact, a different file descriptor.
1804.PP
1805To avoid having to explicitly tell libev about such cases, libev follows
1806the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1807will assume that this is potentially a new file descriptor, otherwise
1808it is assumed that the file descriptor stays the same. That means that
1809you \fIhave\fR to call \f(CW\*(C`ev_io_set\*(C'\fR (or \f(CW\*(C`ev_io_init\*(C'\fR) when you change the
1810descriptor even if the file descriptor number itself did not change.
1811.PP
1812This is how one would do it normally anyway, the important point is that
1813the libev application should not optimise around libev but should leave
1814optimisations to libev.
1815.PP
1816\fIThe special problem of dup'ed file descriptors\fR
1817.IX Subsection "The special problem of dup'ed file descriptors"
1818.PP
1819Some backends (e.g. epoll), cannot register events for file descriptors,
1820but only events for the underlying file descriptions. That means when you
1821have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register
1822events for them, only one file descriptor might actually receive events.
1823.PP
1824There is no workaround possible except not registering events
1825for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1826\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1827.PP
1828\fIThe special problem of files\fR
1829.IX Subsection "The special problem of files"
1830.PP
1831Many people try to use \f(CW\*(C`select\*(C'\fR (or libev) on file descriptors
1832representing files, and expect it to become ready when their program
1833doesn't block on disk accesses (which can take a long time on their own).
1834.PP
1835However, this cannot ever work in the \*(L"expected\*(R" way \- you get a readiness
1836notification as soon as the kernel knows whether and how much data is
1837there, and in the case of open files, that's always the case, so you
1838always get a readiness notification instantly, and your read (or possibly
1839write) will still block on the disk I/O.
1840.PP
1841Another way to view it is that in the case of sockets, pipes, character
1842devices and so on, there is another party (the sender) that delivers data
1843on its own, but in the case of files, there is no such thing: the disk
1844will not send data on its own, simply because it doesn't know what you
1845wish to read \- you would first have to request some data.
1846.PP
1847Since files are typically not-so-well supported by advanced notification
1848mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1849to files, even though you should not use it. The reason for this is
1850convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1851usually a tty, often a pipe, but also sometimes files or special devices
1852(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1853\&\fI/dev/urandom\fR), and even though the file might better be served with
1854asynchronous I/O instead of with non-blocking I/O, it is still useful when
1855it \*(L"just works\*(R" instead of freezing.
1856.PP
1857So avoid file descriptors pointing to files when you know it (e.g. use
1858libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1859when you rarely read from a file instead of from a socket, and want to
1860reuse the same code path.
1861.PP
1862\fIThe special problem of fork\fR
1863.IX Subsection "The special problem of fork"
1864.PP
1865Some backends (epoll, kqueue, probably linuxaio) do not support \f(CW\*(C`fork ()\*(C'\fR
1866at all or exhibit useless behaviour. Libev fully supports fork, but needs
1867to be told about it in the child if you want to continue to use it in the
1868child.
1869.PP
1870To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1871()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1872\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1873.PP
1874\fIThe special problem of \s-1SIGPIPE\s0\fR
1875.IX Subsection "The special problem of SIGPIPE"
1876.PP
1877While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1878when writing to a pipe whose other end has been closed, your program gets
1879sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1880this is sensible behaviour, for daemons, this is usually undesirable.
1881.PP
1882So when you encounter spurious, unexplained daemon exits, make sure you
1883ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1884somewhere, as that would have given you a big clue).
1885.PP
1886\fIThe special problem of \f(BIaccept()\fIing when you can't\fR
1887.IX Subsection "The special problem of accept()ing when you can't"
1888.PP
1889Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
1890found in post\-2004 Linux) have the peculiar behaviour of not removing a
1891connection from the pending queue in all error cases.
1892.PP
1893For example, larger servers often run out of file descriptors (because
1894of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not
1895rejecting the connection, leading to libev signalling readiness on
1896the next iteration again (the connection still exists after all), and
1897typically causing the program to loop at 100% \s-1CPU\s0 usage.
1898.PP
1899Unfortunately, the set of errors that cause this issue differs between
1900operating systems, there is usually little the app can do to remedy the
1901situation, and no known thread-safe method of removing the connection to
1902cope with overload is known (to me).
1903.PP
1904One of the easiest ways to handle this situation is to just ignore it
1905\&\- when the program encounters an overload, it will just loop until the
1906situation is over. While this is a form of busy waiting, no \s-1OS\s0 offers an
1907event-based way to handle this situation, so it's the best one can do.
1908.PP
1909A better way to handle the situation is to log any errors other than
1910\&\f(CW\*(C`EAGAIN\*(C'\fR and \f(CW\*(C`EWOULDBLOCK\*(C'\fR, making sure not to flood the log with such
1911messages, and continue as usual, which at least gives the user an idea of
1912what could be wrong (\*(L"raise the ulimit!\*(R"). For extra points one could stop
1913the \f(CW\*(C`ev_io\*(C'\fR watcher on the listening fd \*(L"for a while\*(R", which reduces \s-1CPU\s0
1914usage.
1915.PP
1916If your program is single-threaded, then you could also keep a dummy file
1917descriptor for overload situations (e.g. by opening \fI/dev/null\fR), and
1918when you run into \f(CW\*(C`ENFILE\*(C'\fR or \f(CW\*(C`EMFILE\*(C'\fR, close it, run \f(CW\*(C`accept\*(C'\fR,
1919close that fd, and create a new dummy fd. This will gracefully refuse
1920clients under typical overload conditions.
1921.PP
1922The last way to handle it is to simply log the error and \f(CW\*(C`exit\*(C'\fR, as
1923is often done with \f(CW\*(C`malloc\*(C'\fR failures, but this results in an easy
1924opportunity for a DoS attack.
1925.PP
1926\fIWatcher-Specific Functions\fR
1927.IX Subsection "Watcher-Specific Functions"
850.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1928.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
851.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1929.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
852.PD 0 1930.PD 0
853.IP "ev_io_set (ev_io *, int fd, int events)" 4 1931.IP "ev_io_set (ev_io *, int fd, int events)" 4
854.IX Item "ev_io_set (ev_io *, int fd, int events)" 1932.IX Item "ev_io_set (ev_io *, int fd, int events)"
855.PD 1933.PD
856Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The fd is the file descriptor to rceeive 1934Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
857events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_READ | 1935receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
858EV_WRITE\*(C'\fR to receive the given events. 1936\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events.
859.Sp 1937.IP "int fd [read\-only]" 4
860Please note that most of the more scalable backend mechanisms (for example 1938.IX Item "int fd [read-only]"
861epoll and solaris ports) can result in spurious readyness notifications 1939The file descriptor being watched.
862for file descriptors, so you practically need to use non-blocking I/O (and 1940.IP "int events [read\-only]" 4
863treat callback invocation as hint only), or retest separately with a safe 1941.IX Item "int events [read-only]"
864interface before doing I/O (XLib can do this), or force the use of either 1942The events being watched.
865\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR, which don't suffer from this
866problem. Also note that it is quite easy to have your callback invoked
867when the readyness condition is no longer valid even when employing
868typical ways of handling events, so its a good idea to use non-blocking
869I/O unconditionally.
870.PP 1943.PP
1944\fIExamples\fR
1945.IX Subsection "Examples"
1946.PP
871Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1947Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
872readable, but only once. Since it is likely line\-buffered, you could 1948readable, but only once. Since it is likely line-buffered, you could
873attempt to read a whole line in the callback: 1949attempt to read a whole line in the callback.
874.PP 1950.PP
875.Vb 6 1951.Vb 6
876\& static void 1952\& static void
877\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1953\& stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
878\& { 1954\& {
879\& ev_io_stop (loop, w); 1955\& ev_io_stop (loop, w);
880\& .. read from stdin here (or from w->fd) and haqndle any I/O errors 1956\& .. read from stdin here (or from w\->fd) and handle any I/O errors
881\& } 1957\& }
882.Ve 1958\&
883.PP
884.Vb 6
885\& ... 1959\& ...
886\& struct ev_loop *loop = ev_default_init (0); 1960\& struct ev_loop *loop = ev_default_init (0);
887\& struct ev_io stdin_readable; 1961\& ev_io stdin_readable;
888\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1962\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
889\& ev_io_start (loop, &stdin_readable); 1963\& ev_io_start (loop, &stdin_readable);
890\& ev_loop (loop, 0); 1964\& ev_run (loop, 0);
891.Ve 1965.Ve
892.ie n .Sh """ev_timer"" \- relative and optionally recurring timeouts" 1966.ie n .SS """ev_timer"" \- relative and optionally repeating timeouts"
893.el .Sh "\f(CWev_timer\fP \- relative and optionally recurring timeouts" 1967.el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
894.IX Subsection "ev_timer - relative and optionally recurring timeouts" 1968.IX Subsection "ev_timer - relative and optionally repeating timeouts"
895Timer watchers are simple relative timers that generate an event after a 1969Timer watchers are simple relative timers that generate an event after a
896given time, and optionally repeating in regular intervals after that. 1970given time, and optionally repeating in regular intervals after that.
897.PP 1971.PP
898The timers are based on real time, that is, if you register an event that 1972The timers are based on real time, that is, if you register an event that
899times out after an hour and you reset your system clock to last years 1973times out after an hour and you reset your system clock to January last
900time, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because 1974year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because
901detecting time jumps is hard, and some inaccuracies are unavoidable (the 1975detecting time jumps is hard, and some inaccuracies are unavoidable (the
902monotonic clock option helps a lot here). 1976monotonic clock option helps a lot here).
1977.PP
1978The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1979passed (not \fIat\fR, so on systems with very low-resolution clocks this
1980might introduce a small delay, see \*(L"the special problem of being too
1981early\*(R", below). If multiple timers become ready during the same loop
1982iteration then the ones with earlier time-out values are invoked before
1983ones of the same priority with later time-out values (but this is no
1984longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1985.PP
1986\fIBe smart about timeouts\fR
1987.IX Subsection "Be smart about timeouts"
1988.PP
1989Many real-world problems involve some kind of timeout, usually for error
1990recovery. A typical example is an \s-1HTTP\s0 request \- if the other side hangs,
1991you want to raise some error after a while.
1992.PP
1993What follows are some ways to handle this problem, from obvious and
1994inefficient to smart and efficient.
1995.PP
1996In the following, a 60 second activity timeout is assumed \- a timeout that
1997gets reset to 60 seconds each time there is activity (e.g. each time some
1998data or other life sign was received).
1999.IP "1. Use a timer and stop, reinitialise and start it on activity." 4
2000.IX Item "1. Use a timer and stop, reinitialise and start it on activity."
2001This is the most obvious, but not the most simple way: In the beginning,
2002start the watcher:
2003.Sp
2004.Vb 2
2005\& ev_timer_init (timer, callback, 60., 0.);
2006\& ev_timer_start (loop, timer);
2007.Ve
2008.Sp
2009Then, each time there is some activity, \f(CW\*(C`ev_timer_stop\*(C'\fR it, initialise it
2010and start it again:
2011.Sp
2012.Vb 3
2013\& ev_timer_stop (loop, timer);
2014\& ev_timer_set (timer, 60., 0.);
2015\& ev_timer_start (loop, timer);
2016.Ve
2017.Sp
2018This is relatively simple to implement, but means that each time there is
2019some activity, libev will first have to remove the timer from its internal
2020data structure and then add it again. Libev tries to be fast, but it's
2021still not a constant-time operation.
2022.ie n .IP "2. Use a timer and re-start it with ""ev_timer_again"" inactivity." 4
2023.el .IP "2. Use a timer and re-start it with \f(CWev_timer_again\fR inactivity." 4
2024.IX Item "2. Use a timer and re-start it with ev_timer_again inactivity."
2025This is the easiest way, and involves using \f(CW\*(C`ev_timer_again\*(C'\fR instead of
2026\&\f(CW\*(C`ev_timer_start\*(C'\fR.
2027.Sp
2028To implement this, configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value
2029of \f(CW60\fR and then call \f(CW\*(C`ev_timer_again\*(C'\fR at start and each time you
2030successfully read or write some data. If you go into an idle state where
2031you do not expect data to travel on the socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR
2032the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will automatically restart it if need be.
2033.Sp
2034That means you can ignore both the \f(CW\*(C`ev_timer_start\*(C'\fR function and the
2035\&\f(CW\*(C`after\*(C'\fR argument to \f(CW\*(C`ev_timer_set\*(C'\fR, and only ever use the \f(CW\*(C`repeat\*(C'\fR
2036member and \f(CW\*(C`ev_timer_again\*(C'\fR.
2037.Sp
2038At start:
2039.Sp
2040.Vb 3
2041\& ev_init (timer, callback);
2042\& timer\->repeat = 60.;
2043\& ev_timer_again (loop, timer);
2044.Ve
2045.Sp
2046Each time there is some activity:
2047.Sp
2048.Vb 1
2049\& ev_timer_again (loop, timer);
2050.Ve
2051.Sp
2052It is even possible to change the time-out on the fly, regardless of
2053whether the watcher is active or not:
2054.Sp
2055.Vb 2
2056\& timer\->repeat = 30.;
2057\& ev_timer_again (loop, timer);
2058.Ve
2059.Sp
2060This is slightly more efficient then stopping/starting the timer each time
2061you want to modify its timeout value, as libev does not have to completely
2062remove and re-insert the timer from/into its internal data structure.
2063.Sp
2064It is, however, even simpler than the \*(L"obvious\*(R" way to do it.
2065.IP "3. Let the timer time out, but then re-arm it as required." 4
2066.IX Item "3. Let the timer time out, but then re-arm it as required."
2067This method is more tricky, but usually most efficient: Most timeouts are
2068relatively long compared to the intervals between other activity \- in
2069our example, within 60 seconds, there are usually many I/O events with
2070associated activity resets.
2071.Sp
2072In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
2073but remember the time of last activity, and check for a real timeout only
2074within the callback:
2075.Sp
2076.Vb 3
2077\& ev_tstamp timeout = 60.;
2078\& ev_tstamp last_activity; // time of last activity
2079\& ev_timer timer;
2080\&
2081\& static void
2082\& callback (EV_P_ ev_timer *w, int revents)
2083\& {
2084\& // calculate when the timeout would happen
2085\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
2086\&
2087\& // if negative, it means we the timeout already occurred
2088\& if (after < 0.)
2089\& {
2090\& // timeout occurred, take action
2091\& }
2092\& else
2093\& {
2094\& // callback was invoked, but there was some recent
2095\& // activity. simply restart the timer to time out
2096\& // after "after" seconds, which is the earliest time
2097\& // the timeout can occur.
2098\& ev_timer_set (w, after, 0.);
2099\& ev_timer_start (EV_A_ w);
2100\& }
2101\& }
2102.Ve
2103.Sp
2104To summarise the callback: first calculate in how many seconds the
2105timeout will occur (by calculating the absolute time when it would occur,
2106\&\f(CW\*(C`last_activity + timeout\*(C'\fR, and subtracting the current time, \f(CW\*(C`ev_now
2107(EV_A)\*(C'\fR from that).
2108.Sp
2109If this value is negative, then we are already past the timeout, i.e. we
2110timed out, and need to do whatever is needed in this case.
2111.Sp
2112Otherwise, we now the earliest time at which the timeout would trigger,
2113and simply start the timer with this timeout value.
2114.Sp
2115In other words, each time the callback is invoked it will check whether
2116the timeout occurred. If not, it will simply reschedule itself to check
2117again at the earliest time it could time out. Rinse. Repeat.
2118.Sp
2119This scheme causes more callback invocations (about one every 60 seconds
2120minus half the average time between activity), but virtually no calls to
2121libev to change the timeout.
2122.Sp
2123To start the machinery, simply initialise the watcher and set
2124\&\f(CW\*(C`last_activity\*(C'\fR to the current time (meaning there was some activity just
2125now), then call the callback, which will \*(L"do the right thing\*(R" and start
2126the timer:
2127.Sp
2128.Vb 3
2129\& last_activity = ev_now (EV_A);
2130\& ev_init (&timer, callback);
2131\& callback (EV_A_ &timer, 0);
2132.Ve
2133.Sp
2134When there is some activity, simply store the current time in
2135\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
2136.Sp
2137.Vb 2
2138\& if (activity detected)
2139\& last_activity = ev_now (EV_A);
2140.Ve
2141.Sp
2142When your timeout value changes, then the timeout can be changed by simply
2143providing a new value, stopping the timer and calling the callback, which
2144will again do the right thing (for example, time out immediately :).
2145.Sp
2146.Vb 3
2147\& timeout = new_value;
2148\& ev_timer_stop (EV_A_ &timer);
2149\& callback (EV_A_ &timer, 0);
2150.Ve
2151.Sp
2152This technique is slightly more complex, but in most cases where the
2153time-out is unlikely to be triggered, much more efficient.
2154.IP "4. Wee, just use a double-linked list for your timeouts." 4
2155.IX Item "4. Wee, just use a double-linked list for your timeouts."
2156If there is not one request, but many thousands (millions...), all
2157employing some kind of timeout with the same timeout value, then one can
2158do even better:
2159.Sp
2160When starting the timeout, calculate the timeout value and put the timeout
2161at the \fIend\fR of the list.
2162.Sp
2163Then use an \f(CW\*(C`ev_timer\*(C'\fR to fire when the timeout at the \fIbeginning\fR of
2164the list is expected to fire (for example, using the technique #3).
2165.Sp
2166When there is some activity, remove the timer from the list, recalculate
2167the timeout, append it to the end of the list again, and make sure to
2168update the \f(CW\*(C`ev_timer\*(C'\fR if it was taken from the beginning of the list.
2169.Sp
2170This way, one can manage an unlimited number of timeouts in O(1) time for
2171starting, stopping and updating the timers, at the expense of a major
2172complication, and having to use a constant timeout. The constant timeout
2173ensures that the list stays sorted.
2174.PP
2175So which method the best?
2176.PP
2177Method #2 is a simple no-brain-required solution that is adequate in most
2178situations. Method #3 requires a bit more thinking, but handles many cases
2179better, and isn't very complicated either. In most case, choosing either
2180one is fine, with #3 being better in typical situations.
2181.PP
2182Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
2183rather complicated, but extremely efficient, something that really pays
2184off after the first million or so of active timers, i.e. it's usually
2185overkill :)
2186.PP
2187\fIThe special problem of being too early\fR
2188.IX Subsection "The special problem of being too early"
2189.PP
2190If you ask a timer to call your callback after three seconds, then
2191you expect it to be invoked after three seconds \- but of course, this
2192cannot be guaranteed to infinite precision. Less obviously, it cannot be
2193guaranteed to any precision by libev \- imagine somebody suspending the
2194process with a \s-1STOP\s0 signal for a few hours for example.
2195.PP
2196So, libev tries to invoke your callback as soon as possible \fIafter\fR the
2197delay has occurred, but cannot guarantee this.
2198.PP
2199A less obvious failure mode is calling your callback too early: many event
2200loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but
2201this can cause your callback to be invoked much earlier than you would
2202expect.
2203.PP
2204To see why, imagine a system with a clock that only offers full second
2205resolution (think windows if you can't come up with a broken enough \s-1OS\s0
2206yourself). If you schedule a one-second timer at the time 500.9, then the
2207event loop will schedule your timeout to elapse at a system time of 500
2208(500.9 truncated to the resolution) + 1, or 501.
2209.PP
2210If an event library looks at the timeout 0.1s later, it will see \*(L"501 >=
2211501\*(R" and invoke the callback 0.1s after it was started, even though a
2212one-second delay was requested \- this is being \*(L"too early\*(R", despite best
2213intentions.
2214.PP
2215This is the reason why libev will never invoke the callback if the elapsed
2216delay equals the requested delay, but only when the elapsed delay is
2217larger than the requested delay. In the example above, libev would only invoke
2218the callback at system time 502, or 1.1s after the timer was started.
2219.PP
2220So, while libev cannot guarantee that your callback will be invoked
2221exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested
2222delay has actually elapsed, or in other words, it always errs on the \*(L"too
2223late\*(R" side of things.
2224.PP
2225\fIThe special problem of time updates\fR
2226.IX Subsection "The special problem of time updates"
2227.PP
2228Establishing the current time is a costly operation (it usually takes
2229at least one system call): \s-1EV\s0 therefore updates its idea of the current
2230time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a
2231growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
2232lots of events in one iteration.
903.PP 2233.PP
904The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2234The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
905time. This is usually the right thing as this timestamp refers to the time 2235time. This is usually the right thing as this timestamp refers to the time
906of the event triggering whatever timeout you are modifying/starting. If 2236of the event triggering whatever timeout you are modifying/starting. If
907you suspect event processing to be delayed and you \fIneed\fR to base the timeout 2237you suspect event processing to be delayed and you \fIneed\fR to base the
908on the current time, use something like this to adjust for this: 2238timeout on the current time, use something like the following to adjust
2239for it:
909.PP 2240.PP
910.Vb 1 2241.Vb 1
911\& ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2242\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
912.Ve 2243.Ve
913.PP 2244.PP
914The callback is guarenteed to be invoked only when its timeout has passed, 2245If the event loop is suspended for a long time, you can also force an
915but if multiple timers become ready during the same loop iteration then 2246update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
916order of execution is undefined. 2247()\*(C'\fR, although that will push the event time of all outstanding events
2248further into the future.
2249.PP
2250\fIThe special problem of unsynchronised clocks\fR
2251.IX Subsection "The special problem of unsynchronised clocks"
2252.PP
2253Modern systems have a variety of clocks \- libev itself uses the normal
2254\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time
2255jumps).
2256.PP
2257Neither of these clocks is synchronised with each other or any other clock
2258on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time
2259than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example,
2260a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher
2261than a directly following call to \f(CW\*(C`time\*(C'\fR.
2262.PP
2263The moral of this is to only compare libev-related timestamps with
2264\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than
2265a second or so.
2266.PP
2267One more problem arises due to this lack of synchronisation: if libev uses
2268the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR
2269or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is
2270invoked, you will find that sometimes the callback is a bit \*(L"early\*(R".
2271.PP
2272This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so
2273libev makes sure your callback is not invoked before the delay happened,
2274\&\fImeasured according to the real time\fR, not the system clock.
2275.PP
2276If your timeouts are based on a physical timescale (e.g. \*(L"time out this
2277connection after 100 seconds\*(R") then this shouldn't bother you as it is
2278exactly the right behaviour.
2279.PP
2280If you want to compare wall clock/system timestamps to your timers, then
2281you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock
2282time, where your comparisons will always generate correct results.
2283.PP
2284\fIThe special problems of suspended animation\fR
2285.IX Subsection "The special problems of suspended animation"
2286.PP
2287When you leave the server world it is quite customary to hit machines that
2288can suspend/hibernate \- what happens to the clocks during such a suspend?
2289.PP
2290Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
2291all processes, while the clocks (\f(CW\*(C`times\*(C'\fR, \f(CW\*(C`CLOCK_MONOTONIC\*(C'\fR) continue
2292to run until the system is suspended, but they will not advance while the
2293system is suspended. That means, on resume, it will be as if the program
2294was frozen for a few seconds, but the suspend time will not be counted
2295towards \f(CW\*(C`ev_timer\*(C'\fR when a monotonic clock source is used. The real time
2296clock advanced as expected, but if it is used as sole clocksource, then a
2297long suspend would be detected as a time jump by libev, and timers would
2298be adjusted accordingly.
2299.PP
2300I would not be surprised to see different behaviour in different between
2301operating systems, \s-1OS\s0 versions or even different hardware.
2302.PP
2303The other form of suspend (job control, or sending a \s-1SIGSTOP\s0) will see a
2304time jump in the monotonic clocks and the realtime clock. If the program
2305is suspended for a very long time, and monotonic clock sources are in use,
2306then you can expect \f(CW\*(C`ev_timer\*(C'\fRs to expire as the full suspension time
2307will be counted towards the timers. When no monotonic clock source is in
2308use, then libev will again assume a timejump and adjust accordingly.
2309.PP
2310It might be beneficial for this latter case to call \f(CW\*(C`ev_suspend\*(C'\fR
2311and \f(CW\*(C`ev_resume\*(C'\fR in code that handles \f(CW\*(C`SIGTSTP\*(C'\fR, to at least get
2312deterministic behaviour in this case (you can do nothing against
2313\&\f(CW\*(C`SIGSTOP\*(C'\fR).
2314.PP
2315\fIWatcher-Specific Functions and Data Members\fR
2316.IX Subsection "Watcher-Specific Functions and Data Members"
917.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 2317.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
918.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2318.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
919.PD 0 2319.PD 0
920.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2320.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
921.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 2321.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
922.PD 2322.PD
923Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR is 2323Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds (fractional and
924\&\f(CW0.\fR, then it will automatically be stopped. If it is positive, then the 2324negative values are supported). If \f(CW\*(C`repeat\*(C'\fR is \f(CW0.\fR, then it will
2325automatically be stopped once the timeout is reached. If it is positive,
925timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds 2326then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
926later, again, and again, until stopped manually. 2327seconds later, again, and again, until stopped manually.
927.Sp 2328.Sp
928The timer itself will do a best-effort at avoiding drift, that is, if you 2329The timer itself will do a best-effort at avoiding drift, that is, if
929configure a timer to trigger every 10 seconds, then it will trigger at 2330you configure a timer to trigger every 10 seconds, then it will normally
930exactly 10 second intervals. If, however, your program cannot keep up with 2331trigger at exactly 10 second intervals. If, however, your program cannot
931the timer (because it takes longer than those 10 seconds to do stuff) the 2332keep up with the timer (because it takes longer than those 10 seconds to
932timer will not fire more than once per event loop iteration. 2333do stuff) the timer will not fire more than once per event loop iteration.
933.IP "ev_timer_again (loop)" 4 2334.IP "ev_timer_again (loop, ev_timer *)" 4
934.IX Item "ev_timer_again (loop)" 2335.IX Item "ev_timer_again (loop, ev_timer *)"
935This will act as if the timer timed out and restart it again if it is 2336This will act as if the timer timed out, and restarts it again if it is
936repeating. The exact semantics are: 2337repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the
2338timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR.
937.Sp 2339.Sp
938If the timer is started but nonrepeating, stop it. 2340The exact semantics are as in the following rules, all of which will be
2341applied to the watcher:
2342.RS 4
2343.IP "If the timer is pending, the pending status is always cleared." 4
2344.IX Item "If the timer is pending, the pending status is always cleared."
2345.PD 0
2346.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4
2347.IX Item "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)."
2348.ie n .IP "If the timer is repeating, make the ""repeat"" value the new timeout and start the timer, if necessary." 4
2349.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4
2350.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary."
2351.RE
2352.RS 4
2353.PD
939.Sp 2354.Sp
940If the timer is repeating, either start it if necessary (with the repeat 2355This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
941value), or reset the running timer to the repeat value. 2356usage example.
2357.RE
2358.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
2359.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
2360Returns the remaining time until a timer fires. If the timer is active,
2361then this time is relative to the current event loop time, otherwise it's
2362the timeout value currently configured.
942.Sp 2363.Sp
943This sounds a bit complicated, but here is a useful and typical 2364That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns
944example: Imagine you have a tcp connection and you want a so-called idle 2365\&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remaining\*(C'\fR
945timeout, that is, you want to be called when there have been, say, 60 2366will return \f(CW4\fR. When the timer expires and is restarted, it will return
946seconds of inactivity on the socket. The easiest way to do this is to 2367roughly \f(CW7\fR (likely slightly less as callback invocation takes some time,
947configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_timer_again each 2368too), and so on.
948time you successfully read or write some data. If you go into an idle 2369.IP "ev_tstamp repeat [read\-write]" 4
949state where you do not expect data to travel on the socket, you can stop 2370.IX Item "ev_tstamp repeat [read-write]"
950the timer, and again will automatically restart it if need be. 2371The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
2372or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any),
2373which is also when any modifications are taken into account.
951.PP 2374.PP
2375\fIExamples\fR
2376.IX Subsection "Examples"
2377.PP
952Example: create a timer that fires after 60 seconds. 2378Example: Create a timer that fires after 60 seconds.
953.PP 2379.PP
954.Vb 5 2380.Vb 5
955\& static void 2381\& static void
956\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 2382\& one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
957\& { 2383\& {
958\& .. one minute over, w is actually stopped right here 2384\& .. one minute over, w is actually stopped right here
959\& } 2385\& }
960.Ve 2386\&
961.PP
962.Vb 3
963\& struct ev_timer mytimer; 2387\& ev_timer mytimer;
964\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 2388\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
965\& ev_timer_start (loop, &mytimer); 2389\& ev_timer_start (loop, &mytimer);
966.Ve 2390.Ve
967.PP 2391.PP
968Example: create a timeout timer that times out after 10 seconds of 2392Example: Create a timeout timer that times out after 10 seconds of
969inactivity. 2393inactivity.
970.PP 2394.PP
971.Vb 5 2395.Vb 5
972\& static void 2396\& static void
973\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 2397\& timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
974\& { 2398\& {
975\& .. ten seconds without any activity 2399\& .. ten seconds without any activity
976\& } 2400\& }
977.Ve 2401\&
978.PP
979.Vb 4
980\& struct ev_timer mytimer; 2402\& ev_timer mytimer;
981\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 2403\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
982\& ev_timer_again (&mytimer); /* start timer */ 2404\& ev_timer_again (&mytimer); /* start timer */
983\& ev_loop (loop, 0); 2405\& ev_run (loop, 0);
984.Ve 2406\&
985.PP
986.Vb 3
987\& // and in some piece of code that gets executed on any "activity": 2407\& // and in some piece of code that gets executed on any "activity":
988\& // reset the timeout to start ticking again at 10 seconds 2408\& // reset the timeout to start ticking again at 10 seconds
989\& ev_timer_again (&mytimer); 2409\& ev_timer_again (&mytimer);
990.Ve 2410.Ve
991.ie n .Sh """ev_periodic"" \- to cron or not to cron" 2411.ie n .SS """ev_periodic"" \- to cron or not to cron?"
992.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron" 2412.el .SS "\f(CWev_periodic\fP \- to cron or not to cron?"
993.IX Subsection "ev_periodic - to cron or not to cron" 2413.IX Subsection "ev_periodic - to cron or not to cron?"
994Periodic watchers are also timers of a kind, but they are very versatile 2414Periodic watchers are also timers of a kind, but they are very versatile
995(and unfortunately a bit complex). 2415(and unfortunately a bit complex).
996.PP 2416.PP
997Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 2417Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
998but on wallclock time (absolute time). You can tell a periodic watcher 2418relative time, the physical time that passes) but on wall clock time
999to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a 2419(absolute time, the thing you can read on your calendar or clock). The
1000periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () 2420difference is that wall clock time can run faster or slower than real
1001+ 10.\*(C'\fR) and then reset your system clock to the last year, then it will 2421time, and time jumps are not uncommon (e.g. when you adjust your
1002take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger 2422wrist-watch).
1003roughly 10 seconds later and of course not if you reset your system time
1004again).
1005.PP 2423.PP
1006They can also be used to implement vastly more complex timers, such as 2424You can tell a periodic watcher to trigger after some specific point
1007triggering an event on eahc midnight, local time. 2425in time: for example, if you tell a periodic watcher to trigger \*(L"in 10
2426seconds\*(R" (by specifying e.g. \f(CW\*(C`ev_now () + 10.\*(C'\fR, that is, an absolute time
2427not a delay) and then reset your system clock to January of the previous
2428year, then it will take a year or more to trigger the event (unlike an
2429\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2430it, as it uses a relative timeout).
1008.PP 2431.PP
2432\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
2433timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
2434other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2435watchers, as those cannot react to time jumps.
2436.PP
1009As with timers, the callback is guarenteed to be invoked only when the 2437As with timers, the callback is guaranteed to be invoked only when the
1010time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready 2438point in time where it is supposed to trigger has passed. If multiple
1011during the same loop iteration then order of execution is undefined. 2439timers become ready during the same loop iteration then the ones with
2440earlier time-out values are invoked before ones with later time-out values
2441(but this is no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
2442.PP
2443\fIWatcher-Specific Functions and Data Members\fR
2444.IX Subsection "Watcher-Specific Functions and Data Members"
1012.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 2445.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1013.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 2446.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1014.PD 0 2447.PD 0
1015.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 2448.IP "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1016.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 2449.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1017.PD 2450.PD
1018Lots of arguments, lets sort it out... There are basically three modes of 2451Lots of arguments, let's sort it out... There are basically three modes of
1019operation, and we will explain them from simplest to complex: 2452operation, and we will explain them from simplest to most complex:
1020.RS 4 2453.RS 4
1021.IP "* absolute timer (interval = reschedule_cb = 0)" 4 2454.IP "\(bu" 4
1022.IX Item "absolute timer (interval = reschedule_cb = 0)" 2455absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
2456.Sp
1023In this configuration the watcher triggers an event at the wallclock time 2457In this configuration the watcher triggers an event after the wall clock
1024\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, 2458time \f(CW\*(C`offset\*(C'\fR has passed. It will not repeat and will not adjust when a
1025that is, if it is to be run at January 1st 2011 then it will run when the 2459time jump occurs, that is, if it is to be run at January 1st 2011 then it
1026system time reaches or surpasses this time. 2460will be stopped and invoked when the system clock reaches or surpasses
1027.IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 2461this point in time.
1028.IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" 2462.IP "\(bu" 4
2463repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
2464.Sp
1029In this mode the watcher will always be scheduled to time out at the next 2465In this mode the watcher will always be scheduled to time out at the next
1030\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless 2466\&\f(CW\*(C`offset + N * interval\*(C'\fR time (for some integer N, which can also be
1031of any time jumps. 2467negative) and then repeat, regardless of any time jumps. The \f(CW\*(C`offset\*(C'\fR
2468argument is merely an offset into the \f(CW\*(C`interval\*(C'\fR periods.
1032.Sp 2469.Sp
1033This can be used to create timers that do not drift with respect to system 2470This can be used to create timers that do not drift with respect to the
1034time: 2471system clock, for example, here is an \f(CW\*(C`ev_periodic\*(C'\fR that triggers each
2472hour, on the hour (with respect to \s-1UTC\s0):
1035.Sp 2473.Sp
1036.Vb 1 2474.Vb 1
1037\& ev_periodic_set (&periodic, 0., 3600., 0); 2475\& ev_periodic_set (&periodic, 0., 3600., 0);
1038.Ve 2476.Ve
1039.Sp 2477.Sp
1040This doesn't mean there will always be 3600 seconds in between triggers, 2478This doesn't mean there will always be 3600 seconds in between triggers,
1041but only that the the callback will be called when the system time shows a 2479but only that the callback will be called when the system time shows a
1042full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible 2480full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible
1043by 3600. 2481by 3600.
1044.Sp 2482.Sp
1045Another way to think about it (for the mathematically inclined) is that 2483Another way to think about it (for the mathematically inclined) is that
1046\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2484\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
1047time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 2485time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
1048.IP "* manual reschedule mode (reschedule_cb = callback)" 4 2486.Sp
1049.IX Item "manual reschedule mode (reschedule_cb = callback)" 2487The \f(CW\*(C`interval\*(C'\fR \fI\s-1MUST\s0\fR be positive, and for numerical stability, the
2488interval value should be higher than \f(CW\*(C`1/8192\*(C'\fR (which is around 100
2489microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have
2490at most a similar magnitude as the current time (say, within a factor of
2491ten). Typical values for offset are, in fact, \f(CW0\fR or something between
2492\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range.
2493.Sp
2494Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
2495speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
2496will of course deteriorate. Libev itself tries to be exact to be about one
2497millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
2498.IP "\(bu" 4
2499manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
2500.Sp
1050In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 2501In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
1051ignored. Instead, each time the periodic watcher gets scheduled, the 2502ignored. Instead, each time the periodic watcher gets scheduled, the
1052reschedule callback will be called with the watcher as first, and the 2503reschedule callback will be called with the watcher as first, and the
1053current time as second argument. 2504current time as second argument.
1054.Sp 2505.Sp
1055\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, 2506\&\s-1NOTE:\s0 \fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
1056ever, or make any event loop modifications\fR. If you need to stop it, 2507or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
1057return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by 2508allowed by documentation here\fR.
1058starting a prepare watcher).
1059.Sp 2509.Sp
2510If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2511it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2512only event loop modification you are allowed to do).
2513.Sp
1060Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 2514The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(ev_periodic
1061ev_tstamp now)\*(C'\fR, e.g.: 2515*w, ev_tstamp now)\*(C'\fR, e.g.:
1062.Sp 2516.Sp
1063.Vb 4 2517.Vb 5
2518\& static ev_tstamp
1064\& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 2519\& my_rescheduler (ev_periodic *w, ev_tstamp now)
1065\& { 2520\& {
1066\& return now + 60.; 2521\& return now + 60.;
1067\& } 2522\& }
1068.Ve 2523.Ve
1069.Sp 2524.Sp
1070It must return the next time to trigger, based on the passed time value 2525It must return the next time to trigger, based on the passed time value
1071(that is, the lowest time value larger than to the second argument). It 2526(that is, the lowest time value larger than to the second argument). It
1072will usually be called just before the callback will be triggered, but 2527will usually be called just before the callback will be triggered, but
1073might be called at other times, too. 2528might be called at other times, too.
1074.Sp 2529.Sp
1075\&\s-1NOTE:\s0 \fIThis callback must always return a time that is later than the 2530\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
1076passed \f(CI\*(C`now\*(C'\fI value\fR. Not even \f(CW\*(C`now\*(C'\fR itself will do, it \fImust\fR be larger. 2531equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
1077.Sp 2532.Sp
1078This can be used to create very complex timers, such as a timer that 2533This can be used to create very complex timers, such as a timer that
1079triggers on each midnight, local time. To do this, you would calculate the 2534triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate
1080next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2535the next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for
1081you do this is, again, up to you (but it is not trivial, which is the main 2536this. Here is a (completely untested, no error checking) example on how to
1082reason I omitted it as an example). 2537do this:
2538.Sp
2539.Vb 1
2540\& #include <time.h>
2541\&
2542\& static ev_tstamp
2543\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2544\& {
2545\& time_t tnow = (time_t)now;
2546\& struct tm tm;
2547\& localtime_r (&tnow, &tm);
2548\&
2549\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2550\& ++tm.tm_mday; // midnight next day
2551\&
2552\& return mktime (&tm);
2553\& }
2554.Ve
2555.Sp
2556Note: this code might run into trouble on days that have more then two
2557midnights (beginning and end).
1083.RE 2558.RE
1084.RS 4 2559.RS 4
1085.RE 2560.RE
1086.IP "ev_periodic_again (loop, ev_periodic *)" 4 2561.IP "ev_periodic_again (loop, ev_periodic *)" 4
1087.IX Item "ev_periodic_again (loop, ev_periodic *)" 2562.IX Item "ev_periodic_again (loop, ev_periodic *)"
1088Simply stops and restarts the periodic watcher again. This is only useful 2563Simply stops and restarts the periodic watcher again. This is only useful
1089when you changed some parameters or the reschedule callback would return 2564when you changed some parameters or the reschedule callback would return
1090a different time than the last time it was called (e.g. in a crond like 2565a different time than the last time it was called (e.g. in a crond like
1091program when the crontabs have changed). 2566program when the crontabs have changed).
2567.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4
2568.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)"
2569When active, returns the absolute time that the watcher is supposed
2570to trigger next. This is not the same as the \f(CW\*(C`offset\*(C'\fR argument to
2571\&\f(CW\*(C`ev_periodic_set\*(C'\fR, but indeed works even in interval and manual
2572rescheduling modes.
2573.IP "ev_tstamp offset [read\-write]" 4
2574.IX Item "ev_tstamp offset [read-write]"
2575When repeating, this contains the offset value, otherwise this is the
2576absolute point in time (the \f(CW\*(C`offset\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR,
2577although libev might modify this value for better numerical stability).
2578.Sp
2579Can be modified any time, but changes only take effect when the periodic
2580timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
2581.IP "ev_tstamp interval [read\-write]" 4
2582.IX Item "ev_tstamp interval [read-write]"
2583The current interval value. Can be modified any time, but changes only
2584take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
2585called.
2586.IP "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read\-write]" 4
2587.IX Item "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]"
2588The current reschedule callback, or \f(CW0\fR, if this functionality is
2589switched off. Can be changed any time, but changes only take effect when
2590the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1092.PP 2591.PP
2592\fIExamples\fR
2593.IX Subsection "Examples"
2594.PP
1093Example: call a callback every hour, or, more precisely, whenever the 2595Example: Call a callback every hour, or, more precisely, whenever the
1094system clock is divisible by 3600. The callback invocation times have 2596system time is divisible by 3600. The callback invocation times have
1095potentially a lot of jittering, but good long-term stability. 2597potentially a lot of jitter, but good long-term stability.
1096.PP 2598.PP
1097.Vb 5 2599.Vb 5
1098\& static void 2600\& static void
1099\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 2601\& clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1100\& { 2602\& {
1101\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 2603\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1102\& } 2604\& }
1103.Ve 2605\&
1104.PP
1105.Vb 3
1106\& struct ev_periodic hourly_tick; 2606\& ev_periodic hourly_tick;
1107\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 2607\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1108\& ev_periodic_start (loop, &hourly_tick); 2608\& ev_periodic_start (loop, &hourly_tick);
1109.Ve 2609.Ve
1110.PP 2610.PP
1111Example: the same as above, but use a reschedule callback to do it: 2611Example: The same as above, but use a reschedule callback to do it:
1112.PP 2612.PP
1113.Vb 1 2613.Vb 1
1114\& #include <math.h> 2614\& #include <math.h>
1115.Ve 2615\&
1116.PP
1117.Vb 5
1118\& static ev_tstamp 2616\& static ev_tstamp
1119\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 2617\& my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1120\& { 2618\& {
1121\& return fmod (now, 3600.) + 3600.; 2619\& return now + (3600. \- fmod (now, 3600.));
1122\& } 2620\& }
1123.Ve 2621\&
1124.PP
1125.Vb 1
1126\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 2622\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1127.Ve 2623.Ve
1128.PP 2624.PP
1129Example: call a callback every hour, starting now: 2625Example: Call a callback every hour, starting now:
1130.PP 2626.PP
1131.Vb 4 2627.Vb 4
1132\& struct ev_periodic hourly_tick; 2628\& ev_periodic hourly_tick;
1133\& ev_periodic_init (&hourly_tick, clock_cb, 2629\& ev_periodic_init (&hourly_tick, clock_cb,
1134\& fmod (ev_now (loop), 3600.), 3600., 0); 2630\& fmod (ev_now (loop), 3600.), 3600., 0);
1135\& ev_periodic_start (loop, &hourly_tick); 2631\& ev_periodic_start (loop, &hourly_tick);
1136.Ve 2632.Ve
1137.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled" 2633.ie n .SS """ev_signal"" \- signal me when a signal gets signalled!"
1138.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled" 2634.el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1139.IX Subsection "ev_signal - signal me when a signal gets signalled" 2635.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1140Signal watchers will trigger an event when the process receives a specific 2636Signal watchers will trigger an event when the process receives a specific
1141signal one or more times. Even though signals are very asynchronous, libev 2637signal one or more times. Even though signals are very asynchronous, libev
1142will try it's best to deliver signals synchronously, i.e. as part of the 2638will try its best to deliver signals synchronously, i.e. as part of the
1143normal event processing, like any other event. 2639normal event processing, like any other event.
1144.PP 2640.PP
2641If you want signals to be delivered truly asynchronously, just use
2642\&\f(CW\*(C`sigaction\*(C'\fR as you would do without libev and forget about sharing
2643the signal. You can even use \f(CW\*(C`ev_async\*(C'\fR from a signal handler to
2644synchronously wake up an event loop.
2645.PP
1145You can configure as many watchers as you like per signal. Only when the 2646You can configure as many watchers as you like for the same signal, but
1146first watcher gets started will libev actually register a signal watcher 2647only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
1147with the kernel (thus it coexists with your own signal handlers as long 2648default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
1148as you don't register any with libev). Similarly, when the last signal 2649\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
1149watcher for a signal is stopped libev will reset the signal handler to 2650the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
1150\&\s-1SIG_DFL\s0 (regardless of what it was set to before). 2651.PP
2652Only after the first watcher for a signal is started will libev actually
2653register something with the kernel. It thus coexists with your own signal
2654handlers as long as you don't register any with libev for the same signal.
2655.PP
2656If possible and supported, libev will install its handlers with
2657\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
2658not be unduly interrupted. If you have a problem with system calls getting
2659interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2660and unblock them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
2661.PP
2662\fIThe special problem of inheritance over fork/execve/pthread_create\fR
2663.IX Subsection "The special problem of inheritance over fork/execve/pthread_create"
2664.PP
2665Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition
2666(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after
2667stopping it again), that is, libev might or might not block the signal,
2668and might or might not set or restore the installed signal handler (but
2669see \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR).
2670.PP
2671While this does not matter for the signal disposition (libev never
2672sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on
2673\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect
2674certain signals to be blocked.
2675.PP
2676This means that before calling \f(CW\*(C`exec\*(C'\fR (from the child) you should reset
2677the signal mask to whatever \*(L"default\*(R" you expect (all clear is a good
2678choice usually).
2679.PP
2680The simplest way to ensure that the signal mask is reset in the child is
2681to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will
2682catch fork calls done by libraries (such as the libc) as well.
2683.PP
2684In current versions of libev, the signal will not be blocked indefinitely
2685unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API\s0 (\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
2686the window of opportunity for problems, it will not go away, as libev
2687\&\fIhas\fR to modify the signal mask, at least temporarily.
2688.PP
2689So I can't stress this enough: \fIIf you do not reset your signal mask when
2690you expect it to be empty, you have a race condition in your code\fR. This
2691is not a libev-specific thing, this is true for most event libraries.
2692.PP
2693\fIThe special problem of threads signal handling\fR
2694.IX Subsection "The special problem of threads signal handling"
2695.PP
2696\&\s-1POSIX\s0 threads has problematic signal handling semantics, specifically,
2697a lot of functionality (sigfd, sigwait etc.) only really works if all
2698threads in a process block signals, which is hard to achieve.
2699.PP
2700When you want to use sigwait (or mix libev signal handling with your own
2701for the same signals), you can tackle this problem by globally blocking
2702all signals before creating any threads (or creating them with a fully set
2703sigprocmask) and also specifying the \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when creating
2704loops. Then designate one thread as \*(L"signal receiver thread\*(R" which handles
2705these signals. You can pass on any signals that libev might be interested
2706in by calling \f(CW\*(C`ev_feed_signal\*(C'\fR.
2707.PP
2708\fIWatcher-Specific Functions and Data Members\fR
2709.IX Subsection "Watcher-Specific Functions and Data Members"
1151.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 2710.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
1152.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 2711.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
1153.PD 0 2712.PD 0
1154.IP "ev_signal_set (ev_signal *, int signum)" 4 2713.IP "ev_signal_set (ev_signal *, int signum)" 4
1155.IX Item "ev_signal_set (ev_signal *, int signum)" 2714.IX Item "ev_signal_set (ev_signal *, int signum)"
1156.PD 2715.PD
1157Configures the watcher to trigger on the given signal number (usually one 2716Configures the watcher to trigger on the given signal number (usually one
1158of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 2717of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
2718.IP "int signum [read\-only]" 4
2719.IX Item "int signum [read-only]"
2720The signal the watcher watches out for.
2721.PP
2722\fIExamples\fR
2723.IX Subsection "Examples"
2724.PP
2725Example: Try to exit cleanly on \s-1SIGINT.\s0
2726.PP
2727.Vb 5
2728\& static void
2729\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2730\& {
2731\& ev_break (loop, EVBREAK_ALL);
2732\& }
2733\&
2734\& ev_signal signal_watcher;
2735\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2736\& ev_signal_start (loop, &signal_watcher);
2737.Ve
1159.ie n .Sh """ev_child"" \- wait for pid status changes" 2738.ie n .SS """ev_child"" \- watch out for process status changes"
1160.el .Sh "\f(CWev_child\fP \- wait for pid status changes" 2739.el .SS "\f(CWev_child\fP \- watch out for process status changes"
1161.IX Subsection "ev_child - wait for pid status changes" 2740.IX Subsection "ev_child - watch out for process status changes"
1162Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 2741Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1163some child status changes (most typically when a child of yours dies). 2742some child status changes (most typically when a child of yours dies or
2743exits). It is permissible to install a child watcher \fIafter\fR the child
2744has been forked (which implies it might have already exited), as long
2745as the event loop isn't entered (or is continued from a watcher), i.e.,
2746forking and then immediately registering a watcher for the child is fine,
2747but forking and registering a watcher a few event loop iterations later or
2748in the next callback invocation is not.
2749.PP
2750Only the default event loop is capable of handling signals, and therefore
2751you can only register child watchers in the default event loop.
2752.PP
2753Due to some design glitches inside libev, child watchers will always be
2754handled at maximum priority (their priority is set to \f(CW\*(C`EV_MAXPRI\*(C'\fR by
2755libev)
2756.PP
2757\fIProcess Interaction\fR
2758.IX Subsection "Process Interaction"
2759.PP
2760Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
2761initialised. This is necessary to guarantee proper behaviour even if the
2762first child watcher is started after the child exits. The occurrence
2763of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
2764synchronously as part of the event loop processing. Libev always reaps all
2765children, even ones not watched.
2766.PP
2767\fIOverriding the Built-In Processing\fR
2768.IX Subsection "Overriding the Built-In Processing"
2769.PP
2770Libev offers no special support for overriding the built-in child
2771processing, but if your application collides with libev's default child
2772handler, you can override it easily by installing your own handler for
2773\&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the
2774default loop never gets destroyed. You are encouraged, however, to use an
2775event-based approach to child reaping and thus use libev's support for
2776that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely.
2777.PP
2778\fIStopping the Child Watcher\fR
2779.IX Subsection "Stopping the Child Watcher"
2780.PP
2781Currently, the child watcher never gets stopped, even when the
2782child terminates, so normally one needs to stop the watcher in the
2783callback. Future versions of libev might stop the watcher automatically
2784when a child exit is detected (calling \f(CW\*(C`ev_child_stop\*(C'\fR twice is not a
2785problem).
2786.PP
2787\fIWatcher-Specific Functions and Data Members\fR
2788.IX Subsection "Watcher-Specific Functions and Data Members"
1164.IP "ev_child_init (ev_child *, callback, int pid)" 4 2789.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
1165.IX Item "ev_child_init (ev_child *, callback, int pid)" 2790.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
1166.PD 0 2791.PD 0
1167.IP "ev_child_set (ev_child *, int pid)" 4 2792.IP "ev_child_set (ev_child *, int pid, int trace)" 4
1168.IX Item "ev_child_set (ev_child *, int pid)" 2793.IX Item "ev_child_set (ev_child *, int pid, int trace)"
1169.PD 2794.PD
1170Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or 2795Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or
1171\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 2796\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1172at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 2797at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1173the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 2798the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1174\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 2799\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1175process causing the status change. 2800process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only
2801activate the watcher when the process terminates) or \f(CW1\fR (additionally
2802activate the watcher when the process is stopped or continued).
2803.IP "int pid [read\-only]" 4
2804.IX Item "int pid [read-only]"
2805The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
2806.IP "int rpid [read\-write]" 4
2807.IX Item "int rpid [read-write]"
2808The process id that detected a status change.
2809.IP "int rstatus [read\-write]" 4
2810.IX Item "int rstatus [read-write]"
2811The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
2812\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1176.PP 2813.PP
1177Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 2814\fIExamples\fR
2815.IX Subsection "Examples"
1178.PP 2816.PP
2817Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for
2818its completion.
2819.PP
1179.Vb 5 2820.Vb 1
2821\& ev_child cw;
2822\&
1180\& static void 2823\& static void
1181\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 2824\& child_cb (EV_P_ ev_child *w, int revents)
1182\& { 2825\& {
1183\& ev_unloop (loop, EVUNLOOP_ALL); 2826\& ev_child_stop (EV_A_ w);
2827\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1184\& } 2828\& }
2829\&
2830\& pid_t pid = fork ();
2831\&
2832\& if (pid < 0)
2833\& // error
2834\& else if (pid == 0)
2835\& {
2836\& // the forked child executes here
2837\& exit (1);
2838\& }
2839\& else
2840\& {
2841\& ev_child_init (&cw, child_cb, pid, 0);
2842\& ev_child_start (EV_DEFAULT_ &cw);
2843\& }
1185.Ve 2844.Ve
2845.ie n .SS """ev_stat"" \- did the file attributes just change?"
2846.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2847.IX Subsection "ev_stat - did the file attributes just change?"
2848This watches a file system path for attribute changes. That is, it calls
2849\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2850and sees if it changed compared to the last time, invoking the callback
2851if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2852happen after the watcher has been started will be reported.
1186.PP 2853.PP
2854The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
2855not exist\*(R" is a status change like any other. The condition \*(L"path does not
2856exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
2857\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
2858least one) and all the other fields of the stat buffer having unspecified
2859contents.
2860.PP
2861The path \fImust not\fR end in a slash or contain special components such as
2862\&\f(CW\*(C`.\*(C'\fR or \f(CW\*(C`..\*(C'\fR. The path \fIshould\fR be absolute: If it is relative and
2863your working directory changes, then the behaviour is undefined.
2864.PP
2865Since there is no portable change notification interface available, the
2866portable implementation simply calls \f(CWstat(2)\fR regularly on the path
2867to see if it changed somehow. You can specify a recommended polling
2868interval for this case. If you specify a polling interval of \f(CW0\fR (highly
2869recommended!) then a \fIsuitable, unspecified default\fR value will be used
2870(which you can expect to be around five seconds, although this might
2871change dynamically). Libev will also impose a minimum interval which is
2872currently around \f(CW0.1\fR, but that's usually overkill.
2873.PP
2874This watcher type is not meant for massive numbers of stat watchers,
2875as even with OS-supported change notifications, this can be
2876resource-intensive.
2877.PP
2878At the time of this writing, the only OS-specific interface implemented
2879is the Linux inotify interface (implementing kqueue support is left as an
2880exercise for the reader. Note, however, that the author sees no way of
2881implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue, except as a hint).
2882.PP
2883\fI\s-1ABI\s0 Issues (Largefile Support)\fR
2884.IX Subsection "ABI Issues (Largefile Support)"
2885.PP
2886Libev by default (unless the user overrides this) uses the default
2887compilation environment, which means that on systems with large file
2888support disabled by default, you get the 32 bit version of the stat
2889structure. When using the library from programs that change the \s-1ABI\s0 to
2890use 64 bit file offsets the programs will fail. In that case you have to
2891compile libev with the same flags to get binary compatibility. This is
2892obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2893most noticeably displayed with ev_stat and large file support.
2894.PP
2895The solution for this is to lobby your distribution maker to make large
2896file interfaces available by default (as e.g. FreeBSD does) and not
2897optional. Libev cannot simply switch on large file support because it has
2898to exchange stat structures with application programs compiled using the
2899default compilation environment.
2900.PP
2901\fIInotify and Kqueue\fR
2902.IX Subsection "Inotify and Kqueue"
2903.PP
2904When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev and present at
2905runtime, it will be used to speed up change detection where possible. The
2906inotify descriptor will be created lazily when the first \f(CW\*(C`ev_stat\*(C'\fR
2907watcher is being started.
2908.PP
2909Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
2910except that changes might be detected earlier, and in some cases, to avoid
2911making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support
2912there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling,
2913but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
2914many bugs), the path exists (i.e. stat succeeds), and the path resides on
2915a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
2916xfs are fully working) libev usually gets away without polling.
2917.PP
2918There is no support for kqueue, as apparently it cannot be used to
2919implement this functionality, due to the requirement of having a file
2920descriptor open on the object at all times, and detecting renames, unlinks
2921etc. is difficult.
2922.PP
2923\fI\f(CI\*(C`stat ()\*(C'\fI is a synchronous operation\fR
2924.IX Subsection "stat () is a synchronous operation"
2925.PP
2926Libev doesn't normally do any kind of I/O itself, and so is not blocking
2927the process. The exception are \f(CW\*(C`ev_stat\*(C'\fR watchers \- those call \f(CW\*(C`stat
2928()\*(C'\fR, which is a synchronous operation.
2929.PP
2930For local paths, this usually doesn't matter: unless the system is very
2931busy or the intervals between stat's are large, a stat call will be fast,
2932as the path data is usually in memory already (except when starting the
2933watcher).
2934.PP
2935For networked file systems, calling \f(CW\*(C`stat ()\*(C'\fR can block an indefinite
2936time due to network issues, and even under good conditions, a stat call
2937often takes multiple milliseconds.
2938.PP
2939Therefore, it is best to avoid using \f(CW\*(C`ev_stat\*(C'\fR watchers on networked
2940paths, although this is fully supported by libev.
2941.PP
2942\fIThe special problem of stat time resolution\fR
2943.IX Subsection "The special problem of stat time resolution"
2944.PP
2945The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably,
2946and even on systems where the resolution is higher, most file systems
2947still only support whole seconds.
2948.PP
2949That means that, if the time is the only thing that changes, you can
2950easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and
2951calls your callback, which does something. When there is another update
2952within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the
2953stat data does change in other ways (e.g. file size).
2954.PP
2955The solution to this is to delay acting on a change for slightly more
2956than a second (or till slightly after the next full second boundary), using
2957a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02);
2958ev_timer_again (loop, w)\*(C'\fR).
2959.PP
2960The \f(CW.02\fR offset is added to work around small timing inconsistencies
2961of some operating systems (where the second counter of the current time
2962might be be delayed. One such system is the Linux kernel, where a call to
2963\&\f(CW\*(C`gettimeofday\*(C'\fR might return a timestamp with a full second later than
2964a subsequent \f(CW\*(C`time\*(C'\fR call \- if the equivalent of \f(CW\*(C`time ()\*(C'\fR is used to
2965update file times then there will be a small window where the kernel uses
2966the previous second to update file times but libev might already execute
2967the timer callback).
2968.PP
2969\fIWatcher-Specific Functions and Data Members\fR
2970.IX Subsection "Watcher-Specific Functions and Data Members"
2971.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
2972.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
2973.PD 0
2974.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
2975.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
2976.PD
2977Configures the watcher to wait for status changes of the given
2978\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
2979be detected and should normally be specified as \f(CW0\fR to let libev choose
2980a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
2981path for as long as the watcher is active.
2982.Sp
2983The callback will receive an \f(CW\*(C`EV_STAT\*(C'\fR event when a change was detected,
2984relative to the attributes at the time the watcher was started (or the
2985last change was detected).
2986.IP "ev_stat_stat (loop, ev_stat *)" 4
2987.IX Item "ev_stat_stat (loop, ev_stat *)"
2988Updates the stat buffer immediately with new values. If you change the
2989watched path in your callback, you could call this function to avoid
2990detecting this change (while introducing a race condition if you are not
2991the only one changing the path). Can also be useful simply to find out the
2992new values.
2993.IP "ev_statdata attr [read\-only]" 4
2994.IX Item "ev_statdata attr [read-only]"
2995The most-recently detected attributes of the file. Although the type is
2996\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types
2997suitable for your system, but you can only rely on the POSIX-standardised
2998members to be present. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there was
2999some error while \f(CW\*(C`stat\*(C'\fRing the file.
3000.IP "ev_statdata prev [read\-only]" 4
3001.IX Item "ev_statdata prev [read-only]"
3002The previous attributes of the file. The callback gets invoked whenever
3003\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR, or, more precisely, one or more of these members
3004differ: \f(CW\*(C`st_dev\*(C'\fR, \f(CW\*(C`st_ino\*(C'\fR, \f(CW\*(C`st_mode\*(C'\fR, \f(CW\*(C`st_nlink\*(C'\fR, \f(CW\*(C`st_uid\*(C'\fR,
3005\&\f(CW\*(C`st_gid\*(C'\fR, \f(CW\*(C`st_rdev\*(C'\fR, \f(CW\*(C`st_size\*(C'\fR, \f(CW\*(C`st_atime\*(C'\fR, \f(CW\*(C`st_mtime\*(C'\fR, \f(CW\*(C`st_ctime\*(C'\fR.
3006.IP "ev_tstamp interval [read\-only]" 4
3007.IX Item "ev_tstamp interval [read-only]"
3008The specified interval.
3009.IP "const char *path [read\-only]" 4
3010.IX Item "const char *path [read-only]"
3011The file system path that is being watched.
3012.PP
3013\fIExamples\fR
3014.IX Subsection "Examples"
3015.PP
3016Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
3017.PP
3018.Vb 10
3019\& static void
3020\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
3021\& {
3022\& /* /etc/passwd changed in some way */
3023\& if (w\->attr.st_nlink)
3024\& {
3025\& printf ("passwd current size %ld\en", (long)w\->attr.st_size);
3026\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime);
3027\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime);
3028\& }
3029\& else
3030\& /* you shalt not abuse printf for puts */
3031\& puts ("wow, /etc/passwd is not there, expect problems. "
3032\& "if this is windows, they already arrived\en");
3033\& }
3034\&
3035\& ...
3036\& ev_stat passwd;
3037\&
3038\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
3039\& ev_stat_start (loop, &passwd);
3040.Ve
3041.PP
3042Example: Like above, but additionally use a one-second delay so we do not
3043miss updates (however, frequent updates will delay processing, too, so
3044one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on
3045\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
3046.PP
1187.Vb 3 3047.Vb 2
1188\& struct ev_signal signal_watcher; 3048\& static ev_stat passwd;
1189\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 3049\& static ev_timer timer;
1190\& ev_signal_start (loop, &sigint_cb); 3050\&
3051\& static void
3052\& timer_cb (EV_P_ ev_timer *w, int revents)
3053\& {
3054\& ev_timer_stop (EV_A_ w);
3055\&
3056\& /* now it\*(Aqs one second after the most recent passwd change */
3057\& }
3058\&
3059\& static void
3060\& stat_cb (EV_P_ ev_stat *w, int revents)
3061\& {
3062\& /* reset the one\-second timer */
3063\& ev_timer_again (EV_A_ &timer);
3064\& }
3065\&
3066\& ...
3067\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
3068\& ev_stat_start (loop, &passwd);
3069\& ev_timer_init (&timer, timer_cb, 0., 1.02);
1191.Ve 3070.Ve
1192.ie n .Sh """ev_idle"" \- when you've got nothing better to do" 3071.ie n .SS """ev_idle"" \- when you've got nothing better to do..."
1193.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do" 3072.el .SS "\f(CWev_idle\fP \- when you've got nothing better to do..."
1194.IX Subsection "ev_idle - when you've got nothing better to do" 3073.IX Subsection "ev_idle - when you've got nothing better to do..."
1195Idle watchers trigger events when there are no other events are pending 3074Idle watchers trigger events when no other events of the same or higher
1196(prepare, check and other idle watchers do not count). That is, as long 3075priority are pending (prepare, check and other idle watchers do not count
1197as your process is busy handling sockets or timeouts (or even signals, 3076as receiving \*(L"events\*(R").
1198imagine) it will not be triggered. But when your process is idle all idle 3077.PP
1199watchers are being called again and again, once per event loop iteration \- 3078That is, as long as your process is busy handling sockets or timeouts
3079(or even signals, imagine) of the same or higher priority it will not be
3080triggered. But when your process is idle (or only lower-priority watchers
3081are pending), the idle watchers are being called once per event loop
1200until stopped, that is, or your process receives more events and becomes 3082iteration \- until stopped, that is, or your process receives more events
1201busy. 3083and becomes busy again with higher priority stuff.
1202.PP 3084.PP
1203The most noteworthy effect is that as long as any idle watchers are 3085The most noteworthy effect is that as long as any idle watchers are
1204active, the process will not block when waiting for new events. 3086active, the process will not block when waiting for new events.
1205.PP 3087.PP
1206Apart from keeping your process non-blocking (which is a useful 3088Apart from keeping your process non-blocking (which is a useful
1207effect on its own sometimes), idle watchers are a good place to do 3089effect on its own sometimes), idle watchers are a good place to do
1208\&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the 3090\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
1209event loop has handled all outstanding events. 3091event loop has handled all outstanding events.
3092.PP
3093\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3094.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3095.PP
3096As long as there is at least one active idle watcher, libev will never
3097sleep unnecessarily. Or in other words, it will loop as fast as possible.
3098For this to work, the idle watcher doesn't need to be invoked at all \- the
3099lowest priority will do.
3100.PP
3101This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3102to do something on each event loop iteration \- for example to balance load
3103between different connections.
3104.PP
3105See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3106example.
3107.PP
3108\fIWatcher-Specific Functions and Data Members\fR
3109.IX Subsection "Watcher-Specific Functions and Data Members"
1210.IP "ev_idle_init (ev_signal *, callback)" 4 3110.IP "ev_idle_init (ev_idle *, callback)" 4
1211.IX Item "ev_idle_init (ev_signal *, callback)" 3111.IX Item "ev_idle_init (ev_idle *, callback)"
1212Initialises and configures the idle watcher \- it has no parameters of any 3112Initialises and configures the idle watcher \- it has no parameters of any
1213kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 3113kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1214believe me. 3114believe me.
1215.PP 3115.PP
3116\fIExamples\fR
3117.IX Subsection "Examples"
3118.PP
1216Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the 3119Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1217callback, free it. Alos, use no error checking, as usual. 3120callback, free it. Also, use no error checking, as usual.
1218.PP 3121.PP
1219.Vb 7 3122.Vb 5
1220\& static void 3123\& static void
1221\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 3124\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1222\& { 3125\& {
3126\& // stop the watcher
3127\& ev_idle_stop (loop, w);
3128\&
3129\& // now we can free it
1223\& free (w); 3130\& free (w);
3131\&
1224\& // now do something you wanted to do when the program has 3132\& // now do something you wanted to do when the program has
1225\& // no longer asnything immediate to do. 3133\& // no longer anything immediate to do.
1226\& } 3134\& }
1227.Ve 3135\&
1228.PP
1229.Vb 3
1230\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 3136\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1231\& ev_idle_init (idle_watcher, idle_cb); 3137\& ev_idle_init (idle_watcher, idle_cb);
1232\& ev_idle_start (loop, idle_cb); 3138\& ev_idle_start (loop, idle_watcher);
1233.Ve 3139.Ve
1234.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop" 3140.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
1235.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop" 3141.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
1236.IX Subsection "ev_prepare and ev_check - customise your event loop" 3142.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1237Prepare and check watchers are usually (but not always) used in tandem: 3143Prepare and check watchers are often (but not always) used in pairs:
1238prepare watchers get invoked before the process blocks and check watchers 3144prepare watchers get invoked before the process blocks and check watchers
1239afterwards. 3145afterwards.
1240.PP 3146.PP
3147You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the
3148current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or
3149\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine,
3150however. The rationale behind this is that you do not need to check
3151for recursion in those watchers, i.e. the sequence will always be
3152\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each
3153kind they will always be called in pairs bracketing the blocking call.
3154.PP
1241Their main purpose is to integrate other event mechanisms into libev and 3155Their main purpose is to integrate other event mechanisms into libev and
1242their use is somewhat advanced. This could be used, for example, to track 3156their use is somewhat advanced. They could be used, for example, to track
1243variable changes, implement your own watchers, integrate net-snmp or a 3157variable changes, implement your own watchers, integrate net-snmp or a
1244coroutine library and lots more. 3158coroutine library and lots more. They are also occasionally useful if
3159you cache some data and want to flush it before blocking (for example,
3160in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR
3161watcher).
1245.PP 3162.PP
1246This is done by examining in each prepare call which file descriptors need 3163This is done by examining in each prepare call which file descriptors
1247to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 3164need to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers
1248them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 3165for them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many
1249provide just this functionality). Then, in the check watcher you check for 3166libraries provide exactly this functionality). Then, in the check watcher,
1250any events that occured (by checking the pending status of all watchers 3167you check for any events that occurred (by checking the pending status
1251and stopping them) and call back into the library. The I/O and timer 3168of all watchers and stopping them) and call back into the library. The
1252callbacks will never actually be called (but must be valid nevertheless, 3169I/O and timer callbacks will never actually be called (but must be valid
1253because you never know, you know?). 3170nevertheless, because you never know, you know?).
1254.PP 3171.PP
1255As another example, the Perl Coro module uses these hooks to integrate 3172As another example, the Perl Coro module uses these hooks to integrate
1256coroutines into libev programs, by yielding to other active coroutines 3173coroutines into libev programs, by yielding to other active coroutines
1257during each prepare and only letting the process block if no coroutines 3174during each prepare and only letting the process block if no coroutines
1258are ready to run (it's actually more complicated: it only runs coroutines 3175are ready to run (it's actually more complicated: it only runs coroutines
1259with priority higher than or equal to the event loop and one coroutine 3176with priority higher than or equal to the event loop and one coroutine
1260of lower priority, but only once, using idle watchers to keep the event 3177of lower priority, but only once, using idle watchers to keep the event
1261loop from blocking if lower-priority coroutines are active, thus mapping 3178loop from blocking if lower-priority coroutines are active, thus mapping
1262low-priority coroutines to idle/background tasks). 3179low-priority coroutines to idle/background tasks).
3180.PP
3181When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
3182highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
3183any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3184watchers).
3185.PP
3186Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
3187activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
3188might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
3189\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
3190loops those other event loops might be in an unusable state until their
3191\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
3192others).
3193.PP
3194\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3195.IX Subsection "Abusing an ev_check watcher for its side-effect"
3196.PP
3197\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3198useful because they are called once per event loop iteration. For
3199example, if you want to handle a large number of connections fairly, you
3200normally only do a bit of work for each active connection, and if there
3201is more work to do, you wait for the next event loop iteration, so other
3202connections have a chance of making progress.
3203.PP
3204Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3205next event loop iteration. However, that isn't as soon as possible \-
3206without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3207.PP
3208This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3209single global idle watcher that is active as long as you have one active
3210\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3211will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3212invoked. Neither watcher alone can do that.
3213.PP
3214\fIWatcher-Specific Functions and Data Members\fR
3215.IX Subsection "Watcher-Specific Functions and Data Members"
1263.IP "ev_prepare_init (ev_prepare *, callback)" 4 3216.IP "ev_prepare_init (ev_prepare *, callback)" 4
1264.IX Item "ev_prepare_init (ev_prepare *, callback)" 3217.IX Item "ev_prepare_init (ev_prepare *, callback)"
1265.PD 0 3218.PD 0
1266.IP "ev_check_init (ev_check *, callback)" 4 3219.IP "ev_check_init (ev_check *, callback)" 4
1267.IX Item "ev_check_init (ev_check *, callback)" 3220.IX Item "ev_check_init (ev_check *, callback)"
1268.PD 3221.PD
1269Initialises and configures the prepare or check watcher \- they have no 3222Initialises and configures the prepare or check watcher \- they have no
1270parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 3223parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1271macros, but using them is utterly, utterly and completely pointless. 3224macros, but using them is utterly, utterly, utterly and completely
3225pointless.
1272.PP 3226.PP
1273Example: *TODO*. 3227\fIExamples\fR
3228.IX Subsection "Examples"
3229.PP
3230There are a number of principal ways to embed other event loops or modules
3231into libev. Here are some ideas on how to include libadns into libev
3232(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
3233use as a working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR embeds a
3234Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 into the
3235Glib event loop).
3236.PP
3237Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler,
3238and in a check watcher, destroy them and call into libadns. What follows
3239is pseudo-code only of course. This requires you to either use a low
3240priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as
3241the callbacks for the IO/timeout watchers might not have been called yet.
3242.PP
3243.Vb 2
3244\& static ev_io iow [nfd];
3245\& static ev_timer tw;
3246\&
3247\& static void
3248\& io_cb (struct ev_loop *loop, ev_io *w, int revents)
3249\& {
3250\& }
3251\&
3252\& // create io watchers for each fd and a timer before blocking
3253\& static void
3254\& adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
3255\& {
3256\& int timeout = 3600000;
3257\& struct pollfd fds [nfd];
3258\& // actual code will need to loop here and realloc etc.
3259\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
3260\&
3261\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
3262\& ev_timer_init (&tw, 0, timeout * 1e\-3, 0.);
3263\& ev_timer_start (loop, &tw);
3264\&
3265\& // create one ev_io per pollfd
3266\& for (int i = 0; i < nfd; ++i)
3267\& {
3268\& ev_io_init (iow + i, io_cb, fds [i].fd,
3269\& ((fds [i].events & POLLIN ? EV_READ : 0)
3270\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
3271\&
3272\& fds [i].revents = 0;
3273\& ev_io_start (loop, iow + i);
3274\& }
3275\& }
3276\&
3277\& // stop all watchers after blocking
3278\& static void
3279\& adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
3280\& {
3281\& ev_timer_stop (loop, &tw);
3282\&
3283\& for (int i = 0; i < nfd; ++i)
3284\& {
3285\& // set the relevant poll flags
3286\& // could also call adns_processreadable etc. here
3287\& struct pollfd *fd = fds + i;
3288\& int revents = ev_clear_pending (iow + i);
3289\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN;
3290\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT;
3291\&
3292\& // now stop the watcher
3293\& ev_io_stop (loop, iow + i);
3294\& }
3295\&
3296\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
3297\& }
3298.Ve
3299.PP
3300Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
3301in the prepare watcher and would dispose of the check watcher.
3302.PP
3303Method 3: If the module to be embedded supports explicit event
3304notification (libadns does), you can also make use of the actual watcher
3305callbacks, and only destroy/create the watchers in the prepare watcher.
3306.PP
3307.Vb 5
3308\& static void
3309\& timer_cb (EV_P_ ev_timer *w, int revents)
3310\& {
3311\& adns_state ads = (adns_state)w\->data;
3312\& update_now (EV_A);
3313\&
3314\& adns_processtimeouts (ads, &tv_now);
3315\& }
3316\&
3317\& static void
3318\& io_cb (EV_P_ ev_io *w, int revents)
3319\& {
3320\& adns_state ads = (adns_state)w\->data;
3321\& update_now (EV_A);
3322\&
3323\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now);
3324\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now);
3325\& }
3326\&
3327\& // do not ever call adns_afterpoll
3328.Ve
3329.PP
3330Method 4: Do not use a prepare or check watcher because the module you
3331want to embed is not flexible enough to support it. Instead, you can
3332override their poll function. The drawback with this solution is that the
3333main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
3334this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3335libglib event loop.
3336.PP
3337.Vb 4
3338\& static gint
3339\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
3340\& {
3341\& int got_events = 0;
3342\&
3343\& for (n = 0; n < nfds; ++n)
3344\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
3345\&
3346\& if (timeout >= 0)
3347\& // create/start timer
3348\&
3349\& // poll
3350\& ev_run (EV_A_ 0);
3351\&
3352\& // stop timer again
3353\& if (timeout >= 0)
3354\& ev_timer_stop (EV_A_ &to);
3355\&
3356\& // stop io watchers again \- their callbacks should have set
3357\& for (n = 0; n < nfds; ++n)
3358\& ev_io_stop (EV_A_ iow [n]);
3359\&
3360\& return got_events;
3361\& }
3362.Ve
1274.ie n .Sh """ev_embed"" \- when one backend isn't enough" 3363.ie n .SS """ev_embed"" \- when one backend isn't enough..."
1275.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough" 3364.el .SS "\f(CWev_embed\fP \- when one backend isn't enough..."
1276.IX Subsection "ev_embed - when one backend isn't enough" 3365.IX Subsection "ev_embed - when one backend isn't enough..."
1277This is a rather advanced watcher type that lets you embed one event loop 3366This is a rather advanced watcher type that lets you embed one event loop
1278into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded 3367into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
1279loop, other types of watchers might be handled in a delayed or incorrect 3368loop, other types of watchers might be handled in a delayed or incorrect
1280fashion and must not be used). 3369fashion and must not be used).
1281.PP 3370.PP
… …
1283prioritise I/O. 3372prioritise I/O.
1284.PP 3373.PP
1285As an example for a bug workaround, the kqueue backend might only support 3374As an example for a bug workaround, the kqueue backend might only support
1286sockets on some platform, so it is unusable as generic backend, but you 3375sockets on some platform, so it is unusable as generic backend, but you
1287still want to make use of it because you have many sockets and it scales 3376still want to make use of it because you have many sockets and it scales
1288so nicely. In this case, you would create a kqueue-based loop and embed it 3377so nicely. In this case, you would create a kqueue-based loop and embed
1289into your default loop (which might use e.g. poll). Overall operation will 3378it into your default loop (which might use e.g. poll). Overall operation
1290be a bit slower because first libev has to poll and then call kevent, but 3379will be a bit slower because first libev has to call \f(CW\*(C`poll\*(C'\fR and then
1291at least you can use both at what they are best. 3380\&\f(CW\*(C`kevent\*(C'\fR, but at least you can use both mechanisms for what they are
3381best: \f(CW\*(C`kqueue\*(C'\fR for scalable sockets and \f(CW\*(C`poll\*(C'\fR if you want it to work :)
1292.PP 3382.PP
1293As for prioritising I/O: rarely you have the case where some fds have 3383As for prioritising I/O: under rare circumstances you have the case where
1294to be watched and handled very quickly (with low latency), and even 3384some fds have to be watched and handled very quickly (with low latency),
1295priorities and idle watchers might have too much overhead. In this case 3385and even priorities and idle watchers might have too much overhead. In
1296you would put all the high priority stuff in one loop and all the rest in 3386this case you would put all the high priority stuff in one loop and all
1297a second one, and embed the second one in the first. 3387the rest in a second one, and embed the second one in the first.
1298.PP 3388.PP
1299As long as the watcher is active, the callback will be invoked every time 3389As long as the watcher is active, the callback will be invoked every
1300there might be events pending in the embedded loop. The callback must then 3390time there might be events pending in the embedded loop. The callback
1301call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke 3391must then call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single
1302their callbacks (you could also start an idle watcher to give the embedded 3392sweep and invoke their callbacks (the callback doesn't need to invoke the
1303loop strictly lower priority for example). You can also set the callback 3393\&\f(CW\*(C`ev_embed_sweep\*(C'\fR function directly, it could also start an idle watcher
1304to \f(CW0\fR, in which case the embed watcher will automatically execute the 3394to give the embedded loop strictly lower priority for example).
1305embedded loop sweep.
1306.PP 3395.PP
1307As long as the watcher is started it will automatically handle events. The 3396You can also set the callback to \f(CW0\fR, in which case the embed watcher
1308callback will be invoked whenever some events have been handled. You can 3397will automatically execute the embedded loop sweep whenever necessary.
1309set the callback to \f(CW0\fR to avoid having to specify one if you are not
1310interested in that.
1311.PP 3398.PP
1312Also, there have not currently been made special provisions for forking: 3399Fork detection will be handled transparently while the \f(CW\*(C`ev_embed\*(C'\fR watcher
1313when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops, 3400is active, i.e., the embedded loop will automatically be forked when the
1314but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers 3401embedding loop forks. In other cases, the user is responsible for calling
1315yourself. 3402\&\f(CW\*(C`ev_loop_fork\*(C'\fR on the embedded loop.
1316.PP 3403.PP
1317Unfortunately, not all backends are embeddable, only the ones returned by 3404Unfortunately, not all backends are embeddable: only the ones returned by
1318\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any 3405\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any
1319portable one. 3406portable one.
1320.PP 3407.PP
1321So when you want to use this feature you will always have to be prepared 3408So when you want to use this feature you will always have to be prepared
1322that you cannot get an embeddable loop. The recommended way to get around 3409that you cannot get an embeddable loop. The recommended way to get around
1323this is to have a separate variables for your embeddable loop, try to 3410this is to have a separate variables for your embeddable loop, try to
1324create it, and if that fails, use the normal loop for everything: 3411create it, and if that fails, use the normal loop for everything.
1325.PP 3412.PP
1326.Vb 3 3413\fI\f(CI\*(C`ev_embed\*(C'\fI and fork\fR
1327\& struct ev_loop *loop_hi = ev_default_init (0); 3414.IX Subsection "ev_embed and fork"
1328\& struct ev_loop *loop_lo = 0;
1329\& struct ev_embed embed;
1330.Ve
1331.PP 3415.PP
1332.Vb 5 3416While the \f(CW\*(C`ev_embed\*(C'\fR watcher is running, forks in the embedding loop will
1333\& // see if there is a chance of getting one that works 3417automatically be applied to the embedded loop as well, so no special
1334\& // (remember that a flags value of 0 means autodetection) 3418fork handling is required in that case. When the watcher is not running,
1335\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3419however, it is still the task of the libev user to call \f(CW\*(C`ev_loop_fork ()\*(C'\fR
1336\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3420as applicable.
1337\& : 0;
1338.Ve
1339.PP 3421.PP
1340.Vb 8 3422\fIWatcher-Specific Functions and Data Members\fR
1341\& // if we got one, then embed it, otherwise default to loop_hi 3423.IX Subsection "Watcher-Specific Functions and Data Members"
1342\& if (loop_lo)
1343\& {
1344\& ev_embed_init (&embed, 0, loop_lo);
1345\& ev_embed_start (loop_hi, &embed);
1346\& }
1347\& else
1348\& loop_lo = loop_hi;
1349.Ve
1350.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3424.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
1351.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3425.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
1352.PD 0 3426.PD 0
1353.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3427.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
1354.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3428.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
1355.PD 3429.PD
1356Configures the watcher to embed the given loop, which must be 3430Configures the watcher to embed the given loop, which must be
1357embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3431embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
1358invoked automatically, otherwise it is the responsibility of the callback 3432invoked automatically, otherwise it is the responsibility of the callback
1359to invoke it (it will continue to be called until the sweep has been done, 3433to invoke it (it will continue to be called until the sweep has been done,
1360if you do not want thta, you need to temporarily stop the embed watcher). 3434if you do not want that, you need to temporarily stop the embed watcher).
1361.IP "ev_embed_sweep (loop, ev_embed *)" 4 3435.IP "ev_embed_sweep (loop, ev_embed *)" 4
1362.IX Item "ev_embed_sweep (loop, ev_embed *)" 3436.IX Item "ev_embed_sweep (loop, ev_embed *)"
1363Make a single, non-blocking sweep over the embedded loop. This works 3437Make a single, non-blocking sweep over the embedded loop. This works
1364similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 3438similarly to \f(CW\*(C`ev_run (embedded_loop, EVRUN_NOWAIT)\*(C'\fR, but in the most
1365apropriate way for embedded loops. 3439appropriate way for embedded loops.
3440.IP "struct ev_loop *other [read\-only]" 4
3441.IX Item "struct ev_loop *other [read-only]"
3442The embedded event loop.
3443.PP
3444\fIExamples\fR
3445.IX Subsection "Examples"
3446.PP
3447Example: Try to get an embeddable event loop and embed it into the default
3448event loop. If that is not possible, use the default loop. The default
3449loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the embeddable loop is stored in
3450\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the case no embeddable loop can be
3451used).
3452.PP
3453.Vb 3
3454\& struct ev_loop *loop_hi = ev_default_init (0);
3455\& struct ev_loop *loop_lo = 0;
3456\& ev_embed embed;
3457\&
3458\& // see if there is a chance of getting one that works
3459\& // (remember that a flags value of 0 means autodetection)
3460\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3461\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3462\& : 0;
3463\&
3464\& // if we got one, then embed it, otherwise default to loop_hi
3465\& if (loop_lo)
3466\& {
3467\& ev_embed_init (&embed, 0, loop_lo);
3468\& ev_embed_start (loop_hi, &embed);
3469\& }
3470\& else
3471\& loop_lo = loop_hi;
3472.Ve
3473.PP
3474Example: Check if kqueue is available but not recommended and create
3475a kqueue backend for use with sockets (which usually work with any
3476kqueue implementation). Store the kqueue/socket\-only event loop in
3477\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
3478.PP
3479.Vb 3
3480\& struct ev_loop *loop = ev_default_init (0);
3481\& struct ev_loop *loop_socket = 0;
3482\& ev_embed embed;
3483\&
3484\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3485\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3486\& {
3487\& ev_embed_init (&embed, 0, loop_socket);
3488\& ev_embed_start (loop, &embed);
3489\& }
3490\&
3491\& if (!loop_socket)
3492\& loop_socket = loop;
3493\&
3494\& // now use loop_socket for all sockets, and loop for everything else
3495.Ve
3496.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
3497.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
3498.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
3499Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
3500whoever is a good citizen cared to tell libev about it by calling
3501\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
3502and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
3503after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
3504and calls it in the wrong process, the fork handlers will be invoked, too,
3505of course.
3506.PP
3507\fIThe special problem of life after fork \- how is it possible?\fR
3508.IX Subsection "The special problem of life after fork - how is it possible?"
3509.PP
3510Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set
3511up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3512sequence should be handled by libev without any problems.
3513.PP
3514This changes when the application actually wants to do event handling
3515in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3516fork.
3517.PP
3518The default mode of operation (for libev, with application help to detect
3519forks) is to duplicate all the state in the child, as would be expected
3520when \fIeither\fR the parent \fIor\fR the child process continues.
3521.PP
3522When both processes want to continue using libev, then this is usually the
3523wrong result. In that case, usually one process (typically the parent) is
3524supposed to continue with all watchers in place as before, while the other
3525process typically wants to start fresh, i.e. without any active watchers.
3526.PP
3527The cleanest and most efficient way to achieve that with libev is to
3528simply create a new event loop, which of course will be \*(L"empty\*(R", and
3529use that for new watchers. This has the advantage of not touching more
3530memory than necessary, and thus avoiding the copy-on-write, and the
3531disadvantage of having to use multiple event loops (which do not support
3532signal watchers).
3533.PP
3534When this is not possible, or you want to use the default loop for
3535other reasons, then in the process that wants to start \*(L"fresh\*(R", call
3536\&\f(CW\*(C`ev_loop_destroy (EV_DEFAULT)\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR.
3537Destroying the default loop will \*(L"orphan\*(R" (not stop) all registered
3538watchers, so you have to be careful not to execute code that modifies
3539those watchers. Note also that in that case, you have to re-register any
3540signal watchers.
3541.PP
3542\fIWatcher-Specific Functions and Data Members\fR
3543.IX Subsection "Watcher-Specific Functions and Data Members"
3544.IP "ev_fork_init (ev_fork *, callback)" 4
3545.IX Item "ev_fork_init (ev_fork *, callback)"
3546Initialises and configures the fork watcher \- it has no parameters of any
3547kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
3548really.
3549.ie n .SS """ev_cleanup"" \- even the best things end"
3550.el .SS "\f(CWev_cleanup\fP \- even the best things end"
3551.IX Subsection "ev_cleanup - even the best things end"
3552Cleanup watchers are called just before the event loop is being destroyed
3553by a call to \f(CW\*(C`ev_loop_destroy\*(C'\fR.
3554.PP
3555While there is no guarantee that the event loop gets destroyed, cleanup
3556watchers provide a convenient method to install cleanup hooks for your
3557program, worker threads and so on \- you just to make sure to destroy the
3558loop when you want them to be invoked.
3559.PP
3560Cleanup watchers are invoked in the same way as any other watcher. Unlike
3561all other watchers, they do not keep a reference to the event loop (which
3562makes a lot of sense if you think about it). Like all other watchers, you
3563can call libev functions in the callback, except \f(CW\*(C`ev_cleanup_start\*(C'\fR.
3564.PP
3565\fIWatcher-Specific Functions and Data Members\fR
3566.IX Subsection "Watcher-Specific Functions and Data Members"
3567.IP "ev_cleanup_init (ev_cleanup *, callback)" 4
3568.IX Item "ev_cleanup_init (ev_cleanup *, callback)"
3569Initialises and configures the cleanup watcher \- it has no parameters of
3570any kind. There is a \f(CW\*(C`ev_cleanup_set\*(C'\fR macro, but using it is utterly
3571pointless, I assure you.
3572.PP
3573Example: Register an atexit handler to destroy the default loop, so any
3574cleanup functions are called.
3575.PP
3576.Vb 5
3577\& static void
3578\& program_exits (void)
3579\& {
3580\& ev_loop_destroy (EV_DEFAULT_UC);
3581\& }
3582\&
3583\& ...
3584\& atexit (program_exits);
3585.Ve
3586.ie n .SS """ev_async"" \- how to wake up an event loop"
3587.el .SS "\f(CWev_async\fP \- how to wake up an event loop"
3588.IX Subsection "ev_async - how to wake up an event loop"
3589In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
3590asynchronous sources such as signal handlers (as opposed to multiple event
3591loops \- those are of course safe to use in different threads).
3592.PP
3593Sometimes, however, you need to wake up an event loop you do not control,
3594for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR
3595watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you can signal
3596it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3597.PP
3598This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
3599too, are asynchronous in nature, and signals, too, will be compressed
3600(i.e. the number of callback invocations may be less than the number of
3601\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
3602of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3603signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3604even without knowing which loop owns the signal.
3605.PP
3606\fIQueueing\fR
3607.IX Subsection "Queueing"
3608.PP
3609\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
3610is that the author does not know of a simple (or any) algorithm for a
3611multiple-writer-single-reader queue that works in all cases and doesn't
3612need elaborate support such as pthreads or unportable memory access
3613semantics.
3614.PP
3615That means that if you want to queue data, you have to provide your own
3616queue. But at least I can tell you how to implement locking around your
3617queue:
3618.IP "queueing from a signal handler context" 4
3619.IX Item "queueing from a signal handler context"
3620To implement race-free queueing, you simply add to the queue in the signal
3621handler but you block the signal handler in the watcher callback. Here is
3622an example that does that for some fictitious \s-1SIGUSR1\s0 handler:
3623.Sp
3624.Vb 1
3625\& static ev_async mysig;
3626\&
3627\& static void
3628\& sigusr1_handler (void)
3629\& {
3630\& sometype data;
3631\&
3632\& // no locking etc.
3633\& queue_put (data);
3634\& ev_async_send (EV_DEFAULT_ &mysig);
3635\& }
3636\&
3637\& static void
3638\& mysig_cb (EV_P_ ev_async *w, int revents)
3639\& {
3640\& sometype data;
3641\& sigset_t block, prev;
3642\&
3643\& sigemptyset (&block);
3644\& sigaddset (&block, SIGUSR1);
3645\& sigprocmask (SIG_BLOCK, &block, &prev);
3646\&
3647\& while (queue_get (&data))
3648\& process (data);
3649\&
3650\& if (sigismember (&prev, SIGUSR1)
3651\& sigprocmask (SIG_UNBLOCK, &block, 0);
3652\& }
3653.Ve
3654.Sp
3655(Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR
3656instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it
3657either...).
3658.IP "queueing from a thread context" 4
3659.IX Item "queueing from a thread context"
3660The strategy for threads is different, as you cannot (easily) block
3661threads but you can easily preempt them, so to queue safely you need to
3662employ a traditional mutex lock, such as in this pthread example:
3663.Sp
3664.Vb 2
3665\& static ev_async mysig;
3666\& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
3667\&
3668\& static void
3669\& otherthread (void)
3670\& {
3671\& // only need to lock the actual queueing operation
3672\& pthread_mutex_lock (&mymutex);
3673\& queue_put (data);
3674\& pthread_mutex_unlock (&mymutex);
3675\&
3676\& ev_async_send (EV_DEFAULT_ &mysig);
3677\& }
3678\&
3679\& static void
3680\& mysig_cb (EV_P_ ev_async *w, int revents)
3681\& {
3682\& pthread_mutex_lock (&mymutex);
3683\&
3684\& while (queue_get (&data))
3685\& process (data);
3686\&
3687\& pthread_mutex_unlock (&mymutex);
3688\& }
3689.Ve
3690.PP
3691\fIWatcher-Specific Functions and Data Members\fR
3692.IX Subsection "Watcher-Specific Functions and Data Members"
3693.IP "ev_async_init (ev_async *, callback)" 4
3694.IX Item "ev_async_init (ev_async *, callback)"
3695Initialises and configures the async watcher \- it has no parameters of any
3696kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless,
3697trust me.
3698.IP "ev_async_send (loop, ev_async *)" 4
3699.IX Item "ev_async_send (loop, ev_async *)"
3700Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
3701an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop, and instantly
3702returns.
3703.Sp
3704Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads,
3705signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the
3706embedding section below on what exactly this means).
3707.Sp
3708Note that, as with other watchers in libev, multiple events might get
3709compressed into a single callback invocation (another way to look at
3710this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on
3711\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that).
3712.Sp
3713This call incurs the overhead of at most one extra system call per event
3714loop iteration, if the event loop is blocked, and no syscall at all if
3715the event loop (or your program) is processing events. That means that
3716repeated calls are basically free (there is no need to avoid calls for
3717performance reasons) and that the overhead becomes smaller (typically
3718zero) under load.
3719.IP "bool = ev_async_pending (ev_async *)" 4
3720.IX Item "bool = ev_async_pending (ev_async *)"
3721Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
3722watcher but the event has not yet been processed (or even noted) by the
3723event loop.
3724.Sp
3725\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
3726the loop iterates next and checks for the watcher to have become active,
3727it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
3728quickly check whether invoking the loop might be a good idea.
3729.Sp
3730Not that this does \fInot\fR check whether the watcher itself is pending,
3731only whether it has been requested to make this watcher pending: there
3732is a time window between the event loop checking and resetting the async
3733notification, and the callback being invoked.
1366.SH "OTHER FUNCTIONS" 3734.SH "OTHER FUNCTIONS"
1367.IX Header "OTHER FUNCTIONS" 3735.IX Header "OTHER FUNCTIONS"
1368There are some other functions of possible interest. Described. Here. Now. 3736There are some other functions of possible interest. Described. Here. Now.
1369.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3737.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" 4
1370.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3738.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)"
1371This function combines a simple timer and an I/O watcher, calls your 3739This function combines a simple timer and an I/O watcher, calls your
1372callback on whichever event happens first and automatically stop both 3740callback on whichever event happens first and automatically stops both
1373watchers. This is useful if you want to wait for a single event on an fd 3741watchers. This is useful if you want to wait for a single event on an fd
1374or timeout without having to allocate/configure/start/stop/free one or 3742or timeout without having to allocate/configure/start/stop/free one or
1375more watchers yourself. 3743more watchers yourself.
1376.Sp 3744.Sp
1377If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events 3745If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and the
1378is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and 3746\&\f(CW\*(C`events\*(C'\fR argument is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for
1379\&\f(CW\*(C`events\*(C'\fR set will be craeted and started. 3747the given \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`events\*(C'\fR set will be created and started.
1380.Sp 3748.Sp
1381If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be 3749If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be
1382started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and 3750started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and
1383repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of 3751repeat = 0) will be started. \f(CW0\fR is a valid timeout.
1384dubious value.
1385.Sp 3752.Sp
1386The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets 3753The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and is
1387passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of 3754passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of
1388\&\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_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR 3755\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
1389value passed to \f(CW\*(C`ev_once\*(C'\fR: 3756value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3757a timeout and an io event at the same time \- you probably should give io
3758events precedence.
3759.Sp
3760Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
1390.Sp 3761.Sp
1391.Vb 7 3762.Vb 7
1392\& static void stdin_ready (int revents, void *arg) 3763\& static void stdin_ready (int revents, void *arg)
3764\& {
3765\& if (revents & EV_READ)
3766\& /* stdin might have data for us, joy! */;
3767\& else if (revents & EV_TIMER)
3768\& /* doh, nothing entered */;
3769\& }
3770\&
3771\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3772.Ve
3773.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
3774.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
3775Feed an event on the given fd, as if a file descriptor backend detected
3776the given events.
3777.IP "ev_feed_signal_event (loop, int signum)" 4
3778.IX Item "ev_feed_signal_event (loop, int signum)"
3779Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
3780which is async-safe.
3781.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3782.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3783This section explains some common idioms that are not immediately
3784obvious. Note that examples are sprinkled over the whole manual, and this
3785section only contains stuff that wouldn't fit anywhere else.
3786.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3787.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3788Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3789or modify at any time: libev will completely ignore it. This can be used
3790to associate arbitrary data with your watcher. If you need more data and
3791don't want to allocate memory separately and store a pointer to it in that
3792data member, you can also \*(L"subclass\*(R" the watcher type and provide your own
3793data:
3794.PP
3795.Vb 7
3796\& struct my_io
3797\& {
3798\& ev_io io;
3799\& int otherfd;
3800\& void *somedata;
3801\& struct whatever *mostinteresting;
3802\& };
3803\&
3804\& ...
3805\& struct my_io w;
3806\& ev_io_init (&w.io, my_cb, fd, EV_READ);
3807.Ve
3808.PP
3809And since your callback will be called with a pointer to the watcher, you
3810can cast it back to your own type:
3811.PP
3812.Vb 5
3813\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
3814\& {
3815\& struct my_io *w = (struct my_io *)w_;
3816\& ...
3817\& }
3818.Ve
3819.PP
3820More interesting and less C\-conformant ways of casting your callback
3821function type instead have been omitted.
3822.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3823.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3824Another common scenario is to use some data structure with multiple
3825embedded watchers, in effect creating your own watcher that combines
3826multiple libev event sources into one \*(L"super-watcher\*(R":
3827.PP
3828.Vb 6
3829\& struct my_biggy
3830\& {
3831\& int some_data;
3832\& ev_timer t1;
3833\& ev_timer t2;
3834\& }
3835.Ve
3836.PP
3837In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
3838complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct in
3839the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies or \*(C+ coders), or you need
3840to use some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for
3841real programmers):
3842.PP
3843.Vb 1
3844\& #include <stddef.h>
3845\&
3846\& static void
3847\& t1_cb (EV_P_ ev_timer *w, int revents)
3848\& {
3849\& struct my_biggy big = (struct my_biggy *)
3850\& (((char *)w) \- offsetof (struct my_biggy, t1));
3851\& }
3852\&
3853\& static void
3854\& t2_cb (EV_P_ ev_timer *w, int revents)
3855\& {
3856\& struct my_biggy big = (struct my_biggy *)
3857\& (((char *)w) \- offsetof (struct my_biggy, t2));
3858\& }
3859.Ve
3860.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3861.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3862Often you have structures like this in event-based programs:
3863.PP
3864.Vb 4
3865\& callback ()
1393\& { 3866\& {
1394\& if (revents & EV_TIMEOUT) 3867\& free (request);
1395\& /* doh, nothing entered */;
1396\& else if (revents & EV_READ)
1397\& /* stdin might have data for us, joy! */;
1398\& } 3868\& }
3869\&
3870\& request = start_new_request (..., callback);
1399.Ve 3871.Ve
1400.Sp 3872.PP
3873The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be
3874used to cancel the operation, or do other things with it.
3875.PP
3876It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that
3877immediately invoke the callback, for example, to report errors. Or you add
3878some caching layer that finds that it can skip the lengthy aspects of the
3879operation and simply invoke the callback with the result.
3880.PP
3881The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR
3882has returned, so \f(CW\*(C`request\*(C'\fR is not set.
3883.PP
3884Even if you pass the request by some safer means to the callback, you
3885might want to do something to the request after starting it, such as
3886canceling it, which probably isn't working so well when the callback has
3887already been invoked.
3888.PP
3889A common way around all these issues is to make sure that
3890\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3891\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3892delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3893example, or more sneakily, by reusing an existing (stopped) watcher and
3894pushing it into the pending queue:
3895.PP
1401.Vb 1 3896.Vb 2
1402\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3897\& ev_set_cb (watcher, callback);
3898\& ev_feed_event (EV_A_ watcher, 0);
1403.Ve 3899.Ve
1404.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 3900.PP
1405.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" 3901This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
1406Feeds the given event set into the event loop, as if the specified event 3902invoked, while not delaying callback invocation too much.
1407had happened for the specified watcher (which must be a pointer to an 3903.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
1408initialised but not necessarily started event watcher). 3904.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
1409.IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4 3905Often (especially in \s-1GUI\s0 toolkits) there are places where you have
1410.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" 3906\&\fImodal\fR interaction, which is most easily implemented by recursively
1411Feed an event on the given fd, as if a file descriptor backend detected 3907invoking \f(CW\*(C`ev_run\*(C'\fR.
1412the given events it. 3908.PP
1413.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 3909This brings the problem of exiting \- a callback might want to finish the
1414.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" 3910main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
1415Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default 3911a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
1416loop!). 3912and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3913other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3914.PP
3915The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3916invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3917triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3918.PP
3919.Vb 2
3920\& // main loop
3921\& int exit_main_loop = 0;
3922\&
3923\& while (!exit_main_loop)
3924\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3925\&
3926\& // in a modal watcher
3927\& int exit_nested_loop = 0;
3928\&
3929\& while (!exit_nested_loop)
3930\& ev_run (EV_A_ EVRUN_ONCE);
3931.Ve
3932.PP
3933To exit from any of these loops, just set the corresponding exit variable:
3934.PP
3935.Vb 2
3936\& // exit modal loop
3937\& exit_nested_loop = 1;
3938\&
3939\& // exit main program, after modal loop is finished
3940\& exit_main_loop = 1;
3941\&
3942\& // exit both
3943\& exit_main_loop = exit_nested_loop = 1;
3944.Ve
3945.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3946.IX Subsection "THREAD LOCKING EXAMPLE"
3947Here is a fictitious example of how to run an event loop in a different
3948thread from where callbacks are being invoked and watchers are
3949created/added/removed.
3950.PP
3951For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
3952which uses exactly this technique (which is suited for many high-level
3953languages).
3954.PP
3955The example uses a pthread mutex to protect the loop data, a condition
3956variable to wait for callback invocations, an async watcher to notify the
3957event loop thread and an unspecified mechanism to wake up the main thread.
3958.PP
3959First, you need to associate some data with the event loop:
3960.PP
3961.Vb 6
3962\& typedef struct {
3963\& mutex_t lock; /* global loop lock */
3964\& ev_async async_w;
3965\& thread_t tid;
3966\& cond_t invoke_cv;
3967\& } userdata;
3968\&
3969\& void prepare_loop (EV_P)
3970\& {
3971\& // for simplicity, we use a static userdata struct.
3972\& static userdata u;
3973\&
3974\& ev_async_init (&u\->async_w, async_cb);
3975\& ev_async_start (EV_A_ &u\->async_w);
3976\&
3977\& pthread_mutex_init (&u\->lock, 0);
3978\& pthread_cond_init (&u\->invoke_cv, 0);
3979\&
3980\& // now associate this with the loop
3981\& ev_set_userdata (EV_A_ u);
3982\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3983\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3984\&
3985\& // then create the thread running ev_run
3986\& pthread_create (&u\->tid, 0, l_run, EV_A);
3987\& }
3988.Ve
3989.PP
3990The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3991solely to wake up the event loop so it takes notice of any new watchers
3992that might have been added:
3993.PP
3994.Vb 5
3995\& static void
3996\& async_cb (EV_P_ ev_async *w, int revents)
3997\& {
3998\& // just used for the side effects
3999\& }
4000.Ve
4001.PP
4002The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
4003protecting the loop data, respectively.
4004.PP
4005.Vb 6
4006\& static void
4007\& l_release (EV_P)
4008\& {
4009\& userdata *u = ev_userdata (EV_A);
4010\& pthread_mutex_unlock (&u\->lock);
4011\& }
4012\&
4013\& static void
4014\& l_acquire (EV_P)
4015\& {
4016\& userdata *u = ev_userdata (EV_A);
4017\& pthread_mutex_lock (&u\->lock);
4018\& }
4019.Ve
4020.PP
4021The event loop thread first acquires the mutex, and then jumps straight
4022into \f(CW\*(C`ev_run\*(C'\fR:
4023.PP
4024.Vb 4
4025\& void *
4026\& l_run (void *thr_arg)
4027\& {
4028\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
4029\&
4030\& l_acquire (EV_A);
4031\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4032\& ev_run (EV_A_ 0);
4033\& l_release (EV_A);
4034\&
4035\& return 0;
4036\& }
4037.Ve
4038.PP
4039Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
4040signal the main thread via some unspecified mechanism (signals? pipe
4041writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
4042have been called (in a while loop because a) spurious wakeups are possible
4043and b) skipping inter-thread-communication when there are no pending
4044watchers is very beneficial):
4045.PP
4046.Vb 4
4047\& static void
4048\& l_invoke (EV_P)
4049\& {
4050\& userdata *u = ev_userdata (EV_A);
4051\&
4052\& while (ev_pending_count (EV_A))
4053\& {
4054\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4055\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
4056\& }
4057\& }
4058.Ve
4059.PP
4060Now, whenever the main thread gets told to invoke pending watchers, it
4061will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
4062thread to continue:
4063.PP
4064.Vb 4
4065\& static void
4066\& real_invoke_pending (EV_P)
4067\& {
4068\& userdata *u = ev_userdata (EV_A);
4069\&
4070\& pthread_mutex_lock (&u\->lock);
4071\& ev_invoke_pending (EV_A);
4072\& pthread_cond_signal (&u\->invoke_cv);
4073\& pthread_mutex_unlock (&u\->lock);
4074\& }
4075.Ve
4076.PP
4077Whenever you want to start/stop a watcher or do other modifications to an
4078event loop, you will now have to lock:
4079.PP
4080.Vb 2
4081\& ev_timer timeout_watcher;
4082\& userdata *u = ev_userdata (EV_A);
4083\&
4084\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4085\&
4086\& pthread_mutex_lock (&u\->lock);
4087\& ev_timer_start (EV_A_ &timeout_watcher);
4088\& ev_async_send (EV_A_ &u\->async_w);
4089\& pthread_mutex_unlock (&u\->lock);
4090.Ve
4091.PP
4092Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
4093an event loop currently blocking in the kernel will have no knowledge
4094about the newly added timer. By waking up the loop it will pick up any new
4095watchers in the next event loop iteration.
4096.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
4097.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
4098While the overhead of a callback that e.g. schedules a thread is small, it
4099is still an overhead. If you embed libev, and your main usage is with some
4100kind of threads or coroutines, you might want to customise libev so that
4101doesn't need callbacks anymore.
4102.PP
4103Imagine you have coroutines that you can switch to using a function
4104\&\f(CW\*(C`switch_to (coro)\*(C'\fR, that libev runs in a coroutine called \f(CW\*(C`libev_coro\*(C'\fR
4105and that due to some magic, the currently active coroutine is stored in a
4106global called \f(CW\*(C`current_coro\*(C'\fR. Then you can build your own \*(L"wait for libev
4107event\*(R" primitive by changing \f(CW\*(C`EV_CB_DECLARE\*(C'\fR and \f(CW\*(C`EV_CB_INVOKE\*(C'\fR (note
4108the differing \f(CW\*(C`;\*(C'\fR conventions):
4109.PP
4110.Vb 2
4111\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4112\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4113.Ve
4114.PP
4115That means instead of having a C callback function, you store the
4116coroutine to switch to in each watcher, and instead of having libev call
4117your callback, you instead have it switch to that coroutine.
4118.PP
4119A coroutine might now wait for an event with a function called
4120\&\f(CW\*(C`wait_for_event\*(C'\fR. (the watcher needs to be started, as always, but it doesn't
4121matter when, or whether the watcher is active or not when this function is
4122called):
4123.PP
4124.Vb 6
4125\& void
4126\& wait_for_event (ev_watcher *w)
4127\& {
4128\& ev_set_cb (w, current_coro);
4129\& switch_to (libev_coro);
4130\& }
4131.Ve
4132.PP
4133That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
4134continues the libev coroutine, which, when appropriate, switches back to
4135this or any other coroutine.
4136.PP
4137You can do similar tricks if you have, say, threads with an event queue \-
4138instead of storing a coroutine, you store the queue object and instead of
4139switching to a coroutine, you push the watcher onto the queue and notify
4140any waiters.
4141.PP
4142To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
4143files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
4144.PP
4145.Vb 4
4146\& // my_ev.h
4147\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4148\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4149\& #include "../libev/ev.h"
4150\&
4151\& // my_ev.c
4152\& #define EV_H "my_ev.h"
4153\& #include "../libev/ev.c"
4154.Ve
4155.PP
4156And then use \fImy_ev.h\fR when you would normally use \fIev.h\fR, and compile
4157\&\fImy_ev.c\fR into your project. When properly specifying include paths, you
4158can even use \fIev.h\fR as header file name directly.
1417.SH "LIBEVENT EMULATION" 4159.SH "LIBEVENT EMULATION"
1418.IX Header "LIBEVENT EMULATION" 4160.IX Header "LIBEVENT EMULATION"
1419Libev offers a compatibility emulation layer for libevent. It cannot 4161Libev offers a compatibility emulation layer for libevent. It cannot
1420emulate the internals of libevent, so here are some usage hints: 4162emulate the internals of libevent, so here are some usage hints:
4163.IP "\(bu" 4
4164Only the libevent\-1.4.1\-beta \s-1API\s0 is being emulated.
4165.Sp
4166This was the newest libevent version available when libev was implemented,
4167and is still mostly unchanged in 2010.
4168.IP "\(bu" 4
1421.IP "* Use it by including <event.h>, as usual." 4 4169Use it by including <event.h>, as usual.
1422.IX Item "Use it by including <event.h>, as usual." 4170.IP "\(bu" 4
1423.PD 0 4171The following members are fully supported: ev_base, ev_callback,
1424.IP "* The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4 4172ev_arg, ev_fd, ev_res, ev_events.
1425.IX Item "The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4173.IP "\(bu" 4
1426.IP "* Avoid using ev_flags and the EVLIST_*\-macros, while it is maintained by libev, it does not work exactly the same way as in libevent (consider it a private \s-1API\s0)." 4 4174Avoid using ev_flags and the EVLIST_*\-macros, while it is
1427.IX Item "Avoid using ev_flags and the EVLIST_*-macros, while it is maintained by libev, it does not work exactly the same way as in libevent (consider it a private API)." 4175maintained by libev, it does not work exactly the same way as in libevent (consider
1428.IP "* Priorities are not currently supported. Initialising priorities will fail and all watchers will have the same priority, even though there is an ev_pri field." 4 4176it a private \s-1API\s0).
1429.IX Item "Priorities are not currently supported. Initialising priorities will fail and all watchers will have the same priority, even though there is an ev_pri field." 4177.IP "\(bu" 4
4178Priorities are not currently supported. Initialising priorities
4179will fail and all watchers will have the same priority, even though there
4180is an ev_pri field.
4181.IP "\(bu" 4
4182In libevent, the last base created gets the signals, in libev, the
4183base that registered the signal gets the signals.
4184.IP "\(bu" 4
1430.IP "* Other members are not supported." 4 4185Other members are not supported.
1431.IX Item "Other members are not supported." 4186.IP "\(bu" 4
1432.IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 4187The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
1433.IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." 4188to use the libev header file and library.
1434.PD
1435.SH "\*(C+ SUPPORT" 4189.SH "\*(C+ SUPPORT"
1436.IX Header " SUPPORT" 4190.IX Header " SUPPORT"
4191.SS "C \s-1API\s0"
4192.IX Subsection "C API"
4193The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4194libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4195will work fine.
4196.PP
4197Proper exception specifications might have to be added to callbacks passed
4198to libev: exceptions may be thrown only from watcher callbacks, all other
4199callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4200callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4201specification. If you have code that needs to be compiled as both C and
4202\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4203.PP
4204.Vb 6
4205\& static void
4206\& fatal_error (const char *msg) EV_NOEXCEPT
4207\& {
4208\& perror (msg);
4209\& abort ();
4210\& }
4211\&
4212\& ...
4213\& ev_set_syserr_cb (fatal_error);
4214.Ve
4215.PP
4216The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4217\&\f(CW\*(C`ev_invoke\*(C'\fR, \f(CW\*(C`ev_invoke_pending\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR (the latter
4218because it runs cleanup watchers).
4219.PP
4220Throwing exceptions in watcher callbacks is only supported if libev itself
4221is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4222throwing exceptions through C libraries (most do).
4223.SS "\*(C+ \s-1API\s0"
4224.IX Subsection " API"
1437Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4225Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
1438you to use some convinience methods to start/stop watchers and also change 4226you to use some convenience methods to start/stop watchers and also change
1439the callback model to a model using method callbacks on objects. 4227the callback model to a model using method callbacks on objects.
1440.PP 4228.PP
1441To use it, 4229To use it,
1442.PP 4230.PP
1443.Vb 1 4231.Vb 1
1444\& #include <ev++.h> 4232\& #include <ev++.h>
1445.Ve 4233.Ve
1446.PP 4234.PP
1447(it is not installed by default). This automatically includes \fIev.h\fR 4235This automatically includes \fIev.h\fR and puts all of its definitions (many
1448and puts all of its definitions (many of them macros) into the global 4236of them macros) into the global namespace. All \*(C+ specific things are
1449namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. 4237put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
4238options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
1450.PP 4239.PP
1451It should support all the same embedding options as \fIev.h\fR, most notably 4240Care has been taken to keep the overhead low. The only data member the \*(C+
1452\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. 4241classes add (compared to plain C\-style watchers) is the event loop pointer
4242that the watcher is associated with (or no additional members at all if
4243you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
4244.PP
4245Currently, functions, static and non-static member functions and classes
4246with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
4247to add as long as they only need one additional pointer for context. If
4248you need support for other types of functors please contact the author
4249(preferably after implementing it).
4250.PP
4251For all this to work, your \*(C+ compiler either has to use the same calling
4252conventions as your C compiler (for static member functions), or you have
4253to embed libev and compile libev itself as \*(C+.
1453.PP 4254.PP
1454Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4255Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
1455.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 4256.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
1456.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4257.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
1457.IX Item "ev::READ, ev::WRITE etc." 4258.IX Item "ev::READ, ev::WRITE etc."
1458These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. 4259These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc.
1459macros from \fIev.h\fR. 4260macros from \fIev.h\fR.
1460.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 4261.ie n .IP """ev::tstamp"", ""ev::now""" 4
1461.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 4262.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4
1462.IX Item "ev::tstamp, ev::now" 4263.IX Item "ev::tstamp, ev::now"
1463Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. 4264Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix.
1464.ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4 4265.ie n .IP """ev::io"", ""ev::timer"", ""ev::periodic"", ""ev::idle"", ""ev::sig"" etc." 4
1465.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 4266.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
1466.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 4267.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
1467For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 4268For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
1468the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 4269the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
1469which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 4270which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
1470defines by many implementations. 4271defined by many implementations.
1471.Sp 4272.Sp
1472All of those classes have these methods: 4273All of those classes have these methods:
1473.RS 4 4274.RS 4
1474.IP "ev::TYPE::TYPE (object *, object::method *)" 4 4275.IP "ev::TYPE::TYPE ()" 4
1475.IX Item "ev::TYPE::TYPE (object *, object::method *)" 4276.IX Item "ev::TYPE::TYPE ()"
1476.PD 0 4277.PD 0
1477.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 4278.IP "ev::TYPE::TYPE (loop)" 4
1478.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4279.IX Item "ev::TYPE::TYPE (loop)"
1479.IP "ev::TYPE::~TYPE" 4 4280.IP "ev::TYPE::~TYPE" 4
1480.IX Item "ev::TYPE::~TYPE" 4281.IX Item "ev::TYPE::~TYPE"
1481.PD 4282.PD
1482The constructor takes a pointer to an object and a method pointer to 4283The constructor (optionally) takes an event loop to associate the watcher
1483the event handler callback to call in this class. The constructor calls 4284with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
1484\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method 4285.Sp
1485before starting it. If you do not specify a loop then the constructor 4286The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the
1486automatically associates the default loop with this watcher. 4287\&\f(CW\*(C`set\*(C'\fR method before starting it.
4288.Sp
4289It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR
4290method to set a callback before you can start the watcher.
4291.Sp
4292(The reason why you have to use a method is a limitation in \*(C+ which does
4293not allow explicit template arguments for constructors).
1487.Sp 4294.Sp
1488The destructor automatically stops the watcher if it is active. 4295The destructor automatically stops the watcher if it is active.
4296.IP "w\->set<class, &class::method> (object *)" 4
4297.IX Item "w->set<class, &class::method> (object *)"
4298This method sets the callback method to call. The method has to have a
4299signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as
4300first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as
4301parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher.
4302.Sp
4303This method synthesizes efficient thunking code to call your method from
4304the C callback that libev requires. If your compiler can inline your
4305callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and
4306your compiler is good :), then the method will be fully inlined into the
4307thunking function, making it as fast as a direct C callback.
4308.Sp
4309Example: simple class declaration and watcher initialisation
4310.Sp
4311.Vb 4
4312\& struct myclass
4313\& {
4314\& void io_cb (ev::io &w, int revents) { }
4315\& }
4316\&
4317\& myclass obj;
4318\& ev::io iow;
4319\& iow.set <myclass, &myclass::io_cb> (&obj);
4320.Ve
4321.IP "w\->set (object *)" 4
4322.IX Item "w->set (object *)"
4323This is a variation of a method callback \- leaving out the method to call
4324will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use
4325functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all
4326the time. Incidentally, you can then also leave out the template argument
4327list.
4328.Sp
4329The \f(CW\*(C`operator ()\*(C'\fR method prototype must be \f(CW\*(C`void operator ()(watcher &w,
4330int revents)\*(C'\fR.
4331.Sp
4332See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
4333.Sp
4334Example: use a functor object as callback.
4335.Sp
4336.Vb 7
4337\& struct myfunctor
4338\& {
4339\& void operator() (ev::io &w, int revents)
4340\& {
4341\& ...
4342\& }
4343\& }
4344\&
4345\& myfunctor f;
4346\&
4347\& ev::io w;
4348\& w.set (&f);
4349.Ve
4350.IP "w\->set<function> (void *data = 0)" 4
4351.IX Item "w->set<function> (void *data = 0)"
4352Also sets a callback, but uses a static method or plain function as
4353callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
4354\&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
4355.Sp
4356The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
4357.Sp
4358See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
4359.Sp
4360Example: Use a plain function as callback.
4361.Sp
4362.Vb 2
4363\& static void io_cb (ev::io &w, int revents) { }
4364\& iow.set <io_cb> ();
4365.Ve
1489.IP "w\->set (struct ev_loop *)" 4 4366.IP "w\->set (loop)" 4
1490.IX Item "w->set (struct ev_loop *)" 4367.IX Item "w->set (loop)"
1491Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4368Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
1492do this when the watcher is inactive (and not pending either). 4369do this when the watcher is inactive (and not pending either).
1493.IP "w\->set ([args])" 4 4370.IP "w\->set ([arguments])" 4
1494.IX Item "w->set ([args])" 4371.IX Item "w->set ([arguments])"
1495Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be 4372Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4373with the same arguments. Either this method or a suitable start method
1496called at least once. Unlike the C counterpart, an active watcher gets 4374must be called at least once. Unlike the C counterpart, an active watcher
1497automatically stopped and restarted. 4375gets automatically stopped and restarted when reconfiguring it with this
4376method.
4377.Sp
4378For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4379clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
1498.IP "w\->start ()" 4 4380.IP "w\->start ()" 4
1499.IX Item "w->start ()" 4381.IX Item "w->start ()"
1500Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the 4382Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
1501constructor already takes the loop. 4383constructor already stores the event loop.
4384.IP "w\->start ([arguments])" 4
4385.IX Item "w->start ([arguments])"
4386Instead of calling \f(CW\*(C`set\*(C'\fR and \f(CW\*(C`start\*(C'\fR methods separately, it is often
4387convenient to wrap them in one call. Uses the same type of arguments as
4388the configure \f(CW\*(C`set\*(C'\fR method of the watcher.
1502.IP "w\->stop ()" 4 4389.IP "w\->stop ()" 4
1503.IX Item "w->stop ()" 4390.IX Item "w->stop ()"
1504Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 4391Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
1505.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 4392.ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4
1506.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 4393.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4
1507.IX Item "w->again () ev::timer, ev::periodic only" 4394.IX Item "w->again () (ev::timer, ev::periodic only)"
1508For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding 4395For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding
1509\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. 4396\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
1510.ie n .IP "w\->sweep () ""ev::embed"" only" 4 4397.ie n .IP "w\->sweep () (""ev::embed"" only)" 4
1511.el .IP "w\->sweep () \f(CWev::embed\fR only" 4 4398.el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4
1512.IX Item "w->sweep () ev::embed only" 4399.IX Item "w->sweep () (ev::embed only)"
1513Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. 4400Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR.
4401.ie n .IP "w\->update () (""ev::stat"" only)" 4
4402.el .IP "w\->update () (\f(CWev::stat\fR only)" 4
4403.IX Item "w->update () (ev::stat only)"
4404Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
1514.RE 4405.RE
1515.RS 4 4406.RS 4
1516.RE 4407.RE
1517.PP 4408.PP
1518Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 4409Example: Define a class with two I/O and idle watchers, start the I/O
1519the constructor. 4410watchers in the constructor.
1520.PP 4411.PP
1521.Vb 4 4412.Vb 5
1522\& class myclass 4413\& class myclass
1523\& { 4414\& {
1524\& ev_io io; void io_cb (ev::io &w, int revents); 4415\& ev::io io ; void io_cb (ev::io &w, int revents);
4416\& ev::io io2 ; void io2_cb (ev::io &w, int revents);
1525\& ev_idle idle void idle_cb (ev::idle &w, int revents); 4417\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
4418\&
4419\& myclass (int fd)
4420\& {
4421\& io .set <myclass, &myclass::io_cb > (this);
4422\& io2 .set <myclass, &myclass::io2_cb > (this);
4423\& idle.set <myclass, &myclass::idle_cb> (this);
4424\&
4425\& io.set (fd, ev::WRITE); // configure the watcher
4426\& io.start (); // start it whenever convenient
4427\&
4428\& io2.start (fd, ev::READ); // set + start in one call
4429\& }
4430\& };
1526.Ve 4431.Ve
4432.SH "OTHER LANGUAGE BINDINGS"
4433.IX Header "OTHER LANGUAGE BINDINGS"
4434Libev does not offer other language bindings itself, but bindings for a
4435number of languages exist in the form of third-party packages. If you know
4436any interesting language binding in addition to the ones listed here, drop
4437me a note.
4438.IP "Perl" 4
4439.IX Item "Perl"
4440The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test
4441libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module,
4442there are additional modules that implement libev-compatible interfaces
4443to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
4444\&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR
4445and \f(CW\*(C`EV::Glib\*(C'\fR).
4446.Sp
4447It can be found and installed via \s-1CPAN,\s0 its homepage is at
4448<http://software.schmorp.de/pkg/EV>.
4449.IP "Python" 4
4450.IX Item "Python"
4451Python bindings can be found at <http://code.google.com/p/pyev/>. It
4452seems to be quite complete and well-documented.
4453.IP "Ruby" 4
4454.IX Item "Ruby"
4455Tony Arcieri has written a ruby extension that offers access to a subset
4456of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and
4457more on top of it. It can be found via gem servers. Its homepage is at
4458<http://rev.rubyforge.org/>.
4459.Sp
4460Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
4461makes rev work even on mingw.
4462.IP "Haskell" 4
4463.IX Item "Haskell"
4464A haskell binding to libev is available at
4465<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4466.IP "D" 4
4467.IX Item "D"
4468Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4469be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4470.IP "Ocaml" 4
4471.IX Item "Ocaml"
4472Erkki Seppala has written Ocaml bindings for libev, to be found at
4473<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4474.IP "Lua" 4
4475.IX Item "Lua"
4476Brian Maher has written a partial interface to libev for lua (at the
4477time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4478<http://github.com/brimworks/lua\-ev>.
4479.IP "Javascript" 4
4480.IX Item "Javascript"
4481Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4482.IP "Others" 4
4483.IX Item "Others"
4484There are others, and I stopped counting.
4485.SH "MACRO MAGIC"
4486.IX Header "MACRO MAGIC"
4487Libev can be compiled with a variety of options, the most fundamental
4488of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
4489functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
1527.PP 4490.PP
4491To make it easier to write programs that cope with either variant, the
4492following macros are defined:
4493.ie n .IP """EV_A"", ""EV_A_""" 4
4494.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
4495.IX Item "EV_A, EV_A_"
4496This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
4497loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
4498\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
4499.Sp
4500.Vb 3
4501\& ev_unref (EV_A);
4502\& ev_timer_add (EV_A_ watcher);
4503\& ev_run (EV_A_ 0);
4504.Ve
4505.Sp
4506It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
4507which is often provided by the following macro.
4508.ie n .IP """EV_P"", ""EV_P_""" 4
4509.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
4510.IX Item "EV_P, EV_P_"
4511This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
4512loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
4513\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
4514.Sp
1528.Vb 2 4515.Vb 2
1529\& myclass (); 4516\& // this is how ev_unref is being declared
1530\& } 4517\& static void ev_unref (EV_P);
4518\&
4519\& // this is how you can declare your typical callback
4520\& static void cb (EV_P_ ev_timer *w, int revents)
1531.Ve 4521.Ve
4522.Sp
4523It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
4524suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
4525.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
4526.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
4527.IX Item "EV_DEFAULT, EV_DEFAULT_"
4528Similar to the other two macros, this gives you the value of the default
4529loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop
4530will be initialised if it isn't already initialised.
4531.Sp
4532For non-multiplicity builds, these macros do nothing, so you always have
4533to initialise the loop somewhere.
4534.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
4535.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
4536.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
4537Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
4538default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
4539is undefined when the default loop has not been initialised by a previous
4540execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR.
4541.Sp
4542It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first
4543watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards.
1532.PP 4544.PP
4545Example: Declare and initialise a check watcher, utilising the above
4546macros so it will work regardless of whether multiple loops are supported
4547or not.
4548.PP
1533.Vb 6 4549.Vb 5
1534\& myclass::myclass (int fd) 4550\& static void
1535\& : io (this, &myclass::io_cb), 4551\& check_cb (EV_P_ ev_timer *w, int revents)
1536\& idle (this, &myclass::idle_cb)
1537\& { 4552\& {
1538\& io.start (fd, ev::READ); 4553\& ev_check_stop (EV_A_ w);
1539\& } 4554\& }
4555\&
4556\& ev_check check;
4557\& ev_check_init (&check, check_cb);
4558\& ev_check_start (EV_DEFAULT_ &check);
4559\& ev_run (EV_DEFAULT_ 0);
1540.Ve 4560.Ve
1541.SH "EMBEDDING" 4561.SH "EMBEDDING"
1542.IX Header "EMBEDDING" 4562.IX Header "EMBEDDING"
1543Libev can (and often is) directly embedded into host 4563Libev can (and often is) directly embedded into host
1544applications. Examples of applications that embed it include the Deliantra 4564applications. Examples of applications that embed it include the Deliantra
1545Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) 4565Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe)
1546and rxvt\-unicode. 4566and rxvt-unicode.
1547.PP 4567.PP
1548The goal is to enable you to just copy the neecssary files into your 4568The goal is to enable you to just copy the necessary files into your
1549source directory without having to change even a single line in them, so 4569source directory without having to change even a single line in them, so
1550you can easily upgrade by simply copying (or having a checked-out copy of 4570you can easily upgrade by simply copying (or having a checked-out copy of
1551libev somewhere in your source tree). 4571libev somewhere in your source tree).
1552.Sh "\s-1FILESETS\s0" 4572.SS "\s-1FILESETS\s0"
1553.IX Subsection "FILESETS" 4573.IX Subsection "FILESETS"
1554Depending on what features you need you need to include one or more sets of files 4574Depending on what features you need you need to include one or more sets of files
1555in your app. 4575in your application.
1556.PP 4576.PP
1557\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4577\fI\s-1CORE EVENT LOOP\s0\fR
1558.IX Subsection "CORE EVENT LOOP" 4578.IX Subsection "CORE EVENT LOOP"
1559.PP 4579.PP
1560To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4580To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
1561configuration (no autoconf): 4581configuration (no autoconf):
1562.PP 4582.PP
1563.Vb 2 4583.Vb 2
1564\& #define EV_STANDALONE 1 4584\& #define EV_STANDALONE 1
1565\& #include "ev.c" 4585\& #include "ev.c"
1566.Ve 4586.Ve
1567.PP 4587.PP
1568This will automatically include \fIev.h\fR, too, and should be done in a 4588This will automatically include \fIev.h\fR, too, and should be done in a
1569single C source file only to provide the function implementations. To use 4589single C source file only to provide the function implementations. To use
1570it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best 4590it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
1571done by writing a wrapper around \fIev.h\fR that you can include instead and 4591done by writing a wrapper around \fIev.h\fR that you can include instead and
1572where you can put other configuration options): 4592where you can put other configuration options):
1573.PP 4593.PP
1574.Vb 2 4594.Vb 2
1575\& #define EV_STANDALONE 1 4595\& #define EV_STANDALONE 1
1576\& #include "ev.h" 4596\& #include "ev.h"
1577.Ve 4597.Ve
1578.PP 4598.PP
1579Both header files and implementation files can be compiled with a \*(C+ 4599Both header files and implementation files can be compiled with a \*(C+
1580compiler (at least, thats a stated goal, and breakage will be treated 4600compiler (at least, that's a stated goal, and breakage will be treated
1581as a bug). 4601as a bug).
1582.PP 4602.PP
1583You need the following files in your source tree, or in a directory 4603You need the following files in your source tree, or in a directory
1584in your include path (e.g. in libev/ when using \-Ilibev): 4604in your include path (e.g. in libev/ when using \-Ilibev):
1585.PP 4605.PP
1586.Vb 4 4606.Vb 4
1587\& ev.h 4607\& ev.h
1588\& ev.c 4608\& ev.c
1589\& ev_vars.h 4609\& ev_vars.h
1590\& ev_wrap.h 4610\& ev_wrap.h
4611\&
4612\& ev_win32.c required on win32 platforms only
4613\&
4614\& ev_select.c only when select backend is enabled
4615\& ev_poll.c only when poll backend is enabled
4616\& ev_epoll.c only when the epoll backend is enabled
4617\& ev_linuxaio.c only when the linux aio backend is enabled
4618\& ev_kqueue.c only when the kqueue backend is enabled
4619\& ev_port.c only when the solaris port backend is enabled
1591.Ve 4620.Ve
4621.PP
4622\&\fIev.c\fR includes the backend files directly when enabled, so you only need
4623to compile this single file.
4624.PP
4625\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
4626.IX Subsection "LIBEVENT COMPATIBILITY API"
4627.PP
4628To include the libevent compatibility \s-1API,\s0 also include:
1592.PP 4629.PP
1593.Vb 1 4630.Vb 1
1594\& ev_win32.c required on win32 platforms only 4631\& #include "event.c"
1595.Ve 4632.Ve
1596.PP 4633.PP
1597.Vb 5 4634in the file including \fIev.c\fR, and:
1598\& ev_select.c only when select backend is enabled (which is is by default)
1599\& ev_poll.c only when poll backend is enabled (disabled by default)
1600\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
1601\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1602\& ev_port.c only when the solaris port backend is enabled (disabled by default)
1603.Ve
1604.PP
1605\&\fIev.c\fR includes the backend files directly when enabled, so you only need
1606to compile a single file.
1607.PP
1608\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR
1609.IX Subsection "LIBEVENT COMPATIBILITY API"
1610.PP
1611To include the libevent compatibility \s-1API\s0, also include:
1612.PP 4635.PP
1613.Vb 1 4636.Vb 1
1614\& #include "event.c" 4637\& #include "event.h"
1615.Ve 4638.Ve
1616.PP 4639.PP
1617in the file including \fIev.c\fR, and: 4640in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
4641.PP
4642You need the following additional files for this:
4643.PP
4644.Vb 2
4645\& event.h
4646\& event.c
4647.Ve
4648.PP
4649\fI\s-1AUTOCONF SUPPORT\s0\fR
4650.IX Subsection "AUTOCONF SUPPORT"
4651.PP
4652Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
4653whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
4654\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
4655include \fIconfig.h\fR and configure itself accordingly.
4656.PP
4657For this of course you need the m4 file:
1618.PP 4658.PP
1619.Vb 1 4659.Vb 1
1620\& #include "event.h"
1621.Ve
1622.PP
1623in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR.
1624.PP
1625You need the following additional files for this:
1626.PP
1627.Vb 2
1628\& event.h
1629\& event.c
1630.Ve
1631.PP
1632\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR
1633.IX Subsection "AUTOCONF SUPPORT"
1634.PP
1635Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in
1636whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
1637\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR off. \fIev.c\fR will then include
1638\&\fIconfig.h\fR and configure itself accordingly.
1639.PP
1640For this of course you need the m4 file:
1641.PP
1642.Vb 1
1643\& libev.m4 4660\& libev.m4
1644.Ve 4661.Ve
1645.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4662.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
1646.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4663.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
1647Libev can be configured via a variety of preprocessor symbols you have to define 4664Libev can be configured via a variety of preprocessor symbols you have to
1648before including any of its files. The default is not to build for multiplicity 4665define before including (or compiling) any of its files. The default in
1649and only include the select backend. 4666the absence of autoconf is documented for every option.
4667.PP
4668Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4669values when compiling libev vs. including \fIev.h\fR, so it is permissible
4670to redefine them before including \fIev.h\fR without breaking compatibility
4671to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4672users of libev and the libev code itself must be compiled with compatible
4673settings.
4674.IP "\s-1EV_COMPAT3\s0 (h)" 4
4675.IX Item "EV_COMPAT3 (h)"
4676Backwards compatibility is a major concern for libev. This is why this
4677release of libev comes with wrappers for the functions and symbols that
4678have been renamed between libev version 3 and 4.
4679.Sp
4680You can disable these wrappers (to test compatibility with future
4681versions) by defining \f(CW\*(C`EV_COMPAT3\*(C'\fR to \f(CW0\fR when compiling your
4682sources. This has the additional advantage that you can drop the \f(CW\*(C`struct\*(C'\fR
4683from \f(CW\*(C`struct ev_loop\*(C'\fR declarations, as libev will provide an \f(CW\*(C`ev_loop\*(C'\fR
4684typedef in that case.
4685.Sp
4686In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR,
4687and in some even more future version the compatibility code will be
4688removed completely.
1650.IP "\s-1EV_STANDALONE\s0" 4 4689.IP "\s-1EV_STANDALONE\s0 (h)" 4
1651.IX Item "EV_STANDALONE" 4690.IX Item "EV_STANDALONE (h)"
1652Must always be \f(CW1\fR if you do not use autoconf configuration, which 4691Must always be \f(CW1\fR if you do not use autoconf configuration, which
1653keeps libev from including \fIconfig.h\fR, and it also defines dummy 4692keeps libev from including \fIconfig.h\fR, and it also defines dummy
1654implementations for some libevent functions (such as logging, which is not 4693implementations for some libevent functions (such as logging, which is not
1655supported). It will also not define any of the structs usually found in 4694supported). It will also not define any of the structs usually found in
1656\&\fIevent.h\fR that are not directly supported by the libev core alone. 4695\&\fIevent.h\fR that are not directly supported by the libev core alone.
4696.Sp
4697In standalone mode, libev will still try to automatically deduce the
4698configuration, but has to be more conservative.
4699.IP "\s-1EV_USE_FLOOR\s0" 4
4700.IX Item "EV_USE_FLOOR"
4701If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its
4702periodic reschedule calculations, otherwise libev will fall back on a
4703portable (slower) implementation. If you enable this, you usually have to
4704link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR
4705function is not available will fail, so the safe default is to not enable
4706this.
1657.IP "\s-1EV_USE_MONOTONIC\s0" 4 4707.IP "\s-1EV_USE_MONOTONIC\s0" 4
1658.IX Item "EV_USE_MONOTONIC" 4708.IX Item "EV_USE_MONOTONIC"
1659If defined to be \f(CW1\fR, libev will try to detect the availability of the 4709If defined to be \f(CW1\fR, libev will try to detect the availability of the
1660monotonic clock option at both compiletime and runtime. Otherwise no use 4710monotonic clock option at both compile time and runtime. Otherwise no
1661of the monotonic clock option will be attempted. If you enable this, you 4711use of the monotonic clock option will be attempted. If you enable this,
1662usually have to link against librt or something similar. Enabling it when 4712you usually have to link against librt or something similar. Enabling it
1663the functionality isn't available is safe, though, althoguh you have 4713when the functionality isn't available is safe, though, although you have
1664to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR 4714to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
1665function is hiding in (often \fI\-lrt\fR). 4715function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
1666.IP "\s-1EV_USE_REALTIME\s0" 4 4716.IP "\s-1EV_USE_REALTIME\s0" 4
1667.IX Item "EV_USE_REALTIME" 4717.IX Item "EV_USE_REALTIME"
1668If defined to be \f(CW1\fR, libev will try to detect the availability of the 4718If defined to be \f(CW1\fR, libev will try to detect the availability of the
1669realtime clock option at compiletime (and assume its availability at 4719real-time clock option at compile time (and assume its availability
1670runtime if successful). Otherwise no use of the realtime clock option will 4720at runtime if successful). Otherwise no use of the real-time clock
1671be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get 4721option will be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR
1672(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries 4722by \f(CW\*(C`clock_get (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect
1673in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. 4723correctness. See the note about libraries in the description of
4724\&\f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. Defaults to the opposite value of
4725\&\f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
4726.IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4
4727.IX Item "EV_USE_CLOCK_SYSCALL"
4728If defined to be \f(CW1\fR, libev will try to use a direct syscall instead
4729of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option
4730exists because on GNU/Linux, \f(CW\*(C`clock_gettime\*(C'\fR is in \f(CW\*(C`librt\*(C'\fR, but \f(CW\*(C`librt\*(C'\fR
4731unconditionally pulls in \f(CW\*(C`libpthread\*(C'\fR, slowing down single-threaded
4732programs needlessly. Using a direct syscall is slightly slower (in
4733theory), because no optimised vdso implementation can be used, but avoids
4734the pthread dependency. Defaults to \f(CW1\fR on GNU/Linux with glibc 2.x or
4735higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR).
4736.IP "\s-1EV_USE_NANOSLEEP\s0" 4
4737.IX Item "EV_USE_NANOSLEEP"
4738If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
4739and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
4740.IP "\s-1EV_USE_EVENTFD\s0" 4
4741.IX Item "EV_USE_EVENTFD"
4742If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4743available and will probe for kernel support at runtime. This will improve
4744\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4745If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
47462.7 or newer, otherwise disabled.
1674.IP "\s-1EV_USE_SELECT\s0" 4 4747.IP "\s-1EV_USE_SELECT\s0" 4
1675.IX Item "EV_USE_SELECT" 4748.IX Item "EV_USE_SELECT"
1676If undefined or defined to be \f(CW1\fR, libev will compile in support for the 4749If undefined or defined to be \f(CW1\fR, libev will compile in support for the
1677\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no 4750\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no
1678other method takes over, select will be it. Otherwise the select backend 4751other method takes over, select will be it. Otherwise the select backend
1679will not be compiled in. 4752will not be compiled in.
1680.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 4753.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
1681.IX Item "EV_SELECT_USE_FD_SET" 4754.IX Item "EV_SELECT_USE_FD_SET"
1682If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR 4755If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
1683structure. This is useful if libev doesn't compile due to a missing 4756structure. This is useful if libev doesn't compile due to a missing
1684\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on 4757\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout
1685exotic systems. This usually limits the range of file descriptors to some 4758on exotic systems. This usually limits the range of file descriptors to
1686low limit such as 1024 or might have other limitations (winsocket only 4759some low limit such as 1024 or might have other limitations (winsocket
1687allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might 4760only allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation,
1688influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. 4761configures the maximum size of the \f(CW\*(C`fd_set\*(C'\fR.
1689.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 4762.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
1690.IX Item "EV_SELECT_IS_WINSOCKET" 4763.IX Item "EV_SELECT_IS_WINSOCKET"
1691When defined to \f(CW1\fR, the select backend will assume that 4764When defined to \f(CW1\fR, the select backend will assume that
1692select/socket/connect etc. don't understand file descriptors but 4765select/socket/connect etc. don't understand file descriptors but
1693wants osf handles on win32 (this is the case when the select to 4766wants osf handles on win32 (this is the case when the select to
1694be used is the winsock select). This means that it will call 4767be used is the winsock select). This means that it will call
1695\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, 4768\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
1696it is assumed that all these functions actually work on fds, even 4769it is assumed that all these functions actually work on fds, even
1697on win32. Should not be defined on non\-win32 platforms. 4770on win32. Should not be defined on non\-win32 platforms.
4771.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0(fd)" 4
4772.IX Item "EV_FD_TO_WIN32_HANDLE(fd)"
4773If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map
4774file descriptors to socket handles. When not defining this symbol (the
4775default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually
4776correct. In some cases, programs use their own file descriptor management,
4777in which case they can provide this function to map fds to socket handles.
4778.IP "\s-1EV_WIN32_HANDLE_TO_FD\s0(handle)" 4
4779.IX Item "EV_WIN32_HANDLE_TO_FD(handle)"
4780If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR then libev maps handles to file descriptors
4781using the standard \f(CW\*(C`_open_osfhandle\*(C'\fR function. For programs implementing
4782their own fd to handle mapping, overwriting this function makes it easier
4783to do so. This can be done by defining this macro to an appropriate value.
4784.IP "\s-1EV_WIN32_CLOSE_FD\s0(fd)" 4
4785.IX Item "EV_WIN32_CLOSE_FD(fd)"
4786If programs implement their own fd to handle mapping on win32, then this
4787macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4788file descriptors again. Note that the replacement function has to close
4789the underlying \s-1OS\s0 handle.
4790.IP "\s-1EV_USE_WSASOCKET\s0" 4
4791.IX Item "EV_USE_WSASOCKET"
4792If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4793communication socket, which works better in some environments. Otherwise,
4794the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4795environments.
1698.IP "\s-1EV_USE_POLL\s0" 4 4796.IP "\s-1EV_USE_POLL\s0" 4
1699.IX Item "EV_USE_POLL" 4797.IX Item "EV_USE_POLL"
1700If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4798If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
1701backend. Otherwise it will be enabled on non\-win32 platforms. It 4799backend. Otherwise it will be enabled on non\-win32 platforms. It
1702takes precedence over select. 4800takes precedence over select.
1703.IP "\s-1EV_USE_EPOLL\s0" 4 4801.IP "\s-1EV_USE_EPOLL\s0" 4
1704.IX Item "EV_USE_EPOLL" 4802.IX Item "EV_USE_EPOLL"
1705If defined to be \f(CW1\fR, libev will compile in support for the Linux 4803If defined to be \f(CW1\fR, libev will compile in support for the Linux
1706\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 4804\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
1707otherwise another method will be used as fallback. This is the 4805otherwise another method will be used as fallback. This is the preferred
1708preferred backend for GNU/Linux systems. 4806backend for GNU/Linux systems. If undefined, it will be enabled if the
4807headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4808.IP "\s-1EV_USE_LINUXAIO\s0" 4
4809.IX Item "EV_USE_LINUXAIO"
4810If defined to be \f(CW1\fR, libev will compile in support for the Linux
4811aio backend. Due to it's currenbt limitations it has to be requested
4812explicitly. If undefined, it will be enabled on linux, otherwise
4813disabled.
1709.IP "\s-1EV_USE_KQUEUE\s0" 4 4814.IP "\s-1EV_USE_KQUEUE\s0" 4
1710.IX Item "EV_USE_KQUEUE" 4815.IX Item "EV_USE_KQUEUE"
1711If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4816If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
1712\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 4817\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
1713otherwise another method will be used as fallback. This is the preferred 4818otherwise another method will be used as fallback. This is the preferred
1714backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only 4819backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only
1715supports some types of fds correctly (the only platform we found that 4820supports some types of fds correctly (the only platform we found that
1716supports ptys for example was NetBSD), so kqueue might be compiled in, but 4821supports ptys for example was NetBSD), so kqueue might be compiled in, but
1717not be used unless explicitly requested. The best way to use it is to find 4822not be used unless explicitly requested. The best way to use it is to find
1718out wether kqueue supports your type of fd properly and use an embedded 4823out whether kqueue supports your type of fd properly and use an embedded
1719kqueue loop. 4824kqueue loop.
1720.IP "\s-1EV_USE_PORT\s0" 4 4825.IP "\s-1EV_USE_PORT\s0" 4
1721.IX Item "EV_USE_PORT" 4826.IX Item "EV_USE_PORT"
1722If defined to be \f(CW1\fR, libev will compile in support for the Solaris 4827If defined to be \f(CW1\fR, libev will compile in support for the Solaris
172310 port style backend. Its availability will be detected at runtime, 482810 port style backend. Its availability will be detected at runtime,
1724otherwise another method will be used as fallback. This is the preferred 4829otherwise another method will be used as fallback. This is the preferred
1725backend for Solaris 10 systems. 4830backend for Solaris 10 systems.
1726.IP "\s-1EV_USE_DEVPOLL\s0" 4 4831.IP "\s-1EV_USE_DEVPOLL\s0" 4
1727.IX Item "EV_USE_DEVPOLL" 4832.IX Item "EV_USE_DEVPOLL"
1728reserved for future expansion, works like the \s-1USE\s0 symbols above. 4833Reserved for future expansion, works like the \s-1USE\s0 symbols above.
4834.IP "\s-1EV_USE_INOTIFY\s0" 4
4835.IX Item "EV_USE_INOTIFY"
4836If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
4837interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
4838be detected at runtime. If undefined, it will be enabled if the headers
4839indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4840.IP "\s-1EV_NO_SMP\s0" 4
4841.IX Item "EV_NO_SMP"
4842If defined to be \f(CW1\fR, libev will assume that memory is always coherent
4843between threads, that is, threads can be used, but threads never run on
4844different cpus (or different cpu cores). This reduces dependencies
4845and makes libev faster.
4846.IP "\s-1EV_NO_THREADS\s0" 4
4847.IX Item "EV_NO_THREADS"
4848If defined to be \f(CW1\fR, libev will assume that it will never be called from
4849different threads (that includes signal handlers), which is a stronger
4850assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4851libev faster.
4852.IP "\s-1EV_ATOMIC_T\s0" 4
4853.IX Item "EV_ATOMIC_T"
4854Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4855access is atomic with respect to other threads or signal contexts. No
4856such type is easily found in the C language, so you can provide your own
4857type that you know is safe for your purposes. It is used both for signal
4858handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4859watchers.
4860.Sp
4861In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4862(from \fIsignal.h\fR), which is usually good enough on most platforms.
1729.IP "\s-1EV_H\s0" 4 4863.IP "\s-1EV_H\s0 (h)" 4
1730.IX Item "EV_H" 4864.IX Item "EV_H (h)"
1731The name of the \fIev.h\fR header file used to include it. The default if 4865The name of the \fIev.h\fR header file used to include it. The default if
1732undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 4866undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
1733can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 4867used to virtually rename the \fIev.h\fR header file in case of conflicts.
1734.IP "\s-1EV_CONFIG_H\s0" 4 4868.IP "\s-1EV_CONFIG_H\s0 (h)" 4
1735.IX Item "EV_CONFIG_H" 4869.IX Item "EV_CONFIG_H (h)"
1736If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 4870If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
1737\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 4871\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
1738\&\f(CW\*(C`EV_H\*(C'\fR, above. 4872\&\f(CW\*(C`EV_H\*(C'\fR, above.
1739.IP "\s-1EV_EVENT_H\s0" 4 4873.IP "\s-1EV_EVENT_H\s0 (h)" 4
1740.IX Item "EV_EVENT_H" 4874.IX Item "EV_EVENT_H (h)"
1741Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 4875Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
1742of how the \fIevent.h\fR header can be found. 4876of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
1743.IP "\s-1EV_PROTOTYPES\s0" 4 4877.IP "\s-1EV_PROTOTYPES\s0 (h)" 4
1744.IX Item "EV_PROTOTYPES" 4878.IX Item "EV_PROTOTYPES (h)"
1745If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 4879If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
1746prototypes, but still define all the structs and other symbols. This is 4880prototypes, but still define all the structs and other symbols. This is
1747occasionally useful if you want to provide your own wrapper functions 4881occasionally useful if you want to provide your own wrapper functions
1748around libev functions. 4882around libev functions.
1749.IP "\s-1EV_MULTIPLICITY\s0" 4 4883.IP "\s-1EV_MULTIPLICITY\s0" 4
… …
1751If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 4885If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
1752will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 4886will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
1753additional independent event loops. Otherwise there will be no support 4887additional independent event loops. Otherwise there will be no support
1754for multiple event loops and there is no first event loop pointer 4888for multiple event loops and there is no first event loop pointer
1755argument. Instead, all functions act on the single default loop. 4889argument. Instead, all functions act on the single default loop.
4890.Sp
4891Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a
4892default loop when multiplicity is switched off \- you always have to
4893initialise the loop manually in this case.
1756.IP "\s-1EV_PERIODICS\s0" 4 4894.IP "\s-1EV_MINPRI\s0" 4
1757.IX Item "EV_PERIODICS" 4895.IX Item "EV_MINPRI"
1758If undefined or defined to be \f(CW1\fR, then periodic timers are supported, 4896.PD 0
1759otherwise not. This saves a few kb of code. 4897.IP "\s-1EV_MAXPRI\s0" 4
4898.IX Item "EV_MAXPRI"
4899.PD
4900The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to
4901\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can
4902provide for more priorities by overriding those symbols (usually defined
4903to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively).
4904.Sp
4905When doing priority-based operations, libev usually has to linearly search
4906all the priorities, so having many of them (hundreds) uses a lot of space
4907and time, so using the defaults of five priorities (\-2 .. +2) is usually
4908fine.
4909.Sp
4910If your embedding application does not need any priorities, defining these
4911both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4912.IP "\s-1EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE.\s0" 4
4913.IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE."
4914If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4915the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4916is not. Disabling watcher types mainly saves code size.
4917.IP "\s-1EV_FEATURES\s0" 4
4918.IX Item "EV_FEATURES"
4919If you need to shave off some kilobytes of code at the expense of some
4920speed (but with the full \s-1API\s0), you can define this symbol to request
4921certain subsets of functionality. The default is to enable all features
4922that can be enabled on the platform.
4923.Sp
4924A typical way to use this symbol is to define it to \f(CW0\fR (or to a bitset
4925with some broad features you want) and then selectively re-enable
4926additional parts you want, for example if you want everything minimal,
4927but multiple event loop support, async and child watchers and the poll
4928backend, use this:
4929.Sp
4930.Vb 5
4931\& #define EV_FEATURES 0
4932\& #define EV_MULTIPLICITY 1
4933\& #define EV_USE_POLL 1
4934\& #define EV_CHILD_ENABLE 1
4935\& #define EV_ASYNC_ENABLE 1
4936.Ve
4937.Sp
4938The actual value is a bitset, it can be a combination of the following
4939values (by default, all of these are enabled):
4940.RS 4
4941.ie n .IP "1 \- faster/larger code" 4
4942.el .IP "\f(CW1\fR \- faster/larger code" 4
4943.IX Item "1 - faster/larger code"
4944Use larger code to speed up some operations.
4945.Sp
4946Currently this is used to override some inlining decisions (enlarging the
4947code size by roughly 30% on amd64).
4948.Sp
4949When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4950gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4951assertions.
4952.Sp
4953The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4954(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4955.ie n .IP "2 \- faster/larger data structures" 4
4956.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4957.IX Item "2 - faster/larger data structures"
4958Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4959hash table sizes and so on. This will usually further increase code size
4960and can additionally have an effect on the size of data structures at
4961runtime.
4962.Sp
4963The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4964(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4965.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4966.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4967.IX Item "4 - full API configuration"
4968This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4969enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4970.ie n .IP "8 \- full \s-1API\s0" 4
4971.el .IP "\f(CW8\fR \- full \s-1API\s0" 4
4972.IX Item "8 - full API"
4973This enables a lot of the \*(L"lesser used\*(R" \s-1API\s0 functions. See \f(CW\*(C`ev.h\*(C'\fR for
4974details on which parts of the \s-1API\s0 are still available without this
4975feature, and do not complain if this subset changes over time.
4976.ie n .IP "16 \- enable all optional watcher types" 4
4977.el .IP "\f(CW16\fR \- enable all optional watcher types" 4
4978.IX Item "16 - enable all optional watcher types"
4979Enables all optional watcher types. If you want to selectively enable
4980only some watcher types other than I/O and timers (e.g. prepare,
4981embed, async, child...) you can enable them manually by defining
4982\&\f(CW\*(C`EV_watchertype_ENABLE\*(C'\fR to \f(CW1\fR instead.
4983.ie n .IP "32 \- enable all backends" 4
4984.el .IP "\f(CW32\fR \- enable all backends" 4
4985.IX Item "32 - enable all backends"
4986This enables all backends \- without this feature, you need to enable at
4987least one backend manually (\f(CW\*(C`EV_USE_SELECT\*(C'\fR is a good choice).
4988.ie n .IP "64 \- enable OS-specific ""helper"" APIs" 4
4989.el .IP "\f(CW64\fR \- enable OS-specific ``helper'' APIs" 4
4990.IX Item "64 - enable OS-specific helper APIs"
4991Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
4992default.
4993.RE
4994.RS 4
4995.Sp
4996Compiling with \f(CW\*(C`gcc \-Os \-DEV_STANDALONE \-DEV_USE_EPOLL=1 \-DEV_FEATURES=0\*(C'\fR
4997reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
4998code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
4999watchers, timers and monotonic clock support.
5000.Sp
5001With an intelligent-enough linker (gcc+binutils are intelligent enough
5002when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by
5003your program might be left out as well \- a binary starting a timer and an
5004I/O watcher then might come out at only 5Kb.
5005.RE
5006.IP "\s-1EV_API_STATIC\s0" 4
5007.IX Item "EV_API_STATIC"
5008If this symbol is defined (by default it is not), then all identifiers
5009will have static linkage. This means that libev will not export any
5010identifiers, and you cannot link against libev anymore. This can be useful
5011when you embed libev, only want to use libev functions in a single file,
5012and do not want its identifiers to be visible.
5013.Sp
5014To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that
5015wants to use libev.
5016.Sp
5017This option only works when libev is compiled with a C compiler, as \*(C+
5018doesn't support the required declaration syntax.
5019.IP "\s-1EV_AVOID_STDIO\s0" 4
5020.IX Item "EV_AVOID_STDIO"
5021If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio
5022functions (printf, scanf, perror etc.). This will increase the code size
5023somewhat, but if your program doesn't otherwise depend on stdio and your
5024libc allows it, this avoids linking in the stdio library which is quite
5025big.
5026.Sp
5027Note that error messages might become less precise when this option is
5028enabled.
5029.IP "\s-1EV_NSIG\s0" 4
5030.IX Item "EV_NSIG"
5031The highest supported signal number, +1 (or, the number of
5032signals): Normally, libev tries to deduce the maximum number of signals
5033automatically, but sometimes this fails, in which case it can be
5034specified. Also, using a lower number than detected (\f(CW32\fR should be
5035good for about any system in existence) can save some memory, as libev
5036statically allocates some 12\-24 bytes per signal number.
5037.IP "\s-1EV_PID_HASHSIZE\s0" 4
5038.IX Item "EV_PID_HASHSIZE"
5039\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
5040pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR disabled),
5041usually more than enough. If you need to manage thousands of children you
5042might want to increase this value (\fImust\fR be a power of two).
5043.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
5044.IX Item "EV_INOTIFY_HASHSIZE"
5045\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
5046inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR
5047disabled), usually more than enough. If you need to manage thousands of
5048\&\f(CW\*(C`ev_stat\*(C'\fR watchers you might want to increase this value (\fImust\fR be a
5049power of two).
5050.IP "\s-1EV_USE_4HEAP\s0" 4
5051.IX Item "EV_USE_4HEAP"
5052Heaps are not very cache-efficient. To improve the cache-efficiency of the
5053timer and periodics heaps, libev uses a 4\-heap when this symbol is defined
5054to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably
5055faster performance with many (thousands) of watchers.
5056.Sp
5057The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
5058will be \f(CW0\fR.
5059.IP "\s-1EV_HEAP_CACHE_AT\s0" 4
5060.IX Item "EV_HEAP_CACHE_AT"
5061Heaps are not very cache-efficient. To improve the cache-efficiency of the
5062timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within
5063the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR),
5064which uses 8\-12 bytes more per watcher and a few hundred bytes more code,
5065but avoids random read accesses on heap changes. This improves performance
5066noticeably with many (hundreds) of watchers.
5067.Sp
5068The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
5069will be \f(CW0\fR.
5070.IP "\s-1EV_VERIFY\s0" 4
5071.IX Item "EV_VERIFY"
5072Controls how much internal verification (see \f(CW\*(C`ev_verify ()\*(C'\fR) will
5073be done: If set to \f(CW0\fR, no internal verification code will be compiled
5074in. If set to \f(CW1\fR, then verification code will be compiled in, but not
5075called. If set to \f(CW2\fR, then the internal verification code will be
5076called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
5077verification code will be called very frequently, which will slow down
5078libev considerably.
5079.Sp
5080The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
5081will be \f(CW0\fR.
1760.IP "\s-1EV_COMMON\s0" 4 5082.IP "\s-1EV_COMMON\s0" 4
1761.IX Item "EV_COMMON" 5083.IX Item "EV_COMMON"
1762By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 5084By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
1763this macro to a something else you can include more and other types of 5085this macro to something else you can include more and other types of
1764members. You have to define it each time you include one of the files, 5086members. You have to define it each time you include one of the files,
1765though, and it must be identical each time. 5087though, and it must be identical each time.
1766.Sp 5088.Sp
1767For example, the perl \s-1EV\s0 module uses something like this: 5089For example, the perl \s-1EV\s0 module uses something like this:
1768.Sp 5090.Sp
1769.Vb 3 5091.Vb 3
1770\& #define EV_COMMON \e 5092\& #define EV_COMMON \e
1771\& SV *self; /* contains this struct */ \e 5093\& SV *self; /* contains this struct */ \e
1772\& SV *cb_sv, *fh /* note no trailing ";" */ 5094\& SV *cb_sv, *fh /* note no trailing ";" */
1773.Ve 5095.Ve
1774.IP "\s-1EV_CB_DECLARE\s0(type)" 4 5096.IP "\s-1EV_CB_DECLARE\s0 (type)" 4
1775.IX Item "EV_CB_DECLARE(type)" 5097.IX Item "EV_CB_DECLARE (type)"
1776.PD 0 5098.PD 0
1777.IP "\s-1EV_CB_INVOKE\s0(watcher,revents)" 4 5099.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4
1778.IX Item "EV_CB_INVOKE(watcher,revents)" 5100.IX Item "EV_CB_INVOKE (watcher, revents)"
1779.IP "ev_set_cb(ev,cb)" 4 5101.IP "ev_set_cb (ev, cb)" 4
1780.IX Item "ev_set_cb(ev,cb)" 5102.IX Item "ev_set_cb (ev, cb)"
1781.PD 5103.PD
1782Can be used to change the callback member declaration in each watcher, 5104Can be used to change the callback member declaration in each watcher,
1783and the way callbacks are invoked and set. Must expand to a struct member 5105and the way callbacks are invoked and set. Must expand to a struct member
1784definition and a statement, respectively. See the \fIev.v\fR header file for 5106definition and a statement, respectively. See the \fIev.h\fR header file for
1785their default definitions. One possible use for overriding these is to 5107their default definitions. One possible use for overriding these is to
1786avoid the ev_loop pointer as first argument in all cases, or to use method 5108avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
1787calls instead of plain function calls in \*(C+. 5109method calls instead of plain function calls in \*(C+.
5110.SS "\s-1EXPORTED API SYMBOLS\s0"
5111.IX Subsection "EXPORTED API SYMBOLS"
5112If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
5113exported symbols, you can use the provided \fISymbol.*\fR files which list
5114all public symbols, one per line:
5115.PP
5116.Vb 2
5117\& Symbols.ev for libev proper
5118\& Symbols.event for the libevent emulation
5119.Ve
5120.PP
5121This can also be used to rename all public symbols to avoid clashes with
5122multiple versions of libev linked together (which is obviously bad in
5123itself, but sometimes it is inconvenient to avoid this).
5124.PP
5125A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to
5126include before including \fIev.h\fR:
5127.PP
5128.Vb 1
5129\& <Symbols.ev sed \-e "s/.*/#define & myprefix_&/" >wrap.h
5130.Ve
5131.PP
5132This would create a file \fIwrap.h\fR which essentially looks like this:
5133.PP
5134.Vb 4
5135\& #define ev_backend myprefix_ev_backend
5136\& #define ev_check_start myprefix_ev_check_start
5137\& #define ev_check_stop myprefix_ev_check_stop
5138\& ...
5139.Ve
1788.Sh "\s-1EXAMPLES\s0" 5140.SS "\s-1EXAMPLES\s0"
1789.IX Subsection "EXAMPLES" 5141.IX Subsection "EXAMPLES"
1790For a real-world example of a program the includes libev 5142For a real-world example of a program the includes libev
1791verbatim, you can have a look at the \s-1EV\s0 perl module 5143verbatim, you can have a look at the \s-1EV\s0 perl module
1792(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in 5144(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
1793the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public 5145the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
1794interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file 5146interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
1795will be compiled. It is pretty complex because it provides its own header 5147will be compiled. It is pretty complex because it provides its own header
1796file. 5148file.
1797.Sp 5149.PP
1798The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 5150The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
1799that everybody includes and which overrides some autoconf choices: 5151that everybody includes and which overrides some configure choices:
1800.Sp 5152.PP
1801.Vb 4 5153.Vb 8
5154\& #define EV_FEATURES 8
5155\& #define EV_USE_SELECT 1
5156\& #define EV_PREPARE_ENABLE 1
5157\& #define EV_IDLE_ENABLE 1
5158\& #define EV_SIGNAL_ENABLE 1
5159\& #define EV_CHILD_ENABLE 1
1802\& #define EV_USE_POLL 0 5160\& #define EV_USE_STDEXCEPT 0
1803\& #define EV_MULTIPLICITY 0
1804\& #define EV_PERIODICS 0
1805\& #define EV_CONFIG_H <config.h> 5161\& #define EV_CONFIG_H <config.h>
1806.Ve 5162\&
1807.Sp
1808.Vb 1
1809\& #include "ev++.h" 5163\& #include "ev++.h"
1810.Ve 5164.Ve
1811.Sp 5165.PP
1812And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 5166And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
1813.Sp 5167.PP
1814.Vb 1
1815\& #include "rxvttoolkit.h"
1816.Ve
1817.Sp
1818.Vb 2 5168.Vb 2
1819\& /* darwin has problems with its header files in C++, requiring this namespace juggling */ 5169\& #include "ev_cpp.h"
1820\& using namespace ev;
1821.Ve
1822.Sp
1823.Vb 1
1824\& #include "ev.c" 5170\& #include "ev.c"
1825.Ve 5171.Ve
5172.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
5173.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
5174.SS "\s-1THREADS AND COROUTINES\s0"
5175.IX Subsection "THREADS AND COROUTINES"
5176\fI\s-1THREADS\s0\fR
5177.IX Subsection "THREADS"
5178.PP
5179All libev functions are reentrant and thread-safe unless explicitly
5180documented otherwise, but libev implements no locking itself. This means
5181that you can use as many loops as you want in parallel, as long as there
5182are no concurrent calls into any libev function with the same loop
5183parameter (\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter,
5184of course): libev guarantees that different event loops share no data
5185structures that need any locking.
5186.PP
5187Or to put it differently: calls with different loop parameters can be done
5188concurrently from multiple threads, calls with the same loop parameter
5189must be done serially (but can be done from different threads, as long as
5190only one thread ever is inside a call at any point in time, e.g. by using
5191a mutex per loop).
5192.PP
5193Specifically to support threads (and signal handlers), libev implements
5194so-called \f(CW\*(C`ev_async\*(C'\fR watchers, which allow some limited form of
5195concurrency on the same event loop, namely waking it up \*(L"from the
5196outside\*(R".
5197.PP
5198If you want to know which design (one loop, locking, or multiple loops
5199without or something else still) is best for your problem, then I cannot
5200help you, but here is some generic advice:
5201.IP "\(bu" 4
5202most applications have a main thread: use the default libev loop
5203in that thread, or create a separate thread running only the default loop.
5204.Sp
5205This helps integrating other libraries or software modules that use libev
5206themselves and don't care/know about threading.
5207.IP "\(bu" 4
5208one loop per thread is usually a good model.
5209.Sp
5210Doing this is almost never wrong, sometimes a better-performance model
5211exists, but it is always a good start.
5212.IP "\(bu" 4
5213other models exist, such as the leader/follower pattern, where one
5214loop is handed through multiple threads in a kind of round-robin fashion.
5215.Sp
5216Choosing a model is hard \- look around, learn, know that usually you can do
5217better than you currently do :\-)
5218.IP "\(bu" 4
5219often you need to talk to some other thread which blocks in the
5220event loop.
5221.Sp
5222\&\f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other threads safely
5223(or from signal contexts...).
5224.Sp
5225An example use would be to communicate signals or other events that only
5226work in the default loop by registering the signal watcher with the
5227default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
5228watcher callback into the event loop interested in the signal.
5229.PP
5230See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
5231.PP
5232\fI\s-1COROUTINES\s0\fR
5233.IX Subsection "COROUTINES"
5234.PP
5235Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
5236libev fully supports nesting calls to its functions from different
5237coroutines (e.g. you can call \f(CW\*(C`ev_run\*(C'\fR on the same loop from two
5238different coroutines, and switch freely between both coroutines running
5239the loop, as long as you don't confuse yourself). The only exception is
5240that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
5241.PP
5242Care has been taken to ensure that libev does not keep local state inside
5243\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
5244they do not call any callbacks.
5245.SS "\s-1COMPILER WARNINGS\s0"
5246.IX Subsection "COMPILER WARNINGS"
5247Depending on your compiler and compiler settings, you might get no or a
5248lot of warnings when compiling libev code. Some people are apparently
5249scared by this.
5250.PP
5251However, these are unavoidable for many reasons. For one, each compiler
5252has different warnings, and each user has different tastes regarding
5253warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when
5254targeting a specific compiler and compiler-version.
5255.PP
5256Another reason is that some compiler warnings require elaborate
5257workarounds, or other changes to the code that make it less clear and less
5258maintainable.
5259.PP
5260And of course, some compiler warnings are just plain stupid, or simply
5261wrong (because they don't actually warn about the condition their message
5262seems to warn about). For example, certain older gcc versions had some
5263warnings that resulted in an extreme number of false positives. These have
5264been fixed, but some people still insist on making code warn-free with
5265such buggy versions.
5266.PP
5267While libev is written to generate as few warnings as possible,
5268\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
5269with any compiler warnings enabled unless you are prepared to cope with
5270them (e.g. by ignoring them). Remember that warnings are just that:
5271warnings, not errors, or proof of bugs.
5272.SS "\s-1VALGRIND\s0"
5273.IX Subsection "VALGRIND"
5274Valgrind has a special section here because it is a popular tool that is
5275highly useful. Unfortunately, valgrind reports are very hard to interpret.
5276.PP
5277If you think you found a bug (memory leak, uninitialised data access etc.)
5278in libev, then check twice: If valgrind reports something like:
5279.PP
5280.Vb 3
5281\& ==2274== definitely lost: 0 bytes in 0 blocks.
5282\& ==2274== possibly lost: 0 bytes in 0 blocks.
5283\& ==2274== still reachable: 256 bytes in 1 blocks.
5284.Ve
5285.PP
5286Then there is no memory leak, just as memory accounted to global variables
5287is not a memleak \- the memory is still being referenced, and didn't leak.
5288.PP
5289Similarly, under some circumstances, valgrind might report kernel bugs
5290as if it were a bug in libev (e.g. in realloc or in the poll backend,
5291although an acceptable workaround has been found here), or it might be
5292confused.
5293.PP
5294Keep in mind that valgrind is a very good tool, but only a tool. Don't
5295make it into some kind of religion.
5296.PP
5297If you are unsure about something, feel free to contact the mailing list
5298with the full valgrind report and an explanation on why you think this
5299is a bug in libev (best check the archives, too :). However, don't be
5300annoyed when you get a brisk \*(L"this is no bug\*(R" answer and take the chance
5301of learning how to interpret valgrind properly.
5302.PP
5303If you need, for some reason, empty reports from valgrind for your project
5304I suggest using suppression lists.
5305.SH "PORTABILITY NOTES"
5306.IX Header "PORTABILITY NOTES"
5307.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
5308.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
5309GNU/Linux is the only common platform that supports 64 bit file/large file
5310interfaces but \fIdisables\fR them by default.
5311.PP
5312That means that libev compiled in the default environment doesn't support
5313files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
5314.PP
5315Unfortunately, many programs try to work around this GNU/Linux issue
5316by enabling the large file \s-1API,\s0 which makes them incompatible with the
5317standard libev compiled for their system.
5318.PP
5319Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
5320suddenly make it incompatible to the default compile time environment,
5321i.e. all programs not using special compile switches.
5322.SS "\s-1OS/X AND DARWIN BUGS\s0"
5323.IX Subsection "OS/X AND DARWIN BUGS"
5324The whole thing is a bug if you ask me \- basically any system interface
5325you touch is broken, whether it is locales, poll, kqueue or even the
5326OpenGL drivers.
5327.PP
5328\fI\f(CI\*(C`kqueue\*(C'\fI is buggy\fR
5329.IX Subsection "kqueue is buggy"
5330.PP
5331The kqueue syscall is broken in all known versions \- most versions support
5332only sockets, many support pipes.
5333.PP
5334Libev tries to work around this by not using \f(CW\*(C`kqueue\*(C'\fR by default on this
5335rotten platform, but of course you can still ask for it when creating a
5336loop \- embedding a socket-only kqueue loop into a select-based one is
5337probably going to work well.
5338.PP
5339\fI\f(CI\*(C`poll\*(C'\fI is buggy\fR
5340.IX Subsection "poll is buggy"
5341.PP
5342Instead of fixing \f(CW\*(C`kqueue\*(C'\fR, Apple replaced their (working) \f(CW\*(C`poll\*(C'\fR
5343implementation by something calling \f(CW\*(C`kqueue\*(C'\fR internally around the 10.5.6
5344release, so now \f(CW\*(C`kqueue\*(C'\fR \fIand\fR \f(CW\*(C`poll\*(C'\fR are broken.
5345.PP
5346Libev tries to work around this by not using \f(CW\*(C`poll\*(C'\fR by default on
5347this rotten platform, but of course you can still ask for it when creating
5348a loop.
5349.PP
5350\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
5351.IX Subsection "select is buggy"
5352.PP
5353All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
5354one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file
5355descriptors you can pass in to 1024 \- your program suddenly crashes when
5356you use more.
5357.PP
5358There is an undocumented \*(L"workaround\*(R" for this \- defining
5359\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
5360work on \s-1OS/X.\s0
5361.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
5362.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
5363\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
5364.IX Subsection "errno reentrancy"
5365.PP
5366The default compile environment on Solaris is unfortunately so
5367thread-unsafe that you can't even use components/libraries compiled
5368without \f(CW\*(C`\-D_REENTRANT\*(C'\fR in a threaded program, which, of course, isn't
5369defined by default. A valid, if stupid, implementation choice.
5370.PP
5371If you want to use libev in threaded environments you have to make sure
5372it's compiled with \f(CW\*(C`_REENTRANT\*(C'\fR defined.
5373.PP
5374\fIEvent port backend\fR
5375.IX Subsection "Event port backend"
5376.PP
5377The scalable event interface for Solaris is called \*(L"event
5378ports\*(R". Unfortunately, this mechanism is very buggy in all major
5379releases. If you run into high \s-1CPU\s0 usage, your program freezes or you get
5380a large number of spurious wakeups, make sure you have all the relevant
5381and latest kernel patches applied. No, I don't know which ones, but there
5382are multiple ones to apply, and afterwards, event ports actually work
5383great.
5384.PP
5385If you can't get it to work, you can try running the program by setting
5386the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
5387\&\f(CW\*(C`select\*(C'\fR backends.
5388.SS "\s-1AIX POLL BUG\s0"
5389.IX Subsection "AIX POLL BUG"
5390\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
5391this by trying to avoid the poll backend altogether (i.e. it's not even
5392compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
5393with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
5394.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
5395.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
5396\fIGeneral issues\fR
5397.IX Subsection "General issues"
5398.PP
5399Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
5400requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
5401model. Libev still offers limited functionality on this platform in
5402the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
5403descriptors. This only applies when using Win32 natively, not when using
5404e.g. cygwin. Actually, it only applies to the microsofts own compilers,
5405as every compiler comes with a slightly differently broken/incompatible
5406environment.
5407.PP
5408Lifting these limitations would basically require the full
5409re-implementation of the I/O system. If you are into this kind of thing,
5410then note that glib does exactly that for you in a very portable way (note
5411also that glib is the slowest event library known to man).
5412.PP
5413There is no supported compilation method available on windows except
5414embedding it into other applications.
5415.PP
5416Sensible signal handling is officially unsupported by Microsoft \- libev
5417tries its best, but under most conditions, signals will simply not work.
5418.PP
5419Not a libev limitation but worth mentioning: windows apparently doesn't
5420accept large writes: instead of resulting in a partial write, windows will
5421either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large,
5422so make sure you only write small amounts into your sockets (less than a
5423megabyte seems safe, but this apparently depends on the amount of memory
5424available).
5425.PP
5426Due to the many, low, and arbitrary limits on the win32 platform and
5427the abysmal performance of winsockets, using a large number of sockets
5428is not recommended (and not reasonable). If your program needs to use
5429more than a hundred or so sockets, then likely it needs to use a totally
5430different implementation for windows, as libev offers the \s-1POSIX\s0 readiness
5431notification model, which cannot be implemented efficiently on windows
5432(due to Microsoft monopoly games).
5433.PP
5434A typical way to use libev under windows is to embed it (see the embedding
5435section for details) and use the following \fIevwrap.h\fR header file instead
5436of \fIev.h\fR:
5437.PP
5438.Vb 2
5439\& #define EV_STANDALONE /* keeps ev from requiring config.h */
5440\& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
5441\&
5442\& #include "ev.h"
5443.Ve
5444.PP
5445And compile the following \fIevwrap.c\fR file into your project (make sure
5446you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!):
5447.PP
5448.Vb 2
5449\& #include "evwrap.h"
5450\& #include "ev.c"
5451.Ve
5452.PP
5453\fIThe winsocket \f(CI\*(C`select\*(C'\fI function\fR
5454.IX Subsection "The winsocket select function"
5455.PP
5456The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
5457requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
5458also extremely buggy). This makes select very inefficient, and also
5459requires a mapping from file descriptors to socket handles (the Microsoft
5460C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
5461discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
5462\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
5463.PP
5464The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime
5465libraries and raw winsocket select is:
5466.PP
5467.Vb 2
5468\& #define EV_USE_SELECT 1
5469\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5470.Ve
5471.PP
5472Note that winsockets handling of fd sets is O(n), so you can easily get a
5473complexity in the O(nX) range when using win32.
5474.PP
5475\fILimited number of file descriptors\fR
5476.IX Subsection "Limited number of file descriptors"
5477.PP
5478Windows has numerous arbitrary (and low) limits on things.
5479.PP
5480Early versions of winsocket's select only supported waiting for a maximum
5481of \f(CW64\fR handles (probably owning to the fact that all windows kernels
5482can only wait for \f(CW64\fR things at the same time internally; Microsoft
5483recommends spawning a chain of threads and wait for 63 handles and the
5484previous thread in each. Sounds great!).
5485.PP
5486Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
5487to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
5488call (which might be in libev or elsewhere, for example, perl and many
5489other interpreters do their own select emulation on windows).
5490.PP
5491Another limit is the number of file descriptors in the Microsoft runtime
5492libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR
5493fetish or something like this inside Microsoft). You can increase this
5494by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
5495(another arbitrary limit), but is broken in many versions of the Microsoft
5496runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
5497(depending on windows version and/or the phase of the moon). To get more,
5498you need to wrap all I/O functions and provide your own fd management, but
5499the cost of calling select (O(nX)) will likely make this unworkable.
5500.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5501.IX Subsection "PORTABILITY REQUIREMENTS"
5502In addition to a working ISO-C implementation and of course the
5503backend-specific APIs, libev relies on a few additional extensions:
5504.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
5505.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
5506.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
5507Libev assumes not only that all watcher pointers have the same internal
5508structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5509assumes that the same (machine) code can be used to call any watcher
5510callback: The watcher callbacks have different type signatures, but libev
5511calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5512.IP "null pointers and integer zero are represented by 0 bytes" 4
5513.IX Item "null pointers and integer zero are represented by 0 bytes"
5514Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5515relies on this setting pointers and integers to null.
5516.IP "pointer accesses must be thread-atomic" 4
5517.IX Item "pointer accesses must be thread-atomic"
5518Accessing a pointer value must be atomic, it must both be readable and
5519writable in one piece \- this is the case on all current architectures.
5520.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
5521.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
5522.IX Item "sig_atomic_t volatile must be thread-atomic as well"
5523The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
5524\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different
5525threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is
5526believed to be sufficiently portable.
5527.ie n .IP """sigprocmask"" must work in a threaded environment" 4
5528.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4
5529.IX Item "sigprocmask must work in a threaded environment"
5530Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not
5531allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical
5532pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main
5533thread\*(R" or will block signals process-wide, both behaviours would
5534be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5535\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5536.Sp
5537The most portable way to handle signals is to block signals in all threads
5538except the initial one, and run the signal handling loop in the initial
5539thread as well.
5540.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
5541.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
5542.IX Item "long must be large enough for common memory allocation sizes"
5543To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
5544instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
5545systems (Microsoft...) this might be unexpectedly low, but is still at
5546least 31 bits everywhere, which is enough for hundreds of millions of
5547watchers.
5548.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
5549.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
5550.IX Item "double must hold a time value in seconds with enough accuracy"
5551The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
5552have at least 51 bits of mantissa (and 9 bits of exponent), which is
5553good enough for at least into the year 4000 with millisecond accuracy
5554(the design goal for libev). This requirement is overfulfilled by
5555implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5556.Sp
5557With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5558year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5559is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5560something like that, just kidding).
5561.PP
5562If you know of other additional requirements drop me a note.
5563.SH "ALGORITHMIC COMPLEXITIES"
5564.IX Header "ALGORITHMIC COMPLEXITIES"
5565In this section the complexities of (many of) the algorithms used inside
5566libev will be documented. For complexity discussions about backends see
5567the documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
5568.PP
5569All of the following are about amortised time: If an array needs to be
5570extended, libev needs to realloc and move the whole array, but this
5571happens asymptotically rarer with higher number of elements, so O(1) might
5572mean that libev does a lengthy realloc operation in rare cases, but on
5573average it is much faster and asymptotically approaches constant time.
5574.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
5575.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
5576This means that, when you have a watcher that triggers in one hour and
5577there are 100 watchers that would trigger before that, then inserting will
5578have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
5579.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
5580.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
5581That means that changing a timer costs less than removing/adding them,
5582as only the relative motion in the event queue has to be paid for.
5583.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4
5584.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)"
5585These just add the watcher into an array or at the head of a list.
5586.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4
5587.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)"
5588.PD 0
5589.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
5590.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
5591.PD
5592These watchers are stored in lists, so they need to be walked to find the
5593correct watcher to remove. The lists are usually short (you don't usually
5594have many watchers waiting for the same fd or signal: one is typical, two
5595is rare).
5596.IP "Finding the next timer in each loop iteration: O(1)" 4
5597.IX Item "Finding the next timer in each loop iteration: O(1)"
5598By virtue of using a binary or 4\-heap, the next timer is always found at a
5599fixed position in the storage array.
5600.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
5601.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
5602A change means an I/O watcher gets started or stopped, which requires
5603libev to recalculate its status (and possibly tell the kernel, depending
5604on backend and whether \f(CW\*(C`ev_io_set\*(C'\fR was used).
5605.IP "Activating one watcher (putting it into the pending state): O(1)" 4
5606.IX Item "Activating one watcher (putting it into the pending state): O(1)"
5607.PD 0
5608.IP "Priority handling: O(number_of_priorities)" 4
5609.IX Item "Priority handling: O(number_of_priorities)"
5610.PD
5611Priorities are implemented by allocating some space for each
5612priority. When doing priority-based operations, libev usually has to
5613linearly search all the priorities, but starting/stopping and activating
5614watchers becomes O(1) with respect to priority handling.
5615.IP "Sending an ev_async: O(1)" 4
5616.IX Item "Sending an ev_async: O(1)"
5617.PD 0
5618.IP "Processing ev_async_send: O(number_of_async_watchers)" 4
5619.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
5620.IP "Processing signals: O(max_signal_number)" 4
5621.IX Item "Processing signals: O(max_signal_number)"
5622.PD
5623Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
5624calls in the current loop iteration and the loop is currently
5625blocked. Checking for async and signal events involves iterating over all
5626running async watchers or all signal numbers.
5627.SH "PORTING FROM LIBEV 3.X TO 4.X"
5628.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5629The major version 4 introduced some incompatible changes to the \s-1API.\s0
5630.PP
5631At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5632for all changes, so most programs should still compile. The compatibility
5633layer might be removed in later versions of libev, so better update to the
5634new \s-1API\s0 early than late.
5635.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5636.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5637.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5638The backward compatibility mechanism can be controlled by
5639\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5640section.
5641.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5642.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5643.IX Item "ev_default_destroy and ev_default_fork have been removed"
5644These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5645.Sp
5646.Vb 2
5647\& ev_loop_destroy (EV_DEFAULT_UC);
5648\& ev_loop_fork (EV_DEFAULT);
5649.Ve
5650.IP "function/symbol renames" 4
5651.IX Item "function/symbol renames"
5652A number of functions and symbols have been renamed:
5653.Sp
5654.Vb 3
5655\& ev_loop => ev_run
5656\& EVLOOP_NONBLOCK => EVRUN_NOWAIT
5657\& EVLOOP_ONESHOT => EVRUN_ONCE
5658\&
5659\& ev_unloop => ev_break
5660\& EVUNLOOP_CANCEL => EVBREAK_CANCEL
5661\& EVUNLOOP_ONE => EVBREAK_ONE
5662\& EVUNLOOP_ALL => EVBREAK_ALL
5663\&
5664\& EV_TIMEOUT => EV_TIMER
5665\&
5666\& ev_loop_count => ev_iteration
5667\& ev_loop_depth => ev_depth
5668\& ev_loop_verify => ev_verify
5669.Ve
5670.Sp
5671Most functions working on \f(CW\*(C`struct ev_loop\*(C'\fR objects don't have an
5672\&\f(CW\*(C`ev_loop_\*(C'\fR prefix, so it was removed; \f(CW\*(C`ev_loop\*(C'\fR, \f(CW\*(C`ev_unloop\*(C'\fR and
5673associated constants have been renamed to not collide with the \f(CW\*(C`struct
5674ev_loop\*(C'\fR anymore and \f(CW\*(C`EV_TIMER\*(C'\fR now follows the same naming scheme
5675as all other watcher types. Note that \f(CW\*(C`ev_loop_fork\*(C'\fR is still called
5676\&\f(CW\*(C`ev_loop_fork\*(C'\fR because it would otherwise clash with the \f(CW\*(C`ev_fork\*(C'\fR
5677typedef.
5678.ie n .IP """EV_MINIMAL"" mechanism replaced by ""EV_FEATURES""" 4
5679.el .IP "\f(CWEV_MINIMAL\fR mechanism replaced by \f(CWEV_FEATURES\fR" 4
5680.IX Item "EV_MINIMAL mechanism replaced by EV_FEATURES"
5681The preprocessor symbol \f(CW\*(C`EV_MINIMAL\*(C'\fR has been replaced by a different
5682mechanism, \f(CW\*(C`EV_FEATURES\*(C'\fR. Programs using \f(CW\*(C`EV_MINIMAL\*(C'\fR usually compile
5683and work, but the library code will of course be larger.
5684.SH "GLOSSARY"
5685.IX Header "GLOSSARY"
5686.IP "active" 4
5687.IX Item "active"
5688A watcher is active as long as it has been started and not yet stopped.
5689See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5690.IP "application" 4
5691.IX Item "application"
5692In this document, an application is whatever is using libev.
5693.IP "backend" 4
5694.IX Item "backend"
5695The part of the code dealing with the operating system interfaces.
5696.IP "callback" 4
5697.IX Item "callback"
5698The address of a function that is called when some event has been
5699detected. Callbacks are being passed the event loop, the watcher that
5700received the event, and the actual event bitset.
5701.IP "callback/watcher invocation" 4
5702.IX Item "callback/watcher invocation"
5703The act of calling the callback associated with a watcher.
5704.IP "event" 4
5705.IX Item "event"
5706A change of state of some external event, such as data now being available
5707for reading on a file descriptor, time having passed or simply not having
5708any other events happening anymore.
5709.Sp
5710In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or
5711\&\f(CW\*(C`EV_TIMER\*(C'\fR).
5712.IP "event library" 4
5713.IX Item "event library"
5714A software package implementing an event model and loop.
5715.IP "event loop" 4
5716.IX Item "event loop"
5717An entity that handles and processes external events and converts them
5718into callback invocations.
5719.IP "event model" 4
5720.IX Item "event model"
5721The model used to describe how an event loop handles and processes
5722watchers and events.
5723.IP "pending" 4
5724.IX Item "pending"
5725A watcher is pending as soon as the corresponding event has been
5726detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5727.IP "real time" 4
5728.IX Item "real time"
5729The physical time that is observed. It is apparently strictly monotonic :)
5730.IP "wall-clock time" 4
5731.IX Item "wall-clock time"
5732The time and date as shown on clocks. Unlike real time, it can actually
5733be wrong and jump forwards and backwards, e.g. when you adjust your
5734clock.
5735.IP "watcher" 4
5736.IX Item "watcher"
5737A data structure that describes interest in certain events. Watchers need
5738to be started (attached to an event loop) before they can receive events.
1826.SH "AUTHOR" 5739.SH "AUTHOR"
1827.IX Header "AUTHOR" 5740.IX Header "AUTHOR"
1828Marc Lehmann <libev@schmorp.de>. 5741Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5742Magnusson and Emanuele Giaquinta, and minor corrections by many others.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines