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

Comparing libev/ev.3 (file contents):
Revision 1.22 by root, Tue Nov 27 08:11:52 2007 UTC vs.
Revision 1.108 by root, Sat Jul 28 04:15:15 2018 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
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 turned on, 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-27" "perl v5.8.8" "User Contributed Perl Documentation" 136.TH LIBEV 3 "2017-11-14" "libev-4.24" "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 \f(CW\*(C`epoll\*(C'\fR, the
157kqueue mechanisms for file descriptor events, relative timers, absolute 246BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
158timers with customised rescheduling, signal events, process status change 247for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
159events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event 248(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: Replace the libev allocator with one that waits a bit and then
258retries: better than mine). 398retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR).
259.Sp 399.Sp
260.Vb 6 400.Vb 6
261\& static void * 401\& static void *
262\& persistent_realloc (void *ptr, long size) 402\& persistent_realloc (void *ptr, size_t size)
263\& { 403\& {
264\& for (;;) 404\& for (;;)
265\& { 405\& {
266\& void *newptr = realloc (ptr, size); 406\& void *newptr = realloc (ptr, size);
267.Ve 407\&
268.Sp
269.Vb 2
270\& if (newptr) 408\& if (newptr)
271\& return newptr; 409\& return newptr;
272.Ve 410\&
273.Sp
274.Vb 3
275\& sleep (60); 411\& sleep (60);
276\& } 412\& }
277\& } 413\& }
278.Ve 414\&
279.Sp
280.Vb 2
281\& ... 415\& ...
282\& ev_set_allocator (persistent_realloc); 416\& ev_set_allocator (persistent_realloc);
283.Ve 417.Ve
284.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 418.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
285.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" 419.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())"
286Set the callback function to call on a retryable syscall error (such 420Set the callback function to call on a retryable system call error (such
287as failed select, poll, epoll_wait). The message is a printable string 421as failed select, poll, epoll_wait). The message is a printable string
288indicating the system call or subsystem causing the problem. If this 422indicating the system call or subsystem causing the problem. If this
289callback is set, then libev will expect it to remedy the sitution, no 423callback is set, then libev will expect it to remedy the situation, no
290matter what, when it returns. That is, libev will generally retry the 424matter what, when it returns. That is, libev will generally retry the
291requested operation, or, if the condition doesn't go away, do bad stuff 425requested operation, or, if the condition doesn't go away, do bad stuff
292(such as abort). 426(such as abort).
293.Sp 427.Sp
294Example: do the same thing as libev does internally: 428Example: This is basically the same thing that libev does internally, too.
295.Sp 429.Sp
296.Vb 6 430.Vb 6
297\& static void 431\& static void
298\& fatal_error (const char *msg) 432\& fatal_error (const char *msg)
299\& { 433\& {
300\& perror (msg); 434\& perror (msg);
301\& abort (); 435\& abort ();
302\& } 436\& }
303.Ve 437\&
304.Sp
305.Vb 2
306\& ... 438\& ...
307\& ev_set_syserr_cb (fatal_error); 439\& ev_set_syserr_cb (fatal_error);
308.Ve 440.Ve
441.IP "ev_feed_signal (int signum)" 4
442.IX Item "ev_feed_signal (int signum)"
443This function can be used to \*(L"simulate\*(R" a signal receive. It is completely
444safe to call this function at any time, from any context, including signal
445handlers or random threads.
446.Sp
447Its main use is to customise signal handling in your process, especially
448in the presence of threads. For example, you could block signals
449by default in all threads (and specifying \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when
450creating any loops), and in one thread, use \f(CW\*(C`sigwait\*(C'\fR or any other
451mechanism to wait for signals, then \*(L"deliver\*(R" them to libev by calling
452\&\f(CW\*(C`ev_feed_signal\*(C'\fR.
309.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 453.SH "FUNCTIONS CONTROLLING EVENT LOOPS"
310.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 454.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 455An 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 456\&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as
313events, and dynamically created loops which do not. 457libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name).
314.PP 458.PP
315If you use threads, a common model is to run the default event loop 459The 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 460supports child process events, and dynamically created event loops which
317create, you also create another event loop. Libev itself does no locking 461do 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 462.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
322.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 463.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
323This will initialise the default event loop if it hasn't been initialised 464This 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 465normally 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 466the \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). 467\&\f(CW\*(C`ev_loop_new\*(C'\fR.
468.Sp
469If the default loop is already initialised then this function simply
470returns it (and ignores the flags. If that is troubling you, check
471\&\f(CW\*(C`ev_backend ()\*(C'\fR afterwards). Otherwise it will create it with the given
472flags, which should almost always be \f(CW0\fR, unless the caller is also the
473one calling \f(CW\*(C`ev_run\*(C'\fR or otherwise qualifies as \*(L"the main program\*(R".
327.Sp 474.Sp
328If you don't know what event loop to use, use the one returned from this 475If you don't know what event loop to use, use the one returned from this
329function. 476function (or via the \f(CW\*(C`EV_DEFAULT\*(C'\fR macro).
477.Sp
478Note that this function is \fInot\fR thread-safe, so if you want to use it
479from multiple threads, you have to employ some kind of mutex (note also
480that this case is unlikely, as loops cannot be shared easily between
481threads anyway).
482.Sp
483The default loop is the only loop that can handle \f(CW\*(C`ev_child\*(C'\fR watchers,
484and to do this, it always registers a handler for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is
485a problem for your application you can either create a dynamic loop with
486\&\f(CW\*(C`ev_loop_new\*(C'\fR which doesn't do that, or you can simply overwrite the
487\&\f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling \f(CW\*(C`ev_default_init\*(C'\fR.
488.Sp
489Example: This is the most typical usage.
490.Sp
491.Vb 2
492\& if (!ev_default_loop (0))
493\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
494.Ve
495.Sp
496Example: Restrict libev to the select and poll backends, and do not allow
497environment settings to be taken into account:
498.Sp
499.Vb 1
500\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
501.Ve
502.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
503.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
504This will create and initialise a new event loop object. If the loop
505could not be initialised, returns false.
506.Sp
507This function is thread-safe, and one common way to use libev with
508threads is indeed to create one loop per thread, and using the default
509loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
330.Sp 510.Sp
331The flags argument can be used to specify special behaviour or specific 511The 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). 512backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
333.Sp 513.Sp
334The following flags are supported: 514The following flags are supported:
… …
339The default flags value. Use this if you have no clue (it's the right 519The default flags value. Use this if you have no clue (it's the right
340thing, believe me). 520thing, believe me).
341.ie n .IP """EVFLAG_NOENV""" 4 521.ie n .IP """EVFLAG_NOENV""" 4
342.el .IP "\f(CWEVFLAG_NOENV\fR" 4 522.el .IP "\f(CWEVFLAG_NOENV\fR" 4
343.IX Item "EVFLAG_NOENV" 523.IX Item "EVFLAG_NOENV"
344If this flag bit is ored into the flag value (or the program runs setuid 524If this flag bit is or'ed into the flag value (or the program runs setuid
345or setgid) then libev will \fInot\fR look at the environment variable 525or 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 526\&\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 527override 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 528useful to try out specific backends to test their performance, to work
349around bugs. 529around bugs, or to make libev threadsafe (accessing environment variables
530cannot be done in a threadsafe way, but usually it works if no other
531thread modifies them).
532.ie n .IP """EVFLAG_FORKCHECK""" 4
533.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
534.IX Item "EVFLAG_FORKCHECK"
535Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
536make libev check for a fork in each iteration by enabling this flag.
537.Sp
538This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
539and thus this might slow down your event loop if you do a lot of loop
540iterations and little real work, but is usually not noticeable (on my
541GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn
542sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux
543system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc
544versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again).
545.Sp
546The big advantage of this flag is that you can forget about fork (and
547forget about forgetting to tell libev about forking, although you still
548have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
549.Sp
550This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
551environment variable.
552.ie n .IP """EVFLAG_NOINOTIFY""" 4
553.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
554.IX Item "EVFLAG_NOINOTIFY"
555When this flag is specified, then libev will not attempt to use the
556\&\fIinotify\fR \s-1API\s0 for its \f(CW\*(C`ev_stat\*(C'\fR watchers. Apart from debugging and
557testing, this flag can be useful to conserve inotify file descriptors, as
558otherwise each loop using \f(CW\*(C`ev_stat\*(C'\fR watchers consumes one inotify handle.
559.ie n .IP """EVFLAG_SIGNALFD""" 4
560.el .IP "\f(CWEVFLAG_SIGNALFD\fR" 4
561.IX Item "EVFLAG_SIGNALFD"
562When this flag is specified, then libev will attempt to use the
563\&\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
564delivers signals synchronously, which makes it both faster and might make
565it possible to get the queued signal data. It can also simplify signal
566handling with threads, as long as you properly block signals in your
567threads that are not interested in handling them.
568.Sp
569Signalfd will not be used by default as this changes your signal mask, and
570there are a lot of shoddy libraries and programs (glib's threadpool for
571example) that can't properly initialise their signal masks.
572.ie n .IP """EVFLAG_NOSIGMASK""" 4
573.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
574.IX Item "EVFLAG_NOSIGMASK"
575When this flag is specified, then libev will avoid to modify the signal
576mask. Specifically, this means you have to make sure signals are unblocked
577when you want to receive them.
578.Sp
579This behaviour is useful when you want to do your own signal handling, or
580want to handle signals only in specific threads and want to avoid libev
581unblocking the signals.
582.Sp
583It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
584\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
585.Sp
586This flag's behaviour will become the default in future versions of libev.
350.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 587.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
351.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 588.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
352.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 589.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
353This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 590This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
354libev tries to roll its own fd_set with no limits on the number of fds, 591libev 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 592but 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 593using this backend. It doesn't scale too well (O(highest_fd)), but its
357the fastest backend for a low number of fds. 594usually the fastest backend for a low number of (low-numbered :) fds.
595.Sp
596To get good performance out of this backend you need a high amount of
597parallelism (most of the file descriptors should be busy). If you are
598writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many
599connections as possible during one iteration. You might also want to have
600a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of
601readiness notifications you get per iteration.
602.Sp
603This 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
604\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
605\&\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 606.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 607.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)" 608.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 609And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
362select, but handles sparse fds better and has no artificial limit on the 610than select, but handles sparse fds better and has no artificial
363number of fds you can use (except it will slow down considerably with a 611limit 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). 612considerably with a lot of inactive fds). It scales similarly to select,
613i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
614performance tips.
615.Sp
616This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
617\&\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 618.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
366.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 619.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
367.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 620.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
621Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
622kernels).
623.Sp
368For few fds, this backend is a bit little slower than poll and select, 624For 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 625it 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 626O(total_fds) where total_fds is the total number of fds (or the highest
371either O(1) or O(active_fds). 627fd), epoll scales either O(1) or O(active_fds).
372.Sp 628.Sp
629The epoll mechanism deserves honorable mention as the most misdesigned
630of the more advanced event mechanisms: mere annoyances include silently
631dropping file descriptors, requiring a system call per change per file
632descriptor (and unnecessary guessing of parameters), problems with dup,
633returning before the timeout value, resulting in additional iterations
634(and only giving 5ms accuracy while select on the same platform gives
6350.1ms) and so on. The biggest issue is fork races, however \- if a program
636forks then \fIboth\fR parent and child process have to recreate the epoll
637set, which can take considerable time (one syscall per file descriptor)
638and is of course hard to detect.
639.Sp
640Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work,
641but of course \fIdoesn't\fR, and epoll just loves to report events for
642totally \fIdifferent\fR file descriptors (even already closed ones, so
643one cannot even remove them from the set) than registered in the set
644(especially on \s-1SMP\s0 systems). Libev tries to counter these spurious
645notifications by employing an additional generation counter and comparing
646that against the events to filter out spurious ones, recreating the set
647when required. Epoll also erroneously rounds down timeouts, but gives you
648no way to know when and by how much, so sometimes you have to busy-wait
649because epoll returns immediately despite a nonzero timeout. And last
650not least, it also refuses to work with some file descriptors which work
651perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...).
652.Sp
653Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
654cobbled together in a hurry, no thought to design or interaction with
655others. Oh, the pain, will it ever stop...
656.Sp
373While stopping and starting an I/O watcher in the same iteration will 657While stopping, setting and starting an I/O watcher in the same iteration
374result in some caching, there is still a syscall per such incident 658will 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 659incident (because the same \fIfile descriptor\fR could point to a different
376best to avoid that. Also, \fIdup()\fRed file descriptors might not work very 660\&\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. 661file descriptors might not work very well if you register events for both
662file descriptors.
378.Sp 663.Sp
379Please note that epoll sometimes generates spurious notifications, so you 664Best 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 665watchers for a file descriptor until it has been closed, if possible,
381(or space) is available. 666i.e. keep at least one watcher active per fd at all times. Stopping and
667starting a watcher (without re-setting it) also usually doesn't cause
668extra overhead. A fork can both result in spurious notifications as well
669as in libev having to destroy and recreate the epoll object, which can
670take considerable time and thus should be avoided.
671.Sp
672All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
673faster than epoll for maybe up to a hundred file descriptors, depending on
674the usage. So sad.
675.Sp
676While nominally embeddable in other event loops, this feature is broken in
677all kernel versions tested so far.
678.Sp
679This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
680\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
382.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 681.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 682.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
384.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 683.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
385Kqueue deserves special mention, as at the time of this writing, it 684Kqueue deserves special mention, as at the time of this writing, it
386was broken on all BSDs except NetBSD (usually it doesn't work with 685was broken on all BSDs except NetBSD (usually it doesn't work reliably
387anything but sockets and pipes, except on Darwin, where of course its 686with anything but sockets and pipes, except on Darwin, where of course
388completely useless). For this reason its not being \*(L"autodetected\*(R" 687it's completely useless). Unlike epoll, however, whose brokenness
688is by design, these kqueue bugs can (and eventually will) be fixed
689without \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 690\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using
390\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). 691\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough)
692system like NetBSD.
693.Sp
694You still can embed kqueue into a normal poll or select backend and use it
695only for sockets (after having made sure that sockets work with kqueue on
696the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
391.Sp 697.Sp
392It scales in the same way as the epoll backend, but the interface to the 698It 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 699kernel is more efficient (which says nothing about its actual speed, of
394course). While starting and stopping an I/O watcher does not cause an 700course). 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 701cause 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. 702two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
703might have to leak fd's on fork, but it's more sane than epoll) and it
704drops fds silently in similarly hard-to-detect cases.
705.Sp
706This backend usually performs well under most conditions.
707.Sp
708While nominally embeddable in other event loops, this doesn't work
709everywhere, so you might need to test for this. And since it is broken
710almost everywhere, you should only use it when you have a lot of sockets
711(for which it usually works), by embedding it into another event loop
712(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
713also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
714.Sp
715This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
716\&\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
717\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
397.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 718.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
398.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 719.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4
399.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" 720.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)"
400This is not implemented yet (and might never be). 721This is not implemented yet (and might never be, unless you send me an
722implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
723and is not embeddable, which would limit the usefulness of this backend
724immensely.
401.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 725.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
402.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 726.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
403.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 727.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
404This uses the Solaris 10 port mechanism. As with everything on Solaris, 728This 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)). 729it's really slow, but it still scales very well (O(active_fds)).
406.Sp 730.Sp
407Please note that solaris ports can result in a lot of spurious 731While 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 732file descriptor per loop iteration. For small and medium numbers of file
409blocking when no data (or space) is available. 733descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
734might perform better.
735.Sp
736On the positive side, this backend actually performed fully to
737specification in all tests and is fully embeddable, which is a rare feat
738among the OS-specific backends (I vastly prefer correctness over speed
739hacks).
740.Sp
741On the negative side, the interface is \fIbizarre\fR \- so bizarre that
742even sun itself gets it wrong in their code examples: The event polling
743function sometimes returns events to the caller even though an error
744occurred, but with no indication whether it has done so or not (yes, it's
745even documented that way) \- deadly for edge-triggered interfaces where you
746absolutely have to know whether an event occurred or not because you have
747to re-arm the watcher.
748.Sp
749Fortunately libev seems to be able to work around these idiocies.
750.Sp
751This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
752\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
410.ie n .IP """EVBACKEND_ALL""" 4 753.ie n .IP """EVBACKEND_ALL""" 4
411.el .IP "\f(CWEVBACKEND_ALL\fR" 4 754.el .IP "\f(CWEVBACKEND_ALL\fR" 4
412.IX Item "EVBACKEND_ALL" 755.IX Item "EVBACKEND_ALL"
413Try all backends (even potentially broken ones that wouldn't be tried 756Try 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 757with \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. 758\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.
759.Sp
760It is definitely not recommended to use this flag, use whatever
761\&\f(CW\*(C`ev_recommended_backends ()\*(C'\fR returns, or simply do not specify a backend
762at all.
763.ie n .IP """EVBACKEND_MASK""" 4
764.el .IP "\f(CWEVBACKEND_MASK\fR" 4
765.IX Item "EVBACKEND_MASK"
766Not a backend at all, but a mask to select all backend bits from a
767\&\f(CW\*(C`flags\*(C'\fR value, in case you want to mask out any backends from a flags
768value (e.g. when modifying the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR environment variable).
416.RE 769.RE
417.RS 4 770.RS 4
418.Sp 771.Sp
419If one or more of these are ored into the flags value, then only these 772If 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 773then only these backends will be tried (in the reverse order as listed
421specified, most compiled-in backend will be tried, usually in reverse 774here). If none are specified, all backends in \f(CW\*(C`ev_recommended_backends
422order of their flag values :) 775()\*(C'\fR will be tried.
423.Sp 776.Sp
424The most typical usage is like this: 777Example: Try to create a event loop that uses epoll and nothing else.
425.Sp 778.Sp
426.Vb 2 779.Vb 3
427\& if (!ev_default_loop (0)) 780\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
428\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 781\& if (!epoller)
782\& fatal ("no epoll found here, maybe it hides under your chair");
429.Ve 783.Ve
430.Sp 784.Sp
431Restrict libev to the select and poll backends, and do not allow 785Example: Use whatever libev has to offer, but make sure that kqueue is
432environment settings to be taken into account: 786used if available.
433.Sp 787.Sp
434.Vb 1 788.Vb 1
435\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
436.Ve
437.Sp
438Use whatever libev has to offer, but make sure that kqueue is used if
439available (warning, breaks stuff, best use only with your own private
440event loop and only if you know the \s-1OS\s0 supports your types of fds):
441.Sp
442.Vb 1
443\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); 789\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
444.Ve 790.Ve
445.RE 791.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 792.IP "ev_loop_destroy (loop)" 4
461.IX Item "ev_default_destroy ()" 793.IX Item "ev_loop_destroy (loop)"
462Destroys the default loop again (frees all memory and kernel state 794Destroys an event loop object (frees all memory and kernel state
463etc.). None of the active event watchers will be stopped in the normal 795etc.). 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 796sense, 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 797responsibility to either stop all watchers cleanly yourself \fIbefore\fR
466calling this function, or cope with the fact afterwards (which is usually 798calling 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 799the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
468for example). 800for 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 801.Sp
480You \fImust\fR call this function in the child process after forking if and 802Note 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 803handlers), will not be freed by this function, and related watchers (such
482fork+exec, you don't have to call it. 804as signal and child watchers) would need to be stopped manually.
483.Sp 805.Sp
484The function itself is quite fast and it's usually not a problem to call 806This 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 807\&\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: 808\&\f(CW\*(C`ev_default_loop\*(C'\fR, in which case it is not thread-safe.
487.Sp 809.Sp
488.Vb 1 810Note that it is not advisable to call this function on the default loop
489\& pthread_atfork (0, 0, ev_default_fork); 811except in the rare occasion where you really need to free its resources.
490.Ve 812If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
491.Sp 813and \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 814.IP "ev_loop_fork (loop)" 4
496.IX Item "ev_loop_fork (loop)" 815.IX Item "ev_loop_fork (loop)"
497Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 816This 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 817to reinitialise the kernel state for backends that have one. Despite
499after fork, and how you do this is entirely your own problem. 818the name, you can call it anytime you are allowed to start or stop
819watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most
820sense after forking, in the child process. You \fImust\fR call it (or use
821\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
822.Sp
823In addition, if you want to reuse a loop (via this function or
824\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR.
825.Sp
826Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
827a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
828because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
829during fork.
830.Sp
831On the other hand, you only need to call this function in the child
832process if and only if you want to use the event loop in the child. If
833you just fork+exec or create a new loop in the child, you don't have to
834call it at all (in fact, \f(CW\*(C`epoll\*(C'\fR is so badly broken that it makes a
835difference, but libev will usually detect this case on its own and do a
836costly reset of the backend).
837.Sp
838The function itself is quite fast and it's usually not a problem to call
839it just in case after a fork.
840.Sp
841Example: Automate calling \f(CW\*(C`ev_loop_fork\*(C'\fR on the default loop when
842using pthreads.
843.Sp
844.Vb 5
845\& static void
846\& post_fork_child (void)
847\& {
848\& ev_loop_fork (EV_DEFAULT);
849\& }
850\&
851\& ...
852\& pthread_atfork (0, 0, post_fork_child);
853.Ve
854.IP "int ev_is_default_loop (loop)" 4
855.IX Item "int ev_is_default_loop (loop)"
856Returns true when the given loop is, in fact, the default loop, and false
857otherwise.
858.IP "unsigned int ev_iteration (loop)" 4
859.IX Item "unsigned int ev_iteration (loop)"
860Returns the current iteration count for the event loop, which is identical
861to the number of times libev did poll for new events. It starts at \f(CW0\fR
862and happily wraps around with enough iterations.
863.Sp
864This value can sometimes be useful as a generation counter of sorts (it
865\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
866\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the
867prepare and check phases.
868.IP "unsigned int ev_depth (loop)" 4
869.IX Item "unsigned int ev_depth (loop)"
870Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of
871times \f(CW\*(C`ev_run\*(C'\fR was exited normally, in other words, the recursion depth.
872.Sp
873Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is
874\&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread),
875in which case it is higher.
876.Sp
877Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread,
878throwing an exception etc.), doesn't count as \*(L"exit\*(R" \- consider this
879as a hint to avoid such ungentleman-like behaviour unless it's really
880convenient, in which case it is fully supported.
500.IP "unsigned int ev_backend (loop)" 4 881.IP "unsigned int ev_backend (loop)" 4
501.IX Item "unsigned int ev_backend (loop)" 882.IX Item "unsigned int ev_backend (loop)"
502Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 883Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
503use. 884use.
504.IP "ev_tstamp ev_now (loop)" 4 885.IP "ev_tstamp ev_now (loop)" 4
505.IX Item "ev_tstamp ev_now (loop)" 886.IX Item "ev_tstamp ev_now (loop)"
506Returns the current \*(L"event loop time\*(R", which is the time the event loop 887Returns the current \*(L"event loop time\*(R", which is the time the event loop
507received events and started processing them. This timestamp does not 888received events and started processing them. This timestamp does not
508change as long as callbacks are being processed, and this is also the base 889change 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 890time used for relative timers. You can treat it as the timestamp of the
510event occuring (or more correctly, libev finding out about it). 891event occurring (or more correctly, libev finding out about it).
892.IP "ev_now_update (loop)" 4
893.IX Item "ev_now_update (loop)"
894Establishes the current time by querying the kernel, updating the time
895returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and
896is usually done automatically within \f(CW\*(C`ev_run ()\*(C'\fR.
897.Sp
898This function is rarely useful, but when some event callback runs for a
899very long time without entering the event loop, updating libev's idea of
900the current time is a good idea.
901.Sp
902See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section.
903.IP "ev_suspend (loop)" 4
904.IX Item "ev_suspend (loop)"
905.PD 0
906.IP "ev_resume (loop)" 4
907.IX Item "ev_resume (loop)"
908.PD
909These two functions suspend and resume an event loop, for use when the
910loop is not used for a while and timeouts should not be processed.
911.Sp
912A typical use case would be an interactive program such as a game: When
913the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it
914would be best to handle timeouts as if no time had actually passed while
915the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR
916in your \f(CW\*(C`SIGTSTP\*(C'\fR handler, sending yourself a \f(CW\*(C`SIGSTOP\*(C'\fR and calling
917\&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing.
918.Sp
919Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend
920between \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
921will be rescheduled (that is, they will lose any events that would have
922occurred while suspended).
923.Sp
924After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the
925given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
926without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
927.Sp
928Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
929event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
511.IP "ev_loop (loop, int flags)" 4 930.IP "bool ev_run (loop, int flags)" 4
512.IX Item "ev_loop (loop, int flags)" 931.IX Item "bool ev_run (loop, int flags)"
513Finally, this is it, the event handler. This function usually is called 932Finally, this is it, the event handler. This function usually is called
514after you initialised all your watchers and you want to start handling 933after you have initialised all your watchers and you want to start
515events. 934handling events. It will ask the operating system for any new events, call
935the watcher callbacks, and then repeat the whole process indefinitely: This
936is why event loops are called \fIloops\fR.
516.Sp 937.Sp
517If the flags argument is specified as \f(CW0\fR, it will not return until 938If 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. 939until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
940called.
519.Sp 941.Sp
942The return value is false if there are no more active watchers (which
943usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
944(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
945.Sp
520Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than 946Please 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 947relying on all watchers to be stopped when deciding when a program has
522finished (especially in interactive programs), but having a program that 948finished (especially in interactive programs), but having a program
523automatically loops as long as it has to and no longer by virtue of 949that automatically loops as long as it has to and no longer by virtue
524relying on its watchers stopping correctly is a thing of beauty. 950of relying on its watchers stopping correctly, that is truly a thing of
951beauty.
525.Sp 952.Sp
953This function is \fImostly\fR exception-safe \- you can break out of a
954\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
955exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
956will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
957.Sp
526A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle 958A 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 959those 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. 960block your process in case there are no events and will return after one
961iteration of the loop. This is sometimes useful to poll and handle new
962events while doing lengthy calculations, to keep the program responsive.
529.Sp 963.Sp
530A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if 964A 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 965necessary) and will handle those and any already outstanding ones. It
532your process until at least one new event arrives, and will return after 966will 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 967be an event internal to libev itself, so there is no guarantee that a
534external event in conjunction with something not expressible using other 968user-registered callback will be called), and will return after one
969iteration of the loop.
970.Sp
971This is useful if you are waiting for some external event in conjunction
972with 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 973own \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. 974usually a better approach for this kind of thing.
537.Sp 975.Sp
538Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 976Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does (this is for your
977understanding, not a guarantee that things will work exactly like this in
978future versions):
539.Sp 979.Sp
540.Vb 18 980.Vb 10
541\& * If there are no active watchers (reference count is zero), return. 981\& \- Increment loop depth.
542\& - Queue prepare watchers and then call all outstanding watchers. 982\& \- Reset the ev_break status.
983\& \- Before the first iteration, call any pending watchers.
984\& LOOP:
985\& \- If EVFLAG_FORKCHECK was used, check for a fork.
986\& \- If a fork was detected (by any means), queue and call all fork watchers.
987\& \- Queue and call all prepare watchers.
988\& \- If ev_break was called, goto FINISH.
543\& - If we have been forked, recreate the kernel state. 989\& \- If we have been forked, detach and recreate the kernel state
990\& as to not disturb the other process.
544\& - Update the kernel state with all outstanding changes. 991\& \- Update the kernel state with all outstanding changes.
545\& - Update the "event loop time". 992\& \- Update the "event loop time" (ev_now ()).
546\& - Calculate for how long to block. 993\& \- Calculate for how long to sleep or block, if at all
994\& (active idle watchers, EVRUN_NOWAIT or not having
995\& any active watchers at all will result in not sleeping).
996\& \- Sleep if the I/O and timer collect interval say so.
997\& \- Increment loop iteration counter.
547\& - Block the process, waiting for any events. 998\& \- Block the process, waiting for any events.
548\& - Queue all outstanding I/O (fd) events. 999\& \- Queue all outstanding I/O (fd) events.
549\& - Update the "event loop time" and do time jump handling. 1000\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments.
550\& - Queue all outstanding timers. 1001\& \- Queue all expired timers.
551\& - Queue all outstanding periodics. 1002\& \- Queue all expired periodics.
552\& - If no events are pending now, queue all idle watchers. 1003\& \- Queue all idle watchers with priority higher than that of pending events.
553\& - Queue all check watchers. 1004\& \- Queue all check watchers.
554\& - Call all queued watchers in reverse order (i.e. check watchers first). 1005\& \- 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 1006\& Signals and child watchers are implemented as I/O watchers, and will
556\& be handled here by queueing them when their watcher gets executed. 1007\& be handled here by queueing them when their watcher gets executed.
557\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 1008\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
558\& were used, return, otherwise continue with step *. 1009\& were used, or there are no active watchers, goto FINISH, otherwise
1010\& continue with step LOOP.
1011\& FINISH:
1012\& \- Reset the ev_break status iff it was EVBREAK_ONE.
1013\& \- Decrement the loop depth.
1014\& \- Return.
559.Ve 1015.Ve
560.Sp 1016.Sp
561Example: queue some jobs and then loop until no events are outsanding 1017Example: Queue some jobs and then loop until no events are outstanding
562anymore. 1018anymore.
563.Sp 1019.Sp
564.Vb 4 1020.Vb 4
565\& ... queue jobs here, make sure they register event watchers as long 1021\& ... 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..) 1022\& ... as they still have work to do (even an idle watcher will do..)
567\& ev_loop (my_loop, 0); 1023\& ev_run (my_loop, 0);
568\& ... jobs done. yeah! 1024\& ... jobs done or somebody called break. yeah!
569.Ve 1025.Ve
570.IP "ev_unloop (loop, how)" 4 1026.IP "ev_break (loop, how)" 4
571.IX Item "ev_unloop (loop, how)" 1027.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 1028Can 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 1029has 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 1030\&\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. 1031\&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return.
1032.Sp
1033This \*(L"break state\*(R" will be cleared on the next call to \f(CW\*(C`ev_run\*(C'\fR.
1034.Sp
1035It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too, in
1036which case it will have no effect.
576.IP "ev_ref (loop)" 4 1037.IP "ev_ref (loop)" 4
577.IX Item "ev_ref (loop)" 1038.IX Item "ev_ref (loop)"
578.PD 0 1039.PD 0
579.IP "ev_unref (loop)" 4 1040.IP "ev_unref (loop)" 4
580.IX Item "ev_unref (loop)" 1041.IX Item "ev_unref (loop)"
581.PD 1042.PD
582Ref/unref can be used to add or remove a reference count on the event 1043Ref/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 1044loop: 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 1045count 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 1046.Sp
586returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For 1047This is useful when you have a watcher that you never intend to
1048unregister, but that nevertheless should not keep \f(CW\*(C`ev_run\*(C'\fR from
1049returning. In such a case, call \f(CW\*(C`ev_unref\*(C'\fR after starting, and \f(CW\*(C`ev_ref\*(C'\fR
1050before stopping it.
1051.Sp
587example, libev itself uses this for its internal signal pipe: It is not 1052As 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 1053is 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 1054exiting 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 1055excellent way to do this for generic recurring timers or from within
591libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. 1056third-party libraries. Just remember to \fIunref after start\fR and \fIref
1057before stop\fR (but only if the watcher wasn't active before, or was active
1058before, respectively. Note also that libev might stop watchers itself
1059(e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR
1060in the callback).
592.Sp 1061.Sp
593Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 1062Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_run\*(C'\fR
594running when nothing else is active. 1063running when nothing else is active.
595.Sp 1064.Sp
596.Vb 4 1065.Vb 4
597\& struct dv_signal exitsig; 1066\& ev_signal exitsig;
598\& ev_signal_init (&exitsig, sig_cb, SIGINT); 1067\& ev_signal_init (&exitsig, sig_cb, SIGINT);
599\& ev_signal_start (myloop, &exitsig); 1068\& ev_signal_start (loop, &exitsig);
600\& evf_unref (myloop); 1069\& ev_unref (loop);
601.Ve 1070.Ve
602.Sp 1071.Sp
603Example: for some weird reason, unregister the above signal handler again. 1072Example: For some weird reason, unregister the above signal handler again.
604.Sp 1073.Sp
605.Vb 2 1074.Vb 2
606\& ev_ref (myloop); 1075\& ev_ref (loop);
607\& ev_signal_stop (myloop, &exitsig); 1076\& ev_signal_stop (loop, &exitsig);
608.Ve 1077.Ve
1078.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4
1079.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)"
1080.PD 0
1081.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4
1082.IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)"
1083.PD
1084These advanced functions influence the time that libev will spend waiting
1085for events. Both time intervals are by default \f(CW0\fR, meaning that libev
1086will try to invoke timer/periodic callbacks and I/O callbacks with minimum
1087latency.
1088.Sp
1089Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR)
1090allows libev to delay invocation of I/O and timer/periodic callbacks
1091to increase efficiency of loop iterations (or to increase power-saving
1092opportunities).
1093.Sp
1094The idea is that sometimes your program runs just fast enough to handle
1095one (or very few) event(s) per loop iteration. While this makes the
1096program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new
1097events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high
1098overhead for the actual polling but can deliver many events at once.
1099.Sp
1100By setting a higher \fIio collect interval\fR you allow libev to spend more
1101time collecting I/O events, so you can handle more events per iteration,
1102at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
1103\&\f(CW\*(C`ev_timer\*(C'\fR) will not be affected. Setting this to a non-null value will
1104introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
1105sleep time ensures that libev will not poll for I/O events more often then
1106once per this interval, on average (as long as the host time resolution is
1107good enough).
1108.Sp
1109Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
1110to spend more time collecting timeouts, at the expense of increased
1111latency/jitter/inexactness (the watcher callback will be called
1112later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
1113value will not introduce any overhead in libev.
1114.Sp
1115Many (busy) programs can usually benefit by setting the I/O collect
1116interval to a value near \f(CW0.1\fR or so, which is often enough for
1117interactive servers (of course not for games), likewise for timeouts. It
1118usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR,
1119as this approaches the timing granularity of most systems. Note that if
1120you do transactions with the outside world and you can't increase the
1121parallelity, then this setting will limit your transaction rate (if you
1122need to poll once per transaction and the I/O collect interval is 0.01,
1123then you can't do more than 100 transactions per second).
1124.Sp
1125Setting the \fItimeout collect interval\fR can improve the opportunity for
1126saving power, as the program will \*(L"bundle\*(R" timer callback invocations that
1127are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of
1128times the process sleeps and wakes up again. Another useful technique to
1129reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure
1130they fire on, say, one-second boundaries only.
1131.Sp
1132Example: we only need 0.1s timeout granularity, and we wish not to poll
1133more often than 100 times per second:
1134.Sp
1135.Vb 2
1136\& ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
1137\& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
1138.Ve
1139.IP "ev_invoke_pending (loop)" 4
1140.IX Item "ev_invoke_pending (loop)"
1141This call will simply invoke all pending watchers while resetting their
1142pending state. Normally, \f(CW\*(C`ev_run\*(C'\fR does this automatically when required,
1143but when overriding the invoke callback this call comes handy. This
1144function can be invoked from a watcher \- this can be useful for example
1145when you want to do some lengthy calculation and want to pass further
1146event handling to another thread (you still have to make sure only one
1147thread executes within \f(CW\*(C`ev_invoke_pending\*(C'\fR or \f(CW\*(C`ev_run\*(C'\fR of course).
1148.IP "int ev_pending_count (loop)" 4
1149.IX Item "int ev_pending_count (loop)"
1150Returns the number of pending watchers \- zero indicates that no watchers
1151are pending.
1152.IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4
1153.IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))"
1154This overrides the invoke pending functionality of the loop: Instead of
1155invoking all pending watchers when there are any, \f(CW\*(C`ev_run\*(C'\fR will call
1156this callback instead. This is useful, for example, when you want to
1157invoke the actual watchers inside another context (another thread etc.).
1158.Sp
1159If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1160callback.
1161.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
1162.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
1163Sometimes you want to share the same loop between multiple threads. This
1164can be done relatively simply by putting mutex_lock/unlock calls around
1165each call to a libev function.
1166.Sp
1167However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1168to wait for it to return. One way around this is to wake up the event
1169loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`ev_async_send\*(C'\fR, another way is to set these
1170\&\fIrelease\fR and \fIacquire\fR callbacks on the loop.
1171.Sp
1172When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1173suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1174afterwards.
1175.Sp
1176Ideally, \f(CW\*(C`release\*(C'\fR will just call your mutex_unlock function, and
1177\&\f(CW\*(C`acquire\*(C'\fR will just call the mutex_lock function again.
1178.Sp
1179While event loop modifications are allowed between invocations of
1180\&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no
1181modifications done will affect the event loop, i.e. adding watchers will
1182have no effect on the set of file descriptors being watched, or the time
1183waited. Use an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_run\*(C'\fR when you want it
1184to take note of any changes you made.
1185.Sp
1186In theory, threads executing \f(CW\*(C`ev_run\*(C'\fR will be async-cancel safe between
1187invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR.
1188.Sp
1189See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this
1190document.
1191.IP "ev_set_userdata (loop, void *data)" 4
1192.IX Item "ev_set_userdata (loop, void *data)"
1193.PD 0
1194.IP "void *ev_userdata (loop)" 4
1195.IX Item "void *ev_userdata (loop)"
1196.PD
1197Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When
1198\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns
1199\&\f(CW0\fR.
1200.Sp
1201These two functions can be used to associate arbitrary data with a loop,
1202and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and
1203\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for
1204any other purpose as well.
1205.IP "ev_verify (loop)" 4
1206.IX Item "ev_verify (loop)"
1207This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been
1208compiled in, which is the default for non-minimal builds. It tries to go
1209through all internal structures and checks them for validity. If anything
1210is found to be inconsistent, it will print an error message to standard
1211error and call \f(CW\*(C`abort ()\*(C'\fR.
1212.Sp
1213This can be used to catch bugs inside libev itself: under normal
1214circumstances, this function will never abort as of course libev keeps its
1215data structures consistent.
609.SH "ANATOMY OF A WATCHER" 1216.SH "ANATOMY OF A WATCHER"
610.IX Header "ANATOMY OF A WATCHER" 1217.IX Header "ANATOMY OF A WATCHER"
1218In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the
1219watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer
1220watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers.
1221.PP
611A watcher is a structure that you create and register to record your 1222A 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 1223your 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: 1224to wait for \s-1STDIN\s0 to become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher
1225for that:
614.PP 1226.PP
615.Vb 5 1227.Vb 5
616\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1228\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
617\& { 1229\& {
618\& ev_io_stop (w); 1230\& ev_io_stop (w);
619\& ev_unloop (loop, EVUNLOOP_ALL); 1231\& ev_break (loop, EVBREAK_ALL);
620\& } 1232\& }
621.Ve 1233\&
622.PP
623.Vb 6
624\& struct ev_loop *loop = ev_default_loop (0); 1234\& struct ev_loop *loop = ev_default_loop (0);
1235\&
625\& struct ev_io stdin_watcher; 1236\& ev_io stdin_watcher;
1237\&
626\& ev_init (&stdin_watcher, my_cb); 1238\& ev_init (&stdin_watcher, my_cb);
627\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 1239\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
628\& ev_io_start (loop, &stdin_watcher); 1240\& ev_io_start (loop, &stdin_watcher);
1241\&
629\& ev_loop (loop, 0); 1242\& ev_run (loop, 0);
630.Ve 1243.Ve
631.PP 1244.PP
632As you can see, you are responsible for allocating the memory for your 1245As 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, 1246watcher structures (and it is \fIusually\fR a bad idea to do this on the
634although this can sometimes be quite valid). 1247stack).
635.PP 1248.PP
1249Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR
1250or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs).
1251.PP
636Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init 1252Each 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 1253*, 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 1254invoked 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 1255time the event loop detects that the file descriptor given is readable
640is readable and/or writable). 1256and/or writable).
641.PP 1257.PP
642Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro 1258Each 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 1259macro 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 1260is 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 1261.PP
647To make the watcher actually watch out for events, you have to start it 1262To 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 1263with 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 1264*)\*(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. 1265corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR.
651.PP 1266.PP
652As long as your watcher is active (has been started but not stopped) you 1267As 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 1268must not touch the values stored in it. Most specifically you must never
654reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro. 1269reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro.
655.PP 1270.PP
656Each and every callback receives the event loop pointer as first, the 1271Each and every callback receives the event loop pointer as first, the
657registered watcher structure as second, and a bitset of received events as 1272registered watcher structure as second, and a bitset of received events as
658third argument. 1273third argument.
659.PP 1274.PP
… …
668.el .IP "\f(CWEV_WRITE\fR" 4 1283.el .IP "\f(CWEV_WRITE\fR" 4
669.IX Item "EV_WRITE" 1284.IX Item "EV_WRITE"
670.PD 1285.PD
671The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or 1286The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or
672writable. 1287writable.
673.ie n .IP """EV_TIMEOUT""" 4 1288.ie n .IP """EV_TIMER""" 4
674.el .IP "\f(CWEV_TIMEOUT\fR" 4 1289.el .IP "\f(CWEV_TIMER\fR" 4
675.IX Item "EV_TIMEOUT" 1290.IX Item "EV_TIMER"
676The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out. 1291The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out.
677.ie n .IP """EV_PERIODIC""" 4 1292.ie n .IP """EV_PERIODIC""" 4
678.el .IP "\f(CWEV_PERIODIC\fR" 4 1293.el .IP "\f(CWEV_PERIODIC\fR" 4
679.IX Item "EV_PERIODIC" 1294.IX Item "EV_PERIODIC"
680The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out. 1295The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out.
… …
700.PD 0 1315.PD 0
701.ie n .IP """EV_CHECK""" 4 1316.ie n .IP """EV_CHECK""" 4
702.el .IP "\f(CWEV_CHECK\fR" 4 1317.el .IP "\f(CWEV_CHECK\fR" 4
703.IX Item "EV_CHECK" 1318.IX Item "EV_CHECK"
704.PD 1319.PD
705All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_loop\*(C'\fR starts 1320All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
706to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1321gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
707\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 1322just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1323for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1324watchers invoked before the event loop sleeps or polls for new events, and
1325\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1326or lower priority within an event loop iteration.
1327.Sp
708received events. Callbacks of both watcher types can start and stop as 1328Callbacks of both watcher types can start and stop as many watchers as
709many watchers as they want, and all of them will be taken into account 1329they want, and all of them will be taken into account (for example, a
710(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1330\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
711\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 1331blocking).
1332.ie n .IP """EV_EMBED""" 4
1333.el .IP "\f(CWEV_EMBED\fR" 4
1334.IX Item "EV_EMBED"
1335The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1336.ie n .IP """EV_FORK""" 4
1337.el .IP "\f(CWEV_FORK\fR" 4
1338.IX Item "EV_FORK"
1339The event loop has been resumed in the child process after fork (see
1340\&\f(CW\*(C`ev_fork\*(C'\fR).
1341.ie n .IP """EV_CLEANUP""" 4
1342.el .IP "\f(CWEV_CLEANUP\fR" 4
1343.IX Item "EV_CLEANUP"
1344The event loop is about to be destroyed (see \f(CW\*(C`ev_cleanup\*(C'\fR).
1345.ie n .IP """EV_ASYNC""" 4
1346.el .IP "\f(CWEV_ASYNC\fR" 4
1347.IX Item "EV_ASYNC"
1348The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
1349.ie n .IP """EV_CUSTOM""" 4
1350.el .IP "\f(CWEV_CUSTOM\fR" 4
1351.IX Item "EV_CUSTOM"
1352Not ever sent (or otherwise used) by libev itself, but can be freely used
1353by libev users to signal watchers (e.g. via \f(CW\*(C`ev_feed_event\*(C'\fR).
712.ie n .IP """EV_ERROR""" 4 1354.ie n .IP """EV_ERROR""" 4
713.el .IP "\f(CWEV_ERROR\fR" 4 1355.el .IP "\f(CWEV_ERROR\fR" 4
714.IX Item "EV_ERROR" 1356.IX Item "EV_ERROR"
715An unspecified error has occured, the watcher has been stopped. This might 1357An unspecified error has occurred, the watcher has been stopped. This might
716happen because the watcher could not be properly started because libev 1358happen because the watcher could not be properly started because libev
717ran out of memory, a file descriptor was found to be closed or any other 1359ran out of memory, a file descriptor was found to be closed or any other
1360problem. Libev considers these application bugs.
1361.Sp
718problem. You best act on it by reporting the problem and somehow coping 1362You best act on it by reporting the problem and somehow coping with the
719with the watcher being stopped. 1363watcher being stopped. Note that well-written programs should not receive
1364an error ever, so when your watcher receives it, this usually indicates a
1365bug in your program.
720.Sp 1366.Sp
721Libev will usually signal a few \*(L"dummy\*(R" events together with an error, 1367Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
722for example it might indicate that a fd is readable or writable, and if 1368example it might indicate that a fd is readable or writable, and if your
723your callbacks is well-written it can just attempt the operation and cope 1369callbacks is well-written it can just attempt the operation and cope with
724with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded 1370the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
725programs, though, so beware. 1371programs, though, as the fd could already be closed and reused for another
1372thing, so beware.
726.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1373.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
727.IX Subsection "GENERIC WATCHER FUNCTIONS" 1374.IX Subsection "GENERIC WATCHER FUNCTIONS"
728In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type,
729e.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.
730.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1375.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
731.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1376.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
732.IX Item "ev_init (ev_TYPE *watcher, callback)" 1377.IX Item "ev_init (ev_TYPE *watcher, callback)"
733This macro initialises the generic portion of a watcher. The contents 1378This macro initialises the generic portion of a watcher. The contents
734of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only 1379of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only
… …
738which rolls both calls into one. 1383which rolls both calls into one.
739.Sp 1384.Sp
740You can reinitialise a watcher at any time as long as it has been stopped 1385You can reinitialise a watcher at any time as long as it has been stopped
741(or never started) and there are no pending events outstanding. 1386(or never started) and there are no pending events outstanding.
742.Sp 1387.Sp
743The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, 1388The callback is always of type \f(CW\*(C`void (*)(struct ev_loop *loop, ev_TYPE *watcher,
744int revents)\*(C'\fR. 1389int revents)\*(C'\fR.
1390.Sp
1391Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps.
1392.Sp
1393.Vb 3
1394\& ev_io w;
1395\& ev_init (&w, my_cb);
1396\& ev_io_set (&w, STDIN_FILENO, EV_READ);
1397.Ve
745.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 1398.ie n .IP """ev_TYPE_set"" (ev_TYPE *watcher, [args])" 4
746.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 1399.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *watcher, [args])" 4
747.IX Item "ev_TYPE_set (ev_TYPE *, [args])" 1400.IX Item "ev_TYPE_set (ev_TYPE *watcher, [args])"
748This macro initialises the type-specific parts of a watcher. You need to 1401This macro initialises the type-specific parts of a watcher. You need to
749call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can 1402call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
750call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this 1403call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this
751macro on a watcher that is active (it can be pending, however, which is a 1404macro on a watcher that is active (it can be pending, however, which is a
752difference to the \f(CW\*(C`ev_init\*(C'\fR macro). 1405difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
753.Sp 1406.Sp
754Although some watcher types do not have type-specific arguments 1407Although some watcher types do not have type-specific arguments
755(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. 1408(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro.
1409.Sp
1410See \f(CW\*(C`ev_init\*(C'\fR, above, for an example.
756.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 1411.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4
757.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 1412.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4
758.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" 1413.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])"
759This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro 1414This convenience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro
760calls into a single call. This is the most convinient method to initialise 1415calls into a single call. This is the most convenient method to initialise
761a watcher. The same limitations apply, of course. 1416a watcher. The same limitations apply, of course.
1417.Sp
1418Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step.
1419.Sp
1420.Vb 1
1421\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1422.Ve
762.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 1423.ie n .IP """ev_TYPE_start"" (loop, ev_TYPE *watcher)" 4
763.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 1424.el .IP "\f(CWev_TYPE_start\fR (loop, ev_TYPE *watcher)" 4
764.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" 1425.IX Item "ev_TYPE_start (loop, ev_TYPE *watcher)"
765Starts (activates) the given watcher. Only active watchers will receive 1426Starts (activates) the given watcher. Only active watchers will receive
766events. If the watcher is already active nothing will happen. 1427events. If the watcher is already active nothing will happen.
1428.Sp
1429Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this
1430whole section.
1431.Sp
1432.Vb 1
1433\& ev_io_start (EV_DEFAULT_UC, &w);
1434.Ve
767.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 1435.ie n .IP """ev_TYPE_stop"" (loop, ev_TYPE *watcher)" 4
768.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 1436.el .IP "\f(CWev_TYPE_stop\fR (loop, ev_TYPE *watcher)" 4
769.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" 1437.IX Item "ev_TYPE_stop (loop, ev_TYPE *watcher)"
770Stops the given watcher again (if active) and clears the pending 1438Stops the given watcher if active, and clears the pending status (whether
1439the watcher was active or not).
1440.Sp
771status. It is possible that stopped watchers are pending (for example, 1441It is possible that stopped watchers are pending \- for example,
772non-repeating timers are being stopped when they become pending), but 1442non-repeating timers are being stopped when they become pending \- but
773\&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If 1443calling \f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor
774you want to free or reuse the memory used by the watcher it is therefore a 1444pending. If you want to free or reuse the memory used by the watcher it is
775good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. 1445therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
776.IP "bool ev_is_active (ev_TYPE *watcher)" 4 1446.IP "bool ev_is_active (ev_TYPE *watcher)" 4
777.IX Item "bool ev_is_active (ev_TYPE *watcher)" 1447.IX Item "bool ev_is_active (ev_TYPE *watcher)"
778Returns a true value iff the watcher is active (i.e. it has been started 1448Returns a true value iff the watcher is active (i.e. it has been started
779and not yet been stopped). As long as a watcher is active you must not modify 1449and not yet been stopped). As long as a watcher is active you must not modify
780it. 1450it.
781.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 1451.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
782.IX Item "bool ev_is_pending (ev_TYPE *watcher)" 1452.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
783Returns a true value iff the watcher is pending, (i.e. it has outstanding 1453Returns a true value iff the watcher is pending, (i.e. it has outstanding
784events but its callback has not yet been invoked). As long as a watcher 1454events but its callback has not yet been invoked). As long as a watcher
785is pending (but not active) you must not call an init function on it (but 1455is pending (but not active) you must not call an init function on it (but
786\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to 1456\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
787libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). 1457make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1458it).
788.IP "callback = ev_cb (ev_TYPE *watcher)" 4 1459.IP "callback ev_cb (ev_TYPE *watcher)" 4
789.IX Item "callback = ev_cb (ev_TYPE *watcher)" 1460.IX Item "callback ev_cb (ev_TYPE *watcher)"
790Returns the callback currently set on the watcher. 1461Returns the callback currently set on the watcher.
791.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1462.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
792.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1463.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
793Change the callback. You can change the callback at virtually any time 1464Change the callback. You can change the callback at virtually any time
794(modulo threads). 1465(modulo threads).
795.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 1466.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
796.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 1467.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
797Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 1468.PD 0
798and read at any time, libev will completely ignore it. This can be used 1469.IP "int ev_priority (ev_TYPE *watcher)" 4
799to associate arbitrary data with your watcher. If you need more data and 1470.IX Item "int ev_priority (ev_TYPE *watcher)"
800don't want to allocate memory and store a pointer to it in that data 1471.PD
801member, you can also \*(L"subclass\*(R" the watcher type and provide your own 1472Set and query the priority of the watcher. The priority is a small
802data: 1473integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
1474(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
1475before watchers with lower priority, but priority will not keep watchers
1476from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
1477.Sp
1478If you need to suppress invocation when higher priority events are pending
1479you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
1480.Sp
1481You \fImust not\fR change the priority of a watcher as long as it is active or
1482pending.
1483.Sp
1484Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
1485fine, as long as you do not mind that the priority value you query might
1486or might not have been clamped to the valid range.
1487.Sp
1488The default priority used by watchers when no priority has been set is
1489always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1490.Sp
1491See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1492priorities.
1493.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1494.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1495Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1496\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1497can deal with that fact, as both are simply passed through to the
1498callback.
1499.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
1500.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
1501If the watcher is pending, this function clears its pending status and
1502returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
1503watcher isn't pending it does nothing and returns \f(CW0\fR.
1504.Sp
1505Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its
1506callback to be invoked, which can be accomplished with this function.
1507.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4
1508.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)"
1509Feeds the given event set into the event loop, as if the specified event
1510had happened for the specified watcher (which must be a pointer to an
1511initialised but not necessarily started event watcher). Obviously you must
1512not free the watcher as long as it has pending events.
1513.Sp
1514Stopping the watcher, letting libev invoke it, or calling
1515\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was
1516not started in the first place.
1517.Sp
1518See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1519functions that do not need a watcher.
803.PP 1520.PP
1521See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1522OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1523.SS "\s-1WATCHER STATES\s0"
1524.IX Subsection "WATCHER STATES"
1525There are various watcher states mentioned throughout this manual \-
1526active, pending and so on. In this section these states and the rules to
1527transition between them will be described in more detail \- and while these
1528rules might look complicated, they usually do \*(L"the right thing\*(R".
1529.IP "initialised" 4
1530.IX Item "initialised"
1531Before a watcher can be registered with the event loop it has to be
1532initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1533\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1534.Sp
1535In this state it is simply some block of memory that is suitable for
1536use in an event loop. It can be moved around, freed, reused etc. at
1537will \- as long as you either keep the memory contents intact, or call
1538\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again.
1539.IP "started/running/active" 4
1540.IX Item "started/running/active"
1541Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1542property of the event loop, and is actively waiting for events. While in
1543this state it cannot be accessed (except in a few documented ways), moved,
1544freed or anything else \- the only legal thing is to keep a pointer to it,
1545and call libev functions on it that are documented to work on active watchers.
1546.IP "pending" 4
1547.IX Item "pending"
1548If a watcher is active and libev determines that an event it is interested
1549in has occurred (such as a timer expiring), it will become pending. It will
1550stay in this pending state until either it is stopped or its callback is
1551about to be invoked, so it is not normally pending inside the watcher
1552callback.
1553.Sp
1554The watcher might or might not be active while it is pending (for example,
1555an expired non-repeating timer can be pending but no longer active). If it
1556is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR),
1557but it is still property of the event loop at this time, so cannot be
1558moved, freed or reused. And if it is active the rules described in the
1559previous item still apply.
1560.Sp
1561It is also possible to feed an event on a watcher that is not active (e.g.
1562via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being
1563active.
1564.IP "stopped" 4
1565.IX Item "stopped"
1566A watcher can be stopped implicitly by libev (in which case it might still
1567be pending), or explicitly by calling its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. The
1568latter will clear any pending state the watcher might be in, regardless
1569of whether it was active or not, so stopping a watcher explicitly before
1570freeing it is often a good idea.
1571.Sp
1572While stopped (and not pending) the watcher is essentially in the
1573initialised state, that is, it can be reused, moved, modified in any way
1574you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1575it again).
1576.SS "\s-1WATCHER PRIORITY MODELS\s0"
1577.IX Subsection "WATCHER PRIORITY MODELS"
1578Many event loops support \fIwatcher priorities\fR, which are usually small
1579integers that influence the ordering of event callback invocation
1580between watchers in some way, all else being equal.
1581.PP
1582In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1583description for the more technical details such as the actual priority
1584range.
1585.PP
1586There are two common ways how these these priorities are being interpreted
1587by event loops:
1588.PP
1589In the more common lock-out model, higher priorities \*(L"lock out\*(R" invocation
1590of lower priority watchers, which means as long as higher priority
1591watchers receive events, lower priority watchers are not being invoked.
1592.PP
1593The less common only-for-ordering model uses priorities solely to order
1594callback invocation within a single event loop iteration: Higher priority
1595watchers are invoked before lower priority ones, but they all get invoked
1596before polling for new events.
1597.PP
1598Libev uses the second (only-for-ordering) model for all its watchers
1599except for idle watchers (which use the lock-out model).
1600.PP
1601The rationale behind this is that implementing the lock-out model for
1602watchers is not well supported by most kernel interfaces, and most event
1603libraries will just poll for the same events again and again as long as
1604their callbacks have not been executed, which is very inefficient in the
1605common case of one high-priority watcher locking out a mass of lower
1606priority ones.
1607.PP
1608Static (ordering) priorities are most useful when you have two or more
1609watchers handling the same resource: a typical usage example is having an
1610\&\f(CW\*(C`ev_io\*(C'\fR watcher to receive data, and an associated \f(CW\*(C`ev_timer\*(C'\fR to handle
1611timeouts. Under load, data might be received while the program handles
1612other jobs, but since timers normally get invoked first, the timeout
1613handler will be executed before checking for data. In that case, giving
1614the timer a lower priority than the I/O watcher ensures that I/O will be
1615handled first even under adverse conditions (which is usually, but not
1616always, what you want).
1617.PP
1618Since idle watchers use the \*(L"lock-out\*(R" model, meaning that idle watchers
1619will only be executed when no same or higher priority watchers have
1620received events, they can be used to implement the \*(L"lock-out\*(R" model when
1621required.
1622.PP
1623For example, to emulate how many other event libraries handle priorities,
1624you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in
1625the normal watcher callback, you just start the idle watcher. The real
1626processing is done in the idle watcher callback. This causes libev to
1627continuously poll and process kernel event data for the watcher, but when
1628the lock-out case is known to be rare (which in turn is rare :), this is
1629workable.
1630.PP
1631Usually, however, the lock-out model implemented that way will perform
1632miserably under the type of load it was designed to handle. In that case,
1633it might be preferable to stop the real watcher before starting the
1634idle watcher, so the kernel will not have to process the event in case
1635the actual processing will be delayed for considerable time.
1636.PP
1637Here is an example of an I/O watcher that should run at a strictly lower
1638priority than the default, and which should only process data when no
1639other events are pending:
1640.PP
804.Vb 7 1641.Vb 2
805\& struct my_io 1642\& ev_idle idle; // actual processing watcher
1643\& ev_io io; // actual event watcher
1644\&
1645\& static void
1646\& io_cb (EV_P_ ev_io *w, int revents)
806\& { 1647\& {
807\& struct ev_io io; 1648\& // stop the I/O watcher, we received the event, but
808\& int otherfd; 1649\& // are not yet ready to handle it.
809\& void *somedata; 1650\& ev_io_stop (EV_A_ w);
810\& struct whatever *mostinteresting; 1651\&
1652\& // start the idle watcher to handle the actual event.
1653\& // it will not be executed as long as other watchers
1654\& // with the default priority are receiving events.
1655\& ev_idle_start (EV_A_ &idle);
811\& } 1656\& }
812.Ve 1657\&
813.PP 1658\& static void
814And since your callback will be called with a pointer to the watcher, you 1659\& idle_cb (EV_P_ ev_idle *w, int revents)
815can cast it back to your own type:
816.PP
817.Vb 5
818\& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
819\& { 1660\& {
820\& struct my_io *w = (struct my_io *)w_; 1661\& // actual processing
821\& ... 1662\& read (STDIN_FILENO, ...);
1663\&
1664\& // have to start the I/O watcher again, as
1665\& // we have handled the event
1666\& ev_io_start (EV_P_ &io);
822\& } 1667\& }
1668\&
1669\& // initialisation
1670\& ev_idle_init (&idle, idle_cb);
1671\& ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1672\& ev_io_start (EV_DEFAULT_ &io);
823.Ve 1673.Ve
824.PP 1674.PP
825More interesting and less C\-conformant ways of catsing your callback type 1675In the \*(L"real\*(R" world, it might also be beneficial to start a timer, so that
826have been omitted.... 1676low-priority connections can not be locked out forever under load. This
1677enables your program to keep a lower latency for important connections
1678during short periods of high load, while not completely locking out less
1679important ones.
827.SH "WATCHER TYPES" 1680.SH "WATCHER TYPES"
828.IX Header "WATCHER TYPES" 1681.IX Header "WATCHER TYPES"
829This section describes each watcher in detail, but will not repeat 1682This section describes each watcher in detail, but will not repeat
830information given in the last section. Any initialisation/set macros, 1683information given in the last section. Any initialisation/set macros,
831functions and members specific to the watcher type are explained. 1684functions and members specific to the watcher type are explained.
… …
836watcher is stopped to your hearts content), or \fI[read\-write]\fR, which 1689watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
837means you can expect it to have some sensible content while the watcher 1690means you can expect it to have some sensible content while the watcher
838is active, but you can also modify it. Modifying it may not do something 1691is active, but you can also modify it. Modifying it may not do something
839sensible or take immediate effect (or do anything at all), but libev will 1692sensible or take immediate effect (or do anything at all), but libev will
840not crash or malfunction in any way. 1693not crash or malfunction in any way.
841.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" 1694.ie n .SS """ev_io"" \- is this file descriptor readable or writable?"
842.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" 1695.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?"
843.IX Subsection "ev_io - is this file descriptor readable or writable?" 1696.IX Subsection "ev_io - is this file descriptor readable or writable?"
844I/O watchers check whether a file descriptor is readable or writable 1697I/O watchers check whether a file descriptor is readable or writable
845in each iteration of the event loop, or, more precisely, when reading 1698in each iteration of the event loop, or, more precisely, when reading
846would not block the process and writing would at least be able to write 1699would not block the process and writing would at least be able to write
847some data. This behaviour is called level-triggering because you keep 1700some data. This behaviour is called level-triggering because you keep
… …
852In general you can register as many read and/or write event watchers per 1705In general you can register as many read and/or write event watchers per
853fd as you want (as long as you don't confuse yourself). Setting all file 1706fd as you want (as long as you don't confuse yourself). Setting all file
854descriptors to non-blocking mode is also usually a good idea (but not 1707descriptors to non-blocking mode is also usually a good idea (but not
855required if you know what you are doing). 1708required if you know what you are doing).
856.PP 1709.PP
857You have to be careful with dup'ed file descriptors, though. Some backends
858(the linux epoll backend is a notable example) cannot handle dup'ed file
859descriptors correctly if you register interest in two or more fds pointing
860to the same underlying file/socket/etc. description (that is, they share
861the same underlying \*(L"file open\*(R").
862.PP
863If you must do this, then force the use of a known-to-be-good backend
864(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and
865\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
866.PP
867Another thing you have to watch out for is that it is quite easy to 1710Another thing you have to watch out for is that it is quite easy to
868receive \*(L"spurious\*(R" readyness notifications, that is your callback might 1711receive \*(L"spurious\*(R" readiness notifications, that is, your callback might
869be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block 1712be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
870because there is no data. Not only are some backends known to create a 1713because there is no data. It is very easy to get into this situation even
871lot of those (for example solaris ports), it is very easy to get into 1714with a relatively standard program structure. Thus it is best to always
872this situation even with a relatively standard program structure. Thus 1715use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning \f(CW\*(C`EAGAIN\*(C'\fR is far
873it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
874\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. 1716preferable to a program hanging until some data arrives.
875.PP 1717.PP
876If you cannot run the fd in non-blocking mode (for example you should not 1718If you cannot run the fd in non-blocking mode (for example you should
877play around with an Xlib connection), then you have to seperately re-test 1719not play around with an Xlib connection), then you have to separately
878wether a file descriptor is really ready with a known-to-be good interface 1720re-test whether a file descriptor is really ready with a known-to-be good
879such as poll (fortunately in our Xlib example, Xlib already does this on 1721interface such as poll (fortunately in the case of Xlib, it already does
880its own, so its quite safe to use). 1722this on its own, so its quite safe to use). Some people additionally
1723use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block
1724indefinitely.
1725.PP
1726But really, best use non-blocking mode.
1727.PP
1728\fIThe special problem of disappearing file descriptors\fR
1729.IX Subsection "The special problem of disappearing file descriptors"
1730.PP
1731Some backends (e.g. kqueue, epoll) need to be told about closing a file
1732descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means,
1733such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file
1734descriptor, but when it goes away, the operating system will silently drop
1735this interest. If another file descriptor with the same number then is
1736registered with libev, there is no efficient way to see that this is, in
1737fact, a different file descriptor.
1738.PP
1739To avoid having to explicitly tell libev about such cases, libev follows
1740the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1741will assume that this is potentially a new file descriptor, otherwise
1742it is assumed that the file descriptor stays the same. That means that
1743you \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
1744descriptor even if the file descriptor number itself did not change.
1745.PP
1746This is how one would do it normally anyway, the important point is that
1747the libev application should not optimise around libev but should leave
1748optimisations to libev.
1749.PP
1750\fIThe special problem of dup'ed file descriptors\fR
1751.IX Subsection "The special problem of dup'ed file descriptors"
1752.PP
1753Some backends (e.g. epoll), cannot register events for file descriptors,
1754but only events for the underlying file descriptions. That means when you
1755have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register
1756events for them, only one file descriptor might actually receive events.
1757.PP
1758There is no workaround possible except not registering events
1759for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1760\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1761.PP
1762\fIThe special problem of files\fR
1763.IX Subsection "The special problem of files"
1764.PP
1765Many people try to use \f(CW\*(C`select\*(C'\fR (or libev) on file descriptors
1766representing files, and expect it to become ready when their program
1767doesn't block on disk accesses (which can take a long time on their own).
1768.PP
1769However, this cannot ever work in the \*(L"expected\*(R" way \- you get a readiness
1770notification as soon as the kernel knows whether and how much data is
1771there, and in the case of open files, that's always the case, so you
1772always get a readiness notification instantly, and your read (or possibly
1773write) will still block on the disk I/O.
1774.PP
1775Another way to view it is that in the case of sockets, pipes, character
1776devices and so on, there is another party (the sender) that delivers data
1777on its own, but in the case of files, there is no such thing: the disk
1778will not send data on its own, simply because it doesn't know what you
1779wish to read \- you would first have to request some data.
1780.PP
1781Since files are typically not-so-well supported by advanced notification
1782mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1783to files, even though you should not use it. The reason for this is
1784convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1785usually a tty, often a pipe, but also sometimes files or special devices
1786(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1787\&\fI/dev/urandom\fR), and even though the file might better be served with
1788asynchronous I/O instead of with non-blocking I/O, it is still useful when
1789it \*(L"just works\*(R" instead of freezing.
1790.PP
1791So avoid file descriptors pointing to files when you know it (e.g. use
1792libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1793when you rarely read from a file instead of from a socket, and want to
1794reuse the same code path.
1795.PP
1796\fIThe special problem of fork\fR
1797.IX Subsection "The special problem of fork"
1798.PP
1799Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit
1800useless behaviour. Libev fully supports fork, but needs to be told about
1801it in the child if you want to continue to use it in the child.
1802.PP
1803To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1804()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1805\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1806.PP
1807\fIThe special problem of \s-1SIGPIPE\s0\fR
1808.IX Subsection "The special problem of SIGPIPE"
1809.PP
1810While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1811when writing to a pipe whose other end has been closed, your program gets
1812sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1813this is sensible behaviour, for daemons, this is usually undesirable.
1814.PP
1815So when you encounter spurious, unexplained daemon exits, make sure you
1816ignore \s-1SIGPIPE \s0(and maybe make sure you log the exit status of your daemon
1817somewhere, as that would have given you a big clue).
1818.PP
1819\fIThe special problem of \fIaccept()\fIing when you can't\fR
1820.IX Subsection "The special problem of accept()ing when you can't"
1821.PP
1822Many implementations of the \s-1POSIX \s0\f(CW\*(C`accept\*(C'\fR function (for example,
1823found in post\-2004 Linux) have the peculiar behaviour of not removing a
1824connection from the pending queue in all error cases.
1825.PP
1826For example, larger servers often run out of file descriptors (because
1827of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not
1828rejecting the connection, leading to libev signalling readiness on
1829the next iteration again (the connection still exists after all), and
1830typically causing the program to loop at 100% \s-1CPU\s0 usage.
1831.PP
1832Unfortunately, the set of errors that cause this issue differs between
1833operating systems, there is usually little the app can do to remedy the
1834situation, and no known thread-safe method of removing the connection to
1835cope with overload is known (to me).
1836.PP
1837One of the easiest ways to handle this situation is to just ignore it
1838\&\- when the program encounters an overload, it will just loop until the
1839situation is over. While this is a form of busy waiting, no \s-1OS\s0 offers an
1840event-based way to handle this situation, so it's the best one can do.
1841.PP
1842A better way to handle the situation is to log any errors other than
1843\&\f(CW\*(C`EAGAIN\*(C'\fR and \f(CW\*(C`EWOULDBLOCK\*(C'\fR, making sure not to flood the log with such
1844messages, and continue as usual, which at least gives the user an idea of
1845what could be wrong (\*(L"raise the ulimit!\*(R"). For extra points one could stop
1846the \f(CW\*(C`ev_io\*(C'\fR watcher on the listening fd \*(L"for a while\*(R", which reduces \s-1CPU\s0
1847usage.
1848.PP
1849If your program is single-threaded, then you could also keep a dummy file
1850descriptor for overload situations (e.g. by opening \fI/dev/null\fR), and
1851when 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,
1852close that fd, and create a new dummy fd. This will gracefully refuse
1853clients under typical overload conditions.
1854.PP
1855The last way to handle it is to simply log the error and \f(CW\*(C`exit\*(C'\fR, as
1856is often done with \f(CW\*(C`malloc\*(C'\fR failures, but this results in an easy
1857opportunity for a DoS attack.
1858.PP
1859\fIWatcher-Specific Functions\fR
1860.IX Subsection "Watcher-Specific Functions"
881.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1861.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
882.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1862.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
883.PD 0 1863.PD 0
884.IP "ev_io_set (ev_io *, int fd, int events)" 4 1864.IP "ev_io_set (ev_io *, int fd, int events)" 4
885.IX Item "ev_io_set (ev_io *, int fd, int events)" 1865.IX Item "ev_io_set (ev_io *, int fd, int events)"
886.PD 1866.PD
887Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1867Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
888rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or 1868receive 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
889\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. 1869\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events.
890.IP "int fd [read\-only]" 4 1870.IP "int fd [read\-only]" 4
891.IX Item "int fd [read-only]" 1871.IX Item "int fd [read-only]"
892The file descriptor being watched. 1872The file descriptor being watched.
893.IP "int events [read\-only]" 4 1873.IP "int events [read\-only]" 4
894.IX Item "int events [read-only]" 1874.IX Item "int events [read-only]"
895The events being watched. 1875The events being watched.
896.PP 1876.PP
1877\fIExamples\fR
1878.IX Subsection "Examples"
1879.PP
897Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1880Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
898readable, but only once. Since it is likely line\-buffered, you could 1881readable, but only once. Since it is likely line-buffered, you could
899attempt to read a whole line in the callback: 1882attempt to read a whole line in the callback.
900.PP 1883.PP
901.Vb 6 1884.Vb 6
902\& static void 1885\& static void
903\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1886\& stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
904\& { 1887\& {
905\& ev_io_stop (loop, w); 1888\& ev_io_stop (loop, w);
906\& .. read from stdin here (or from w->fd) and haqndle any I/O errors 1889\& .. read from stdin here (or from w\->fd) and handle any I/O errors
907\& } 1890\& }
908.Ve 1891\&
909.PP
910.Vb 6
911\& ... 1892\& ...
912\& struct ev_loop *loop = ev_default_init (0); 1893\& struct ev_loop *loop = ev_default_init (0);
913\& struct ev_io stdin_readable; 1894\& ev_io stdin_readable;
914\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1895\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
915\& ev_io_start (loop, &stdin_readable); 1896\& ev_io_start (loop, &stdin_readable);
916\& ev_loop (loop, 0); 1897\& ev_run (loop, 0);
917.Ve 1898.Ve
918.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" 1899.ie n .SS """ev_timer"" \- relative and optionally repeating timeouts"
919.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" 1900.el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
920.IX Subsection "ev_timer - relative and optionally repeating timeouts" 1901.IX Subsection "ev_timer - relative and optionally repeating timeouts"
921Timer watchers are simple relative timers that generate an event after a 1902Timer watchers are simple relative timers that generate an event after a
922given time, and optionally repeating in regular intervals after that. 1903given time, and optionally repeating in regular intervals after that.
923.PP 1904.PP
924The timers are based on real time, that is, if you register an event that 1905The timers are based on real time, that is, if you register an event that
925times out after an hour and you reset your system clock to last years 1906times out after an hour and you reset your system clock to January last
926time, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because 1907year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because
927detecting time jumps is hard, and some inaccuracies are unavoidable (the 1908detecting time jumps is hard, and some inaccuracies are unavoidable (the
928monotonic clock option helps a lot here). 1909monotonic clock option helps a lot here).
1910.PP
1911The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1912passed (not \fIat\fR, so on systems with very low-resolution clocks this
1913might introduce a small delay, see \*(L"the special problem of being too
1914early\*(R", below). If multiple timers become ready during the same loop
1915iteration then the ones with earlier time-out values are invoked before
1916ones of the same priority with later time-out values (but this is no
1917longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1918.PP
1919\fIBe smart about timeouts\fR
1920.IX Subsection "Be smart about timeouts"
1921.PP
1922Many real-world problems involve some kind of timeout, usually for error
1923recovery. A typical example is an \s-1HTTP\s0 request \- if the other side hangs,
1924you want to raise some error after a while.
1925.PP
1926What follows are some ways to handle this problem, from obvious and
1927inefficient to smart and efficient.
1928.PP
1929In the following, a 60 second activity timeout is assumed \- a timeout that
1930gets reset to 60 seconds each time there is activity (e.g. each time some
1931data or other life sign was received).
1932.IP "1. Use a timer and stop, reinitialise and start it on activity." 4
1933.IX Item "1. Use a timer and stop, reinitialise and start it on activity."
1934This is the most obvious, but not the most simple way: In the beginning,
1935start the watcher:
1936.Sp
1937.Vb 2
1938\& ev_timer_init (timer, callback, 60., 0.);
1939\& ev_timer_start (loop, timer);
1940.Ve
1941.Sp
1942Then, each time there is some activity, \f(CW\*(C`ev_timer_stop\*(C'\fR it, initialise it
1943and start it again:
1944.Sp
1945.Vb 3
1946\& ev_timer_stop (loop, timer);
1947\& ev_timer_set (timer, 60., 0.);
1948\& ev_timer_start (loop, timer);
1949.Ve
1950.Sp
1951This is relatively simple to implement, but means that each time there is
1952some activity, libev will first have to remove the timer from its internal
1953data structure and then add it again. Libev tries to be fast, but it's
1954still not a constant-time operation.
1955.ie n .IP "2. Use a timer and re-start it with ""ev_timer_again"" inactivity." 4
1956.el .IP "2. Use a timer and re-start it with \f(CWev_timer_again\fR inactivity." 4
1957.IX Item "2. Use a timer and re-start it with ev_timer_again inactivity."
1958This is the easiest way, and involves using \f(CW\*(C`ev_timer_again\*(C'\fR instead of
1959\&\f(CW\*(C`ev_timer_start\*(C'\fR.
1960.Sp
1961To implement this, configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value
1962of \f(CW60\fR and then call \f(CW\*(C`ev_timer_again\*(C'\fR at start and each time you
1963successfully read or write some data. If you go into an idle state where
1964you do not expect data to travel on the socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR
1965the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will automatically restart it if need be.
1966.Sp
1967That means you can ignore both the \f(CW\*(C`ev_timer_start\*(C'\fR function and the
1968\&\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
1969member and \f(CW\*(C`ev_timer_again\*(C'\fR.
1970.Sp
1971At start:
1972.Sp
1973.Vb 3
1974\& ev_init (timer, callback);
1975\& timer\->repeat = 60.;
1976\& ev_timer_again (loop, timer);
1977.Ve
1978.Sp
1979Each time there is some activity:
1980.Sp
1981.Vb 1
1982\& ev_timer_again (loop, timer);
1983.Ve
1984.Sp
1985It is even possible to change the time-out on the fly, regardless of
1986whether the watcher is active or not:
1987.Sp
1988.Vb 2
1989\& timer\->repeat = 30.;
1990\& ev_timer_again (loop, timer);
1991.Ve
1992.Sp
1993This is slightly more efficient then stopping/starting the timer each time
1994you want to modify its timeout value, as libev does not have to completely
1995remove and re-insert the timer from/into its internal data structure.
1996.Sp
1997It is, however, even simpler than the \*(L"obvious\*(R" way to do it.
1998.IP "3. Let the timer time out, but then re-arm it as required." 4
1999.IX Item "3. Let the timer time out, but then re-arm it as required."
2000This method is more tricky, but usually most efficient: Most timeouts are
2001relatively long compared to the intervals between other activity \- in
2002our example, within 60 seconds, there are usually many I/O events with
2003associated activity resets.
2004.Sp
2005In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
2006but remember the time of last activity, and check for a real timeout only
2007within the callback:
2008.Sp
2009.Vb 3
2010\& ev_tstamp timeout = 60.;
2011\& ev_tstamp last_activity; // time of last activity
2012\& ev_timer timer;
2013\&
2014\& static void
2015\& callback (EV_P_ ev_timer *w, int revents)
2016\& {
2017\& // calculate when the timeout would happen
2018\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
2019\&
2020\& // if negative, it means we the timeout already occurred
2021\& if (after < 0.)
2022\& {
2023\& // timeout occurred, take action
2024\& }
2025\& else
2026\& {
2027\& // callback was invoked, but there was some recent
2028\& // activity. simply restart the timer to time out
2029\& // after "after" seconds, which is the earliest time
2030\& // the timeout can occur.
2031\& ev_timer_set (w, after, 0.);
2032\& ev_timer_start (EV_A_ w);
2033\& }
2034\& }
2035.Ve
2036.Sp
2037To summarise the callback: first calculate in how many seconds the
2038timeout will occur (by calculating the absolute time when it would occur,
2039\&\f(CW\*(C`last_activity + timeout\*(C'\fR, and subtracting the current time, \f(CW\*(C`ev_now
2040(EV_A)\*(C'\fR from that).
2041.Sp
2042If this value is negative, then we are already past the timeout, i.e. we
2043timed out, and need to do whatever is needed in this case.
2044.Sp
2045Otherwise, we now the earliest time at which the timeout would trigger,
2046and simply start the timer with this timeout value.
2047.Sp
2048In other words, each time the callback is invoked it will check whether
2049the timeout occurred. If not, it will simply reschedule itself to check
2050again at the earliest time it could time out. Rinse. Repeat.
2051.Sp
2052This scheme causes more callback invocations (about one every 60 seconds
2053minus half the average time between activity), but virtually no calls to
2054libev to change the timeout.
2055.Sp
2056To start the machinery, simply initialise the watcher and set
2057\&\f(CW\*(C`last_activity\*(C'\fR to the current time (meaning there was some activity just
2058now), then call the callback, which will \*(L"do the right thing\*(R" and start
2059the timer:
2060.Sp
2061.Vb 3
2062\& last_activity = ev_now (EV_A);
2063\& ev_init (&timer, callback);
2064\& callback (EV_A_ &timer, 0);
2065.Ve
2066.Sp
2067When there is some activity, simply store the current time in
2068\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
2069.Sp
2070.Vb 2
2071\& if (activity detected)
2072\& last_activity = ev_now (EV_A);
2073.Ve
2074.Sp
2075When your timeout value changes, then the timeout can be changed by simply
2076providing a new value, stopping the timer and calling the callback, which
2077will again do the right thing (for example, time out immediately :).
2078.Sp
2079.Vb 3
2080\& timeout = new_value;
2081\& ev_timer_stop (EV_A_ &timer);
2082\& callback (EV_A_ &timer, 0);
2083.Ve
2084.Sp
2085This technique is slightly more complex, but in most cases where the
2086time-out is unlikely to be triggered, much more efficient.
2087.IP "4. Wee, just use a double-linked list for your timeouts." 4
2088.IX Item "4. Wee, just use a double-linked list for your timeouts."
2089If there is not one request, but many thousands (millions...), all
2090employing some kind of timeout with the same timeout value, then one can
2091do even better:
2092.Sp
2093When starting the timeout, calculate the timeout value and put the timeout
2094at the \fIend\fR of the list.
2095.Sp
2096Then use an \f(CW\*(C`ev_timer\*(C'\fR to fire when the timeout at the \fIbeginning\fR of
2097the list is expected to fire (for example, using the technique #3).
2098.Sp
2099When there is some activity, remove the timer from the list, recalculate
2100the timeout, append it to the end of the list again, and make sure to
2101update the \f(CW\*(C`ev_timer\*(C'\fR if it was taken from the beginning of the list.
2102.Sp
2103This way, one can manage an unlimited number of timeouts in O(1) time for
2104starting, stopping and updating the timers, at the expense of a major
2105complication, and having to use a constant timeout. The constant timeout
2106ensures that the list stays sorted.
2107.PP
2108So which method the best?
2109.PP
2110Method #2 is a simple no-brain-required solution that is adequate in most
2111situations. Method #3 requires a bit more thinking, but handles many cases
2112better, and isn't very complicated either. In most case, choosing either
2113one is fine, with #3 being better in typical situations.
2114.PP
2115Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
2116rather complicated, but extremely efficient, something that really pays
2117off after the first million or so of active timers, i.e. it's usually
2118overkill :)
2119.PP
2120\fIThe special problem of being too early\fR
2121.IX Subsection "The special problem of being too early"
2122.PP
2123If you ask a timer to call your callback after three seconds, then
2124you expect it to be invoked after three seconds \- but of course, this
2125cannot be guaranteed to infinite precision. Less obviously, it cannot be
2126guaranteed to any precision by libev \- imagine somebody suspending the
2127process with a \s-1STOP\s0 signal for a few hours for example.
2128.PP
2129So, libev tries to invoke your callback as soon as possible \fIafter\fR the
2130delay has occurred, but cannot guarantee this.
2131.PP
2132A less obvious failure mode is calling your callback too early: many event
2133loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but
2134this can cause your callback to be invoked much earlier than you would
2135expect.
2136.PP
2137To see why, imagine a system with a clock that only offers full second
2138resolution (think windows if you can't come up with a broken enough \s-1OS\s0
2139yourself). If you schedule a one-second timer at the time 500.9, then the
2140event loop will schedule your timeout to elapse at a system time of 500
2141(500.9 truncated to the resolution) + 1, or 501.
2142.PP
2143If an event library looks at the timeout 0.1s later, it will see \*(L"501 >=
2144501\*(R" and invoke the callback 0.1s after it was started, even though a
2145one-second delay was requested \- this is being \*(L"too early\*(R", despite best
2146intentions.
2147.PP
2148This is the reason why libev will never invoke the callback if the elapsed
2149delay equals the requested delay, but only when the elapsed delay is
2150larger than the requested delay. In the example above, libev would only invoke
2151the callback at system time 502, or 1.1s after the timer was started.
2152.PP
2153So, while libev cannot guarantee that your callback will be invoked
2154exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested
2155delay has actually elapsed, or in other words, it always errs on the \*(L"too
2156late\*(R" side of things.
2157.PP
2158\fIThe special problem of time updates\fR
2159.IX Subsection "The special problem of time updates"
2160.PP
2161Establishing the current time is a costly operation (it usually takes
2162at least one system call): \s-1EV\s0 therefore updates its idea of the current
2163time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a
2164growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
2165lots of events in one iteration.
929.PP 2166.PP
930The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2167The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
931time. This is usually the right thing as this timestamp refers to the time 2168time. This is usually the right thing as this timestamp refers to the time
932of the event triggering whatever timeout you are modifying/starting. If 2169of the event triggering whatever timeout you are modifying/starting. If
933you suspect event processing to be delayed and you \fIneed\fR to base the timeout 2170you suspect event processing to be delayed and you \fIneed\fR to base the
934on the current time, use something like this to adjust for this: 2171timeout on the current time, use something like the following to adjust
2172for it:
935.PP 2173.PP
936.Vb 1 2174.Vb 1
937\& ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2175\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
938.Ve 2176.Ve
939.PP 2177.PP
940The callback is guarenteed to be invoked only when its timeout has passed, 2178If the event loop is suspended for a long time, you can also force an
941but if multiple timers become ready during the same loop iteration then 2179update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
942order of execution is undefined. 2180()\*(C'\fR, although that will push the event time of all outstanding events
2181further into the future.
2182.PP
2183\fIThe special problem of unsynchronised clocks\fR
2184.IX Subsection "The special problem of unsynchronised clocks"
2185.PP
2186Modern systems have a variety of clocks \- libev itself uses the normal
2187\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time
2188jumps).
2189.PP
2190Neither of these clocks is synchronised with each other or any other clock
2191on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time
2192than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example,
2193a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher
2194than a directly following call to \f(CW\*(C`time\*(C'\fR.
2195.PP
2196The moral of this is to only compare libev-related timestamps with
2197\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than
2198a second or so.
2199.PP
2200One more problem arises due to this lack of synchronisation: if libev uses
2201the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR
2202or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is
2203invoked, you will find that sometimes the callback is a bit \*(L"early\*(R".
2204.PP
2205This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so
2206libev makes sure your callback is not invoked before the delay happened,
2207\&\fImeasured according to the real time\fR, not the system clock.
2208.PP
2209If your timeouts are based on a physical timescale (e.g. \*(L"time out this
2210connection after 100 seconds\*(R") then this shouldn't bother you as it is
2211exactly the right behaviour.
2212.PP
2213If you want to compare wall clock/system timestamps to your timers, then
2214you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock
2215time, where your comparisons will always generate correct results.
2216.PP
2217\fIThe special problems of suspended animation\fR
2218.IX Subsection "The special problems of suspended animation"
2219.PP
2220When you leave the server world it is quite customary to hit machines that
2221can suspend/hibernate \- what happens to the clocks during such a suspend?
2222.PP
2223Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
2224all processes, while the clocks (\f(CW\*(C`times\*(C'\fR, \f(CW\*(C`CLOCK_MONOTONIC\*(C'\fR) continue
2225to run until the system is suspended, but they will not advance while the
2226system is suspended. That means, on resume, it will be as if the program
2227was frozen for a few seconds, but the suspend time will not be counted
2228towards \f(CW\*(C`ev_timer\*(C'\fR when a monotonic clock source is used. The real time
2229clock advanced as expected, but if it is used as sole clocksource, then a
2230long suspend would be detected as a time jump by libev, and timers would
2231be adjusted accordingly.
2232.PP
2233I would not be surprised to see different behaviour in different between
2234operating systems, \s-1OS\s0 versions or even different hardware.
2235.PP
2236The other form of suspend (job control, or sending a \s-1SIGSTOP\s0) will see a
2237time jump in the monotonic clocks and the realtime clock. If the program
2238is suspended for a very long time, and monotonic clock sources are in use,
2239then you can expect \f(CW\*(C`ev_timer\*(C'\fRs to expire as the full suspension time
2240will be counted towards the timers. When no monotonic clock source is in
2241use, then libev will again assume a timejump and adjust accordingly.
2242.PP
2243It might be beneficial for this latter case to call \f(CW\*(C`ev_suspend\*(C'\fR
2244and \f(CW\*(C`ev_resume\*(C'\fR in code that handles \f(CW\*(C`SIGTSTP\*(C'\fR, to at least get
2245deterministic behaviour in this case (you can do nothing against
2246\&\f(CW\*(C`SIGSTOP\*(C'\fR).
2247.PP
2248\fIWatcher-Specific Functions and Data Members\fR
2249.IX Subsection "Watcher-Specific Functions and Data Members"
943.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 2250.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
944.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2251.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
945.PD 0 2252.PD 0
946.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2253.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
947.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 2254.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
948.PD 2255.PD
949Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR is 2256Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR
950\&\f(CW0.\fR, then it will automatically be stopped. If it is positive, then the 2257is \f(CW0.\fR, then it will automatically be stopped once the timeout is
951timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds 2258reached. If it is positive, then the timer will automatically be
952later, again, and again, until stopped manually. 2259configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again,
2260until stopped manually.
953.Sp 2261.Sp
954The timer itself will do a best-effort at avoiding drift, that is, if you 2262The timer itself will do a best-effort at avoiding drift, that is, if
955configure a timer to trigger every 10 seconds, then it will trigger at 2263you configure a timer to trigger every 10 seconds, then it will normally
956exactly 10 second intervals. If, however, your program cannot keep up with 2264trigger at exactly 10 second intervals. If, however, your program cannot
957the timer (because it takes longer than those 10 seconds to do stuff) the 2265keep up with the timer (because it takes longer than those 10 seconds to
958timer will not fire more than once per event loop iteration. 2266do stuff) the timer will not fire more than once per event loop iteration.
959.IP "ev_timer_again (loop)" 4 2267.IP "ev_timer_again (loop, ev_timer *)" 4
960.IX Item "ev_timer_again (loop)" 2268.IX Item "ev_timer_again (loop, ev_timer *)"
961This will act as if the timer timed out and restart it again if it is 2269This will act as if the timer timed out, and restarts it again if it is
962repeating. The exact semantics are: 2270repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the
2271timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR.
963.Sp 2272.Sp
964If the timer is started but nonrepeating, stop it. 2273The exact semantics are as in the following rules, all of which will be
2274applied to the watcher:
2275.RS 4
2276.IP "If the timer is pending, the pending status is always cleared." 4
2277.IX Item "If the timer is pending, the pending status is always cleared."
2278.PD 0
2279.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4
2280.IX Item "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)."
2281.ie n .IP "If the timer is repeating, make the ""repeat"" value the new timeout and start the timer, if necessary." 4
2282.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4
2283.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary."
2284.RE
2285.RS 4
2286.PD
965.Sp 2287.Sp
966If the timer is repeating, either start it if necessary (with the repeat 2288This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
967value), or reset the running timer to the repeat value. 2289usage example.
2290.RE
2291.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
2292.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
2293Returns the remaining time until a timer fires. If the timer is active,
2294then this time is relative to the current event loop time, otherwise it's
2295the timeout value currently configured.
968.Sp 2296.Sp
969This sounds a bit complicated, but here is a useful and typical 2297That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns
970example: Imagine you have a tcp connection and you want a so-called 2298\&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remaining\*(C'\fR
971idle timeout, that is, you want to be called when there have been, 2299will return \f(CW4\fR. When the timer expires and is restarted, it will return
972say, 60 seconds of inactivity on the socket. The easiest way to do 2300roughly \f(CW7\fR (likely slightly less as callback invocation takes some time,
973this is to configure an \f(CW\*(C`ev_timer\*(C'\fR with \f(CW\*(C`after\*(C'\fR=\f(CW\*(C`repeat\*(C'\fR=\f(CW60\fR and calling 2301too), and so on.
974\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
975you go into an idle state where you do not expect data to travel on the
976socket, you can stop the timer, and again will automatically restart it if
977need be.
978.Sp
979You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether
980and only ever use the \f(CW\*(C`repeat\*(C'\fR value:
981.Sp
982.Vb 8
983\& ev_timer_init (timer, callback, 0., 5.);
984\& ev_timer_again (loop, timer);
985\& ...
986\& timer->again = 17.;
987\& ev_timer_again (loop, timer);
988\& ...
989\& timer->again = 10.;
990\& ev_timer_again (loop, timer);
991.Ve
992.Sp
993This is more efficient then stopping/starting the timer eahc time you want
994to modify its timeout value.
995.IP "ev_tstamp repeat [read\-write]" 4 2302.IP "ev_tstamp repeat [read\-write]" 4
996.IX Item "ev_tstamp repeat [read-write]" 2303.IX Item "ev_tstamp repeat [read-write]"
997The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 2304The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
998or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), 2305or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any),
999which is also when any modifications are taken into account. 2306which is also when any modifications are taken into account.
1000.PP 2307.PP
2308\fIExamples\fR
2309.IX Subsection "Examples"
2310.PP
1001Example: create a timer that fires after 60 seconds. 2311Example: Create a timer that fires after 60 seconds.
1002.PP 2312.PP
1003.Vb 5 2313.Vb 5
1004\& static void 2314\& static void
1005\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 2315\& one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1006\& { 2316\& {
1007\& .. one minute over, w is actually stopped right here 2317\& .. one minute over, w is actually stopped right here
1008\& } 2318\& }
1009.Ve 2319\&
1010.PP
1011.Vb 3
1012\& struct ev_timer mytimer; 2320\& ev_timer mytimer;
1013\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 2321\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1014\& ev_timer_start (loop, &mytimer); 2322\& ev_timer_start (loop, &mytimer);
1015.Ve 2323.Ve
1016.PP 2324.PP
1017Example: create a timeout timer that times out after 10 seconds of 2325Example: Create a timeout timer that times out after 10 seconds of
1018inactivity. 2326inactivity.
1019.PP 2327.PP
1020.Vb 5 2328.Vb 5
1021\& static void 2329\& static void
1022\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 2330\& timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1023\& { 2331\& {
1024\& .. ten seconds without any activity 2332\& .. ten seconds without any activity
1025\& } 2333\& }
1026.Ve 2334\&
1027.PP
1028.Vb 4
1029\& struct ev_timer mytimer; 2335\& ev_timer mytimer;
1030\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 2336\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1031\& ev_timer_again (&mytimer); /* start timer */ 2337\& ev_timer_again (&mytimer); /* start timer */
1032\& ev_loop (loop, 0); 2338\& ev_run (loop, 0);
1033.Ve 2339\&
1034.PP
1035.Vb 3
1036\& // and in some piece of code that gets executed on any "activity": 2340\& // and in some piece of code that gets executed on any "activity":
1037\& // reset the timeout to start ticking again at 10 seconds 2341\& // reset the timeout to start ticking again at 10 seconds
1038\& ev_timer_again (&mytimer); 2342\& ev_timer_again (&mytimer);
1039.Ve 2343.Ve
1040.ie n .Sh """ev_periodic"" \- to cron or not to cron?" 2344.ie n .SS """ev_periodic"" \- to cron or not to cron?"
1041.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" 2345.el .SS "\f(CWev_periodic\fP \- to cron or not to cron?"
1042.IX Subsection "ev_periodic - to cron or not to cron?" 2346.IX Subsection "ev_periodic - to cron or not to cron?"
1043Periodic watchers are also timers of a kind, but they are very versatile 2347Periodic watchers are also timers of a kind, but they are very versatile
1044(and unfortunately a bit complex). 2348(and unfortunately a bit complex).
1045.PP 2349.PP
1046Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 2350Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
1047but on wallclock time (absolute time). You can tell a periodic watcher 2351relative time, the physical time that passes) but on wall clock time
1048to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a 2352(absolute time, the thing you can read on your calendar or clock). The
1049periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () 2353difference is that wall clock time can run faster or slower than real
1050+ 10.\*(C'\fR) and then reset your system clock to the last year, then it will 2354time, and time jumps are not uncommon (e.g. when you adjust your
1051take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger 2355wrist-watch).
1052roughly 10 seconds later and of course not if you reset your system time
1053again).
1054.PP 2356.PP
1055They can also be used to implement vastly more complex timers, such as 2357You can tell a periodic watcher to trigger after some specific point
1056triggering an event on eahc midnight, local time. 2358in time: for example, if you tell a periodic watcher to trigger \*(L"in 10
2359seconds\*(R" (by specifying e.g. \f(CW\*(C`ev_now () + 10.\*(C'\fR, that is, an absolute time
2360not a delay) and then reset your system clock to January of the previous
2361year, then it will take a year or more to trigger the event (unlike an
2362\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2363it, as it uses a relative timeout).
1057.PP 2364.PP
2365\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
2366timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
2367other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as
2368those cannot react to time jumps.
2369.PP
1058As with timers, the callback is guarenteed to be invoked only when the 2370As with timers, the callback is guaranteed to be invoked only when the
1059time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready 2371point in time where it is supposed to trigger has passed. If multiple
1060during the same loop iteration then order of execution is undefined. 2372timers become ready during the same loop iteration then the ones with
2373earlier time-out values are invoked before ones with later time-out values
2374(but this is no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
2375.PP
2376\fIWatcher-Specific Functions and Data Members\fR
2377.IX Subsection "Watcher-Specific Functions and Data Members"
1061.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 2378.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1062.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 2379.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1063.PD 0 2380.PD 0
1064.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 2381.IP "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1065.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 2382.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1066.PD 2383.PD
1067Lots of arguments, lets sort it out... There are basically three modes of 2384Lots of arguments, let's sort it out... There are basically three modes of
1068operation, and we will explain them from simplest to complex: 2385operation, and we will explain them from simplest to most complex:
1069.RS 4 2386.RS 4
1070.IP "* absolute timer (interval = reschedule_cb = 0)" 4 2387.IP "\(bu" 4
1071.IX Item "absolute timer (interval = reschedule_cb = 0)" 2388absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
2389.Sp
1072In this configuration the watcher triggers an event at the wallclock time 2390In this configuration the watcher triggers an event after the wall clock
1073\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, 2391time \f(CW\*(C`offset\*(C'\fR has passed. It will not repeat and will not adjust when a
1074that is, if it is to be run at January 1st 2011 then it will run when the 2392time jump occurs, that is, if it is to be run at January 1st 2011 then it
1075system time reaches or surpasses this time. 2393will be stopped and invoked when the system clock reaches or surpasses
1076.IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 2394this point in time.
1077.IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" 2395.IP "\(bu" 4
2396repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
2397.Sp
1078In this mode the watcher will always be scheduled to time out at the next 2398In this mode the watcher will always be scheduled to time out at the next
1079\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless 2399\&\f(CW\*(C`offset + N * interval\*(C'\fR time (for some integer N, which can also be
1080of any time jumps. 2400negative) and then repeat, regardless of any time jumps. The \f(CW\*(C`offset\*(C'\fR
2401argument is merely an offset into the \f(CW\*(C`interval\*(C'\fR periods.
1081.Sp 2402.Sp
1082This can be used to create timers that do not drift with respect to system 2403This can be used to create timers that do not drift with respect to the
1083time: 2404system clock, for example, here is an \f(CW\*(C`ev_periodic\*(C'\fR that triggers each
2405hour, on the hour (with respect to \s-1UTC\s0):
1084.Sp 2406.Sp
1085.Vb 1 2407.Vb 1
1086\& ev_periodic_set (&periodic, 0., 3600., 0); 2408\& ev_periodic_set (&periodic, 0., 3600., 0);
1087.Ve 2409.Ve
1088.Sp 2410.Sp
1089This doesn't mean there will always be 3600 seconds in between triggers, 2411This doesn't mean there will always be 3600 seconds in between triggers,
1090but only that the the callback will be called when the system time shows a 2412but only that the callback will be called when the system time shows a
1091full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible 2413full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible
1092by 3600. 2414by 3600.
1093.Sp 2415.Sp
1094Another way to think about it (for the mathematically inclined) is that 2416Another way to think about it (for the mathematically inclined) is that
1095\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2417\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
1096time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 2418time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
1097.IP "* manual reschedule mode (reschedule_cb = callback)" 4 2419.Sp
1098.IX Item "manual reschedule mode (reschedule_cb = callback)" 2420The \f(CW\*(C`interval\*(C'\fR \fI\s-1MUST\s0\fR be positive, and for numerical stability, the
2421interval value should be higher than \f(CW\*(C`1/8192\*(C'\fR (which is around 100
2422microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have
2423at most a similar magnitude as the current time (say, within a factor of
2424ten). Typical values for offset are, in fact, \f(CW0\fR or something between
2425\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range.
2426.Sp
2427Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
2428speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
2429will of course deteriorate. Libev itself tries to be exact to be about one
2430millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
2431.IP "\(bu" 4
2432manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
2433.Sp
1099In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 2434In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
1100ignored. Instead, each time the periodic watcher gets scheduled, the 2435ignored. Instead, each time the periodic watcher gets scheduled, the
1101reschedule callback will be called with the watcher as first, and the 2436reschedule callback will be called with the watcher as first, and the
1102current time as second argument. 2437current time as second argument.
1103.Sp 2438.Sp
1104\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, 2439\&\s-1NOTE: \s0\fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
1105ever, or make any event loop modifications\fR. If you need to stop it, 2440or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
1106return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by 2441allowed by documentation here\fR.
1107starting a prepare watcher).
1108.Sp 2442.Sp
2443If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2444it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2445only event loop modification you are allowed to do).
2446.Sp
1109Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 2447The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(ev_periodic
1110ev_tstamp now)\*(C'\fR, e.g.: 2448*w, ev_tstamp now)\*(C'\fR, e.g.:
1111.Sp 2449.Sp
1112.Vb 4 2450.Vb 5
2451\& static ev_tstamp
1113\& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 2452\& my_rescheduler (ev_periodic *w, ev_tstamp now)
1114\& { 2453\& {
1115\& return now + 60.; 2454\& return now + 60.;
1116\& } 2455\& }
1117.Ve 2456.Ve
1118.Sp 2457.Sp
1119It must return the next time to trigger, based on the passed time value 2458It must return the next time to trigger, based on the passed time value
1120(that is, the lowest time value larger than to the second argument). It 2459(that is, the lowest time value larger than to the second argument). It
1121will usually be called just before the callback will be triggered, but 2460will usually be called just before the callback will be triggered, but
1122might be called at other times, too. 2461might be called at other times, too.
1123.Sp 2462.Sp
1124\&\s-1NOTE:\s0 \fIThis callback must always return a time that is later than the 2463\&\s-1NOTE: \s0\fIThis callback must always return a time that is higher than or
1125passed \f(CI\*(C`now\*(C'\fI value\fR. Not even \f(CW\*(C`now\*(C'\fR itself will do, it \fImust\fR be larger. 2464equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
1126.Sp 2465.Sp
1127This can be used to create very complex timers, such as a timer that 2466This can be used to create very complex timers, such as a timer that
1128triggers on each midnight, local time. To do this, you would calculate the 2467triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the
1129next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2468next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How
1130you do this is, again, up to you (but it is not trivial, which is the main 2469you do this is, again, up to you (but it is not trivial, which is the main
1131reason I omitted it as an example). 2470reason I omitted it as an example).
1132.RE 2471.RE
1133.RS 4 2472.RS 4
… …
1136.IX Item "ev_periodic_again (loop, ev_periodic *)" 2475.IX Item "ev_periodic_again (loop, ev_periodic *)"
1137Simply stops and restarts the periodic watcher again. This is only useful 2476Simply stops and restarts the periodic watcher again. This is only useful
1138when you changed some parameters or the reschedule callback would return 2477when you changed some parameters or the reschedule callback would return
1139a different time than the last time it was called (e.g. in a crond like 2478a different time than the last time it was called (e.g. in a crond like
1140program when the crontabs have changed). 2479program when the crontabs have changed).
2480.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4
2481.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)"
2482When active, returns the absolute time that the watcher is supposed
2483to trigger next. This is not the same as the \f(CW\*(C`offset\*(C'\fR argument to
2484\&\f(CW\*(C`ev_periodic_set\*(C'\fR, but indeed works even in interval and manual
2485rescheduling modes.
2486.IP "ev_tstamp offset [read\-write]" 4
2487.IX Item "ev_tstamp offset [read-write]"
2488When repeating, this contains the offset value, otherwise this is the
2489absolute point in time (the \f(CW\*(C`offset\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR,
2490although libev might modify this value for better numerical stability).
2491.Sp
2492Can be modified any time, but changes only take effect when the periodic
2493timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1141.IP "ev_tstamp interval [read\-write]" 4 2494.IP "ev_tstamp interval [read\-write]" 4
1142.IX Item "ev_tstamp interval [read-write]" 2495.IX Item "ev_tstamp interval [read-write]"
1143The current interval value. Can be modified any time, but changes only 2496The current interval value. Can be modified any time, but changes only
1144take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being 2497take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
1145called. 2498called.
1146.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 2499.IP "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read\-write]" 4
1147.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" 2500.IX Item "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]"
1148The current reschedule callback, or \f(CW0\fR, if this functionality is 2501The current reschedule callback, or \f(CW0\fR, if this functionality is
1149switched off. Can be changed any time, but changes only take effect when 2502switched off. Can be changed any time, but changes only take effect when
1150the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. 2503the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1151.PP 2504.PP
2505\fIExamples\fR
2506.IX Subsection "Examples"
2507.PP
1152Example: call a callback every hour, or, more precisely, whenever the 2508Example: Call a callback every hour, or, more precisely, whenever the
1153system clock is divisible by 3600. The callback invocation times have 2509system time is divisible by 3600. The callback invocation times have
1154potentially a lot of jittering, but good long-term stability. 2510potentially a lot of jitter, but good long-term stability.
1155.PP 2511.PP
1156.Vb 5 2512.Vb 5
1157\& static void 2513\& static void
1158\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 2514\& clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1159\& { 2515\& {
1160\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 2516\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1161\& } 2517\& }
1162.Ve 2518\&
1163.PP
1164.Vb 3
1165\& struct ev_periodic hourly_tick; 2519\& ev_periodic hourly_tick;
1166\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 2520\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1167\& ev_periodic_start (loop, &hourly_tick); 2521\& ev_periodic_start (loop, &hourly_tick);
1168.Ve 2522.Ve
1169.PP 2523.PP
1170Example: the same as above, but use a reschedule callback to do it: 2524Example: The same as above, but use a reschedule callback to do it:
1171.PP 2525.PP
1172.Vb 1 2526.Vb 1
1173\& #include <math.h> 2527\& #include <math.h>
1174.Ve 2528\&
1175.PP
1176.Vb 5
1177\& static ev_tstamp 2529\& static ev_tstamp
1178\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 2530\& my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1179\& { 2531\& {
1180\& return fmod (now, 3600.) + 3600.; 2532\& return now + (3600. \- fmod (now, 3600.));
1181\& } 2533\& }
1182.Ve 2534\&
1183.PP
1184.Vb 1
1185\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 2535\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1186.Ve 2536.Ve
1187.PP 2537.PP
1188Example: call a callback every hour, starting now: 2538Example: Call a callback every hour, starting now:
1189.PP 2539.PP
1190.Vb 4 2540.Vb 4
1191\& struct ev_periodic hourly_tick; 2541\& ev_periodic hourly_tick;
1192\& ev_periodic_init (&hourly_tick, clock_cb, 2542\& ev_periodic_init (&hourly_tick, clock_cb,
1193\& fmod (ev_now (loop), 3600.), 3600., 0); 2543\& fmod (ev_now (loop), 3600.), 3600., 0);
1194\& ev_periodic_start (loop, &hourly_tick); 2544\& ev_periodic_start (loop, &hourly_tick);
1195.Ve 2545.Ve
1196.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" 2546.ie n .SS """ev_signal"" \- signal me when a signal gets signalled!"
1197.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" 2547.el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1198.IX Subsection "ev_signal - signal me when a signal gets signalled!" 2548.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1199Signal watchers will trigger an event when the process receives a specific 2549Signal watchers will trigger an event when the process receives a specific
1200signal one or more times. Even though signals are very asynchronous, libev 2550signal one or more times. Even though signals are very asynchronous, libev
1201will try it's best to deliver signals synchronously, i.e. as part of the 2551will try its best to deliver signals synchronously, i.e. as part of the
1202normal event processing, like any other event. 2552normal event processing, like any other event.
1203.PP 2553.PP
2554If you want signals to be delivered truly asynchronously, just use
2555\&\f(CW\*(C`sigaction\*(C'\fR as you would do without libev and forget about sharing
2556the signal. You can even use \f(CW\*(C`ev_async\*(C'\fR from a signal handler to
2557synchronously wake up an event loop.
2558.PP
1204You can configure as many watchers as you like per signal. Only when the 2559You can configure as many watchers as you like for the same signal, but
1205first watcher gets started will libev actually register a signal watcher 2560only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
1206with the kernel (thus it coexists with your own signal handlers as long 2561default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
1207as you don't register any with libev). Similarly, when the last signal 2562\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
1208watcher for a signal is stopped libev will reset the signal handler to 2563the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
1209\&\s-1SIG_DFL\s0 (regardless of what it was set to before). 2564.PP
2565Only after the first watcher for a signal is started will libev actually
2566register something with the kernel. It thus coexists with your own signal
2567handlers as long as you don't register any with libev for the same signal.
2568.PP
2569If possible and supported, libev will install its handlers with
2570\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
2571not be unduly interrupted. If you have a problem with system calls getting
2572interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2573and unblock them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
2574.PP
2575\fIThe special problem of inheritance over fork/execve/pthread_create\fR
2576.IX Subsection "The special problem of inheritance over fork/execve/pthread_create"
2577.PP
2578Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition
2579(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after
2580stopping it again), that is, libev might or might not block the signal,
2581and might or might not set or restore the installed signal handler (but
2582see \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR).
2583.PP
2584While this does not matter for the signal disposition (libev never
2585sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on
2586\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect
2587certain signals to be blocked.
2588.PP
2589This means that before calling \f(CW\*(C`exec\*(C'\fR (from the child) you should reset
2590the signal mask to whatever \*(L"default\*(R" you expect (all clear is a good
2591choice usually).
2592.PP
2593The simplest way to ensure that the signal mask is reset in the child is
2594to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will
2595catch fork calls done by libraries (such as the libc) as well.
2596.PP
2597In current versions of libev, the signal will not be blocked indefinitely
2598unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API \s0(\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
2599the window of opportunity for problems, it will not go away, as libev
2600\&\fIhas\fR to modify the signal mask, at least temporarily.
2601.PP
2602So I can't stress this enough: \fIIf you do not reset your signal mask when
2603you expect it to be empty, you have a race condition in your code\fR. This
2604is not a libev-specific thing, this is true for most event libraries.
2605.PP
2606\fIThe special problem of threads signal handling\fR
2607.IX Subsection "The special problem of threads signal handling"
2608.PP
2609\&\s-1POSIX\s0 threads has problematic signal handling semantics, specifically,
2610a lot of functionality (sigfd, sigwait etc.) only really works if all
2611threads in a process block signals, which is hard to achieve.
2612.PP
2613When you want to use sigwait (or mix libev signal handling with your own
2614for the same signals), you can tackle this problem by globally blocking
2615all signals before creating any threads (or creating them with a fully set
2616sigprocmask) and also specifying the \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when creating
2617loops. Then designate one thread as \*(L"signal receiver thread\*(R" which handles
2618these signals. You can pass on any signals that libev might be interested
2619in by calling \f(CW\*(C`ev_feed_signal\*(C'\fR.
2620.PP
2621\fIWatcher-Specific Functions and Data Members\fR
2622.IX Subsection "Watcher-Specific Functions and Data Members"
1210.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 2623.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
1211.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 2624.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
1212.PD 0 2625.PD 0
1213.IP "ev_signal_set (ev_signal *, int signum)" 4 2626.IP "ev_signal_set (ev_signal *, int signum)" 4
1214.IX Item "ev_signal_set (ev_signal *, int signum)" 2627.IX Item "ev_signal_set (ev_signal *, int signum)"
… …
1216Configures the watcher to trigger on the given signal number (usually one 2629Configures the watcher to trigger on the given signal number (usually one
1217of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 2630of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
1218.IP "int signum [read\-only]" 4 2631.IP "int signum [read\-only]" 4
1219.IX Item "int signum [read-only]" 2632.IX Item "int signum [read-only]"
1220The signal the watcher watches out for. 2633The signal the watcher watches out for.
2634.PP
2635\fIExamples\fR
2636.IX Subsection "Examples"
2637.PP
2638Example: Try to exit cleanly on \s-1SIGINT.\s0
2639.PP
2640.Vb 5
2641\& static void
2642\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2643\& {
2644\& ev_break (loop, EVBREAK_ALL);
2645\& }
2646\&
2647\& ev_signal signal_watcher;
2648\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2649\& ev_signal_start (loop, &signal_watcher);
2650.Ve
1221.ie n .Sh """ev_child"" \- watch out for process status changes" 2651.ie n .SS """ev_child"" \- watch out for process status changes"
1222.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 2652.el .SS "\f(CWev_child\fP \- watch out for process status changes"
1223.IX Subsection "ev_child - watch out for process status changes" 2653.IX Subsection "ev_child - watch out for process status changes"
1224Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 2654Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1225some child status changes (most typically when a child of yours dies). 2655some child status changes (most typically when a child of yours dies or
2656exits). It is permissible to install a child watcher \fIafter\fR the child
2657has been forked (which implies it might have already exited), as long
2658as the event loop isn't entered (or is continued from a watcher), i.e.,
2659forking and then immediately registering a watcher for the child is fine,
2660but forking and registering a watcher a few event loop iterations later or
2661in the next callback invocation is not.
2662.PP
2663Only the default event loop is capable of handling signals, and therefore
2664you can only register child watchers in the default event loop.
2665.PP
2666Due to some design glitches inside libev, child watchers will always be
2667handled at maximum priority (their priority is set to \f(CW\*(C`EV_MAXPRI\*(C'\fR by
2668libev)
2669.PP
2670\fIProcess Interaction\fR
2671.IX Subsection "Process Interaction"
2672.PP
2673Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
2674initialised. This is necessary to guarantee proper behaviour even if the
2675first child watcher is started after the child exits. The occurrence
2676of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
2677synchronously as part of the event loop processing. Libev always reaps all
2678children, even ones not watched.
2679.PP
2680\fIOverriding the Built-In Processing\fR
2681.IX Subsection "Overriding the Built-In Processing"
2682.PP
2683Libev offers no special support for overriding the built-in child
2684processing, but if your application collides with libev's default child
2685handler, you can override it easily by installing your own handler for
2686\&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the
2687default loop never gets destroyed. You are encouraged, however, to use an
2688event-based approach to child reaping and thus use libev's support for
2689that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely.
2690.PP
2691\fIStopping the Child Watcher\fR
2692.IX Subsection "Stopping the Child Watcher"
2693.PP
2694Currently, the child watcher never gets stopped, even when the
2695child terminates, so normally one needs to stop the watcher in the
2696callback. Future versions of libev might stop the watcher automatically
2697when a child exit is detected (calling \f(CW\*(C`ev_child_stop\*(C'\fR twice is not a
2698problem).
2699.PP
2700\fIWatcher-Specific Functions and Data Members\fR
2701.IX Subsection "Watcher-Specific Functions and Data Members"
1226.IP "ev_child_init (ev_child *, callback, int pid)" 4 2702.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
1227.IX Item "ev_child_init (ev_child *, callback, int pid)" 2703.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
1228.PD 0 2704.PD 0
1229.IP "ev_child_set (ev_child *, int pid)" 4 2705.IP "ev_child_set (ev_child *, int pid, int trace)" 4
1230.IX Item "ev_child_set (ev_child *, int pid)" 2706.IX Item "ev_child_set (ev_child *, int pid, int trace)"
1231.PD 2707.PD
1232Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or 2708Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or
1233\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 2709\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1234at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 2710at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1235the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 2711the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1236\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 2712\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1237process causing the status change. 2713process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only
2714activate the watcher when the process terminates) or \f(CW1\fR (additionally
2715activate the watcher when the process is stopped or continued).
1238.IP "int pid [read\-only]" 4 2716.IP "int pid [read\-only]" 4
1239.IX Item "int pid [read-only]" 2717.IX Item "int pid [read-only]"
1240The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. 2718The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
1241.IP "int rpid [read\-write]" 4 2719.IP "int rpid [read\-write]" 4
1242.IX Item "int rpid [read-write]" 2720.IX Item "int rpid [read-write]"
… …
1244.IP "int rstatus [read\-write]" 4 2722.IP "int rstatus [read\-write]" 4
1245.IX Item "int rstatus [read-write]" 2723.IX Item "int rstatus [read-write]"
1246The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems 2724The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1247\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). 2725\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1248.PP 2726.PP
1249Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 2727\fIExamples\fR
2728.IX Subsection "Examples"
1250.PP 2729.PP
2730Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for
2731its completion.
2732.PP
1251.Vb 5 2733.Vb 1
2734\& ev_child cw;
2735\&
1252\& static void 2736\& static void
1253\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 2737\& child_cb (EV_P_ ev_child *w, int revents)
1254\& { 2738\& {
1255\& ev_unloop (loop, EVUNLOOP_ALL); 2739\& ev_child_stop (EV_A_ w);
2740\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1256\& } 2741\& }
2742\&
2743\& pid_t pid = fork ();
2744\&
2745\& if (pid < 0)
2746\& // error
2747\& else if (pid == 0)
2748\& {
2749\& // the forked child executes here
2750\& exit (1);
2751\& }
2752\& else
2753\& {
2754\& ev_child_init (&cw, child_cb, pid, 0);
2755\& ev_child_start (EV_DEFAULT_ &cw);
2756\& }
1257.Ve 2757.Ve
1258.PP
1259.Vb 3
1260\& struct ev_signal signal_watcher;
1261\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1262\& ev_signal_start (loop, &sigint_cb);
1263.Ve
1264.ie n .Sh """ev_stat"" \- did the file attributes just change?" 2758.ie n .SS """ev_stat"" \- did the file attributes just change?"
1265.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" 2759.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
1266.IX Subsection "ev_stat - did the file attributes just change?" 2760.IX Subsection "ev_stat - did the file attributes just change?"
1267This watches a filesystem path for attribute changes. That is, it calls 2761This watches a file system path for attribute changes. That is, it calls
1268\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed 2762\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
1269compared to the last time, invoking the callback if it did. 2763and sees if it changed compared to the last time, invoking the callback
2764if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2765happen after the watcher has been started will be reported.
1270.PP 2766.PP
1271The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2767The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
1272not exist\*(R" is a status change like any other. The condition \*(L"path does 2768not exist\*(R" is a status change like any other. The condition \*(L"path does not
1273not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is 2769exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
1274otherwise always forced to be at least one) and all the other fields of 2770\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
1275the stat buffer having unspecified contents. 2771least one) and all the other fields of the stat buffer having unspecified
2772contents.
1276.PP 2773.PP
1277Since there is no standard to do this, the portable implementation simply 2774The path \fImust not\fR end in a slash or contain special components such as
1278calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You 2775\&\f(CW\*(C`.\*(C'\fR or \f(CW\*(C`..\*(C'\fR. The path \fIshould\fR be absolute: If it is relative and
1279can specify a recommended polling interval for this case. If you specify 2776your working directory changes, then the behaviour is undefined.
1280a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, 2777.PP
1281unspecified default\fR value will be used (which you can expect to be around 2778Since there is no portable change notification interface available, the
1282five seconds, although this might change dynamically). Libev will also 2779portable implementation simply calls \f(CWstat(2)\fR regularly on the path
1283impose a minimum interval which is currently around \f(CW0.1\fR, but thats 2780to see if it changed somehow. You can specify a recommended polling
1284usually overkill. 2781interval for this case. If you specify a polling interval of \f(CW0\fR (highly
2782recommended!) then a \fIsuitable, unspecified default\fR value will be used
2783(which you can expect to be around five seconds, although this might
2784change dynamically). Libev will also impose a minimum interval which is
2785currently around \f(CW0.1\fR, but that's usually overkill.
1285.PP 2786.PP
1286This watcher type is not meant for massive numbers of stat watchers, 2787This watcher type is not meant for massive numbers of stat watchers,
1287as even with OS-supported change notifications, this can be 2788as even with OS-supported change notifications, this can be
1288resource\-intensive. 2789resource-intensive.
1289.PP 2790.PP
1290At the time of this writing, no specific \s-1OS\s0 backends are implemented, but 2791At the time of this writing, the only OS-specific interface implemented
1291if demand increases, at least a kqueue and inotify backend will be added. 2792is the Linux inotify interface (implementing kqueue support is left as an
2793exercise for the reader. Note, however, that the author sees no way of
2794implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue, except as a hint).
2795.PP
2796\fI\s-1ABI\s0 Issues (Largefile Support)\fR
2797.IX Subsection "ABI Issues (Largefile Support)"
2798.PP
2799Libev by default (unless the user overrides this) uses the default
2800compilation environment, which means that on systems with large file
2801support disabled by default, you get the 32 bit version of the stat
2802structure. When using the library from programs that change the \s-1ABI\s0 to
2803use 64 bit file offsets the programs will fail. In that case you have to
2804compile libev with the same flags to get binary compatibility. This is
2805obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2806most noticeably displayed with ev_stat and large file support.
2807.PP
2808The solution for this is to lobby your distribution maker to make large
2809file interfaces available by default (as e.g. FreeBSD does) and not
2810optional. Libev cannot simply switch on large file support because it has
2811to exchange stat structures with application programs compiled using the
2812default compilation environment.
2813.PP
2814\fIInotify and Kqueue\fR
2815.IX Subsection "Inotify and Kqueue"
2816.PP
2817When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev and present at
2818runtime, it will be used to speed up change detection where possible. The
2819inotify descriptor will be created lazily when the first \f(CW\*(C`ev_stat\*(C'\fR
2820watcher is being started.
2821.PP
2822Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
2823except that changes might be detected earlier, and in some cases, to avoid
2824making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support
2825there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling,
2826but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
2827many bugs), the path exists (i.e. stat succeeds), and the path resides on
2828a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
2829xfs are fully working) libev usually gets away without polling.
2830.PP
2831There is no support for kqueue, as apparently it cannot be used to
2832implement this functionality, due to the requirement of having a file
2833descriptor open on the object at all times, and detecting renames, unlinks
2834etc. is difficult.
2835.PP
2836\fI\f(CI\*(C`stat ()\*(C'\fI is a synchronous operation\fR
2837.IX Subsection "stat () is a synchronous operation"
2838.PP
2839Libev doesn't normally do any kind of I/O itself, and so is not blocking
2840the process. The exception are \f(CW\*(C`ev_stat\*(C'\fR watchers \- those call \f(CW\*(C`stat
2841()\*(C'\fR, which is a synchronous operation.
2842.PP
2843For local paths, this usually doesn't matter: unless the system is very
2844busy or the intervals between stat's are large, a stat call will be fast,
2845as the path data is usually in memory already (except when starting the
2846watcher).
2847.PP
2848For networked file systems, calling \f(CW\*(C`stat ()\*(C'\fR can block an indefinite
2849time due to network issues, and even under good conditions, a stat call
2850often takes multiple milliseconds.
2851.PP
2852Therefore, it is best to avoid using \f(CW\*(C`ev_stat\*(C'\fR watchers on networked
2853paths, although this is fully supported by libev.
2854.PP
2855\fIThe special problem of stat time resolution\fR
2856.IX Subsection "The special problem of stat time resolution"
2857.PP
2858The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably,
2859and even on systems where the resolution is higher, most file systems
2860still only support whole seconds.
2861.PP
2862That means that, if the time is the only thing that changes, you can
2863easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and
2864calls your callback, which does something. When there is another update
2865within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the
2866stat data does change in other ways (e.g. file size).
2867.PP
2868The solution to this is to delay acting on a change for slightly more
2869than a second (or till slightly after the next full second boundary), using
2870a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02);
2871ev_timer_again (loop, w)\*(C'\fR).
2872.PP
2873The \f(CW.02\fR offset is added to work around small timing inconsistencies
2874of some operating systems (where the second counter of the current time
2875might be be delayed. One such system is the Linux kernel, where a call to
2876\&\f(CW\*(C`gettimeofday\*(C'\fR might return a timestamp with a full second later than
2877a subsequent \f(CW\*(C`time\*(C'\fR call \- if the equivalent of \f(CW\*(C`time ()\*(C'\fR is used to
2878update file times then there will be a small window where the kernel uses
2879the previous second to update file times but libev might already execute
2880the timer callback).
2881.PP
2882\fIWatcher-Specific Functions and Data Members\fR
2883.IX Subsection "Watcher-Specific Functions and Data Members"
1292.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 2884.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1293.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 2885.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1294.PD 0 2886.PD 0
1295.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 2887.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1296.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 2888.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
… …
1299\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to 2891\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
1300be detected and should normally be specified as \f(CW0\fR to let libev choose 2892be detected and should normally be specified as \f(CW0\fR to let libev choose
1301a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same 2893a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
1302path for as long as the watcher is active. 2894path for as long as the watcher is active.
1303.Sp 2895.Sp
1304The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, 2896The callback will receive an \f(CW\*(C`EV_STAT\*(C'\fR event when a change was detected,
1305relative to the attributes at the time the watcher was started (or the 2897relative to the attributes at the time the watcher was started (or the
1306last change was detected). 2898last change was detected).
1307.IP "ev_stat_stat (ev_stat *)" 4 2899.IP "ev_stat_stat (loop, ev_stat *)" 4
1308.IX Item "ev_stat_stat (ev_stat *)" 2900.IX Item "ev_stat_stat (loop, ev_stat *)"
1309Updates the stat buffer immediately with new values. If you change the 2901Updates the stat buffer immediately with new values. If you change the
1310watched path in your callback, you could call this fucntion to avoid 2902watched path in your callback, you could call this function to avoid
1311detecting this change (while introducing a race condition). Can also be 2903detecting this change (while introducing a race condition if you are not
1312useful simply to find out the new values. 2904the only one changing the path). Can also be useful simply to find out the
2905new values.
1313.IP "ev_statdata attr [read\-only]" 4 2906.IP "ev_statdata attr [read\-only]" 4
1314.IX Item "ev_statdata attr [read-only]" 2907.IX Item "ev_statdata attr [read-only]"
1315The most-recently detected attributes of the file. Although the type is of 2908The most-recently detected attributes of the file. Although the type is
1316\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types 2909\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types
2910suitable for your system, but you can only rely on the POSIX-standardised
1317suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there 2911members to be present. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there was
1318was some error while \f(CW\*(C`stat\*(C'\fRing the file. 2912some error while \f(CW\*(C`stat\*(C'\fRing the file.
1319.IP "ev_statdata prev [read\-only]" 4 2913.IP "ev_statdata prev [read\-only]" 4
1320.IX Item "ev_statdata prev [read-only]" 2914.IX Item "ev_statdata prev [read-only]"
1321The previous attributes of the file. The callback gets invoked whenever 2915The previous attributes of the file. The callback gets invoked whenever
1322\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR. 2916\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR, or, more precisely, one or more of these members
2917differ: \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,
2918\&\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.
1323.IP "ev_tstamp interval [read\-only]" 4 2919.IP "ev_tstamp interval [read\-only]" 4
1324.IX Item "ev_tstamp interval [read-only]" 2920.IX Item "ev_tstamp interval [read-only]"
1325The specified interval. 2921The specified interval.
1326.IP "const char *path [read\-only]" 4 2922.IP "const char *path [read\-only]" 4
1327.IX Item "const char *path [read-only]" 2923.IX Item "const char *path [read-only]"
1328The filesystem path that is being watched. 2924The file system path that is being watched.
2925.PP
2926\fIExamples\fR
2927.IX Subsection "Examples"
1329.PP 2928.PP
1330Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. 2929Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1331.PP 2930.PP
1332.Vb 15 2931.Vb 10
1333\& static void 2932\& static void
1334\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 2933\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1335\& { 2934\& {
1336\& /* /etc/passwd changed in some way */ 2935\& /* /etc/passwd changed in some way */
1337\& if (w->attr.st_nlink) 2936\& if (w\->attr.st_nlink)
1338\& { 2937\& {
1339\& printf ("passwd current size %ld\en", (long)w->attr.st_size); 2938\& printf ("passwd current size %ld\en", (long)w\->attr.st_size);
1340\& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime); 2939\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime);
1341\& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime); 2940\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime);
1342\& } 2941\& }
1343\& else 2942\& else
1344\& /* you shalt not abuse printf for puts */ 2943\& /* you shalt not abuse printf for puts */
1345\& puts ("wow, /etc/passwd is not there, expect problems. " 2944\& puts ("wow, /etc/passwd is not there, expect problems. "
1346\& "if this is windows, they already arrived\en"); 2945\& "if this is windows, they already arrived\en");
1347\& } 2946\& }
2947\&
2948\& ...
2949\& ev_stat passwd;
2950\&
2951\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
2952\& ev_stat_start (loop, &passwd);
1348.Ve 2953.Ve
2954.PP
2955Example: Like above, but additionally use a one-second delay so we do not
2956miss updates (however, frequent updates will delay processing, too, so
2957one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on
2958\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
1349.PP 2959.PP
1350.Vb 2 2960.Vb 2
2961\& static ev_stat passwd;
2962\& static ev_timer timer;
2963\&
2964\& static void
2965\& timer_cb (EV_P_ ev_timer *w, int revents)
2966\& {
2967\& ev_timer_stop (EV_A_ w);
2968\&
2969\& /* now it\*(Aqs one second after the most recent passwd change */
2970\& }
2971\&
2972\& static void
2973\& stat_cb (EV_P_ ev_stat *w, int revents)
2974\& {
2975\& /* reset the one\-second timer */
2976\& ev_timer_again (EV_A_ &timer);
2977\& }
2978\&
1351\& ... 2979\& ...
1352\& ev_stat passwd;
1353.Ve
1354.PP
1355.Vb 2
1356\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 2980\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1357\& ev_stat_start (loop, &passwd); 2981\& ev_stat_start (loop, &passwd);
2982\& ev_timer_init (&timer, timer_cb, 0., 1.02);
1358.Ve 2983.Ve
1359.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 2984.ie n .SS """ev_idle"" \- when you've got nothing better to do..."
1360.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 2985.el .SS "\f(CWev_idle\fP \- when you've got nothing better to do..."
1361.IX Subsection "ev_idle - when you've got nothing better to do..." 2986.IX Subsection "ev_idle - when you've got nothing better to do..."
1362Idle watchers trigger events when there are no other events are pending 2987Idle watchers trigger events when no other events of the same or higher
1363(prepare, check and other idle watchers do not count). That is, as long 2988priority are pending (prepare, check and other idle watchers do not count
1364as your process is busy handling sockets or timeouts (or even signals, 2989as receiving \*(L"events\*(R").
1365imagine) it will not be triggered. But when your process is idle all idle 2990.PP
1366watchers are being called again and again, once per event loop iteration \- 2991That is, as long as your process is busy handling sockets or timeouts
2992(or even signals, imagine) of the same or higher priority it will not be
2993triggered. But when your process is idle (or only lower-priority watchers
2994are pending), the idle watchers are being called once per event loop
1367until stopped, that is, or your process receives more events and becomes 2995iteration \- until stopped, that is, or your process receives more events
1368busy. 2996and becomes busy again with higher priority stuff.
1369.PP 2997.PP
1370The most noteworthy effect is that as long as any idle watchers are 2998The most noteworthy effect is that as long as any idle watchers are
1371active, the process will not block when waiting for new events. 2999active, the process will not block when waiting for new events.
1372.PP 3000.PP
1373Apart from keeping your process non-blocking (which is a useful 3001Apart from keeping your process non-blocking (which is a useful
1374effect on its own sometimes), idle watchers are a good place to do 3002effect on its own sometimes), idle watchers are a good place to do
1375\&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the 3003\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
1376event loop has handled all outstanding events. 3004event loop has handled all outstanding events.
3005.PP
3006\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3007.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3008.PP
3009As long as there is at least one active idle watcher, libev will never
3010sleep unnecessarily. Or in other words, it will loop as fast as possible.
3011For this to work, the idle watcher doesn't need to be invoked at all \- the
3012lowest priority will do.
3013.PP
3014This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3015to do something on each event loop iteration \- for example to balance load
3016between different connections.
3017.PP
3018See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3019example.
3020.PP
3021\fIWatcher-Specific Functions and Data Members\fR
3022.IX Subsection "Watcher-Specific Functions and Data Members"
1377.IP "ev_idle_init (ev_signal *, callback)" 4 3023.IP "ev_idle_init (ev_idle *, callback)" 4
1378.IX Item "ev_idle_init (ev_signal *, callback)" 3024.IX Item "ev_idle_init (ev_idle *, callback)"
1379Initialises and configures the idle watcher \- it has no parameters of any 3025Initialises and configures the idle watcher \- it has no parameters of any
1380kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 3026kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1381believe me. 3027believe me.
1382.PP 3028.PP
3029\fIExamples\fR
3030.IX Subsection "Examples"
3031.PP
1383Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the 3032Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1384callback, free it. Alos, use no error checking, as usual. 3033callback, free it. Also, use no error checking, as usual.
1385.PP 3034.PP
1386.Vb 7 3035.Vb 5
1387\& static void 3036\& static void
1388\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 3037\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1389\& { 3038\& {
3039\& // stop the watcher
3040\& ev_idle_stop (loop, w);
3041\&
3042\& // now we can free it
1390\& free (w); 3043\& free (w);
3044\&
1391\& // now do something you wanted to do when the program has 3045\& // now do something you wanted to do when the program has
1392\& // no longer asnything immediate to do. 3046\& // no longer anything immediate to do.
1393\& } 3047\& }
1394.Ve 3048\&
1395.PP
1396.Vb 3
1397\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 3049\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1398\& ev_idle_init (idle_watcher, idle_cb); 3050\& ev_idle_init (idle_watcher, idle_cb);
1399\& ev_idle_start (loop, idle_cb); 3051\& ev_idle_start (loop, idle_watcher);
1400.Ve 3052.Ve
1401.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" 3053.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
1402.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 3054.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
1403.IX Subsection "ev_prepare and ev_check - customise your event loop!" 3055.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1404Prepare and check watchers are usually (but not always) used in tandem: 3056Prepare and check watchers are often (but not always) used in pairs:
1405prepare watchers get invoked before the process blocks and check watchers 3057prepare watchers get invoked before the process blocks and check watchers
1406afterwards. 3058afterwards.
1407.PP 3059.PP
1408You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter 3060You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the
1409the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 3061current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or
1410watchers. Other loops than the current one are fine, however. The 3062\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine,
1411rationale behind this is that you do not need to check for recursion in 3063however. The rationale behind this is that you do not need to check
1412those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 3064for recursion in those watchers, i.e. the sequence will always be
1413\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 3065\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each
1414called in pairs bracketing the blocking call. 3066kind they will always be called in pairs bracketing the blocking call.
1415.PP 3067.PP
1416Their main purpose is to integrate other event mechanisms into libev and 3068Their main purpose is to integrate other event mechanisms into libev and
1417their use is somewhat advanced. This could be used, for example, to track 3069their use is somewhat advanced. They could be used, for example, to track
1418variable changes, implement your own watchers, integrate net-snmp or a 3070variable changes, implement your own watchers, integrate net-snmp or a
1419coroutine library and lots more. They are also occasionally useful if 3071coroutine library and lots more. They are also occasionally useful if
1420you cache some data and want to flush it before blocking (for example, 3072you cache some data and want to flush it before blocking (for example,
1421in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR 3073in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR
1422watcher). 3074watcher).
1423.PP 3075.PP
1424This is done by examining in each prepare call which file descriptors need 3076This is done by examining in each prepare call which file descriptors
1425to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 3077need to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers
1426them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 3078for them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many
1427provide just this functionality). Then, in the check watcher you check for 3079libraries provide exactly this functionality). Then, in the check watcher,
1428any events that occured (by checking the pending status of all watchers 3080you check for any events that occurred (by checking the pending status
1429and stopping them) and call back into the library. The I/O and timer 3081of all watchers and stopping them) and call back into the library. The
1430callbacks will never actually be called (but must be valid nevertheless, 3082I/O and timer callbacks will never actually be called (but must be valid
1431because you never know, you know?). 3083nevertheless, because you never know, you know?).
1432.PP 3084.PP
1433As another example, the Perl Coro module uses these hooks to integrate 3085As another example, the Perl Coro module uses these hooks to integrate
1434coroutines into libev programs, by yielding to other active coroutines 3086coroutines into libev programs, by yielding to other active coroutines
1435during each prepare and only letting the process block if no coroutines 3087during each prepare and only letting the process block if no coroutines
1436are ready to run (it's actually more complicated: it only runs coroutines 3088are ready to run (it's actually more complicated: it only runs coroutines
1437with priority higher than or equal to the event loop and one coroutine 3089with priority higher than or equal to the event loop and one coroutine
1438of lower priority, but only once, using idle watchers to keep the event 3090of lower priority, but only once, using idle watchers to keep the event
1439loop from blocking if lower-priority coroutines are active, thus mapping 3091loop from blocking if lower-priority coroutines are active, thus mapping
1440low-priority coroutines to idle/background tasks). 3092low-priority coroutines to idle/background tasks).
3093.PP
3094When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
3095highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
3096any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3097watchers).
3098.PP
3099Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
3100activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
3101might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
3102\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
3103loops those other event loops might be in an unusable state until their
3104\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
3105others).
3106.PP
3107\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3108.IX Subsection "Abusing an ev_check watcher for its side-effect"
3109.PP
3110\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3111useful because they are called once per event loop iteration. For
3112example, if you want to handle a large number of connections fairly, you
3113normally only do a bit of work for each active connection, and if there
3114is more work to do, you wait for the next event loop iteration, so other
3115connections have a chance of making progress.
3116.PP
3117Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3118next event loop iteration. However, that isn't as soon as possible \-
3119without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3120.PP
3121This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3122single global idle watcher that is active as long as you have one active
3123\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3124will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3125invoked. Neither watcher alone can do that.
3126.PP
3127\fIWatcher-Specific Functions and Data Members\fR
3128.IX Subsection "Watcher-Specific Functions and Data Members"
1441.IP "ev_prepare_init (ev_prepare *, callback)" 4 3129.IP "ev_prepare_init (ev_prepare *, callback)" 4
1442.IX Item "ev_prepare_init (ev_prepare *, callback)" 3130.IX Item "ev_prepare_init (ev_prepare *, callback)"
1443.PD 0 3131.PD 0
1444.IP "ev_check_init (ev_check *, callback)" 4 3132.IP "ev_check_init (ev_check *, callback)" 4
1445.IX Item "ev_check_init (ev_check *, callback)" 3133.IX Item "ev_check_init (ev_check *, callback)"
1446.PD 3134.PD
1447Initialises and configures the prepare or check watcher \- they have no 3135Initialises and configures the prepare or check watcher \- they have no
1448parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 3136parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1449macros, but using them is utterly, utterly and completely pointless. 3137macros, but using them is utterly, utterly, utterly and completely
3138pointless.
1450.PP 3139.PP
1451Example: To include a library such as adns, you would add \s-1IO\s0 watchers 3140\fIExamples\fR
1452and a timeout watcher in a prepare handler, as required by libadns, and 3141.IX Subsection "Examples"
3142.PP
3143There are a number of principal ways to embed other event loops or modules
3144into libev. Here are some ideas on how to include libadns into libev
3145(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
3146use as a working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR embeds a
3147Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 into the
3148Glib event loop).
3149.PP
3150Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler,
1453in a check watcher, destroy them and call into libadns. What follows is 3151and in a check watcher, destroy them and call into libadns. What follows
1454pseudo-code only of course: 3152is pseudo-code only of course. This requires you to either use a low
3153priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as
3154the callbacks for the IO/timeout watchers might not have been called yet.
1455.PP 3155.PP
1456.Vb 2 3156.Vb 2
1457\& static ev_io iow [nfd]; 3157\& static ev_io iow [nfd];
1458\& static ev_timer tw; 3158\& static ev_timer tw;
1459.Ve 3159\&
1460.PP
1461.Vb 9
1462\& static void 3160\& static void
1463\& io_cb (ev_loop *loop, ev_io *w, int revents) 3161\& io_cb (struct ev_loop *loop, ev_io *w, int revents)
1464\& { 3162\& {
1465\& // set the relevant poll flags
1466\& // could also call adns_processreadable etc. here
1467\& struct pollfd *fd = (struct pollfd *)w->data;
1468\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1469\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1470\& } 3163\& }
1471.Ve 3164\&
1472.PP
1473.Vb 7
1474\& // create io watchers for each fd and a timer before blocking 3165\& // create io watchers for each fd and a timer before blocking
1475\& static void 3166\& static void
1476\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 3167\& adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
1477\& { 3168\& {
1478\& int timeout = 3600000;truct pollfd fds [nfd]; 3169\& int timeout = 3600000;
3170\& struct pollfd fds [nfd];
1479\& // actual code will need to loop here and realloc etc. 3171\& // actual code will need to loop here and realloc etc.
1480\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 3172\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1481.Ve 3173\&
1482.PP
1483.Vb 3
1484\& /* the callback is illegal, but won't be called as we stop during check */ 3174\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
1485\& ev_timer_init (&tw, 0, timeout * 1e-3); 3175\& ev_timer_init (&tw, 0, timeout * 1e\-3, 0.);
1486\& ev_timer_start (loop, &tw); 3176\& ev_timer_start (loop, &tw);
1487.Ve 3177\&
1488.PP
1489.Vb 6
1490\& // create on ev_io per pollfd 3178\& // create one ev_io per pollfd
1491\& for (int i = 0; i < nfd; ++i) 3179\& for (int i = 0; i < nfd; ++i)
1492\& { 3180\& {
1493\& ev_io_init (iow + i, io_cb, fds [i].fd, 3181\& ev_io_init (iow + i, io_cb, fds [i].fd,
1494\& ((fds [i].events & POLLIN ? EV_READ : 0) 3182\& ((fds [i].events & POLLIN ? EV_READ : 0)
1495\& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 3183\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
3184\&
3185\& fds [i].revents = 0;
3186\& ev_io_start (loop, iow + i);
3187\& }
3188\& }
3189\&
3190\& // stop all watchers after blocking
3191\& static void
3192\& adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
3193\& {
3194\& ev_timer_stop (loop, &tw);
3195\&
3196\& for (int i = 0; i < nfd; ++i)
3197\& {
3198\& // set the relevant poll flags
3199\& // could also call adns_processreadable etc. here
3200\& struct pollfd *fd = fds + i;
3201\& int revents = ev_clear_pending (iow + i);
3202\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN;
3203\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT;
3204\&
3205\& // now stop the watcher
3206\& ev_io_stop (loop, iow + i);
3207\& }
3208\&
3209\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
3210\& }
1496.Ve 3211.Ve
3212.PP
3213Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
3214in the prepare watcher and would dispose of the check watcher.
3215.PP
3216Method 3: If the module to be embedded supports explicit event
3217notification (libadns does), you can also make use of the actual watcher
3218callbacks, and only destroy/create the watchers in the prepare watcher.
1497.PP 3219.PP
1498.Vb 5 3220.Vb 5
1499\& fds [i].revents = 0;
1500\& iow [i].data = fds + i;
1501\& ev_io_start (loop, iow + i);
1502\& }
1503\& }
1504.Ve
1505.PP
1506.Vb 5
1507\& // stop all watchers after blocking
1508\& static void 3221\& static void
1509\& adns_check_cb (ev_loop *loop, ev_check *w, int revents) 3222\& timer_cb (EV_P_ ev_timer *w, int revents)
1510\& { 3223\& {
1511\& ev_timer_stop (loop, &tw); 3224\& adns_state ads = (adns_state)w\->data;
1512.Ve 3225\& update_now (EV_A);
1513.PP 3226\&
1514.Vb 2 3227\& adns_processtimeouts (ads, &tv_now);
1515\& for (int i = 0; i < nfd; ++i)
1516\& ev_io_stop (loop, iow + i);
1517.Ve
1518.PP
1519.Vb 2
1520\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1521\& } 3228\& }
3229\&
3230\& static void
3231\& io_cb (EV_P_ ev_io *w, int revents)
3232\& {
3233\& adns_state ads = (adns_state)w\->data;
3234\& update_now (EV_A);
3235\&
3236\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now);
3237\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now);
3238\& }
3239\&
3240\& // do not ever call adns_afterpoll
1522.Ve 3241.Ve
3242.PP
3243Method 4: Do not use a prepare or check watcher because the module you
3244want to embed is not flexible enough to support it. Instead, you can
3245override their poll function. The drawback with this solution is that the
3246main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
3247this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3248libglib event loop.
3249.PP
3250.Vb 4
3251\& static gint
3252\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
3253\& {
3254\& int got_events = 0;
3255\&
3256\& for (n = 0; n < nfds; ++n)
3257\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
3258\&
3259\& if (timeout >= 0)
3260\& // create/start timer
3261\&
3262\& // poll
3263\& ev_run (EV_A_ 0);
3264\&
3265\& // stop timer again
3266\& if (timeout >= 0)
3267\& ev_timer_stop (EV_A_ &to);
3268\&
3269\& // stop io watchers again \- their callbacks should have set
3270\& for (n = 0; n < nfds; ++n)
3271\& ev_io_stop (EV_A_ iow [n]);
3272\&
3273\& return got_events;
3274\& }
3275.Ve
1523.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 3276.ie n .SS """ev_embed"" \- when one backend isn't enough..."
1524.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 3277.el .SS "\f(CWev_embed\fP \- when one backend isn't enough..."
1525.IX Subsection "ev_embed - when one backend isn't enough..." 3278.IX Subsection "ev_embed - when one backend isn't enough..."
1526This is a rather advanced watcher type that lets you embed one event loop 3279This is a rather advanced watcher type that lets you embed one event loop
1527into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded 3280into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
1528loop, other types of watchers might be handled in a delayed or incorrect 3281loop, other types of watchers might be handled in a delayed or incorrect
1529fashion and must not be used). 3282fashion and must not be used).
… …
1532prioritise I/O. 3285prioritise I/O.
1533.PP 3286.PP
1534As an example for a bug workaround, the kqueue backend might only support 3287As an example for a bug workaround, the kqueue backend might only support
1535sockets on some platform, so it is unusable as generic backend, but you 3288sockets on some platform, so it is unusable as generic backend, but you
1536still want to make use of it because you have many sockets and it scales 3289still want to make use of it because you have many sockets and it scales
1537so nicely. In this case, you would create a kqueue-based loop and embed it 3290so nicely. In this case, you would create a kqueue-based loop and embed
1538into your default loop (which might use e.g. poll). Overall operation will 3291it into your default loop (which might use e.g. poll). Overall operation
1539be a bit slower because first libev has to poll and then call kevent, but 3292will be a bit slower because first libev has to call \f(CW\*(C`poll\*(C'\fR and then
1540at least you can use both at what they are best. 3293\&\f(CW\*(C`kevent\*(C'\fR, but at least you can use both mechanisms for what they are
3294best: \f(CW\*(C`kqueue\*(C'\fR for scalable sockets and \f(CW\*(C`poll\*(C'\fR if you want it to work :)
1541.PP 3295.PP
1542As for prioritising I/O: rarely you have the case where some fds have 3296As for prioritising I/O: under rare circumstances you have the case where
1543to be watched and handled very quickly (with low latency), and even 3297some fds have to be watched and handled very quickly (with low latency),
1544priorities and idle watchers might have too much overhead. In this case 3298and even priorities and idle watchers might have too much overhead. In
1545you would put all the high priority stuff in one loop and all the rest in 3299this case you would put all the high priority stuff in one loop and all
1546a second one, and embed the second one in the first. 3300the rest in a second one, and embed the second one in the first.
1547.PP 3301.PP
1548As long as the watcher is active, the callback will be invoked every time 3302As long as the watcher is active, the callback will be invoked every
1549there might be events pending in the embedded loop. The callback must then 3303time there might be events pending in the embedded loop. The callback
1550call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke 3304must then call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single
1551their callbacks (you could also start an idle watcher to give the embedded 3305sweep and invoke their callbacks (the callback doesn't need to invoke the
1552loop strictly lower priority for example). You can also set the callback 3306\&\f(CW\*(C`ev_embed_sweep\*(C'\fR function directly, it could also start an idle watcher
1553to \f(CW0\fR, in which case the embed watcher will automatically execute the 3307to give the embedded loop strictly lower priority for example).
1554embedded loop sweep.
1555.PP 3308.PP
1556As long as the watcher is started it will automatically handle events. The 3309You can also set the callback to \f(CW0\fR, in which case the embed watcher
1557callback will be invoked whenever some events have been handled. You can 3310will automatically execute the embedded loop sweep whenever necessary.
1558set the callback to \f(CW0\fR to avoid having to specify one if you are not
1559interested in that.
1560.PP 3311.PP
1561Also, there have not currently been made special provisions for forking: 3312Fork detection will be handled transparently while the \f(CW\*(C`ev_embed\*(C'\fR watcher
1562when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops, 3313is active, i.e., the embedded loop will automatically be forked when the
1563but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers 3314embedding loop forks. In other cases, the user is responsible for calling
1564yourself. 3315\&\f(CW\*(C`ev_loop_fork\*(C'\fR on the embedded loop.
1565.PP 3316.PP
1566Unfortunately, not all backends are embeddable, only the ones returned by 3317Unfortunately, not all backends are embeddable: only the ones returned by
1567\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any 3318\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any
1568portable one. 3319portable one.
1569.PP 3320.PP
1570So when you want to use this feature you will always have to be prepared 3321So when you want to use this feature you will always have to be prepared
1571that you cannot get an embeddable loop. The recommended way to get around 3322that you cannot get an embeddable loop. The recommended way to get around
1572this is to have a separate variables for your embeddable loop, try to 3323this is to have a separate variables for your embeddable loop, try to
1573create it, and if that fails, use the normal loop for everything: 3324create it, and if that fails, use the normal loop for everything.
1574.PP 3325.PP
1575.Vb 3 3326\fI\f(CI\*(C`ev_embed\*(C'\fI and fork\fR
1576\& struct ev_loop *loop_hi = ev_default_init (0); 3327.IX Subsection "ev_embed and fork"
1577\& struct ev_loop *loop_lo = 0;
1578\& struct ev_embed embed;
1579.Ve
1580.PP 3328.PP
1581.Vb 5 3329While the \f(CW\*(C`ev_embed\*(C'\fR watcher is running, forks in the embedding loop will
1582\& // see if there is a chance of getting one that works 3330automatically be applied to the embedded loop as well, so no special
1583\& // (remember that a flags value of 0 means autodetection) 3331fork handling is required in that case. When the watcher is not running,
1584\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3332however, it is still the task of the libev user to call \f(CW\*(C`ev_loop_fork ()\*(C'\fR
1585\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3333as applicable.
1586\& : 0;
1587.Ve
1588.PP 3334.PP
1589.Vb 8 3335\fIWatcher-Specific Functions and Data Members\fR
1590\& // if we got one, then embed it, otherwise default to loop_hi 3336.IX Subsection "Watcher-Specific Functions and Data Members"
1591\& if (loop_lo)
1592\& {
1593\& ev_embed_init (&embed, 0, loop_lo);
1594\& ev_embed_start (loop_hi, &embed);
1595\& }
1596\& else
1597\& loop_lo = loop_hi;
1598.Ve
1599.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3337.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
1600.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3338.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
1601.PD 0 3339.PD 0
1602.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3340.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
1603.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3341.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
1604.PD 3342.PD
1605Configures the watcher to embed the given loop, which must be 3343Configures the watcher to embed the given loop, which must be
1606embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3344embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
1607invoked automatically, otherwise it is the responsibility of the callback 3345invoked automatically, otherwise it is the responsibility of the callback
1608to invoke it (it will continue to be called until the sweep has been done, 3346to invoke it (it will continue to be called until the sweep has been done,
1609if you do not want thta, you need to temporarily stop the embed watcher). 3347if you do not want that, you need to temporarily stop the embed watcher).
1610.IP "ev_embed_sweep (loop, ev_embed *)" 4 3348.IP "ev_embed_sweep (loop, ev_embed *)" 4
1611.IX Item "ev_embed_sweep (loop, ev_embed *)" 3349.IX Item "ev_embed_sweep (loop, ev_embed *)"
1612Make a single, non-blocking sweep over the embedded loop. This works 3350Make a single, non-blocking sweep over the embedded loop. This works
1613similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 3351similarly to \f(CW\*(C`ev_run (embedded_loop, EVRUN_NOWAIT)\*(C'\fR, but in the most
1614apropriate way for embedded loops. 3352appropriate way for embedded loops.
1615.IP "struct ev_loop *loop [read\-only]" 4 3353.IP "struct ev_loop *other [read\-only]" 4
1616.IX Item "struct ev_loop *loop [read-only]" 3354.IX Item "struct ev_loop *other [read-only]"
1617The embedded event loop. 3355The embedded event loop.
3356.PP
3357\fIExamples\fR
3358.IX Subsection "Examples"
3359.PP
3360Example: Try to get an embeddable event loop and embed it into the default
3361event loop. If that is not possible, use the default loop. The default
3362loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the embeddable loop is stored in
3363\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the case no embeddable loop can be
3364used).
3365.PP
3366.Vb 3
3367\& struct ev_loop *loop_hi = ev_default_init (0);
3368\& struct ev_loop *loop_lo = 0;
3369\& ev_embed embed;
3370\&
3371\& // see if there is a chance of getting one that works
3372\& // (remember that a flags value of 0 means autodetection)
3373\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3374\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3375\& : 0;
3376\&
3377\& // if we got one, then embed it, otherwise default to loop_hi
3378\& if (loop_lo)
3379\& {
3380\& ev_embed_init (&embed, 0, loop_lo);
3381\& ev_embed_start (loop_hi, &embed);
3382\& }
3383\& else
3384\& loop_lo = loop_hi;
3385.Ve
3386.PP
3387Example: Check if kqueue is available but not recommended and create
3388a kqueue backend for use with sockets (which usually work with any
3389kqueue implementation). Store the kqueue/socket\-only event loop in
3390\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
3391.PP
3392.Vb 3
3393\& struct ev_loop *loop = ev_default_init (0);
3394\& struct ev_loop *loop_socket = 0;
3395\& ev_embed embed;
3396\&
3397\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3398\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3399\& {
3400\& ev_embed_init (&embed, 0, loop_socket);
3401\& ev_embed_start (loop, &embed);
3402\& }
3403\&
3404\& if (!loop_socket)
3405\& loop_socket = loop;
3406\&
3407\& // now use loop_socket for all sockets, and loop for everything else
3408.Ve
3409.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
3410.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
3411.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
3412Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
3413whoever is a good citizen cared to tell libev about it by calling
3414\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
3415and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
3416after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
3417and calls it in the wrong process, the fork handlers will be invoked, too,
3418of course.
3419.PP
3420\fIThe special problem of life after fork \- how is it possible?\fR
3421.IX Subsection "The special problem of life after fork - how is it possible?"
3422.PP
3423Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set
3424up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3425sequence should be handled by libev without any problems.
3426.PP
3427This changes when the application actually wants to do event handling
3428in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3429fork.
3430.PP
3431The default mode of operation (for libev, with application help to detect
3432forks) is to duplicate all the state in the child, as would be expected
3433when \fIeither\fR the parent \fIor\fR the child process continues.
3434.PP
3435When both processes want to continue using libev, then this is usually the
3436wrong result. In that case, usually one process (typically the parent) is
3437supposed to continue with all watchers in place as before, while the other
3438process typically wants to start fresh, i.e. without any active watchers.
3439.PP
3440The cleanest and most efficient way to achieve that with libev is to
3441simply create a new event loop, which of course will be \*(L"empty\*(R", and
3442use that for new watchers. This has the advantage of not touching more
3443memory than necessary, and thus avoiding the copy-on-write, and the
3444disadvantage of having to use multiple event loops (which do not support
3445signal watchers).
3446.PP
3447When this is not possible, or you want to use the default loop for
3448other reasons, then in the process that wants to start \*(L"fresh\*(R", call
3449\&\f(CW\*(C`ev_loop_destroy (EV_DEFAULT)\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR.
3450Destroying the default loop will \*(L"orphan\*(R" (not stop) all registered
3451watchers, so you have to be careful not to execute code that modifies
3452those watchers. Note also that in that case, you have to re-register any
3453signal watchers.
3454.PP
3455\fIWatcher-Specific Functions and Data Members\fR
3456.IX Subsection "Watcher-Specific Functions and Data Members"
3457.IP "ev_fork_init (ev_fork *, callback)" 4
3458.IX Item "ev_fork_init (ev_fork *, callback)"
3459Initialises and configures the fork watcher \- it has no parameters of any
3460kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
3461really.
3462.ie n .SS """ev_cleanup"" \- even the best things end"
3463.el .SS "\f(CWev_cleanup\fP \- even the best things end"
3464.IX Subsection "ev_cleanup - even the best things end"
3465Cleanup watchers are called just before the event loop is being destroyed
3466by a call to \f(CW\*(C`ev_loop_destroy\*(C'\fR.
3467.PP
3468While there is no guarantee that the event loop gets destroyed, cleanup
3469watchers provide a convenient method to install cleanup hooks for your
3470program, worker threads and so on \- you just to make sure to destroy the
3471loop when you want them to be invoked.
3472.PP
3473Cleanup watchers are invoked in the same way as any other watcher. Unlike
3474all other watchers, they do not keep a reference to the event loop (which
3475makes a lot of sense if you think about it). Like all other watchers, you
3476can call libev functions in the callback, except \f(CW\*(C`ev_cleanup_start\*(C'\fR.
3477.PP
3478\fIWatcher-Specific Functions and Data Members\fR
3479.IX Subsection "Watcher-Specific Functions and Data Members"
3480.IP "ev_cleanup_init (ev_cleanup *, callback)" 4
3481.IX Item "ev_cleanup_init (ev_cleanup *, callback)"
3482Initialises and configures the cleanup watcher \- it has no parameters of
3483any kind. There is a \f(CW\*(C`ev_cleanup_set\*(C'\fR macro, but using it is utterly
3484pointless, I assure you.
3485.PP
3486Example: Register an atexit handler to destroy the default loop, so any
3487cleanup functions are called.
3488.PP
3489.Vb 5
3490\& static void
3491\& program_exits (void)
3492\& {
3493\& ev_loop_destroy (EV_DEFAULT_UC);
3494\& }
3495\&
3496\& ...
3497\& atexit (program_exits);
3498.Ve
3499.ie n .SS """ev_async"" \- how to wake up an event loop"
3500.el .SS "\f(CWev_async\fP \- how to wake up an event loop"
3501.IX Subsection "ev_async - how to wake up an event loop"
3502In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
3503asynchronous sources such as signal handlers (as opposed to multiple event
3504loops \- those are of course safe to use in different threads).
3505.PP
3506Sometimes, however, you need to wake up an event loop you do not control,
3507for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR
3508watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you can signal
3509it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3510.PP
3511This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
3512too, are asynchronous in nature, and signals, too, will be compressed
3513(i.e. the number of callback invocations may be less than the number of
3514\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
3515of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3516signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3517even without knowing which loop owns the signal.
3518.PP
3519\fIQueueing\fR
3520.IX Subsection "Queueing"
3521.PP
3522\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
3523is that the author does not know of a simple (or any) algorithm for a
3524multiple-writer-single-reader queue that works in all cases and doesn't
3525need elaborate support such as pthreads or unportable memory access
3526semantics.
3527.PP
3528That means that if you want to queue data, you have to provide your own
3529queue. But at least I can tell you how to implement locking around your
3530queue:
3531.IP "queueing from a signal handler context" 4
3532.IX Item "queueing from a signal handler context"
3533To implement race-free queueing, you simply add to the queue in the signal
3534handler but you block the signal handler in the watcher callback. Here is
3535an example that does that for some fictitious \s-1SIGUSR1\s0 handler:
3536.Sp
3537.Vb 1
3538\& static ev_async mysig;
3539\&
3540\& static void
3541\& sigusr1_handler (void)
3542\& {
3543\& sometype data;
3544\&
3545\& // no locking etc.
3546\& queue_put (data);
3547\& ev_async_send (EV_DEFAULT_ &mysig);
3548\& }
3549\&
3550\& static void
3551\& mysig_cb (EV_P_ ev_async *w, int revents)
3552\& {
3553\& sometype data;
3554\& sigset_t block, prev;
3555\&
3556\& sigemptyset (&block);
3557\& sigaddset (&block, SIGUSR1);
3558\& sigprocmask (SIG_BLOCK, &block, &prev);
3559\&
3560\& while (queue_get (&data))
3561\& process (data);
3562\&
3563\& if (sigismember (&prev, SIGUSR1)
3564\& sigprocmask (SIG_UNBLOCK, &block, 0);
3565\& }
3566.Ve
3567.Sp
3568(Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR
3569instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it
3570either...).
3571.IP "queueing from a thread context" 4
3572.IX Item "queueing from a thread context"
3573The strategy for threads is different, as you cannot (easily) block
3574threads but you can easily preempt them, so to queue safely you need to
3575employ a traditional mutex lock, such as in this pthread example:
3576.Sp
3577.Vb 2
3578\& static ev_async mysig;
3579\& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
3580\&
3581\& static void
3582\& otherthread (void)
3583\& {
3584\& // only need to lock the actual queueing operation
3585\& pthread_mutex_lock (&mymutex);
3586\& queue_put (data);
3587\& pthread_mutex_unlock (&mymutex);
3588\&
3589\& ev_async_send (EV_DEFAULT_ &mysig);
3590\& }
3591\&
3592\& static void
3593\& mysig_cb (EV_P_ ev_async *w, int revents)
3594\& {
3595\& pthread_mutex_lock (&mymutex);
3596\&
3597\& while (queue_get (&data))
3598\& process (data);
3599\&
3600\& pthread_mutex_unlock (&mymutex);
3601\& }
3602.Ve
3603.PP
3604\fIWatcher-Specific Functions and Data Members\fR
3605.IX Subsection "Watcher-Specific Functions and Data Members"
3606.IP "ev_async_init (ev_async *, callback)" 4
3607.IX Item "ev_async_init (ev_async *, callback)"
3608Initialises and configures the async watcher \- it has no parameters of any
3609kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless,
3610trust me.
3611.IP "ev_async_send (loop, ev_async *)" 4
3612.IX Item "ev_async_send (loop, ev_async *)"
3613Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
3614an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop, and instantly
3615returns.
3616.Sp
3617Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads,
3618signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the
3619embedding section below on what exactly this means).
3620.Sp
3621Note that, as with other watchers in libev, multiple events might get
3622compressed into a single callback invocation (another way to look at
3623this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on
3624\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that).
3625.Sp
3626This call incurs the overhead of at most one extra system call per event
3627loop iteration, if the event loop is blocked, and no syscall at all if
3628the event loop (or your program) is processing events. That means that
3629repeated calls are basically free (there is no need to avoid calls for
3630performance reasons) and that the overhead becomes smaller (typically
3631zero) under load.
3632.IP "bool = ev_async_pending (ev_async *)" 4
3633.IX Item "bool = ev_async_pending (ev_async *)"
3634Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
3635watcher but the event has not yet been processed (or even noted) by the
3636event loop.
3637.Sp
3638\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
3639the loop iterates next and checks for the watcher to have become active,
3640it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
3641quickly check whether invoking the loop might be a good idea.
3642.Sp
3643Not that this does \fInot\fR check whether the watcher itself is pending,
3644only whether it has been requested to make this watcher pending: there
3645is a time window between the event loop checking and resetting the async
3646notification, and the callback being invoked.
1618.SH "OTHER FUNCTIONS" 3647.SH "OTHER FUNCTIONS"
1619.IX Header "OTHER FUNCTIONS" 3648.IX Header "OTHER FUNCTIONS"
1620There are some other functions of possible interest. Described. Here. Now. 3649There are some other functions of possible interest. Described. Here. Now.
1621.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3650.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
1622.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3651.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
1623This function combines a simple timer and an I/O watcher, calls your 3652This function combines a simple timer and an I/O watcher, calls your
1624callback on whichever event happens first and automatically stop both 3653callback on whichever event happens first and automatically stops both
1625watchers. This is useful if you want to wait for a single event on an fd 3654watchers. This is useful if you want to wait for a single event on an fd
1626or timeout without having to allocate/configure/start/stop/free one or 3655or timeout without having to allocate/configure/start/stop/free one or
1627more watchers yourself. 3656more watchers yourself.
1628.Sp 3657.Sp
1629If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events 3658If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and the
1630is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and 3659\&\f(CW\*(C`events\*(C'\fR argument is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for
1631\&\f(CW\*(C`events\*(C'\fR set will be craeted and started. 3660the given \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`events\*(C'\fR set will be created and started.
1632.Sp 3661.Sp
1633If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be 3662If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be
1634started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and 3663started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and
1635repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of 3664repeat = 0) will be started. \f(CW0\fR is a valid timeout.
1636dubious value.
1637.Sp 3665.Sp
1638The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets 3666The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and is
1639passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of 3667passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of
1640\&\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 3668\&\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
1641value passed to \f(CW\*(C`ev_once\*(C'\fR: 3669value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3670a timeout and an io event at the same time \- you probably should give io
3671events precedence.
3672.Sp
3673Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
1642.Sp 3674.Sp
1643.Vb 7 3675.Vb 7
1644\& static void stdin_ready (int revents, void *arg) 3676\& static void stdin_ready (int revents, void *arg)
3677\& {
3678\& if (revents & EV_READ)
3679\& /* stdin might have data for us, joy! */;
3680\& else if (revents & EV_TIMER)
3681\& /* doh, nothing entered */;
3682\& }
3683\&
3684\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3685.Ve
3686.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
3687.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
3688Feed an event on the given fd, as if a file descriptor backend detected
3689the given events.
3690.IP "ev_feed_signal_event (loop, int signum)" 4
3691.IX Item "ev_feed_signal_event (loop, int signum)"
3692Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
3693which is async-safe.
3694.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3695.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3696This section explains some common idioms that are not immediately
3697obvious. Note that examples are sprinkled over the whole manual, and this
3698section only contains stuff that wouldn't fit anywhere else.
3699.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3700.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3701Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3702or modify at any time: libev will completely ignore it. This can be used
3703to associate arbitrary data with your watcher. If you need more data and
3704don't want to allocate memory separately and store a pointer to it in that
3705data member, you can also \*(L"subclass\*(R" the watcher type and provide your own
3706data:
3707.PP
3708.Vb 7
3709\& struct my_io
3710\& {
3711\& ev_io io;
3712\& int otherfd;
3713\& void *somedata;
3714\& struct whatever *mostinteresting;
3715\& };
3716\&
3717\& ...
3718\& struct my_io w;
3719\& ev_io_init (&w.io, my_cb, fd, EV_READ);
3720.Ve
3721.PP
3722And since your callback will be called with a pointer to the watcher, you
3723can cast it back to your own type:
3724.PP
3725.Vb 5
3726\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
3727\& {
3728\& struct my_io *w = (struct my_io *)w_;
3729\& ...
3730\& }
3731.Ve
3732.PP
3733More interesting and less C\-conformant ways of casting your callback
3734function type instead have been omitted.
3735.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3736.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3737Another common scenario is to use some data structure with multiple
3738embedded watchers, in effect creating your own watcher that combines
3739multiple libev event sources into one \*(L"super-watcher\*(R":
3740.PP
3741.Vb 6
3742\& struct my_biggy
3743\& {
3744\& int some_data;
3745\& ev_timer t1;
3746\& ev_timer t2;
3747\& }
3748.Ve
3749.PP
3750In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
3751complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct in
3752the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies or \*(C+ coders), or you need
3753to use some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for
3754real programmers):
3755.PP
3756.Vb 1
3757\& #include <stddef.h>
3758\&
3759\& static void
3760\& t1_cb (EV_P_ ev_timer *w, int revents)
3761\& {
3762\& struct my_biggy big = (struct my_biggy *)
3763\& (((char *)w) \- offsetof (struct my_biggy, t1));
3764\& }
3765\&
3766\& static void
3767\& t2_cb (EV_P_ ev_timer *w, int revents)
3768\& {
3769\& struct my_biggy big = (struct my_biggy *)
3770\& (((char *)w) \- offsetof (struct my_biggy, t2));
3771\& }
3772.Ve
3773.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3774.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3775Often you have structures like this in event-based programs:
3776.PP
3777.Vb 4
3778\& callback ()
1645\& { 3779\& {
1646\& if (revents & EV_TIMEOUT) 3780\& free (request);
1647\& /* doh, nothing entered */;
1648\& else if (revents & EV_READ)
1649\& /* stdin might have data for us, joy! */;
1650\& } 3781\& }
3782\&
3783\& request = start_new_request (..., callback);
1651.Ve 3784.Ve
1652.Sp 3785.PP
3786The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be
3787used to cancel the operation, or do other things with it.
3788.PP
3789It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that
3790immediately invoke the callback, for example, to report errors. Or you add
3791some caching layer that finds that it can skip the lengthy aspects of the
3792operation and simply invoke the callback with the result.
3793.PP
3794The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR
3795has returned, so \f(CW\*(C`request\*(C'\fR is not set.
3796.PP
3797Even if you pass the request by some safer means to the callback, you
3798might want to do something to the request after starting it, such as
3799canceling it, which probably isn't working so well when the callback has
3800already been invoked.
3801.PP
3802A common way around all these issues is to make sure that
3803\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3804\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3805delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3806example, or more sneakily, by reusing an existing (stopped) watcher and
3807pushing it into the pending queue:
3808.PP
1653.Vb 1 3809.Vb 2
1654\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3810\& ev_set_cb (watcher, callback);
3811\& ev_feed_event (EV_A_ watcher, 0);
1655.Ve 3812.Ve
1656.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 3813.PP
1657.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" 3814This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
1658Feeds the given event set into the event loop, as if the specified event 3815invoked, while not delaying callback invocation too much.
1659had happened for the specified watcher (which must be a pointer to an 3816.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
1660initialised but not necessarily started event watcher). 3817.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
1661.IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4 3818Often (especially in \s-1GUI\s0 toolkits) there are places where you have
1662.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" 3819\&\fImodal\fR interaction, which is most easily implemented by recursively
1663Feed an event on the given fd, as if a file descriptor backend detected 3820invoking \f(CW\*(C`ev_run\*(C'\fR.
1664the given events it. 3821.PP
1665.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 3822This brings the problem of exiting \- a callback might want to finish the
1666.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" 3823main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
1667Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default 3824a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
1668loop!). 3825and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3826other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3827.PP
3828The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3829invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3830triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3831.PP
3832.Vb 2
3833\& // main loop
3834\& int exit_main_loop = 0;
3835\&
3836\& while (!exit_main_loop)
3837\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3838\&
3839\& // in a modal watcher
3840\& int exit_nested_loop = 0;
3841\&
3842\& while (!exit_nested_loop)
3843\& ev_run (EV_A_ EVRUN_ONCE);
3844.Ve
3845.PP
3846To exit from any of these loops, just set the corresponding exit variable:
3847.PP
3848.Vb 2
3849\& // exit modal loop
3850\& exit_nested_loop = 1;
3851\&
3852\& // exit main program, after modal loop is finished
3853\& exit_main_loop = 1;
3854\&
3855\& // exit both
3856\& exit_main_loop = exit_nested_loop = 1;
3857.Ve
3858.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3859.IX Subsection "THREAD LOCKING EXAMPLE"
3860Here is a fictitious example of how to run an event loop in a different
3861thread from where callbacks are being invoked and watchers are
3862created/added/removed.
3863.PP
3864For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
3865which uses exactly this technique (which is suited for many high-level
3866languages).
3867.PP
3868The example uses a pthread mutex to protect the loop data, a condition
3869variable to wait for callback invocations, an async watcher to notify the
3870event loop thread and an unspecified mechanism to wake up the main thread.
3871.PP
3872First, you need to associate some data with the event loop:
3873.PP
3874.Vb 6
3875\& typedef struct {
3876\& mutex_t lock; /* global loop lock */
3877\& ev_async async_w;
3878\& thread_t tid;
3879\& cond_t invoke_cv;
3880\& } userdata;
3881\&
3882\& void prepare_loop (EV_P)
3883\& {
3884\& // for simplicity, we use a static userdata struct.
3885\& static userdata u;
3886\&
3887\& ev_async_init (&u\->async_w, async_cb);
3888\& ev_async_start (EV_A_ &u\->async_w);
3889\&
3890\& pthread_mutex_init (&u\->lock, 0);
3891\& pthread_cond_init (&u\->invoke_cv, 0);
3892\&
3893\& // now associate this with the loop
3894\& ev_set_userdata (EV_A_ u);
3895\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3896\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3897\&
3898\& // then create the thread running ev_run
3899\& pthread_create (&u\->tid, 0, l_run, EV_A);
3900\& }
3901.Ve
3902.PP
3903The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3904solely to wake up the event loop so it takes notice of any new watchers
3905that might have been added:
3906.PP
3907.Vb 5
3908\& static void
3909\& async_cb (EV_P_ ev_async *w, int revents)
3910\& {
3911\& // just used for the side effects
3912\& }
3913.Ve
3914.PP
3915The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
3916protecting the loop data, respectively.
3917.PP
3918.Vb 6
3919\& static void
3920\& l_release (EV_P)
3921\& {
3922\& userdata *u = ev_userdata (EV_A);
3923\& pthread_mutex_unlock (&u\->lock);
3924\& }
3925\&
3926\& static void
3927\& l_acquire (EV_P)
3928\& {
3929\& userdata *u = ev_userdata (EV_A);
3930\& pthread_mutex_lock (&u\->lock);
3931\& }
3932.Ve
3933.PP
3934The event loop thread first acquires the mutex, and then jumps straight
3935into \f(CW\*(C`ev_run\*(C'\fR:
3936.PP
3937.Vb 4
3938\& void *
3939\& l_run (void *thr_arg)
3940\& {
3941\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
3942\&
3943\& l_acquire (EV_A);
3944\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
3945\& ev_run (EV_A_ 0);
3946\& l_release (EV_A);
3947\&
3948\& return 0;
3949\& }
3950.Ve
3951.PP
3952Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
3953signal the main thread via some unspecified mechanism (signals? pipe
3954writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
3955have been called (in a while loop because a) spurious wakeups are possible
3956and b) skipping inter-thread-communication when there are no pending
3957watchers is very beneficial):
3958.PP
3959.Vb 4
3960\& static void
3961\& l_invoke (EV_P)
3962\& {
3963\& userdata *u = ev_userdata (EV_A);
3964\&
3965\& while (ev_pending_count (EV_A))
3966\& {
3967\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
3968\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
3969\& }
3970\& }
3971.Ve
3972.PP
3973Now, whenever the main thread gets told to invoke pending watchers, it
3974will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
3975thread to continue:
3976.PP
3977.Vb 4
3978\& static void
3979\& real_invoke_pending (EV_P)
3980\& {
3981\& userdata *u = ev_userdata (EV_A);
3982\&
3983\& pthread_mutex_lock (&u\->lock);
3984\& ev_invoke_pending (EV_A);
3985\& pthread_cond_signal (&u\->invoke_cv);
3986\& pthread_mutex_unlock (&u\->lock);
3987\& }
3988.Ve
3989.PP
3990Whenever you want to start/stop a watcher or do other modifications to an
3991event loop, you will now have to lock:
3992.PP
3993.Vb 2
3994\& ev_timer timeout_watcher;
3995\& userdata *u = ev_userdata (EV_A);
3996\&
3997\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
3998\&
3999\& pthread_mutex_lock (&u\->lock);
4000\& ev_timer_start (EV_A_ &timeout_watcher);
4001\& ev_async_send (EV_A_ &u\->async_w);
4002\& pthread_mutex_unlock (&u\->lock);
4003.Ve
4004.PP
4005Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
4006an event loop currently blocking in the kernel will have no knowledge
4007about the newly added timer. By waking up the loop it will pick up any new
4008watchers in the next event loop iteration.
4009.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
4010.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
4011While the overhead of a callback that e.g. schedules a thread is small, it
4012is still an overhead. If you embed libev, and your main usage is with some
4013kind of threads or coroutines, you might want to customise libev so that
4014doesn't need callbacks anymore.
4015.PP
4016Imagine you have coroutines that you can switch to using a function
4017\&\f(CW\*(C`switch_to (coro)\*(C'\fR, that libev runs in a coroutine called \f(CW\*(C`libev_coro\*(C'\fR
4018and that due to some magic, the currently active coroutine is stored in a
4019global called \f(CW\*(C`current_coro\*(C'\fR. Then you can build your own \*(L"wait for libev
4020event\*(R" primitive by changing \f(CW\*(C`EV_CB_DECLARE\*(C'\fR and \f(CW\*(C`EV_CB_INVOKE\*(C'\fR (note
4021the differing \f(CW\*(C`;\*(C'\fR conventions):
4022.PP
4023.Vb 2
4024\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4025\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4026.Ve
4027.PP
4028That means instead of having a C callback function, you store the
4029coroutine to switch to in each watcher, and instead of having libev call
4030your callback, you instead have it switch to that coroutine.
4031.PP
4032A coroutine might now wait for an event with a function called
4033\&\f(CW\*(C`wait_for_event\*(C'\fR. (the watcher needs to be started, as always, but it doesn't
4034matter when, or whether the watcher is active or not when this function is
4035called):
4036.PP
4037.Vb 6
4038\& void
4039\& wait_for_event (ev_watcher *w)
4040\& {
4041\& ev_set_cb (w, current_coro);
4042\& switch_to (libev_coro);
4043\& }
4044.Ve
4045.PP
4046That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
4047continues the libev coroutine, which, when appropriate, switches back to
4048this or any other coroutine.
4049.PP
4050You can do similar tricks if you have, say, threads with an event queue \-
4051instead of storing a coroutine, you store the queue object and instead of
4052switching to a coroutine, you push the watcher onto the queue and notify
4053any waiters.
4054.PP
4055To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
4056files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
4057.PP
4058.Vb 4
4059\& // my_ev.h
4060\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4061\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4062\& #include "../libev/ev.h"
4063\&
4064\& // my_ev.c
4065\& #define EV_H "my_ev.h"
4066\& #include "../libev/ev.c"
4067.Ve
4068.PP
4069And then use \fImy_ev.h\fR when you would normally use \fIev.h\fR, and compile
4070\&\fImy_ev.c\fR into your project. When properly specifying include paths, you
4071can even use \fIev.h\fR as header file name directly.
1669.SH "LIBEVENT EMULATION" 4072.SH "LIBEVENT EMULATION"
1670.IX Header "LIBEVENT EMULATION" 4073.IX Header "LIBEVENT EMULATION"
1671Libev offers a compatibility emulation layer for libevent. It cannot 4074Libev offers a compatibility emulation layer for libevent. It cannot
1672emulate the internals of libevent, so here are some usage hints: 4075emulate the internals of libevent, so here are some usage hints:
4076.IP "\(bu" 4
4077Only the libevent\-1.4.1\-beta \s-1API\s0 is being emulated.
4078.Sp
4079This was the newest libevent version available when libev was implemented,
4080and is still mostly unchanged in 2010.
4081.IP "\(bu" 4
1673.IP "* Use it by including <event.h>, as usual." 4 4082Use it by including <event.h>, as usual.
1674.IX Item "Use it by including <event.h>, as usual." 4083.IP "\(bu" 4
1675.PD 0 4084The following members are fully supported: ev_base, ev_callback,
1676.IP "* The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4 4085ev_arg, ev_fd, ev_res, ev_events.
1677.IX Item "The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4086.IP "\(bu" 4
1678.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 4087Avoid using ev_flags and the EVLIST_*\-macros, while it is
1679.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)." 4088maintained by libev, it does not work exactly the same way as in libevent (consider
1680.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 4089it a private \s-1API\s0).
1681.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." 4090.IP "\(bu" 4
4091Priorities are not currently supported. Initialising priorities
4092will fail and all watchers will have the same priority, even though there
4093is an ev_pri field.
4094.IP "\(bu" 4
4095In libevent, the last base created gets the signals, in libev, the
4096base that registered the signal gets the signals.
4097.IP "\(bu" 4
1682.IP "* Other members are not supported." 4 4098Other members are not supported.
1683.IX Item "Other members are not supported." 4099.IP "\(bu" 4
1684.IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 4100The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
1685.IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." 4101to use the libev header file and library.
1686.PD
1687.SH "\*(C+ SUPPORT" 4102.SH "\*(C+ SUPPORT"
1688.IX Header " SUPPORT" 4103.IX Header " SUPPORT"
4104.SS "C \s-1API\s0"
4105.IX Subsection "C API"
4106The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4107libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4108will work fine.
4109.PP
4110Proper exception specifications might have to be added to callbacks passed
4111to libev: exceptions may be thrown only from watcher callbacks, all
4112other callbacks (allocator, syserr, loop acquire/release and periodic
4113reschedule callbacks) must not throw exceptions, and might need a \f(CW\*(C`throw
4114()\*(C'\fR specification. If you have code that needs to be compiled as both C
4115and \*(C+ you can use the \f(CW\*(C`EV_THROW\*(C'\fR macro for this:
4116.PP
4117.Vb 6
4118\& static void
4119\& fatal_error (const char *msg) EV_THROW
4120\& {
4121\& perror (msg);
4122\& abort ();
4123\& }
4124\&
4125\& ...
4126\& ev_set_syserr_cb (fatal_error);
4127.Ve
4128.PP
4129The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4130\&\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
4131because it runs cleanup watchers).
4132.PP
4133Throwing exceptions in watcher callbacks is only supported if libev itself
4134is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4135throwing exceptions through C libraries (most do).
4136.SS "\*(C+ \s-1API\s0"
4137.IX Subsection " API"
1689Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4138Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
1690you to use some convinience methods to start/stop watchers and also change 4139you to use some convenience methods to start/stop watchers and also change
1691the callback model to a model using method callbacks on objects. 4140the callback model to a model using method callbacks on objects.
1692.PP 4141.PP
1693To use it, 4142To use it,
1694.PP 4143.PP
1695.Vb 1 4144.Vb 1
1696\& #include <ev++.h> 4145\& #include <ev++.h>
1697.Ve 4146.Ve
1698.PP 4147.PP
1699(it is not installed by default). This automatically includes \fIev.h\fR 4148This automatically includes \fIev.h\fR and puts all of its definitions (many
1700and puts all of its definitions (many of them macros) into the global 4149of them macros) into the global namespace. All \*(C+ specific things are
1701namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. 4150put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
4151options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
1702.PP 4152.PP
1703It should support all the same embedding options as \fIev.h\fR, most notably 4153Care has been taken to keep the overhead low. The only data member the \*(C+
1704\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. 4154classes add (compared to plain C\-style watchers) is the event loop pointer
4155that the watcher is associated with (or no additional members at all if
4156you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
4157.PP
4158Currently, functions, static and non-static member functions and classes
4159with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
4160to add as long as they only need one additional pointer for context. If
4161you need support for other types of functors please contact the author
4162(preferably after implementing it).
4163.PP
4164For all this to work, your \*(C+ compiler either has to use the same calling
4165conventions as your C compiler (for static member functions), or you have
4166to embed libev and compile libev itself as \*(C+.
1705.PP 4167.PP
1706Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4168Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
1707.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 4169.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
1708.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4170.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
1709.IX Item "ev::READ, ev::WRITE etc." 4171.IX Item "ev::READ, ev::WRITE etc."
1710These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. 4172These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc.
1711macros from \fIev.h\fR. 4173macros from \fIev.h\fR.
1712.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 4174.ie n .IP """ev::tstamp"", ""ev::now""" 4
1713.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 4175.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4
1714.IX Item "ev::tstamp, ev::now" 4176.IX Item "ev::tstamp, ev::now"
1715Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. 4177Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix.
1716.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 4178.ie n .IP """ev::io"", ""ev::timer"", ""ev::periodic"", ""ev::idle"", ""ev::sig"" etc." 4
1717.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 4179.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
1718.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 4180.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
1719For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 4181For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
1720the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 4182the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
1721which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 4183which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
1722defines by many implementations. 4184defined by many implementations.
1723.Sp 4185.Sp
1724All of those classes have these methods: 4186All of those classes have these methods:
1725.RS 4 4187.RS 4
1726.IP "ev::TYPE::TYPE (object *, object::method *)" 4 4188.IP "ev::TYPE::TYPE ()" 4
1727.IX Item "ev::TYPE::TYPE (object *, object::method *)" 4189.IX Item "ev::TYPE::TYPE ()"
1728.PD 0 4190.PD 0
1729.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 4191.IP "ev::TYPE::TYPE (loop)" 4
1730.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4192.IX Item "ev::TYPE::TYPE (loop)"
1731.IP "ev::TYPE::~TYPE" 4 4193.IP "ev::TYPE::~TYPE" 4
1732.IX Item "ev::TYPE::~TYPE" 4194.IX Item "ev::TYPE::~TYPE"
1733.PD 4195.PD
1734The constructor takes a pointer to an object and a method pointer to 4196The constructor (optionally) takes an event loop to associate the watcher
1735the event handler callback to call in this class. The constructor calls 4197with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
1736\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method 4198.Sp
1737before starting it. If you do not specify a loop then the constructor 4199The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the
1738automatically associates the default loop with this watcher. 4200\&\f(CW\*(C`set\*(C'\fR method before starting it.
4201.Sp
4202It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR
4203method to set a callback before you can start the watcher.
4204.Sp
4205(The reason why you have to use a method is a limitation in \*(C+ which does
4206not allow explicit template arguments for constructors).
1739.Sp 4207.Sp
1740The destructor automatically stops the watcher if it is active. 4208The destructor automatically stops the watcher if it is active.
4209.IP "w\->set<class, &class::method> (object *)" 4
4210.IX Item "w->set<class, &class::method> (object *)"
4211This method sets the callback method to call. The method has to have a
4212signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as
4213first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as
4214parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher.
4215.Sp
4216This method synthesizes efficient thunking code to call your method from
4217the C callback that libev requires. If your compiler can inline your
4218callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and
4219your compiler is good :), then the method will be fully inlined into the
4220thunking function, making it as fast as a direct C callback.
4221.Sp
4222Example: simple class declaration and watcher initialisation
4223.Sp
4224.Vb 4
4225\& struct myclass
4226\& {
4227\& void io_cb (ev::io &w, int revents) { }
4228\& }
4229\&
4230\& myclass obj;
4231\& ev::io iow;
4232\& iow.set <myclass, &myclass::io_cb> (&obj);
4233.Ve
4234.IP "w\->set (object *)" 4
4235.IX Item "w->set (object *)"
4236This is a variation of a method callback \- leaving out the method to call
4237will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use
4238functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all
4239the time. Incidentally, you can then also leave out the template argument
4240list.
4241.Sp
4242The \f(CW\*(C`operator ()\*(C'\fR method prototype must be \f(CW\*(C`void operator ()(watcher &w,
4243int revents)\*(C'\fR.
4244.Sp
4245See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
4246.Sp
4247Example: use a functor object as callback.
4248.Sp
4249.Vb 7
4250\& struct myfunctor
4251\& {
4252\& void operator() (ev::io &w, int revents)
4253\& {
4254\& ...
4255\& }
4256\& }
4257\&
4258\& myfunctor f;
4259\&
4260\& ev::io w;
4261\& w.set (&f);
4262.Ve
4263.IP "w\->set<function> (void *data = 0)" 4
4264.IX Item "w->set<function> (void *data = 0)"
4265Also sets a callback, but uses a static method or plain function as
4266callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
4267\&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
4268.Sp
4269The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
4270.Sp
4271See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
4272.Sp
4273Example: Use a plain function as callback.
4274.Sp
4275.Vb 2
4276\& static void io_cb (ev::io &w, int revents) { }
4277\& iow.set <io_cb> ();
4278.Ve
1741.IP "w\->set (struct ev_loop *)" 4 4279.IP "w\->set (loop)" 4
1742.IX Item "w->set (struct ev_loop *)" 4280.IX Item "w->set (loop)"
1743Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4281Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
1744do this when the watcher is inactive (and not pending either). 4282do this when the watcher is inactive (and not pending either).
1745.IP "w\->set ([args])" 4 4283.IP "w\->set ([arguments])" 4
1746.IX Item "w->set ([args])" 4284.IX Item "w->set ([arguments])"
1747Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be 4285Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4286with the same arguments. Either this method or a suitable start method
1748called at least once. Unlike the C counterpart, an active watcher gets 4287must be called at least once. Unlike the C counterpart, an active watcher
1749automatically stopped and restarted. 4288gets automatically stopped and restarted when reconfiguring it with this
4289method.
4290.Sp
4291For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4292clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
1750.IP "w\->start ()" 4 4293.IP "w\->start ()" 4
1751.IX Item "w->start ()" 4294.IX Item "w->start ()"
1752Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the 4295Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
1753constructor already takes the loop. 4296constructor already stores the event loop.
4297.IP "w\->start ([arguments])" 4
4298.IX Item "w->start ([arguments])"
4299Instead of calling \f(CW\*(C`set\*(C'\fR and \f(CW\*(C`start\*(C'\fR methods separately, it is often
4300convenient to wrap them in one call. Uses the same type of arguments as
4301the configure \f(CW\*(C`set\*(C'\fR method of the watcher.
1754.IP "w\->stop ()" 4 4302.IP "w\->stop ()" 4
1755.IX Item "w->stop ()" 4303.IX Item "w->stop ()"
1756Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 4304Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
1757.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 4305.ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4
1758.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 4306.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4
1759.IX Item "w->again () ev::timer, ev::periodic only" 4307.IX Item "w->again () (ev::timer, ev::periodic only)"
1760For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding 4308For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding
1761\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. 4309\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
1762.ie n .IP "w\->sweep () ""ev::embed"" only" 4 4310.ie n .IP "w\->sweep () (""ev::embed"" only)" 4
1763.el .IP "w\->sweep () \f(CWev::embed\fR only" 4 4311.el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4
1764.IX Item "w->sweep () ev::embed only" 4312.IX Item "w->sweep () (ev::embed only)"
1765Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. 4313Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR.
4314.ie n .IP "w\->update () (""ev::stat"" only)" 4
4315.el .IP "w\->update () (\f(CWev::stat\fR only)" 4
4316.IX Item "w->update () (ev::stat only)"
4317Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
1766.RE 4318.RE
1767.RS 4 4319.RS 4
1768.RE 4320.RE
1769.PP 4321.PP
1770Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 4322Example: Define a class with two I/O and idle watchers, start the I/O
1771the constructor. 4323watchers in the constructor.
1772.PP 4324.PP
1773.Vb 4 4325.Vb 5
1774\& class myclass 4326\& class myclass
1775\& { 4327\& {
1776\& ev_io io; void io_cb (ev::io &w, int revents); 4328\& ev::io io ; void io_cb (ev::io &w, int revents);
4329\& ev::io io2 ; void io2_cb (ev::io &w, int revents);
1777\& ev_idle idle void idle_cb (ev::idle &w, int revents); 4330\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
4331\&
4332\& myclass (int fd)
4333\& {
4334\& io .set <myclass, &myclass::io_cb > (this);
4335\& io2 .set <myclass, &myclass::io2_cb > (this);
4336\& idle.set <myclass, &myclass::idle_cb> (this);
4337\&
4338\& io.set (fd, ev::WRITE); // configure the watcher
4339\& io.start (); // start it whenever convenient
4340\&
4341\& io2.start (fd, ev::READ); // set + start in one call
4342\& }
4343\& };
1778.Ve 4344.Ve
4345.SH "OTHER LANGUAGE BINDINGS"
4346.IX Header "OTHER LANGUAGE BINDINGS"
4347Libev does not offer other language bindings itself, but bindings for a
4348number of languages exist in the form of third-party packages. If you know
4349any interesting language binding in addition to the ones listed here, drop
4350me a note.
4351.IP "Perl" 4
4352.IX Item "Perl"
4353The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test
4354libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module,
4355there are additional modules that implement libev-compatible interfaces
4356to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
4357\&\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
4358and \f(CW\*(C`EV::Glib\*(C'\fR).
4359.Sp
4360It can be found and installed via \s-1CPAN,\s0 its homepage is at
4361<http://software.schmorp.de/pkg/EV>.
4362.IP "Python" 4
4363.IX Item "Python"
4364Python bindings can be found at <http://code.google.com/p/pyev/>. It
4365seems to be quite complete and well-documented.
4366.IP "Ruby" 4
4367.IX Item "Ruby"
4368Tony Arcieri has written a ruby extension that offers access to a subset
4369of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and
4370more on top of it. It can be found via gem servers. Its homepage is at
4371<http://rev.rubyforge.org/>.
4372.Sp
4373Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
4374makes rev work even on mingw.
4375.IP "Haskell" 4
4376.IX Item "Haskell"
4377A haskell binding to libev is available at
4378<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4379.IP "D" 4
4380.IX Item "D"
4381Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4382be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4383.IP "Ocaml" 4
4384.IX Item "Ocaml"
4385Erkki Seppala has written Ocaml bindings for libev, to be found at
4386<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4387.IP "Lua" 4
4388.IX Item "Lua"
4389Brian Maher has written a partial interface to libev for lua (at the
4390time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4391<http://github.com/brimworks/lua\-ev>.
4392.IP "Javascript" 4
4393.IX Item "Javascript"
4394Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4395.IP "Others" 4
4396.IX Item "Others"
4397There are others, and I stopped counting.
4398.SH "MACRO MAGIC"
4399.IX Header "MACRO MAGIC"
4400Libev can be compiled with a variety of options, the most fundamental
4401of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
4402functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
1779.PP 4403.PP
4404To make it easier to write programs that cope with either variant, the
4405following macros are defined:
4406.ie n .IP """EV_A"", ""EV_A_""" 4
4407.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
4408.IX Item "EV_A, EV_A_"
4409This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
4410loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
4411\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
4412.Sp
4413.Vb 3
4414\& ev_unref (EV_A);
4415\& ev_timer_add (EV_A_ watcher);
4416\& ev_run (EV_A_ 0);
4417.Ve
4418.Sp
4419It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
4420which is often provided by the following macro.
4421.ie n .IP """EV_P"", ""EV_P_""" 4
4422.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
4423.IX Item "EV_P, EV_P_"
4424This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
4425loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
4426\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
4427.Sp
1780.Vb 2 4428.Vb 2
1781\& myclass (); 4429\& // this is how ev_unref is being declared
1782\& } 4430\& static void ev_unref (EV_P);
4431\&
4432\& // this is how you can declare your typical callback
4433\& static void cb (EV_P_ ev_timer *w, int revents)
1783.Ve 4434.Ve
4435.Sp
4436It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
4437suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
4438.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
4439.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
4440.IX Item "EV_DEFAULT, EV_DEFAULT_"
4441Similar to the other two macros, this gives you the value of the default
4442loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop
4443will be initialised if it isn't already initialised.
4444.Sp
4445For non-multiplicity builds, these macros do nothing, so you always have
4446to initialise the loop somewhere.
4447.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
4448.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
4449.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
4450Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
4451default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
4452is undefined when the default loop has not been initialised by a previous
4453execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR.
4454.Sp
4455It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first
4456watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards.
1784.PP 4457.PP
4458Example: Declare and initialise a check watcher, utilising the above
4459macros so it will work regardless of whether multiple loops are supported
4460or not.
4461.PP
1785.Vb 6 4462.Vb 5
1786\& myclass::myclass (int fd) 4463\& static void
1787\& : io (this, &myclass::io_cb), 4464\& check_cb (EV_P_ ev_timer *w, int revents)
1788\& idle (this, &myclass::idle_cb)
1789\& { 4465\& {
1790\& io.start (fd, ev::READ); 4466\& ev_check_stop (EV_A_ w);
1791\& } 4467\& }
4468\&
4469\& ev_check check;
4470\& ev_check_init (&check, check_cb);
4471\& ev_check_start (EV_DEFAULT_ &check);
4472\& ev_run (EV_DEFAULT_ 0);
1792.Ve 4473.Ve
1793.SH "EMBEDDING" 4474.SH "EMBEDDING"
1794.IX Header "EMBEDDING" 4475.IX Header "EMBEDDING"
1795Libev can (and often is) directly embedded into host 4476Libev can (and often is) directly embedded into host
1796applications. Examples of applications that embed it include the Deliantra 4477applications. Examples of applications that embed it include the Deliantra
1797Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) 4478Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe)
1798and rxvt\-unicode. 4479and rxvt-unicode.
1799.PP 4480.PP
1800The goal is to enable you to just copy the neecssary files into your 4481The goal is to enable you to just copy the necessary files into your
1801source directory without having to change even a single line in them, so 4482source directory without having to change even a single line in them, so
1802you can easily upgrade by simply copying (or having a checked-out copy of 4483you can easily upgrade by simply copying (or having a checked-out copy of
1803libev somewhere in your source tree). 4484libev somewhere in your source tree).
1804.Sh "\s-1FILESETS\s0" 4485.SS "\s-1FILESETS\s0"
1805.IX Subsection "FILESETS" 4486.IX Subsection "FILESETS"
1806Depending on what features you need you need to include one or more sets of files 4487Depending on what features you need you need to include one or more sets of files
1807in your app. 4488in your application.
1808.PP 4489.PP
1809\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4490\fI\s-1CORE EVENT LOOP\s0\fR
1810.IX Subsection "CORE EVENT LOOP" 4491.IX Subsection "CORE EVENT LOOP"
1811.PP 4492.PP
1812To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4493To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
1813configuration (no autoconf): 4494configuration (no autoconf):
1814.PP 4495.PP
1815.Vb 2 4496.Vb 2
1816\& #define EV_STANDALONE 1 4497\& #define EV_STANDALONE 1
1817\& #include "ev.c" 4498\& #include "ev.c"
1818.Ve 4499.Ve
1819.PP 4500.PP
1820This will automatically include \fIev.h\fR, too, and should be done in a 4501This will automatically include \fIev.h\fR, too, and should be done in a
1821single C source file only to provide the function implementations. To use 4502single C source file only to provide the function implementations. To use
1822it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best 4503it, do the same for \fIev.h\fR in all files wishing to use this \s-1API \s0(best
1823done by writing a wrapper around \fIev.h\fR that you can include instead and 4504done by writing a wrapper around \fIev.h\fR that you can include instead and
1824where you can put other configuration options): 4505where you can put other configuration options):
1825.PP 4506.PP
1826.Vb 2 4507.Vb 2
1827\& #define EV_STANDALONE 1 4508\& #define EV_STANDALONE 1
1828\& #include "ev.h" 4509\& #include "ev.h"
1829.Ve 4510.Ve
1830.PP 4511.PP
1831Both header files and implementation files can be compiled with a \*(C+ 4512Both header files and implementation files can be compiled with a \*(C+
1832compiler (at least, thats a stated goal, and breakage will be treated 4513compiler (at least, that's a stated goal, and breakage will be treated
1833as a bug). 4514as a bug).
1834.PP 4515.PP
1835You need the following files in your source tree, or in a directory 4516You need the following files in your source tree, or in a directory
1836in your include path (e.g. in libev/ when using \-Ilibev): 4517in your include path (e.g. in libev/ when using \-Ilibev):
1837.PP 4518.PP
1838.Vb 4 4519.Vb 4
1839\& ev.h 4520\& ev.h
1840\& ev.c 4521\& ev.c
1841\& ev_vars.h 4522\& ev_vars.h
1842\& ev_wrap.h 4523\& ev_wrap.h
1843.Ve 4524\&
1844.PP
1845.Vb 1
1846\& ev_win32.c required on win32 platforms only 4525\& ev_win32.c required on win32 platforms only
1847.Ve 4526\&
1848.PP
1849.Vb 5
1850\& ev_select.c only when select backend is enabled (which is by default) 4527\& ev_select.c only when select backend is enabled
1851\& ev_poll.c only when poll backend is enabled (disabled by default) 4528\& ev_poll.c only when poll backend is enabled
1852\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4529\& ev_epoll.c only when the epoll backend is enabled
1853\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4530\& ev_kqueue.c only when the kqueue backend is enabled
1854\& ev_port.c only when the solaris port backend is enabled (disabled by default) 4531\& ev_port.c only when the solaris port backend is enabled
1855.Ve 4532.Ve
1856.PP 4533.PP
1857\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4534\&\fIev.c\fR includes the backend files directly when enabled, so you only need
1858to compile this single file. 4535to compile this single file.
1859.PP 4536.PP
1860\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4537\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
1861.IX Subsection "LIBEVENT COMPATIBILITY API" 4538.IX Subsection "LIBEVENT COMPATIBILITY API"
1862.PP 4539.PP
1863To include the libevent compatibility \s-1API\s0, also include: 4540To include the libevent compatibility \s-1API,\s0 also include:
1864.PP 4541.PP
1865.Vb 1 4542.Vb 1
1866\& #include "event.c" 4543\& #include "event.c"
1867.Ve 4544.Ve
1868.PP 4545.PP
1869in the file including \fIev.c\fR, and: 4546in the file including \fIev.c\fR, and:
1870.PP 4547.PP
1871.Vb 1 4548.Vb 1
1872\& #include "event.h" 4549\& #include "event.h"
1873.Ve 4550.Ve
1874.PP 4551.PP
1875in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4552in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
1876.PP 4553.PP
1877You need the following additional files for this: 4554You need the following additional files for this:
1878.PP 4555.PP
1879.Vb 2 4556.Vb 2
1880\& event.h 4557\& event.h
1881\& event.c 4558\& event.c
1882.Ve 4559.Ve
1883.PP 4560.PP
1884\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4561\fI\s-1AUTOCONF SUPPORT\s0\fR
1885.IX Subsection "AUTOCONF SUPPORT" 4562.IX Subsection "AUTOCONF SUPPORT"
1886.PP 4563.PP
1887Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in 4564Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
1888whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4565whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
1889\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4566\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
1890include \fIconfig.h\fR and configure itself accordingly. 4567include \fIconfig.h\fR and configure itself accordingly.
1891.PP 4568.PP
1892For this of course you need the m4 file: 4569For this of course you need the m4 file:
1893.PP 4570.PP
1894.Vb 1 4571.Vb 1
1895\& libev.m4 4572\& libev.m4
1896.Ve 4573.Ve
1897.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4574.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
1898.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4575.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
1899Libev can be configured via a variety of preprocessor symbols you have to define 4576Libev can be configured via a variety of preprocessor symbols you have to
1900before including any of its files. The default is not to build for multiplicity 4577define before including (or compiling) any of its files. The default in
1901and only include the select backend. 4578the absence of autoconf is documented for every option.
4579.PP
4580Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4581values when compiling libev vs. including \fIev.h\fR, so it is permissible
4582to redefine them before including \fIev.h\fR without breaking compatibility
4583to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4584users of libev and the libev code itself must be compiled with compatible
4585settings.
4586.IP "\s-1EV_COMPAT3 \s0(h)" 4
4587.IX Item "EV_COMPAT3 (h)"
4588Backwards compatibility is a major concern for libev. This is why this
4589release of libev comes with wrappers for the functions and symbols that
4590have been renamed between libev version 3 and 4.
4591.Sp
4592You can disable these wrappers (to test compatibility with future
4593versions) by defining \f(CW\*(C`EV_COMPAT3\*(C'\fR to \f(CW0\fR when compiling your
4594sources. This has the additional advantage that you can drop the \f(CW\*(C`struct\*(C'\fR
4595from \f(CW\*(C`struct ev_loop\*(C'\fR declarations, as libev will provide an \f(CW\*(C`ev_loop\*(C'\fR
4596typedef in that case.
4597.Sp
4598In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR,
4599and in some even more future version the compatibility code will be
4600removed completely.
1902.IP "\s-1EV_STANDALONE\s0" 4 4601.IP "\s-1EV_STANDALONE \s0(h)" 4
1903.IX Item "EV_STANDALONE" 4602.IX Item "EV_STANDALONE (h)"
1904Must always be \f(CW1\fR if you do not use autoconf configuration, which 4603Must always be \f(CW1\fR if you do not use autoconf configuration, which
1905keeps libev from including \fIconfig.h\fR, and it also defines dummy 4604keeps libev from including \fIconfig.h\fR, and it also defines dummy
1906implementations for some libevent functions (such as logging, which is not 4605implementations for some libevent functions (such as logging, which is not
1907supported). It will also not define any of the structs usually found in 4606supported). It will also not define any of the structs usually found in
1908\&\fIevent.h\fR that are not directly supported by the libev core alone. 4607\&\fIevent.h\fR that are not directly supported by the libev core alone.
4608.Sp
4609In standalone mode, libev will still try to automatically deduce the
4610configuration, but has to be more conservative.
4611.IP "\s-1EV_USE_FLOOR\s0" 4
4612.IX Item "EV_USE_FLOOR"
4613If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its
4614periodic reschedule calculations, otherwise libev will fall back on a
4615portable (slower) implementation. If you enable this, you usually have to
4616link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR
4617function is not available will fail, so the safe default is to not enable
4618this.
1909.IP "\s-1EV_USE_MONOTONIC\s0" 4 4619.IP "\s-1EV_USE_MONOTONIC\s0" 4
1910.IX Item "EV_USE_MONOTONIC" 4620.IX Item "EV_USE_MONOTONIC"
1911If defined to be \f(CW1\fR, libev will try to detect the availability of the 4621If defined to be \f(CW1\fR, libev will try to detect the availability of the
1912monotonic clock option at both compiletime and runtime. Otherwise no use 4622monotonic clock option at both compile time and runtime. Otherwise no
1913of the monotonic clock option will be attempted. If you enable this, you 4623use of the monotonic clock option will be attempted. If you enable this,
1914usually have to link against librt or something similar. Enabling it when 4624you usually have to link against librt or something similar. Enabling it
1915the functionality isn't available is safe, though, althoguh you have 4625when the functionality isn't available is safe, though, although you have
1916to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR 4626to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
1917function is hiding in (often \fI\-lrt\fR). 4627function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
1918.IP "\s-1EV_USE_REALTIME\s0" 4 4628.IP "\s-1EV_USE_REALTIME\s0" 4
1919.IX Item "EV_USE_REALTIME" 4629.IX Item "EV_USE_REALTIME"
1920If defined to be \f(CW1\fR, libev will try to detect the availability of the 4630If defined to be \f(CW1\fR, libev will try to detect the availability of the
1921realtime clock option at compiletime (and assume its availability at 4631real-time clock option at compile time (and assume its availability
1922runtime if successful). Otherwise no use of the realtime clock option will 4632at runtime if successful). Otherwise no use of the real-time clock
1923be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get 4633option will be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR
1924(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries 4634by \f(CW\*(C`clock_get (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect
1925in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. 4635correctness. See the note about libraries in the description of
4636\&\f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. Defaults to the opposite value of
4637\&\f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
4638.IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4
4639.IX Item "EV_USE_CLOCK_SYSCALL"
4640If defined to be \f(CW1\fR, libev will try to use a direct syscall instead
4641of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option
4642exists 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
4643unconditionally pulls in \f(CW\*(C`libpthread\*(C'\fR, slowing down single-threaded
4644programs needlessly. Using a direct syscall is slightly slower (in
4645theory), because no optimised vdso implementation can be used, but avoids
4646the pthread dependency. Defaults to \f(CW1\fR on GNU/Linux with glibc 2.x or
4647higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR).
4648.IP "\s-1EV_USE_NANOSLEEP\s0" 4
4649.IX Item "EV_USE_NANOSLEEP"
4650If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
4651and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
4652.IP "\s-1EV_USE_EVENTFD\s0" 4
4653.IX Item "EV_USE_EVENTFD"
4654If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4655available and will probe for kernel support at runtime. This will improve
4656\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4657If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46582.7 or newer, otherwise disabled.
1926.IP "\s-1EV_USE_SELECT\s0" 4 4659.IP "\s-1EV_USE_SELECT\s0" 4
1927.IX Item "EV_USE_SELECT" 4660.IX Item "EV_USE_SELECT"
1928If undefined or defined to be \f(CW1\fR, libev will compile in support for the 4661If undefined or defined to be \f(CW1\fR, libev will compile in support for the
1929\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no 4662\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no
1930other method takes over, select will be it. Otherwise the select backend 4663other method takes over, select will be it. Otherwise the select backend
1931will not be compiled in. 4664will not be compiled in.
1932.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 4665.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
1933.IX Item "EV_SELECT_USE_FD_SET" 4666.IX Item "EV_SELECT_USE_FD_SET"
1934If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR 4667If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
1935structure. This is useful if libev doesn't compile due to a missing 4668structure. This is useful if libev doesn't compile due to a missing
1936\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on 4669\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout
1937exotic systems. This usually limits the range of file descriptors to some 4670on exotic systems. This usually limits the range of file descriptors to
1938low limit such as 1024 or might have other limitations (winsocket only 4671some low limit such as 1024 or might have other limitations (winsocket
1939allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might 4672only allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation,
1940influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. 4673configures the maximum size of the \f(CW\*(C`fd_set\*(C'\fR.
1941.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 4674.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
1942.IX Item "EV_SELECT_IS_WINSOCKET" 4675.IX Item "EV_SELECT_IS_WINSOCKET"
1943When defined to \f(CW1\fR, the select backend will assume that 4676When defined to \f(CW1\fR, the select backend will assume that
1944select/socket/connect etc. don't understand file descriptors but 4677select/socket/connect etc. don't understand file descriptors but
1945wants osf handles on win32 (this is the case when the select to 4678wants osf handles on win32 (this is the case when the select to
1946be used is the winsock select). This means that it will call 4679be used is the winsock select). This means that it will call
1947\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, 4680\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
1948it is assumed that all these functions actually work on fds, even 4681it is assumed that all these functions actually work on fds, even
1949on win32. Should not be defined on non\-win32 platforms. 4682on win32. Should not be defined on non\-win32 platforms.
4683.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0(fd)" 4
4684.IX Item "EV_FD_TO_WIN32_HANDLE(fd)"
4685If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map
4686file descriptors to socket handles. When not defining this symbol (the
4687default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually
4688correct. In some cases, programs use their own file descriptor management,
4689in which case they can provide this function to map fds to socket handles.
4690.IP "\s-1EV_WIN32_HANDLE_TO_FD\s0(handle)" 4
4691.IX Item "EV_WIN32_HANDLE_TO_FD(handle)"
4692If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR then libev maps handles to file descriptors
4693using the standard \f(CW\*(C`_open_osfhandle\*(C'\fR function. For programs implementing
4694their own fd to handle mapping, overwriting this function makes it easier
4695to do so. This can be done by defining this macro to an appropriate value.
4696.IP "\s-1EV_WIN32_CLOSE_FD\s0(fd)" 4
4697.IX Item "EV_WIN32_CLOSE_FD(fd)"
4698If programs implement their own fd to handle mapping on win32, then this
4699macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4700file descriptors again. Note that the replacement function has to close
4701the underlying \s-1OS\s0 handle.
4702.IP "\s-1EV_USE_WSASOCKET\s0" 4
4703.IX Item "EV_USE_WSASOCKET"
4704If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4705communication socket, which works better in some environments. Otherwise,
4706the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4707environments.
1950.IP "\s-1EV_USE_POLL\s0" 4 4708.IP "\s-1EV_USE_POLL\s0" 4
1951.IX Item "EV_USE_POLL" 4709.IX Item "EV_USE_POLL"
1952If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4710If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
1953backend. Otherwise it will be enabled on non\-win32 platforms. It 4711backend. Otherwise it will be enabled on non\-win32 platforms. It
1954takes precedence over select. 4712takes precedence over select.
1955.IP "\s-1EV_USE_EPOLL\s0" 4 4713.IP "\s-1EV_USE_EPOLL\s0" 4
1956.IX Item "EV_USE_EPOLL" 4714.IX Item "EV_USE_EPOLL"
1957If defined to be \f(CW1\fR, libev will compile in support for the Linux 4715If defined to be \f(CW1\fR, libev will compile in support for the Linux
1958\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 4716\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
1959otherwise another method will be used as fallback. This is the 4717otherwise another method will be used as fallback. This is the preferred
1960preferred backend for GNU/Linux systems. 4718backend for GNU/Linux systems. If undefined, it will be enabled if the
4719headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
1961.IP "\s-1EV_USE_KQUEUE\s0" 4 4720.IP "\s-1EV_USE_KQUEUE\s0" 4
1962.IX Item "EV_USE_KQUEUE" 4721.IX Item "EV_USE_KQUEUE"
1963If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4722If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
1964\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 4723\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
1965otherwise another method will be used as fallback. This is the preferred 4724otherwise another method will be used as fallback. This is the preferred
… …
197510 port style backend. Its availability will be detected at runtime, 473410 port style backend. Its availability will be detected at runtime,
1976otherwise another method will be used as fallback. This is the preferred 4735otherwise another method will be used as fallback. This is the preferred
1977backend for Solaris 10 systems. 4736backend for Solaris 10 systems.
1978.IP "\s-1EV_USE_DEVPOLL\s0" 4 4737.IP "\s-1EV_USE_DEVPOLL\s0" 4
1979.IX Item "EV_USE_DEVPOLL" 4738.IX Item "EV_USE_DEVPOLL"
1980reserved for future expansion, works like the \s-1USE\s0 symbols above. 4739Reserved for future expansion, works like the \s-1USE\s0 symbols above.
4740.IP "\s-1EV_USE_INOTIFY\s0" 4
4741.IX Item "EV_USE_INOTIFY"
4742If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
4743interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
4744be detected at runtime. If undefined, it will be enabled if the headers
4745indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4746.IP "\s-1EV_NO_SMP\s0" 4
4747.IX Item "EV_NO_SMP"
4748If defined to be \f(CW1\fR, libev will assume that memory is always coherent
4749between threads, that is, threads can be used, but threads never run on
4750different cpus (or different cpu cores). This reduces dependencies
4751and makes libev faster.
4752.IP "\s-1EV_NO_THREADS\s0" 4
4753.IX Item "EV_NO_THREADS"
4754If defined to be \f(CW1\fR, libev will assume that it will never be called from
4755different threads (that includes signal handlers), which is a stronger
4756assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4757libev faster.
4758.IP "\s-1EV_ATOMIC_T\s0" 4
4759.IX Item "EV_ATOMIC_T"
4760Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4761access is atomic with respect to other threads or signal contexts. No
4762such type is easily found in the C language, so you can provide your own
4763type that you know is safe for your purposes. It is used both for signal
4764handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4765watchers.
4766.Sp
4767In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4768(from \fIsignal.h\fR), which is usually good enough on most platforms.
1981.IP "\s-1EV_H\s0" 4 4769.IP "\s-1EV_H \s0(h)" 4
1982.IX Item "EV_H" 4770.IX Item "EV_H (h)"
1983The name of the \fIev.h\fR header file used to include it. The default if 4771The name of the \fIev.h\fR header file used to include it. The default if
1984undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 4772undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
1985can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 4773used to virtually rename the \fIev.h\fR header file in case of conflicts.
1986.IP "\s-1EV_CONFIG_H\s0" 4 4774.IP "\s-1EV_CONFIG_H \s0(h)" 4
1987.IX Item "EV_CONFIG_H" 4775.IX Item "EV_CONFIG_H (h)"
1988If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 4776If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
1989\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 4777\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
1990\&\f(CW\*(C`EV_H\*(C'\fR, above. 4778\&\f(CW\*(C`EV_H\*(C'\fR, above.
1991.IP "\s-1EV_EVENT_H\s0" 4 4779.IP "\s-1EV_EVENT_H \s0(h)" 4
1992.IX Item "EV_EVENT_H" 4780.IX Item "EV_EVENT_H (h)"
1993Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 4781Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
1994of how the \fIevent.h\fR header can be found. 4782of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
1995.IP "\s-1EV_PROTOTYPES\s0" 4 4783.IP "\s-1EV_PROTOTYPES \s0(h)" 4
1996.IX Item "EV_PROTOTYPES" 4784.IX Item "EV_PROTOTYPES (h)"
1997If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 4785If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
1998prototypes, but still define all the structs and other symbols. This is 4786prototypes, but still define all the structs and other symbols. This is
1999occasionally useful if you want to provide your own wrapper functions 4787occasionally useful if you want to provide your own wrapper functions
2000around libev functions. 4788around libev functions.
2001.IP "\s-1EV_MULTIPLICITY\s0" 4 4789.IP "\s-1EV_MULTIPLICITY\s0" 4
… …
2003If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 4791If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
2004will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 4792will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
2005additional independent event loops. Otherwise there will be no support 4793additional independent event loops. Otherwise there will be no support
2006for multiple event loops and there is no first event loop pointer 4794for multiple event loops and there is no first event loop pointer
2007argument. Instead, all functions act on the single default loop. 4795argument. Instead, all functions act on the single default loop.
2008.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 4796.Sp
2009.IX Item "EV_PERIODIC_ENABLE" 4797Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a
2010If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 4798default loop when multiplicity is switched off \- you always have to
2011defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 4799initialise the loop manually in this case.
2012code.
2013.IP "\s-1EV_EMBED_ENABLE\s0" 4
2014.IX Item "EV_EMBED_ENABLE"
2015If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
2016defined to be \f(CW0\fR, then they are not.
2017.IP "\s-1EV_STAT_ENABLE\s0" 4
2018.IX Item "EV_STAT_ENABLE"
2019If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
2020defined to be \f(CW0\fR, then they are not.
2021.IP "\s-1EV_MINIMAL\s0" 4 4800.IP "\s-1EV_MINPRI\s0" 4
2022.IX Item "EV_MINIMAL" 4801.IX Item "EV_MINPRI"
4802.PD 0
4803.IP "\s-1EV_MAXPRI\s0" 4
4804.IX Item "EV_MAXPRI"
4805.PD
4806The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to
4807\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can
4808provide for more priorities by overriding those symbols (usually defined
4809to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively).
4810.Sp
4811When doing priority-based operations, libev usually has to linearly search
4812all the priorities, so having many of them (hundreds) uses a lot of space
4813and time, so using the defaults of five priorities (\-2 .. +2) is usually
4814fine.
4815.Sp
4816If your embedding application does not need any priorities, defining these
4817both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4818.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
4819.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."
4820If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4821the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4822is not. Disabling watcher types mainly saves code size.
4823.IP "\s-1EV_FEATURES\s0" 4
4824.IX Item "EV_FEATURES"
2023If you need to shave off some kilobytes of code at the expense of some 4825If you need to shave off some kilobytes of code at the expense of some
2024speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override 4826speed (but with the full \s-1API\s0), you can define this symbol to request
2025some inlining decisions, saves roughly 30% codesize of amd64. 4827certain subsets of functionality. The default is to enable all features
4828that can be enabled on the platform.
4829.Sp
4830A typical way to use this symbol is to define it to \f(CW0\fR (or to a bitset
4831with some broad features you want) and then selectively re-enable
4832additional parts you want, for example if you want everything minimal,
4833but multiple event loop support, async and child watchers and the poll
4834backend, use this:
4835.Sp
4836.Vb 5
4837\& #define EV_FEATURES 0
4838\& #define EV_MULTIPLICITY 1
4839\& #define EV_USE_POLL 1
4840\& #define EV_CHILD_ENABLE 1
4841\& #define EV_ASYNC_ENABLE 1
4842.Ve
4843.Sp
4844The actual value is a bitset, it can be a combination of the following
4845values (by default, all of these are enabled):
4846.RS 4
4847.ie n .IP "1 \- faster/larger code" 4
4848.el .IP "\f(CW1\fR \- faster/larger code" 4
4849.IX Item "1 - faster/larger code"
4850Use larger code to speed up some operations.
4851.Sp
4852Currently this is used to override some inlining decisions (enlarging the
4853code size by roughly 30% on amd64).
4854.Sp
4855When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4856gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4857assertions.
4858.Sp
4859The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4860(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4861.ie n .IP "2 \- faster/larger data structures" 4
4862.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4863.IX Item "2 - faster/larger data structures"
4864Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4865hash table sizes and so on. This will usually further increase code size
4866and can additionally have an effect on the size of data structures at
4867runtime.
4868.Sp
4869The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4870(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4871.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4872.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4873.IX Item "4 - full API configuration"
4874This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4875enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4876.ie n .IP "8 \- full \s-1API\s0" 4
4877.el .IP "\f(CW8\fR \- full \s-1API\s0" 4
4878.IX Item "8 - full API"
4879This enables a lot of the \*(L"lesser used\*(R" \s-1API\s0 functions. See \f(CW\*(C`ev.h\*(C'\fR for
4880details on which parts of the \s-1API\s0 are still available without this
4881feature, and do not complain if this subset changes over time.
4882.ie n .IP "16 \- enable all optional watcher types" 4
4883.el .IP "\f(CW16\fR \- enable all optional watcher types" 4
4884.IX Item "16 - enable all optional watcher types"
4885Enables all optional watcher types. If you want to selectively enable
4886only some watcher types other than I/O and timers (e.g. prepare,
4887embed, async, child...) you can enable them manually by defining
4888\&\f(CW\*(C`EV_watchertype_ENABLE\*(C'\fR to \f(CW1\fR instead.
4889.ie n .IP "32 \- enable all backends" 4
4890.el .IP "\f(CW32\fR \- enable all backends" 4
4891.IX Item "32 - enable all backends"
4892This enables all backends \- without this feature, you need to enable at
4893least one backend manually (\f(CW\*(C`EV_USE_SELECT\*(C'\fR is a good choice).
4894.ie n .IP "64 \- enable OS-specific ""helper"" APIs" 4
4895.el .IP "\f(CW64\fR \- enable OS-specific ``helper'' APIs" 4
4896.IX Item "64 - enable OS-specific helper APIs"
4897Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
4898default.
4899.RE
4900.RS 4
4901.Sp
4902Compiling with \f(CW\*(C`gcc \-Os \-DEV_STANDALONE \-DEV_USE_EPOLL=1 \-DEV_FEATURES=0\*(C'\fR
4903reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
4904code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
4905watchers, timers and monotonic clock support.
4906.Sp
4907With an intelligent-enough linker (gcc+binutils are intelligent enough
4908when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by
4909your program might be left out as well \- a binary starting a timer and an
4910I/O watcher then might come out at only 5Kb.
4911.RE
4912.IP "\s-1EV_API_STATIC\s0" 4
4913.IX Item "EV_API_STATIC"
4914If this symbol is defined (by default it is not), then all identifiers
4915will have static linkage. This means that libev will not export any
4916identifiers, and you cannot link against libev anymore. This can be useful
4917when you embed libev, only want to use libev functions in a single file,
4918and do not want its identifiers to be visible.
4919.Sp
4920To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that
4921wants to use libev.
4922.Sp
4923This option only works when libev is compiled with a C compiler, as \*(C+
4924doesn't support the required declaration syntax.
4925.IP "\s-1EV_AVOID_STDIO\s0" 4
4926.IX Item "EV_AVOID_STDIO"
4927If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio
4928functions (printf, scanf, perror etc.). This will increase the code size
4929somewhat, but if your program doesn't otherwise depend on stdio and your
4930libc allows it, this avoids linking in the stdio library which is quite
4931big.
4932.Sp
4933Note that error messages might become less precise when this option is
4934enabled.
4935.IP "\s-1EV_NSIG\s0" 4
4936.IX Item "EV_NSIG"
4937The highest supported signal number, +1 (or, the number of
4938signals): Normally, libev tries to deduce the maximum number of signals
4939automatically, but sometimes this fails, in which case it can be
4940specified. Also, using a lower number than detected (\f(CW32\fR should be
4941good for about any system in existence) can save some memory, as libev
4942statically allocates some 12\-24 bytes per signal number.
4943.IP "\s-1EV_PID_HASHSIZE\s0" 4
4944.IX Item "EV_PID_HASHSIZE"
4945\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
4946pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR disabled),
4947usually more than enough. If you need to manage thousands of children you
4948might want to increase this value (\fImust\fR be a power of two).
4949.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
4950.IX Item "EV_INOTIFY_HASHSIZE"
4951\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
4952inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR
4953disabled), usually more than enough. If you need to manage thousands of
4954\&\f(CW\*(C`ev_stat\*(C'\fR watchers you might want to increase this value (\fImust\fR be a
4955power of two).
4956.IP "\s-1EV_USE_4HEAP\s0" 4
4957.IX Item "EV_USE_4HEAP"
4958Heaps are not very cache-efficient. To improve the cache-efficiency of the
4959timer and periodics heaps, libev uses a 4\-heap when this symbol is defined
4960to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably
4961faster performance with many (thousands) of watchers.
4962.Sp
4963The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4964will be \f(CW0\fR.
4965.IP "\s-1EV_HEAP_CACHE_AT\s0" 4
4966.IX Item "EV_HEAP_CACHE_AT"
4967Heaps are not very cache-efficient. To improve the cache-efficiency of the
4968timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within
4969the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR),
4970which uses 8\-12 bytes more per watcher and a few hundred bytes more code,
4971but avoids random read accesses on heap changes. This improves performance
4972noticeably with many (hundreds) of watchers.
4973.Sp
4974The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4975will be \f(CW0\fR.
4976.IP "\s-1EV_VERIFY\s0" 4
4977.IX Item "EV_VERIFY"
4978Controls how much internal verification (see \f(CW\*(C`ev_verify ()\*(C'\fR) will
4979be done: If set to \f(CW0\fR, no internal verification code will be compiled
4980in. If set to \f(CW1\fR, then verification code will be compiled in, but not
4981called. If set to \f(CW2\fR, then the internal verification code will be
4982called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
4983verification code will be called very frequently, which will slow down
4984libev considerably.
4985.Sp
4986The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4987will be \f(CW0\fR.
2026.IP "\s-1EV_COMMON\s0" 4 4988.IP "\s-1EV_COMMON\s0" 4
2027.IX Item "EV_COMMON" 4989.IX Item "EV_COMMON"
2028By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 4990By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
2029this macro to a something else you can include more and other types of 4991this macro to something else you can include more and other types of
2030members. You have to define it each time you include one of the files, 4992members. You have to define it each time you include one of the files,
2031though, and it must be identical each time. 4993though, and it must be identical each time.
2032.Sp 4994.Sp
2033For example, the perl \s-1EV\s0 module uses something like this: 4995For example, the perl \s-1EV\s0 module uses something like this:
2034.Sp 4996.Sp
2035.Vb 3 4997.Vb 3
2036\& #define EV_COMMON \e 4998\& #define EV_COMMON \e
2037\& SV *self; /* contains this struct */ \e 4999\& SV *self; /* contains this struct */ \e
2038\& SV *cb_sv, *fh /* note no trailing ";" */ 5000\& SV *cb_sv, *fh /* note no trailing ";" */
2039.Ve 5001.Ve
2040.IP "\s-1EV_CB_DECLARE\s0 (type)" 4 5002.IP "\s-1EV_CB_DECLARE \s0(type)" 4
2041.IX Item "EV_CB_DECLARE (type)" 5003.IX Item "EV_CB_DECLARE (type)"
2042.PD 0 5004.PD 0
2043.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 5005.IP "\s-1EV_CB_INVOKE \s0(watcher, revents)" 4
2044.IX Item "EV_CB_INVOKE (watcher, revents)" 5006.IX Item "EV_CB_INVOKE (watcher, revents)"
2045.IP "ev_set_cb (ev, cb)" 4 5007.IP "ev_set_cb (ev, cb)" 4
2046.IX Item "ev_set_cb (ev, cb)" 5008.IX Item "ev_set_cb (ev, cb)"
2047.PD 5009.PD
2048Can be used to change the callback member declaration in each watcher, 5010Can be used to change the callback member declaration in each watcher,
2049and the way callbacks are invoked and set. Must expand to a struct member 5011and the way callbacks are invoked and set. Must expand to a struct member
2050definition and a statement, respectively. See the \fIev.v\fR header file for 5012definition and a statement, respectively. See the \fIev.h\fR header file for
2051their default definitions. One possible use for overriding these is to 5013their default definitions. One possible use for overriding these is to
2052avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5014avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
2053method calls instead of plain function calls in \*(C+. 5015method calls instead of plain function calls in \*(C+.
5016.SS "\s-1EXPORTED API SYMBOLS\s0"
5017.IX Subsection "EXPORTED API SYMBOLS"
5018If you need to re-export the \s-1API \s0(e.g. via a \s-1DLL\s0) and you need a list of
5019exported symbols, you can use the provided \fISymbol.*\fR files which list
5020all public symbols, one per line:
5021.PP
5022.Vb 2
5023\& Symbols.ev for libev proper
5024\& Symbols.event for the libevent emulation
5025.Ve
5026.PP
5027This can also be used to rename all public symbols to avoid clashes with
5028multiple versions of libev linked together (which is obviously bad in
5029itself, but sometimes it is inconvenient to avoid this).
5030.PP
5031A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to
5032include before including \fIev.h\fR:
5033.PP
5034.Vb 1
5035\& <Symbols.ev sed \-e "s/.*/#define & myprefix_&/" >wrap.h
5036.Ve
5037.PP
5038This would create a file \fIwrap.h\fR which essentially looks like this:
5039.PP
5040.Vb 4
5041\& #define ev_backend myprefix_ev_backend
5042\& #define ev_check_start myprefix_ev_check_start
5043\& #define ev_check_stop myprefix_ev_check_stop
5044\& ...
5045.Ve
2054.Sh "\s-1EXAMPLES\s0" 5046.SS "\s-1EXAMPLES\s0"
2055.IX Subsection "EXAMPLES" 5047.IX Subsection "EXAMPLES"
2056For a real-world example of a program the includes libev 5048For a real-world example of a program the includes libev
2057verbatim, you can have a look at the \s-1EV\s0 perl module 5049verbatim, you can have a look at the \s-1EV\s0 perl module
2058(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in 5050(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
2059the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public 5051the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
2060interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file 5052interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
2061will be compiled. It is pretty complex because it provides its own header 5053will be compiled. It is pretty complex because it provides its own header
2062file. 5054file.
2063.Sp 5055.PP
2064The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 5056The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
2065that everybody includes and which overrides some autoconf choices: 5057that everybody includes and which overrides some configure choices:
2066.Sp 5058.PP
2067.Vb 4 5059.Vb 8
5060\& #define EV_FEATURES 8
5061\& #define EV_USE_SELECT 1
5062\& #define EV_PREPARE_ENABLE 1
5063\& #define EV_IDLE_ENABLE 1
5064\& #define EV_SIGNAL_ENABLE 1
5065\& #define EV_CHILD_ENABLE 1
2068\& #define EV_USE_POLL 0 5066\& #define EV_USE_STDEXCEPT 0
2069\& #define EV_MULTIPLICITY 0
2070\& #define EV_PERIODICS 0
2071\& #define EV_CONFIG_H <config.h> 5067\& #define EV_CONFIG_H <config.h>
2072.Ve 5068\&
2073.Sp
2074.Vb 1
2075\& #include "ev++.h" 5069\& #include "ev++.h"
2076.Ve 5070.Ve
2077.Sp 5071.PP
2078And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 5072And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
2079.Sp 5073.PP
2080.Vb 2 5074.Vb 2
2081\& #include "ev_cpp.h" 5075\& #include "ev_cpp.h"
2082\& #include "ev.c" 5076\& #include "ev.c"
2083.Ve 5077.Ve
5078.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
5079.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
5080.SS "\s-1THREADS AND COROUTINES\s0"
5081.IX Subsection "THREADS AND COROUTINES"
5082\fI\s-1THREADS\s0\fR
5083.IX Subsection "THREADS"
5084.PP
5085All libev functions are reentrant and thread-safe unless explicitly
5086documented otherwise, but libev implements no locking itself. This means
5087that you can use as many loops as you want in parallel, as long as there
5088are no concurrent calls into any libev function with the same loop
5089parameter (\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter,
5090of course): libev guarantees that different event loops share no data
5091structures that need any locking.
5092.PP
5093Or to put it differently: calls with different loop parameters can be done
5094concurrently from multiple threads, calls with the same loop parameter
5095must be done serially (but can be done from different threads, as long as
5096only one thread ever is inside a call at any point in time, e.g. by using
5097a mutex per loop).
5098.PP
5099Specifically to support threads (and signal handlers), libev implements
5100so-called \f(CW\*(C`ev_async\*(C'\fR watchers, which allow some limited form of
5101concurrency on the same event loop, namely waking it up \*(L"from the
5102outside\*(R".
5103.PP
5104If you want to know which design (one loop, locking, or multiple loops
5105without or something else still) is best for your problem, then I cannot
5106help you, but here is some generic advice:
5107.IP "\(bu" 4
5108most applications have a main thread: use the default libev loop
5109in that thread, or create a separate thread running only the default loop.
5110.Sp
5111This helps integrating other libraries or software modules that use libev
5112themselves and don't care/know about threading.
5113.IP "\(bu" 4
5114one loop per thread is usually a good model.
5115.Sp
5116Doing this is almost never wrong, sometimes a better-performance model
5117exists, but it is always a good start.
5118.IP "\(bu" 4
5119other models exist, such as the leader/follower pattern, where one
5120loop is handed through multiple threads in a kind of round-robin fashion.
5121.Sp
5122Choosing a model is hard \- look around, learn, know that usually you can do
5123better than you currently do :\-)
5124.IP "\(bu" 4
5125often you need to talk to some other thread which blocks in the
5126event loop.
5127.Sp
5128\&\f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other threads safely
5129(or from signal contexts...).
5130.Sp
5131An example use would be to communicate signals or other events that only
5132work in the default loop by registering the signal watcher with the
5133default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
5134watcher callback into the event loop interested in the signal.
5135.PP
5136See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
5137.PP
5138\fI\s-1COROUTINES\s0\fR
5139.IX Subsection "COROUTINES"
5140.PP
5141Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
5142libev fully supports nesting calls to its functions from different
5143coroutines (e.g. you can call \f(CW\*(C`ev_run\*(C'\fR on the same loop from two
5144different coroutines, and switch freely between both coroutines running
5145the loop, as long as you don't confuse yourself). The only exception is
5146that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
5147.PP
5148Care has been taken to ensure that libev does not keep local state inside
5149\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
5150they do not call any callbacks.
5151.SS "\s-1COMPILER WARNINGS\s0"
5152.IX Subsection "COMPILER WARNINGS"
5153Depending on your compiler and compiler settings, you might get no or a
5154lot of warnings when compiling libev code. Some people are apparently
5155scared by this.
5156.PP
5157However, these are unavoidable for many reasons. For one, each compiler
5158has different warnings, and each user has different tastes regarding
5159warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when
5160targeting a specific compiler and compiler-version.
5161.PP
5162Another reason is that some compiler warnings require elaborate
5163workarounds, or other changes to the code that make it less clear and less
5164maintainable.
5165.PP
5166And of course, some compiler warnings are just plain stupid, or simply
5167wrong (because they don't actually warn about the condition their message
5168seems to warn about). For example, certain older gcc versions had some
5169warnings that resulted in an extreme number of false positives. These have
5170been fixed, but some people still insist on making code warn-free with
5171such buggy versions.
5172.PP
5173While libev is written to generate as few warnings as possible,
5174\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
5175with any compiler warnings enabled unless you are prepared to cope with
5176them (e.g. by ignoring them). Remember that warnings are just that:
5177warnings, not errors, or proof of bugs.
5178.SS "\s-1VALGRIND\s0"
5179.IX Subsection "VALGRIND"
5180Valgrind has a special section here because it is a popular tool that is
5181highly useful. Unfortunately, valgrind reports are very hard to interpret.
5182.PP
5183If you think you found a bug (memory leak, uninitialised data access etc.)
5184in libev, then check twice: If valgrind reports something like:
5185.PP
5186.Vb 3
5187\& ==2274== definitely lost: 0 bytes in 0 blocks.
5188\& ==2274== possibly lost: 0 bytes in 0 blocks.
5189\& ==2274== still reachable: 256 bytes in 1 blocks.
5190.Ve
5191.PP
5192Then there is no memory leak, just as memory accounted to global variables
5193is not a memleak \- the memory is still being referenced, and didn't leak.
5194.PP
5195Similarly, under some circumstances, valgrind might report kernel bugs
5196as if it were a bug in libev (e.g. in realloc or in the poll backend,
5197although an acceptable workaround has been found here), or it might be
5198confused.
5199.PP
5200Keep in mind that valgrind is a very good tool, but only a tool. Don't
5201make it into some kind of religion.
5202.PP
5203If you are unsure about something, feel free to contact the mailing list
5204with the full valgrind report and an explanation on why you think this
5205is a bug in libev (best check the archives, too :). However, don't be
5206annoyed when you get a brisk \*(L"this is no bug\*(R" answer and take the chance
5207of learning how to interpret valgrind properly.
5208.PP
5209If you need, for some reason, empty reports from valgrind for your project
5210I suggest using suppression lists.
5211.SH "PORTABILITY NOTES"
5212.IX Header "PORTABILITY NOTES"
5213.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
5214.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
5215GNU/Linux is the only common platform that supports 64 bit file/large file
5216interfaces but \fIdisables\fR them by default.
5217.PP
5218That means that libev compiled in the default environment doesn't support
5219files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
5220.PP
5221Unfortunately, many programs try to work around this GNU/Linux issue
5222by enabling the large file \s-1API,\s0 which makes them incompatible with the
5223standard libev compiled for their system.
5224.PP
5225Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
5226suddenly make it incompatible to the default compile time environment,
5227i.e. all programs not using special compile switches.
5228.SS "\s-1OS/X AND DARWIN BUGS\s0"
5229.IX Subsection "OS/X AND DARWIN BUGS"
5230The whole thing is a bug if you ask me \- basically any system interface
5231you touch is broken, whether it is locales, poll, kqueue or even the
5232OpenGL drivers.
5233.PP
5234\fI\f(CI\*(C`kqueue\*(C'\fI is buggy\fR
5235.IX Subsection "kqueue is buggy"
5236.PP
5237The kqueue syscall is broken in all known versions \- most versions support
5238only sockets, many support pipes.
5239.PP
5240Libev tries to work around this by not using \f(CW\*(C`kqueue\*(C'\fR by default on this
5241rotten platform, but of course you can still ask for it when creating a
5242loop \- embedding a socket-only kqueue loop into a select-based one is
5243probably going to work well.
5244.PP
5245\fI\f(CI\*(C`poll\*(C'\fI is buggy\fR
5246.IX Subsection "poll is buggy"
5247.PP
5248Instead of fixing \f(CW\*(C`kqueue\*(C'\fR, Apple replaced their (working) \f(CW\*(C`poll\*(C'\fR
5249implementation by something calling \f(CW\*(C`kqueue\*(C'\fR internally around the 10.5.6
5250release, so now \f(CW\*(C`kqueue\*(C'\fR \fIand\fR \f(CW\*(C`poll\*(C'\fR are broken.
5251.PP
5252Libev tries to work around this by not using \f(CW\*(C`poll\*(C'\fR by default on
5253this rotten platform, but of course you can still ask for it when creating
5254a loop.
5255.PP
5256\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
5257.IX Subsection "select is buggy"
5258.PP
5259All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
5260one up as well: On \s-1OS/X, \s0\f(CW\*(C`select\*(C'\fR actively limits the number of file
5261descriptors you can pass in to 1024 \- your program suddenly crashes when
5262you use more.
5263.PP
5264There is an undocumented \*(L"workaround\*(R" for this \- defining
5265\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
5266work on \s-1OS/X.\s0
5267.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
5268.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
5269\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
5270.IX Subsection "errno reentrancy"
5271.PP
5272The default compile environment on Solaris is unfortunately so
5273thread-unsafe that you can't even use components/libraries compiled
5274without \f(CW\*(C`\-D_REENTRANT\*(C'\fR in a threaded program, which, of course, isn't
5275defined by default. A valid, if stupid, implementation choice.
5276.PP
5277If you want to use libev in threaded environments you have to make sure
5278it's compiled with \f(CW\*(C`_REENTRANT\*(C'\fR defined.
5279.PP
5280\fIEvent port backend\fR
5281.IX Subsection "Event port backend"
5282.PP
5283The scalable event interface for Solaris is called \*(L"event
5284ports\*(R". Unfortunately, this mechanism is very buggy in all major
5285releases. If you run into high \s-1CPU\s0 usage, your program freezes or you get
5286a large number of spurious wakeups, make sure you have all the relevant
5287and latest kernel patches applied. No, I don't know which ones, but there
5288are multiple ones to apply, and afterwards, event ports actually work
5289great.
5290.PP
5291If you can't get it to work, you can try running the program by setting
5292the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
5293\&\f(CW\*(C`select\*(C'\fR backends.
5294.SS "\s-1AIX POLL BUG\s0"
5295.IX Subsection "AIX POLL BUG"
5296\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
5297this by trying to avoid the poll backend altogether (i.e. it's not even
5298compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
5299with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
5300.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
5301.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
5302\fIGeneral issues\fR
5303.IX Subsection "General issues"
5304.PP
5305Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
5306requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
5307model. Libev still offers limited functionality on this platform in
5308the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
5309descriptors. This only applies when using Win32 natively, not when using
5310e.g. cygwin. Actually, it only applies to the microsofts own compilers,
5311as every compiler comes with a slightly differently broken/incompatible
5312environment.
5313.PP
5314Lifting these limitations would basically require the full
5315re-implementation of the I/O system. If you are into this kind of thing,
5316then note that glib does exactly that for you in a very portable way (note
5317also that glib is the slowest event library known to man).
5318.PP
5319There is no supported compilation method available on windows except
5320embedding it into other applications.
5321.PP
5322Sensible signal handling is officially unsupported by Microsoft \- libev
5323tries its best, but under most conditions, signals will simply not work.
5324.PP
5325Not a libev limitation but worth mentioning: windows apparently doesn't
5326accept large writes: instead of resulting in a partial write, windows will
5327either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large,
5328so make sure you only write small amounts into your sockets (less than a
5329megabyte seems safe, but this apparently depends on the amount of memory
5330available).
5331.PP
5332Due to the many, low, and arbitrary limits on the win32 platform and
5333the abysmal performance of winsockets, using a large number of sockets
5334is not recommended (and not reasonable). If your program needs to use
5335more than a hundred or so sockets, then likely it needs to use a totally
5336different implementation for windows, as libev offers the \s-1POSIX\s0 readiness
5337notification model, which cannot be implemented efficiently on windows
5338(due to Microsoft monopoly games).
5339.PP
5340A typical way to use libev under windows is to embed it (see the embedding
5341section for details) and use the following \fIevwrap.h\fR header file instead
5342of \fIev.h\fR:
5343.PP
5344.Vb 2
5345\& #define EV_STANDALONE /* keeps ev from requiring config.h */
5346\& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
5347\&
5348\& #include "ev.h"
5349.Ve
5350.PP
5351And compile the following \fIevwrap.c\fR file into your project (make sure
5352you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!):
5353.PP
5354.Vb 2
5355\& #include "evwrap.h"
5356\& #include "ev.c"
5357.Ve
5358.PP
5359\fIThe winsocket \f(CI\*(C`select\*(C'\fI function\fR
5360.IX Subsection "The winsocket select function"
5361.PP
5362The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
5363requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
5364also extremely buggy). This makes select very inefficient, and also
5365requires a mapping from file descriptors to socket handles (the Microsoft
5366C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
5367discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
5368\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
5369.PP
5370The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime
5371libraries and raw winsocket select is:
5372.PP
5373.Vb 2
5374\& #define EV_USE_SELECT 1
5375\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5376.Ve
5377.PP
5378Note that winsockets handling of fd sets is O(n), so you can easily get a
5379complexity in the O(nX) range when using win32.
5380.PP
5381\fILimited number of file descriptors\fR
5382.IX Subsection "Limited number of file descriptors"
5383.PP
5384Windows has numerous arbitrary (and low) limits on things.
5385.PP
5386Early versions of winsocket's select only supported waiting for a maximum
5387of \f(CW64\fR handles (probably owning to the fact that all windows kernels
5388can only wait for \f(CW64\fR things at the same time internally; Microsoft
5389recommends spawning a chain of threads and wait for 63 handles and the
5390previous thread in each. Sounds great!).
5391.PP
5392Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
5393to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
5394call (which might be in libev or elsewhere, for example, perl and many
5395other interpreters do their own select emulation on windows).
5396.PP
5397Another limit is the number of file descriptors in the Microsoft runtime
5398libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR
5399fetish or something like this inside Microsoft). You can increase this
5400by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
5401(another arbitrary limit), but is broken in many versions of the Microsoft
5402runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
5403(depending on windows version and/or the phase of the moon). To get more,
5404you need to wrap all I/O functions and provide your own fd management, but
5405the cost of calling select (O(nX)) will likely make this unworkable.
5406.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5407.IX Subsection "PORTABILITY REQUIREMENTS"
5408In addition to a working ISO-C implementation and of course the
5409backend-specific APIs, libev relies on a few additional extensions:
5410.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
5411.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
5412.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
5413Libev assumes not only that all watcher pointers have the same internal
5414structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5415assumes that the same (machine) code can be used to call any watcher
5416callback: The watcher callbacks have different type signatures, but libev
5417calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5418.IP "null pointers and integer zero are represented by 0 bytes" 4
5419.IX Item "null pointers and integer zero are represented by 0 bytes"
5420Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5421relies on this setting pointers and integers to null.
5422.IP "pointer accesses must be thread-atomic" 4
5423.IX Item "pointer accesses must be thread-atomic"
5424Accessing a pointer value must be atomic, it must both be readable and
5425writable in one piece \- this is the case on all current architectures.
5426.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
5427.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
5428.IX Item "sig_atomic_t volatile must be thread-atomic as well"
5429The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
5430\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different
5431threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is
5432believed to be sufficiently portable.
5433.ie n .IP """sigprocmask"" must work in a threaded environment" 4
5434.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4
5435.IX Item "sigprocmask must work in a threaded environment"
5436Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not
5437allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical
5438pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main
5439thread\*(R" or will block signals process-wide, both behaviours would
5440be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5441\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5442.Sp
5443The most portable way to handle signals is to block signals in all threads
5444except the initial one, and run the signal handling loop in the initial
5445thread as well.
5446.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
5447.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
5448.IX Item "long must be large enough for common memory allocation sizes"
5449To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
5450instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
5451systems (Microsoft...) this might be unexpectedly low, but is still at
5452least 31 bits everywhere, which is enough for hundreds of millions of
5453watchers.
5454.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
5455.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
5456.IX Item "double must hold a time value in seconds with enough accuracy"
5457The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
5458have at least 51 bits of mantissa (and 9 bits of exponent), which is
5459good enough for at least into the year 4000 with millisecond accuracy
5460(the design goal for libev). This requirement is overfulfilled by
5461implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5462.Sp
5463With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5464year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5465is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5466something like that, just kidding).
5467.PP
5468If you know of other additional requirements drop me a note.
2084.SH "COMPLEXITIES" 5469.SH "ALGORITHMIC COMPLEXITIES"
2085.IX Header "COMPLEXITIES" 5470.IX Header "ALGORITHMIC COMPLEXITIES"
2086In this section the complexities of (many of) the algorithms used inside 5471In this section the complexities of (many of) the algorithms used inside
2087libev will be explained. For complexity discussions about backends see the 5472libev will be documented. For complexity discussions about backends see
2088documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 5473the documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2089.RS 4 5474.PP
5475All of the following are about amortised time: If an array needs to be
5476extended, libev needs to realloc and move the whole array, but this
5477happens asymptotically rarer with higher number of elements, so O(1) might
5478mean that libev does a lengthy realloc operation in rare cases, but on
5479average it is much faster and asymptotically approaches constant time.
2090.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 5480.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2091.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 5481.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
5482This means that, when you have a watcher that triggers in one hour and
5483there are 100 watchers that would trigger before that, then inserting will
5484have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
5485.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
5486.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
5487That means that changing a timer costs less than removing/adding them,
5488as only the relative motion in the event queue has to be paid for.
5489.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4
5490.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)"
5491These just add the watcher into an array or at the head of a list.
5492.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4
5493.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)"
2092.PD 0 5494.PD 0
2093.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4
2094.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2095.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2096.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2097.IP "Stopping check/prepare/idle watchers: O(1)" 4
2098.IX Item "Stopping check/prepare/idle watchers: O(1)"
2099.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 5495.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2100.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 5496.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
5497.PD
5498These watchers are stored in lists, so they need to be walked to find the
5499correct watcher to remove. The lists are usually short (you don't usually
5500have many watchers waiting for the same fd or signal: one is typical, two
5501is rare).
2101.IP "Finding the next timer per loop iteration: O(1)" 4 5502.IP "Finding the next timer in each loop iteration: O(1)" 4
2102.IX Item "Finding the next timer per loop iteration: O(1)" 5503.IX Item "Finding the next timer in each loop iteration: O(1)"
5504By virtue of using a binary or 4\-heap, the next timer is always found at a
5505fixed position in the storage array.
2103.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 5506.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2104.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 5507.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2105.IP "Activating one watcher: O(1)" 4 5508A change means an I/O watcher gets started or stopped, which requires
2106.IX Item "Activating one watcher: O(1)" 5509libev to recalculate its status (and possibly tell the kernel, depending
2107.RE 5510on backend and whether \f(CW\*(C`ev_io_set\*(C'\fR was used).
2108.RS 4 5511.IP "Activating one watcher (putting it into the pending state): O(1)" 4
5512.IX Item "Activating one watcher (putting it into the pending state): O(1)"
5513.PD 0
5514.IP "Priority handling: O(number_of_priorities)" 4
5515.IX Item "Priority handling: O(number_of_priorities)"
2109.PD 5516.PD
5517Priorities are implemented by allocating some space for each
5518priority. When doing priority-based operations, libev usually has to
5519linearly search all the priorities, but starting/stopping and activating
5520watchers becomes O(1) with respect to priority handling.
5521.IP "Sending an ev_async: O(1)" 4
5522.IX Item "Sending an ev_async: O(1)"
5523.PD 0
5524.IP "Processing ev_async_send: O(number_of_async_watchers)" 4
5525.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
5526.IP "Processing signals: O(max_signal_number)" 4
5527.IX Item "Processing signals: O(max_signal_number)"
5528.PD
5529Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
5530calls in the current loop iteration and the loop is currently
5531blocked. Checking for async and signal events involves iterating over all
5532running async watchers or all signal numbers.
5533.SH "PORTING FROM LIBEV 3.X TO 4.X"
5534.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5535The major version 4 introduced some incompatible changes to the \s-1API.\s0
5536.PP
5537At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5538for all changes, so most programs should still compile. The compatibility
5539layer might be removed in later versions of libev, so better update to the
5540new \s-1API\s0 early than late.
5541.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5542.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5543.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5544The backward compatibility mechanism can be controlled by
5545\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5546section.
5547.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5548.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5549.IX Item "ev_default_destroy and ev_default_fork have been removed"
5550These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5551.Sp
5552.Vb 2
5553\& ev_loop_destroy (EV_DEFAULT_UC);
5554\& ev_loop_fork (EV_DEFAULT);
5555.Ve
5556.IP "function/symbol renames" 4
5557.IX Item "function/symbol renames"
5558A number of functions and symbols have been renamed:
5559.Sp
5560.Vb 3
5561\& ev_loop => ev_run
5562\& EVLOOP_NONBLOCK => EVRUN_NOWAIT
5563\& EVLOOP_ONESHOT => EVRUN_ONCE
5564\&
5565\& ev_unloop => ev_break
5566\& EVUNLOOP_CANCEL => EVBREAK_CANCEL
5567\& EVUNLOOP_ONE => EVBREAK_ONE
5568\& EVUNLOOP_ALL => EVBREAK_ALL
5569\&
5570\& EV_TIMEOUT => EV_TIMER
5571\&
5572\& ev_loop_count => ev_iteration
5573\& ev_loop_depth => ev_depth
5574\& ev_loop_verify => ev_verify
5575.Ve
5576.Sp
5577Most functions working on \f(CW\*(C`struct ev_loop\*(C'\fR objects don't have an
5578\&\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
5579associated constants have been renamed to not collide with the \f(CW\*(C`struct
5580ev_loop\*(C'\fR anymore and \f(CW\*(C`EV_TIMER\*(C'\fR now follows the same naming scheme
5581as all other watcher types. Note that \f(CW\*(C`ev_loop_fork\*(C'\fR is still called
5582\&\f(CW\*(C`ev_loop_fork\*(C'\fR because it would otherwise clash with the \f(CW\*(C`ev_fork\*(C'\fR
5583typedef.
5584.ie n .IP """EV_MINIMAL"" mechanism replaced by ""EV_FEATURES""" 4
5585.el .IP "\f(CWEV_MINIMAL\fR mechanism replaced by \f(CWEV_FEATURES\fR" 4
5586.IX Item "EV_MINIMAL mechanism replaced by EV_FEATURES"
5587The preprocessor symbol \f(CW\*(C`EV_MINIMAL\*(C'\fR has been replaced by a different
5588mechanism, \f(CW\*(C`EV_FEATURES\*(C'\fR. Programs using \f(CW\*(C`EV_MINIMAL\*(C'\fR usually compile
5589and work, but the library code will of course be larger.
5590.SH "GLOSSARY"
5591.IX Header "GLOSSARY"
5592.IP "active" 4
5593.IX Item "active"
5594A watcher is active as long as it has been started and not yet stopped.
5595See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5596.IP "application" 4
5597.IX Item "application"
5598In this document, an application is whatever is using libev.
5599.IP "backend" 4
5600.IX Item "backend"
5601The part of the code dealing with the operating system interfaces.
5602.IP "callback" 4
5603.IX Item "callback"
5604The address of a function that is called when some event has been
5605detected. Callbacks are being passed the event loop, the watcher that
5606received the event, and the actual event bitset.
5607.IP "callback/watcher invocation" 4
5608.IX Item "callback/watcher invocation"
5609The act of calling the callback associated with a watcher.
5610.IP "event" 4
5611.IX Item "event"
5612A change of state of some external event, such as data now being available
5613for reading on a file descriptor, time having passed or simply not having
5614any other events happening anymore.
5615.Sp
5616In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or
5617\&\f(CW\*(C`EV_TIMER\*(C'\fR).
5618.IP "event library" 4
5619.IX Item "event library"
5620A software package implementing an event model and loop.
5621.IP "event loop" 4
5622.IX Item "event loop"
5623An entity that handles and processes external events and converts them
5624into callback invocations.
5625.IP "event model" 4
5626.IX Item "event model"
5627The model used to describe how an event loop handles and processes
5628watchers and events.
5629.IP "pending" 4
5630.IX Item "pending"
5631A watcher is pending as soon as the corresponding event has been
5632detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5633.IP "real time" 4
5634.IX Item "real time"
5635The physical time that is observed. It is apparently strictly monotonic :)
5636.IP "wall-clock time" 4
5637.IX Item "wall-clock time"
5638The time and date as shown on clocks. Unlike real time, it can actually
5639be wrong and jump forwards and backwards, e.g. when you adjust your
5640clock.
5641.IP "watcher" 4
5642.IX Item "watcher"
5643A data structure that describes interest in certain events. Watchers need
5644to be started (attached to an event loop) before they can receive events.
2110.SH "AUTHOR" 5645.SH "AUTHOR"
2111.IX Header "AUTHOR" 5646.IX Header "AUTHOR"
2112Marc Lehmann <libev@schmorp.de>. 5647Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5648Magnusson and Emanuele Giaquinta, and minor corrections by many others.

Diff Legend

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