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

Comparing libev/ev.3 (file contents):
Revision 1.76 by root, Wed Jan 7 20:45:52 2009 UTC vs.
Revision 1.85 by root, Tue Jan 11 13:45:28 2011 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
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
51.\" Escape single quotes in literal strings from groff's Unicode transform. 43.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq 44.ie \n(.g .ds Aq \(aq
53.el .ds Aq ' 45.el .ds Aq '
54.\" 46.\"
55.\" If the F register is turned on, we'll generate index entries on stderr for 47.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the 49.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 51.ie \nF \{\
60. de IX 52. de IX
61. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
130.\} 122.\}
131.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
132.\" ======================================================================== 124.\" ========================================================================
133.\" 125.\"
134.IX Title "LIBEV 3" 126.IX Title "LIBEV 3"
135.TH LIBEV 3 "2008-12-14" "libev-3.52" "libev - high performance full featured event loop" 127.TH LIBEV 3 "2011-01-11" "libev-4.03" "libev - high performance full featured event loop"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
138.if n .ad l 130.if n .ad l
139.nh 131.nh
140.SH "NAME" 132.SH "NAME"
142.SH "SYNOPSIS" 134.SH "SYNOPSIS"
143.IX Header "SYNOPSIS" 135.IX Header "SYNOPSIS"
144.Vb 1 136.Vb 1
145\& #include <ev.h> 137\& #include <ev.h>
146.Ve 138.Ve
147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 139.SS "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
148.IX Subsection "EXAMPLE PROGRAM" 140.IX Subsection "EXAMPLE PROGRAM"
149.Vb 2 141.Vb 2
150\& // a single header file is required 142\& // a single header file is required
151\& #include <ev.h> 143\& #include <ev.h>
152\& 144\&
165\& puts ("stdin ready"); 157\& puts ("stdin ready");
166\& // for one\-shot events, one must manually stop the watcher 158\& // for one\-shot events, one must manually stop the watcher
167\& // with its corresponding stop function. 159\& // with its corresponding stop function.
168\& ev_io_stop (EV_A_ w); 160\& ev_io_stop (EV_A_ w);
169\& 161\&
170\& // this causes all nested ev_loop\*(Aqs to stop iterating 162\& // this causes all nested ev_run\*(Aqs to stop iterating
171\& ev_unloop (EV_A_ EVUNLOOP_ALL); 163\& ev_break (EV_A_ EVBREAK_ALL);
172\& } 164\& }
173\& 165\&
174\& // another callback, this time for a time\-out 166\& // another callback, this time for a time\-out
175\& static void 167\& static void
176\& timeout_cb (EV_P_ ev_timer *w, int revents) 168\& timeout_cb (EV_P_ ev_timer *w, int revents)
177\& { 169\& {
178\& puts ("timeout"); 170\& puts ("timeout");
179\& // this causes the innermost ev_loop to stop iterating 171\& // this causes the innermost ev_run to stop iterating
180\& ev_unloop (EV_A_ EVUNLOOP_ONE); 172\& ev_break (EV_A_ EVBREAK_ONE);
181\& } 173\& }
182\& 174\&
183\& int 175\& int
184\& main (void) 176\& main (void)
185\& { 177\& {
186\& // use the default event loop unless you have special needs 178\& // use the default event loop unless you have special needs
187\& struct ev_loop *loop = ev_default_loop (0); 179\& struct ev_loop *loop = EV_DEFAULT;
188\& 180\&
189\& // initialise an io watcher, then start it 181\& // initialise an io watcher, then start it
190\& // this one will watch for stdin to become readable 182\& // this one will watch for stdin to become readable
191\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 183\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
192\& ev_io_start (loop, &stdin_watcher); 184\& ev_io_start (loop, &stdin_watcher);
195\& // simple non\-repeating 5.5 second timeout 187\& // simple non\-repeating 5.5 second timeout
196\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 188\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
197\& ev_timer_start (loop, &timeout_watcher); 189\& ev_timer_start (loop, &timeout_watcher);
198\& 190\&
199\& // now wait for events to arrive 191\& // now wait for events to arrive
200\& ev_loop (loop, 0); 192\& ev_run (loop, 0);
201\& 193\&
202\& // unloop was called, so exit 194\& // unloop was called, so exit
203\& return 0; 195\& return 0;
204\& } 196\& }
205.Ve 197.Ve
206.SH "DESCRIPTION" 198.SH "ABOUT THIS DOCUMENT"
207.IX Header "DESCRIPTION" 199.IX Header "ABOUT THIS DOCUMENT"
200This document documents the libev software package.
201.PP
208The newest version of this document is also available as an html-formatted 202The newest version of this document is also available as an html-formatted
209web page you might find easier to navigate when reading it for the first 203web page you might find easier to navigate when reading it for the first
210time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. 204time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
211.PP 205.PP
206While this document tries to be as complete as possible in documenting
207libev, its usage and the rationale behind its design, it is not a tutorial
208on event-based programming, nor will it introduce event-based programming
209with libev.
210.PP
211Familiarity with event based programming techniques in general is assumed
212throughout this document.
213.SH "WHAT TO READ WHEN IN A HURRY"
214.IX Header "WHAT TO READ WHEN IN A HURRY"
215This manual tries to be very detailed, but unfortunately, this also makes
216it very long. If you just want to know the basics of libev, I suggest
217reading \*(L"\s-1ANATOMY\s0 \s-1OF\s0 A \s-1WATCHER\s0\*(R", then the \*(L"\s-1EXAMPLE\s0 \s-1PROGRAM\s0\*(R" above and
218look up the missing functions in \*(L"\s-1GLOBAL\s0 \s-1FUNCTIONS\s0\*(R" and the \f(CW\*(C`ev_io\*(C'\fR and
219\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER\s0 \s-1TYPES\s0\*(R".
220.SH "ABOUT LIBEV"
221.IX Header "ABOUT LIBEV"
212Libev is an event loop: you register interest in certain events (such as a 222Libev is an event loop: you register interest in certain events (such as a
213file descriptor being readable or a timeout occurring), and it will manage 223file descriptor being readable or a timeout occurring), and it will manage
214these event sources and provide your program with events. 224these event sources and provide your program with events.
215.PP 225.PP
216To do this, it must take more or less complete control over your process 226To do this, it must take more or less complete control over your process
219.PP 229.PP
220You register interest in certain events by registering so-called \fIevent 230You register interest in certain events by registering so-called \fIevent
221watchers\fR, which are relatively small C structures you initialise with the 231watchers\fR, which are relatively small C structures you initialise with the
222details of the event, and then hand it over to libev by \fIstarting\fR the 232details of the event, and then hand it over to libev by \fIstarting\fR the
223watcher. 233watcher.
224.Sh "\s-1FEATURES\s0" 234.SS "\s-1FEATURES\s0"
225.IX Subsection "FEATURES" 235.IX Subsection "FEATURES"
226Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 236Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
227BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 237BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
228for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 238for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
229(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers 239(for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner
230with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals 240inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative
231(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event 241timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling
232watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, 242(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status
233\&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as 243change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event
234file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events 244loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and
235(\f(CW\*(C`ev_fork\*(C'\fR). 245\&\f(CW\*(C`ev_check\*(C'\fR watchers) as well as file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even
246limited support for fork events (\f(CW\*(C`ev_fork\*(C'\fR).
236.PP 247.PP
237It also is quite fast (see this 248It also is quite fast (see this
238benchmark comparing it to libevent 249<benchmark> comparing it to libevent
239for example). 250for example).
240.Sh "\s-1CONVENTIONS\s0" 251.SS "\s-1CONVENTIONS\s0"
241.IX Subsection "CONVENTIONS" 252.IX Subsection "CONVENTIONS"
242Libev is very configurable. In this manual the default (and most common) 253Libev is very configurable. In this manual the default (and most common)
243configuration will be described, which supports multiple event loops. For 254configuration will be described, which supports multiple event loops. For
244more info about various configuration options please have a look at 255more info about various configuration options please have a look at
245\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support 256\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
246for multiple event loops, then all functions taking an initial argument of 257for multiple event loops, then all functions taking an initial argument of
247name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`ev_loop *\*(C'\fR) will not have 258name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
248this argument. 259this argument.
249.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0" 260.SS "\s-1TIME\s0 \s-1REPRESENTATION\s0"
250.IX Subsection "TIME REPRESENTATION" 261.IX Subsection "TIME REPRESENTATION"
251Libev represents time as a single floating point number, representing the 262Libev represents time as a single floating point number, representing
252(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 263the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice
253the beginning of 1970, details are complicated, don't ask). This type is 264somewhere near the beginning of 1970, details are complicated, don't
254called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases 265ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use
255to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on 266too. It usually aliases to the \f(CW\*(C`double\*(C'\fR type in C. When you need to do
256it, you should treat it as some floating point value. Unlike the name 267any calculations on it, you should treat it as some floating point value.
268.PP
257component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences 269Unlike the name component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for
258throughout libev. 270time differences (e.g. delays) throughout libev.
259.SH "ERROR HANDLING" 271.SH "ERROR HANDLING"
260.IX Header "ERROR HANDLING" 272.IX Header "ERROR HANDLING"
261Libev knows three classes of errors: operating system errors, usage errors 273Libev knows three classes of errors: operating system errors, usage errors
262and internal errors (bugs). 274and internal errors (bugs).
263.PP 275.PP
281library in any way. 293library in any way.
282.IP "ev_tstamp ev_time ()" 4 294.IP "ev_tstamp ev_time ()" 4
283.IX Item "ev_tstamp ev_time ()" 295.IX Item "ev_tstamp ev_time ()"
284Returns the current time as libev would use it. Please note that the 296Returns the current time as libev would use it. Please note that the
285\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp 297\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp
286you actually want to know. 298you actually want to know. Also interesting is the combination of
299\&\f(CW\*(C`ev_update_now\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR.
287.IP "ev_sleep (ev_tstamp interval)" 4 300.IP "ev_sleep (ev_tstamp interval)" 4
288.IX Item "ev_sleep (ev_tstamp interval)" 301.IX Item "ev_sleep (ev_tstamp interval)"
289Sleep for the given interval: The current thread will be blocked until 302Sleep for the given interval: The current thread will be blocked until
290either it is interrupted or the given time interval has passed. Basically 303either it is interrupted or the given time interval has passed. Basically
291this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR. 304this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR.
308as this indicates an incompatible change. Minor versions are usually 321as this indicates an incompatible change. Minor versions are usually
309compatible to older versions, so a larger minor version alone is usually 322compatible to older versions, so a larger minor version alone is usually
310not a problem. 323not a problem.
311.Sp 324.Sp
312Example: Make sure we haven't accidentally been linked against the wrong 325Example: Make sure we haven't accidentally been linked against the wrong
313version. 326version (note, however, that this will not detect other \s-1ABI\s0 mismatches,
327such as \s-1LFS\s0 or reentrancy).
314.Sp 328.Sp
315.Vb 3 329.Vb 3
316\& assert (("libev version mismatch", 330\& assert (("libev version mismatch",
317\& ev_version_major () == EV_VERSION_MAJOR 331\& ev_version_major () == EV_VERSION_MAJOR
318\& && ev_version_minor () >= EV_VERSION_MINOR)); 332\& && ev_version_minor () >= EV_VERSION_MINOR));
331\& assert (("sorry, no epoll, no sex", 345\& assert (("sorry, no epoll, no sex",
332\& ev_supported_backends () & EVBACKEND_EPOLL)); 346\& ev_supported_backends () & EVBACKEND_EPOLL));
333.Ve 347.Ve
334.IP "unsigned int ev_recommended_backends ()" 4 348.IP "unsigned int ev_recommended_backends ()" 4
335.IX Item "unsigned int ev_recommended_backends ()" 349.IX Item "unsigned int ev_recommended_backends ()"
336Return the set of all backends compiled into this binary of libev and also 350Return the set of all backends compiled into this binary of libev and
337recommended for this platform. This set is often smaller than the one 351also recommended for this platform, meaning it will work for most file
352descriptor types. This set is often smaller than the one returned by
338returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on 353\&\f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on most BSDs
339most BSDs and will not be auto-detected unless you explicitly request it 354and will not be auto-detected unless you explicitly request it (assuming
340(assuming you know what you are doing). This is the set of backends that 355you know what you are doing). This is the set of backends that libev will
341libev will probe for if you specify no backends explicitly. 356probe for if you specify no backends explicitly.
342.IP "unsigned int ev_embeddable_backends ()" 4 357.IP "unsigned int ev_embeddable_backends ()" 4
343.IX Item "unsigned int ev_embeddable_backends ()" 358.IX Item "unsigned int ev_embeddable_backends ()"
344Returns the set of backends that are embeddable in other event loops. This 359Returns the set of backends that are embeddable in other event loops. This
345is the theoretical, all-platform, value. To find which backends 360value is platform-specific but can include backends not available on the
346might be supported on the current system, you would need to look at 361current system. To find which embeddable backends might be supported on
347\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 362the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
348recommended ones. 363& ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
349.Sp 364.Sp
350See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 365See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
351.IP "ev_set_allocator (void *(*cb)(void *ptr, long size)) [\s-1NOT\s0 \s-1REENTRANT\s0]" 4 366.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
352.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]" 367.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
353Sets the allocation function to use (the prototype is similar \- the 368Sets the allocation function to use (the prototype is similar \- the
354semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is 369semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
355used to allocate and free memory (no surprises here). If it returns zero 370used to allocate and free memory (no surprises here). If it returns zero
356when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort 371when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
357or take some potentially destructive action. 372or take some potentially destructive action.
383\& } 398\& }
384\& 399\&
385\& ... 400\& ...
386\& ev_set_allocator (persistent_realloc); 401\& ev_set_allocator (persistent_realloc);
387.Ve 402.Ve
388.IP "ev_set_syserr_cb (void (*cb)(const char *msg)); [\s-1NOT\s0 \s-1REENTRANT\s0]" 4 403.IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4
389.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]" 404.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))"
390Set the callback function to call on a retryable system call error (such 405Set the callback function to call on a retryable system call error (such
391as failed select, poll, epoll_wait). The message is a printable string 406as failed select, poll, epoll_wait). The message is a printable string
392indicating the system call or subsystem causing the problem. If this 407indicating the system call or subsystem causing the problem. If this
393callback is set, then libev will expect it to remedy the situation, no 408callback is set, then libev will expect it to remedy the situation, no
394matter what, when it returns. That is, libev will generally retry the 409matter what, when it returns. That is, libev will generally retry the
406\& } 421\& }
407\& 422\&
408\& ... 423\& ...
409\& ev_set_syserr_cb (fatal_error); 424\& ev_set_syserr_cb (fatal_error);
410.Ve 425.Ve
426.IP "ev_feed_signal (int signum)" 4
427.IX Item "ev_feed_signal (int signum)"
428This function can be used to \*(L"simulate\*(R" a signal receive. It is completely
429safe to call this function at any time, from any context, including signal
430handlers or random threads.
431.Sp
432Its main use is to customise signal handling in your process, especially
433in the presence of threads. For example, you could block signals
434by default in all threads (and specifying \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when
435creating any loops), and in one thread, use \f(CW\*(C`sigwait\*(C'\fR or any other
436mechanism to wait for signals, then \*(L"deliver\*(R" them to libev by calling
437\&\f(CW\*(C`ev_feed_signal\*(C'\fR.
411.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 438.SH "FUNCTIONS CONTROLLING EVENT LOOPS"
412.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 439.IX Header "FUNCTIONS CONTROLLING EVENT LOOPS"
413An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR 440An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR is
414is \fInot\fR optional in this case, as there is also an \f(CW\*(C`ev_loop\*(C'\fR 441\&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as
415\&\fIfunction\fR). 442libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name).
416.PP 443.PP
417The library knows two types of such loops, the \fIdefault\fR loop, which 444The library knows two types of such loops, the \fIdefault\fR loop, which
418supports signals and child events, and dynamically created loops which do 445supports child process events, and dynamically created event loops which
419not. 446do not.
420.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 447.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
421.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 448.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
422This will initialise the default event loop if it hasn't been initialised 449This returns the \*(L"default\*(R" event loop object, which is what you should
423yet and return it. If the default loop could not be initialised, returns 450normally use when you just need \*(L"the event loop\*(R". Event loop objects and
424false. If it already was initialised it simply returns it (and ignores the 451the \f(CW\*(C`flags\*(C'\fR parameter are described in more detail in the entry for
425flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). 452\&\f(CW\*(C`ev_loop_new\*(C'\fR.
453.Sp
454If the default loop is already initialised then this function simply
455returns it (and ignores the flags. If that is troubling you, check
456\&\f(CW\*(C`ev_backend ()\*(C'\fR afterwards). Otherwise it will create it with the given
457flags, which should almost always be \f(CW0\fR, unless the caller is also the
458one calling \f(CW\*(C`ev_run\*(C'\fR or otherwise qualifies as \*(L"the main program\*(R".
426.Sp 459.Sp
427If you don't know what event loop to use, use the one returned from this 460If you don't know what event loop to use, use the one returned from this
428function. 461function (or via the \f(CW\*(C`EV_DEFAULT\*(C'\fR macro).
429.Sp 462.Sp
430Note that this function is \fInot\fR thread-safe, so if you want to use it 463Note that this function is \fInot\fR thread-safe, so if you want to use it
431from multiple threads, you have to lock (note also that this is unlikely, 464from multiple threads, you have to employ some kind of mutex (note also
432as loops cannot be shared easily between threads anyway). 465that this case is unlikely, as loops cannot be shared easily between
466threads anyway).
433.Sp 467.Sp
434The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and 468The default loop is the only loop that can handle \f(CW\*(C`ev_child\*(C'\fR watchers,
435\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler 469and to do this, it always registers a handler for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is
436for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your application you can either 470a problem for your application you can either create a dynamic loop with
437create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you 471\&\f(CW\*(C`ev_loop_new\*(C'\fR which doesn't do that, or you can simply overwrite the
438can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling 472\&\f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling \f(CW\*(C`ev_default_init\*(C'\fR.
439\&\f(CW\*(C`ev_default_init\*(C'\fR. 473.Sp
474Example: This is the most typical usage.
475.Sp
476.Vb 2
477\& if (!ev_default_loop (0))
478\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
479.Ve
480.Sp
481Example: Restrict libev to the select and poll backends, and do not allow
482environment settings to be taken into account:
483.Sp
484.Vb 1
485\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
486.Ve
487.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
488.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
489This will create and initialise a new event loop object. If the loop
490could not be initialised, returns false.
491.Sp
492This function is thread-safe, and one common way to use libev with
493threads is indeed to create one loop per thread, and using the default
494loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
440.Sp 495.Sp
441The flags argument can be used to specify special behaviour or specific 496The flags argument can be used to specify special behaviour or specific
442backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). 497backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
443.Sp 498.Sp
444The following flags are supported: 499The following flags are supported:
458useful to try out specific backends to test their performance, or to work 513useful to try out specific backends to test their performance, or to work
459around bugs. 514around bugs.
460.ie n .IP """EVFLAG_FORKCHECK""" 4 515.ie n .IP """EVFLAG_FORKCHECK""" 4
461.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 516.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
462.IX Item "EVFLAG_FORKCHECK" 517.IX Item "EVFLAG_FORKCHECK"
463Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after 518Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
464a fork, you can also make libev check for a fork in each iteration by 519make libev check for a fork in each iteration by enabling this flag.
465enabling this flag.
466.Sp 520.Sp
467This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 521This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
468and thus this might slow down your event loop if you do a lot of loop 522and thus this might slow down your event loop if you do a lot of loop
469iterations and little real work, but is usually not noticeable (on my 523iterations and little real work, but is usually not noticeable (on my
470GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 524GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
475forget about forgetting to tell libev about forking) when you use this 529forget about forgetting to tell libev about forking) when you use this
476flag. 530flag.
477.Sp 531.Sp
478This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 532This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
479environment variable. 533environment variable.
534.ie n .IP """EVFLAG_NOINOTIFY""" 4
535.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
536.IX Item "EVFLAG_NOINOTIFY"
537When this flag is specified, then libev will not attempt to use the
538\&\fIinotify\fR \s-1API\s0 for its \f(CW\*(C`ev_stat\*(C'\fR watchers. Apart from debugging and
539testing, this flag can be useful to conserve inotify file descriptors, as
540otherwise each loop using \f(CW\*(C`ev_stat\*(C'\fR watchers consumes one inotify handle.
541.ie n .IP """EVFLAG_SIGNALFD""" 4
542.el .IP "\f(CWEVFLAG_SIGNALFD\fR" 4
543.IX Item "EVFLAG_SIGNALFD"
544When this flag is specified, then libev will attempt to use the
545\&\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
546delivers signals synchronously, which makes it both faster and might make
547it possible to get the queued signal data. It can also simplify signal
548handling with threads, as long as you properly block signals in your
549threads that are not interested in handling them.
550.Sp
551Signalfd will not be used by default as this changes your signal mask, and
552there are a lot of shoddy libraries and programs (glib's threadpool for
553example) that can't properly initialise their signal masks.
554.ie n .IP """EVFLAG_NOSIGMASK""" 4
555.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
556.IX Item "EVFLAG_NOSIGMASK"
557When this flag is specified, then libev will avoid to modify the signal
558mask. Specifically, this means you ahve to make sure signals are unblocked
559when you want to receive them.
560.Sp
561This behaviour is useful when you want to do your own signal handling, or
562want to handle signals only in specific threads and want to avoid libev
563unblocking the signals.
564.Sp
565This flag's behaviour will become the default in future versions of libev.
480.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 566.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
481.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 567.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
482.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 568.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
483This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 569This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
484libev tries to roll its own fd_set with no limits on the number of fds, 570libev tries to roll its own fd_set with no limits on the number of fds,
509This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 595This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
510\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 596\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
511.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 597.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
512.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 598.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
513.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 599.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
600Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
601kernels).
602.Sp
514For few fds, this backend is a bit little slower than poll and select, 603For few fds, this backend is a bit little slower than poll and select,
515but it scales phenomenally better. While poll and select usually scale 604but it scales phenomenally better. While poll and select usually scale
516like O(total_fds) where n is the total number of fds (or the highest fd), 605like O(total_fds) where n is the total number of fds (or the highest fd),
517epoll scales either O(1) or O(active_fds). 606epoll scales either O(1) or O(active_fds).
518.Sp 607.Sp
519The epoll mechanism deserves honorable mention as the most misdesigned 608The epoll mechanism deserves honorable mention as the most misdesigned
520of the more advanced event mechanisms: mere annoyances include silently 609of the more advanced event mechanisms: mere annoyances include silently
521dropping file descriptors, requiring a system call per change per file 610dropping file descriptors, requiring a system call per change per file
522descriptor (and unnecessary guessing of parameters), problems with dup and 611descriptor (and unnecessary guessing of parameters), problems with dup,
612returning before the timeout value, resulting in additional iterations
613(and only giving 5ms accuracy while select on the same platform gives
523so on. The biggest issue is fork races, however \- if a program forks then 6140.1ms) and so on. The biggest issue is fork races, however \- if a program
524\&\fIboth\fR parent and child process have to recreate the epoll set, which can 615forks then \fIboth\fR parent and child process have to recreate the epoll
525take considerable time (one syscall per file descriptor) and is of course 616set, which can take considerable time (one syscall per file descriptor)
526hard to detect. 617and is of course hard to detect.
527.Sp 618.Sp
528Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but 619Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but
529of course \fIdoesn't\fR, and epoll just loves to report events for totally 620of course \fIdoesn't\fR, and epoll just loves to report events for totally
530\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot 621\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot
531even remove them from the set) than registered in the set (especially 622even remove them from the set) than registered in the set (especially
532on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by 623on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by
533employing an additional generation counter and comparing that against the 624employing an additional generation counter and comparing that against the
534events to filter out spurious ones, recreating the set when required. 625events to filter out spurious ones, recreating the set when required. Last
626not least, it also refuses to work with some file descriptors which work
627perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...).
628.Sp
629Epoll is truly the train wreck analog among event poll mechanisms,
630a frankenpoll, cobbled together in a hurry, no thought to design or
631interaction with others.
535.Sp 632.Sp
536While stopping, setting and starting an I/O watcher in the same iteration 633While stopping, setting and starting an I/O watcher in the same iteration
537will result in some caching, there is still a system call per such 634will result in some caching, there is still a system call per such
538incident (because the same \fIfile descriptor\fR could point to a different 635incident (because the same \fIfile descriptor\fR could point to a different
539\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed 636\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
605.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 702.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
606.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 703.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
607This uses the Solaris 10 event port mechanism. As with everything on Solaris, 704This uses the Solaris 10 event port mechanism. As with everything on Solaris,
608it's really slow, but it still scales very well (O(active_fds)). 705it's really slow, but it still scales very well (O(active_fds)).
609.Sp 706.Sp
610Please note that Solaris event ports can deliver a lot of spurious
611notifications, so you need to use non-blocking I/O or other means to avoid
612blocking when no data (or space) is available.
613.Sp
614While this backend scales well, it requires one system call per active 707While this backend scales well, it requires one system call per active
615file descriptor per loop iteration. For small and medium numbers of file 708file descriptor per loop iteration. For small and medium numbers of file
616descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend 709descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
617might perform better. 710might perform better.
618.Sp 711.Sp
619On the positive side, with the exception of the spurious readiness 712On the positive side, this backend actually performed fully to
620notifications, this backend actually performed fully to specification
621in all tests and is fully embeddable, which is a rare feat among the 713specification in all tests and is fully embeddable, which is a rare feat
622OS-specific backends (I vastly prefer correctness over speed hacks). 714among the OS-specific backends (I vastly prefer correctness over speed
715hacks).
716.Sp
717On the negative side, the interface is \fIbizarre\fR \- so bizarre that
718even sun itself gets it wrong in their code examples: The event polling
719function sometimes returning events to the caller even though an error
720occurred, but with no indication whether it has done so or not (yes, it's
721even documented that way) \- deadly for edge-triggered interfaces where
722you absolutely have to know whether an event occurred or not because you
723have to re-arm the watcher.
724.Sp
725Fortunately libev seems to be able to work around these idiocies.
623.Sp 726.Sp
624This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 727This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
625\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 728\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
626.ie n .IP """EVBACKEND_ALL""" 4 729.ie n .IP """EVBACKEND_ALL""" 4
627.el .IP "\f(CWEVBACKEND_ALL\fR" 4 730.el .IP "\f(CWEVBACKEND_ALL\fR" 4
628.IX Item "EVBACKEND_ALL" 731.IX Item "EVBACKEND_ALL"
629Try all backends (even potentially broken ones that wouldn't be tried 732Try all backends (even potentially broken ones that wouldn't be tried
630with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 733with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
631\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. 734\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.
632.Sp 735.Sp
633It is definitely not recommended to use this flag. 736It is definitely not recommended to use this flag, use whatever
737\&\f(CW\*(C`ev_recommended_backends ()\*(C'\fR returns, or simply do not specify a backend
738at all.
739.ie n .IP """EVBACKEND_MASK""" 4
740.el .IP "\f(CWEVBACKEND_MASK\fR" 4
741.IX Item "EVBACKEND_MASK"
742Not a backend at all, but a mask to select all backend bits from a
743\&\f(CW\*(C`flags\*(C'\fR value, in case you want to mask out any backends from a flags
744value (e.g. when modifying the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR environment variable).
634.RE 745.RE
635.RS 4 746.RS 4
636.Sp 747.Sp
637If one or more of these are or'ed into the flags value, then only these 748If one or more of the backend flags are or'ed into the flags value,
638backends will be tried (in the reverse order as listed here). If none are 749then only these backends will be tried (in the reverse order as listed
639specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried. 750here). If none are specified, all backends in \f(CW\*(C`ev_recommended_backends
640.Sp 751()\*(C'\fR will be tried.
641Example: This is the most typical usage.
642.Sp
643.Vb 2
644\& if (!ev_default_loop (0))
645\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
646.Ve
647.Sp
648Example: Restrict libev to the select and poll backends, and do not allow
649environment settings to be taken into account:
650.Sp
651.Vb 1
652\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
653.Ve
654.Sp
655Example: Use whatever libev has to offer, but make sure that kqueue is
656used if available (warning, breaks stuff, best use only with your own
657private event loop and only if you know the \s-1OS\s0 supports your types of
658fds):
659.Sp
660.Vb 1
661\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
662.Ve
663.RE
664.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
665.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
666Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
667always distinct from the default loop. Unlike the default loop, it cannot
668handle signal and child watchers, and attempts to do so will be greeted by
669undefined behaviour (or a failed assertion if assertions are enabled).
670.Sp
671Note that this function \fIis\fR thread-safe, and the recommended way to use
672libev with threads is indeed to create one loop per thread, and using the
673default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
674.Sp 752.Sp
675Example: Try to create a event loop that uses epoll and nothing else. 753Example: Try to create a event loop that uses epoll and nothing else.
676.Sp 754.Sp
677.Vb 3 755.Vb 3
678\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 756\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
679\& if (!epoller) 757\& if (!epoller)
680\& fatal ("no epoll found here, maybe it hides under your chair"); 758\& fatal ("no epoll found here, maybe it hides under your chair");
681.Ve 759.Ve
760.Sp
761Example: Use whatever libev has to offer, but make sure that kqueue is
762used if available.
763.Sp
764.Vb 1
765\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
766.Ve
767.RE
682.IP "ev_default_destroy ()" 4 768.IP "ev_loop_destroy (loop)" 4
683.IX Item "ev_default_destroy ()" 769.IX Item "ev_loop_destroy (loop)"
684Destroys the default loop again (frees all memory and kernel state 770Destroys an event loop object (frees all memory and kernel state
685etc.). None of the active event watchers will be stopped in the normal 771etc.). None of the active event watchers will be stopped in the normal
686sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your 772sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your
687responsibility to either stop all watchers cleanly yourself \fIbefore\fR 773responsibility to either stop all watchers cleanly yourself \fIbefore\fR
688calling this function, or cope with the fact afterwards (which is usually 774calling this function, or cope with the fact afterwards (which is usually
689the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them 775the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
691.Sp 777.Sp
692Note that certain global state, such as signal state (and installed signal 778Note that certain global state, such as signal state (and installed signal
693handlers), will not be freed by this function, and related watchers (such 779handlers), will not be freed by this function, and related watchers (such
694as signal and child watchers) would need to be stopped manually. 780as signal and child watchers) would need to be stopped manually.
695.Sp 781.Sp
696In general it is not advisable to call this function except in the 782This function is normally used on loop objects allocated by
697rare occasion where you really need to free e.g. the signal handling 783\&\f(CW\*(C`ev_loop_new\*(C'\fR, but it can also be used on the default loop returned by
698pipe fds. If you need dynamically allocated loops it is better to use 784\&\f(CW\*(C`ev_default_loop\*(C'\fR, in which case it is not thread-safe.
699\&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR).
700.IP "ev_loop_destroy (loop)" 4
701.IX Item "ev_loop_destroy (loop)"
702Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an
703earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR.
704.IP "ev_default_fork ()" 4
705.IX Item "ev_default_fork ()"
706This function sets a flag that causes subsequent \f(CW\*(C`ev_loop\*(C'\fR iterations
707to reinitialise the kernel state for backends that have one. Despite the
708name, you can call it anytime, but it makes most sense after forking, in
709the child process (or both child and parent, but that again makes little
710sense). You \fImust\fR call it in the child before using any of the libev
711functions, and it will only take effect at the next \f(CW\*(C`ev_loop\*(C'\fR iteration.
712.Sp 785.Sp
713On the other hand, you only need to call this function in the child 786Note that it is not advisable to call this function on the default loop
714process if and only if you want to use the event library in the child. If 787except in the rare occasion where you really need to free its resources.
715you just fork+exec, you don't have to call it at all. 788If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
716.Sp 789and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
717The function itself is quite fast and it's usually not a problem to call
718it just in case after a fork. To make this easy, the function will fit in
719quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR:
720.Sp
721.Vb 1
722\& pthread_atfork (0, 0, ev_default_fork);
723.Ve
724.IP "ev_loop_fork (loop)" 4 790.IP "ev_loop_fork (loop)" 4
725.IX Item "ev_loop_fork (loop)" 791.IX Item "ev_loop_fork (loop)"
726Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 792This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to
727\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 793reinitialise the kernel state for backends that have one. Despite the
728after fork that you want to re-use in the child, and how you do this is 794name, you can call it anytime, but it makes most sense after forking, in
729entirely your own problem. 795the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the
796child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
797.Sp
798Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
799a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
800because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
801during fork.
802.Sp
803On the other hand, you only need to call this function in the child
804process if and only if you want to use the event loop in the child. If
805you just fork+exec or create a new loop in the child, you don't have to
806call it at all (in fact, \f(CW\*(C`epoll\*(C'\fR is so badly broken that it makes a
807difference, but libev will usually detect this case on its own and do a
808costly reset of the backend).
809.Sp
810The function itself is quite fast and it's usually not a problem to call
811it just in case after a fork.
812.Sp
813Example: Automate calling \f(CW\*(C`ev_loop_fork\*(C'\fR on the default loop when
814using pthreads.
815.Sp
816.Vb 5
817\& static void
818\& post_fork_child (void)
819\& {
820\& ev_loop_fork (EV_DEFAULT);
821\& }
822\&
823\& ...
824\& pthread_atfork (0, 0, post_fork_child);
825.Ve
730.IP "int ev_is_default_loop (loop)" 4 826.IP "int ev_is_default_loop (loop)" 4
731.IX Item "int ev_is_default_loop (loop)" 827.IX Item "int ev_is_default_loop (loop)"
732Returns true when the given loop is, in fact, the default loop, and false 828Returns true when the given loop is, in fact, the default loop, and false
733otherwise. 829otherwise.
734.IP "unsigned int ev_loop_count (loop)" 4 830.IP "unsigned int ev_iteration (loop)" 4
735.IX Item "unsigned int ev_loop_count (loop)" 831.IX Item "unsigned int ev_iteration (loop)"
736Returns the count of loop iterations for the loop, which is identical to 832Returns the current iteration count for the event loop, which is identical
737the number of times libev did poll for new events. It starts at \f(CW0\fR and 833to the number of times libev did poll for new events. It starts at \f(CW0\fR
738happily wraps around with enough iterations. 834and happily wraps around with enough iterations.
739.Sp 835.Sp
740This value can sometimes be useful as a generation counter of sorts (it 836This value can sometimes be useful as a generation counter of sorts (it
741\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with 837\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
742\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. 838\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the
839prepare and check phases.
840.IP "unsigned int ev_depth (loop)" 4
841.IX Item "unsigned int ev_depth (loop)"
842Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of
843times \f(CW\*(C`ev_run\*(C'\fR was exited normally, in other words, the recursion depth.
844.Sp
845Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is
846\&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread),
847in which case it is higher.
848.Sp
849Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread,
850throwing an exception etc.), doesn't count as \*(L"exit\*(R" \- consider this
851as a hint to avoid such ungentleman-like behaviour unless it's really
852convenient, in which case it is fully supported.
743.IP "unsigned int ev_backend (loop)" 4 853.IP "unsigned int ev_backend (loop)" 4
744.IX Item "unsigned int ev_backend (loop)" 854.IX Item "unsigned int ev_backend (loop)"
745Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 855Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
746use. 856use.
747.IP "ev_tstamp ev_now (loop)" 4 857.IP "ev_tstamp ev_now (loop)" 4
753event occurring (or more correctly, libev finding out about it). 863event occurring (or more correctly, libev finding out about it).
754.IP "ev_now_update (loop)" 4 864.IP "ev_now_update (loop)" 4
755.IX Item "ev_now_update (loop)" 865.IX Item "ev_now_update (loop)"
756Establishes the current time by querying the kernel, updating the time 866Establishes the current time by querying the kernel, updating the time
757returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and 867returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and
758is usually done automatically within \f(CW\*(C`ev_loop ()\*(C'\fR. 868is usually done automatically within \f(CW\*(C`ev_run ()\*(C'\fR.
759.Sp 869.Sp
760This function is rarely useful, but when some event callback runs for a 870This function is rarely useful, but when some event callback runs for a
761very long time without entering the event loop, updating libev's idea of 871very long time without entering the event loop, updating libev's idea of
762the current time is a good idea. 872the current time is a good idea.
763.Sp 873.Sp
764See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section. 874See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section.
875.IP "ev_suspend (loop)" 4
876.IX Item "ev_suspend (loop)"
877.PD 0
878.IP "ev_resume (loop)" 4
879.IX Item "ev_resume (loop)"
880.PD
881These two functions suspend and resume an event loop, for use when the
882loop is not used for a while and timeouts should not be processed.
883.Sp
884A typical use case would be an interactive program such as a game: When
885the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it
886would be best to handle timeouts as if no time had actually passed while
887the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR
888in your \f(CW\*(C`SIGTSTP\*(C'\fR handler, sending yourself a \f(CW\*(C`SIGSTOP\*(C'\fR and calling
889\&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing.
890.Sp
891Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend
892between \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
893will be rescheduled (that is, they will lose any events that would have
894occurred while suspended).
895.Sp
896After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the
897given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
898without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
899.Sp
900Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
901event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
765.IP "ev_loop (loop, int flags)" 4 902.IP "ev_run (loop, int flags)" 4
766.IX Item "ev_loop (loop, int flags)" 903.IX Item "ev_run (loop, int flags)"
767Finally, this is it, the event handler. This function usually is called 904Finally, this is it, the event handler. This function usually is called
768after you initialised all your watchers and you want to start handling 905after you have initialised all your watchers and you want to start
769events. 906handling events. It will ask the operating system for any new events, call
907the watcher callbacks, an then repeat the whole process indefinitely: This
908is why event loops are called \fIloops\fR.
770.Sp 909.Sp
771If the flags argument is specified as \f(CW0\fR, it will not return until 910If the flags argument is specified as \f(CW0\fR, it will keep handling events
772either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. 911until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
912called.
773.Sp 913.Sp
774Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than 914Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
775relying on all watchers to be stopped when deciding when a program has 915relying on all watchers to be stopped when deciding when a program has
776finished (especially in interactive programs), but having a program 916finished (especially in interactive programs), but having a program
777that automatically loops as long as it has to and no longer by virtue 917that automatically loops as long as it has to and no longer by virtue
778of relying on its watchers stopping correctly, that is truly a thing of 918of relying on its watchers stopping correctly, that is truly a thing of
779beauty. 919beauty.
780.Sp 920.Sp
921This function is also \fImostly\fR exception-safe \- you can break out of
922a \f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
923exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
924will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
925.Sp
781A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle 926A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
782those events and any already outstanding ones, but will not block your 927those events and any already outstanding ones, but will not wait and
783process in case there are no events and will return after one iteration of 928block your process in case there are no events and will return after one
784the loop. 929iteration of the loop. This is sometimes useful to poll and handle new
930events while doing lengthy calculations, to keep the program responsive.
785.Sp 931.Sp
786A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if 932A flags value of \f(CW\*(C`EVRUN_ONCE\*(C'\fR will look for new events (waiting if
787necessary) and will handle those and any already outstanding ones. It 933necessary) and will handle those and any already outstanding ones. It
788will block your process until at least one new event arrives (which could 934will block your process until at least one new event arrives (which could
789be an event internal to libev itself, so there is no guarantee that a 935be an event internal to libev itself, so there is no guarantee that a
790user-registered callback will be called), and will return after one 936user-registered callback will be called), and will return after one
791iteration of the loop. 937iteration of the loop.
792.Sp 938.Sp
793This is useful if you are waiting for some external event in conjunction 939This is useful if you are waiting for some external event in conjunction
794with something not expressible using other libev watchers (i.e. "roll your 940with something not expressible using other libev watchers (i.e. "roll your
795own \f(CW\*(C`ev_loop\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 941own \f(CW\*(C`ev_run\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
796usually a better approach for this kind of thing. 942usually a better approach for this kind of thing.
797.Sp 943.Sp
798Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 944Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does:
799.Sp 945.Sp
800.Vb 10 946.Vb 10
947\& \- Increment loop depth.
948\& \- Reset the ev_break status.
801\& \- Before the first iteration, call any pending watchers. 949\& \- Before the first iteration, call any pending watchers.
950\& LOOP:
802\& * If EVFLAG_FORKCHECK was used, check for a fork. 951\& \- If EVFLAG_FORKCHECK was used, check for a fork.
803\& \- If a fork was detected (by any means), queue and call all fork watchers. 952\& \- If a fork was detected (by any means), queue and call all fork watchers.
804\& \- Queue and call all prepare watchers. 953\& \- Queue and call all prepare watchers.
954\& \- If ev_break was called, goto FINISH.
805\& \- If we have been forked, detach and recreate the kernel state 955\& \- If we have been forked, detach and recreate the kernel state
806\& as to not disturb the other process. 956\& as to not disturb the other process.
807\& \- Update the kernel state with all outstanding changes. 957\& \- Update the kernel state with all outstanding changes.
808\& \- Update the "event loop time" (ev_now ()). 958\& \- Update the "event loop time" (ev_now ()).
809\& \- Calculate for how long to sleep or block, if at all 959\& \- Calculate for how long to sleep or block, if at all
810\& (active idle watchers, EVLOOP_NONBLOCK or not having 960\& (active idle watchers, EVRUN_NOWAIT or not having
811\& any active watchers at all will result in not sleeping). 961\& any active watchers at all will result in not sleeping).
812\& \- Sleep if the I/O and timer collect interval say so. 962\& \- Sleep if the I/O and timer collect interval say so.
963\& \- Increment loop iteration counter.
813\& \- Block the process, waiting for any events. 964\& \- Block the process, waiting for any events.
814\& \- Queue all outstanding I/O (fd) events. 965\& \- Queue all outstanding I/O (fd) events.
815\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments. 966\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments.
816\& \- Queue all expired timers. 967\& \- Queue all expired timers.
817\& \- Queue all expired periodics. 968\& \- Queue all expired periodics.
818\& \- Unless any events are pending now, queue all idle watchers. 969\& \- Queue all idle watchers with priority higher than that of pending events.
819\& \- Queue all check watchers. 970\& \- Queue all check watchers.
820\& \- Call all queued watchers in reverse order (i.e. check watchers first). 971\& \- Call all queued watchers in reverse order (i.e. check watchers first).
821\& Signals and child watchers are implemented as I/O watchers, and will 972\& Signals and child watchers are implemented as I/O watchers, and will
822\& be handled here by queueing them when their watcher gets executed. 973\& be handled here by queueing them when their watcher gets executed.
823\& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 974\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
824\& were used, or there are no active watchers, return, otherwise 975\& were used, or there are no active watchers, goto FINISH, otherwise
825\& continue with step *. 976\& continue with step LOOP.
977\& FINISH:
978\& \- Reset the ev_break status iff it was EVBREAK_ONE.
979\& \- Decrement the loop depth.
980\& \- Return.
826.Ve 981.Ve
827.Sp 982.Sp
828Example: Queue some jobs and then loop until no events are outstanding 983Example: Queue some jobs and then loop until no events are outstanding
829anymore. 984anymore.
830.Sp 985.Sp
831.Vb 4 986.Vb 4
832\& ... queue jobs here, make sure they register event watchers as long 987\& ... queue jobs here, make sure they register event watchers as long
833\& ... as they still have work to do (even an idle watcher will do..) 988\& ... as they still have work to do (even an idle watcher will do..)
834\& ev_loop (my_loop, 0); 989\& ev_run (my_loop, 0);
835\& ... jobs done or somebody called unloop. yeah! 990\& ... jobs done or somebody called unloop. yeah!
836.Ve 991.Ve
837.IP "ev_unloop (loop, how)" 4 992.IP "ev_break (loop, how)" 4
838.IX Item "ev_unloop (loop, how)" 993.IX Item "ev_break (loop, how)"
839Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it 994Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it
840has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 995has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
841\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or 996\&\f(CW\*(C`EVBREAK_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_run\*(C'\fR call return, or
842\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. 997\&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return.
843.Sp 998.Sp
844This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again. 999This \*(L"break state\*(R" will be cleared on the next call to \f(CW\*(C`ev_run\*(C'\fR.
845.Sp 1000.Sp
846It is safe to call \f(CW\*(C`ev_unloop\*(C'\fR from otuside any \f(CW\*(C`ev_loop\*(C'\fR calls. 1001It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too, in
1002which case it will have no effect.
847.IP "ev_ref (loop)" 4 1003.IP "ev_ref (loop)" 4
848.IX Item "ev_ref (loop)" 1004.IX Item "ev_ref (loop)"
849.PD 0 1005.PD 0
850.IP "ev_unref (loop)" 4 1006.IP "ev_unref (loop)" 4
851.IX Item "ev_unref (loop)" 1007.IX Item "ev_unref (loop)"
852.PD 1008.PD
853Ref/unref can be used to add or remove a reference count on the event 1009Ref/unref can be used to add or remove a reference count on the event
854loop: Every watcher keeps one reference, and as long as the reference 1010loop: Every watcher keeps one reference, and as long as the reference
855count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own. 1011count is nonzero, \f(CW\*(C`ev_run\*(C'\fR will not return on its own.
856.Sp 1012.Sp
857If you have a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR 1013This is useful when you have a watcher that you never intend to
858from returning, call \fIev_unref()\fR after starting, and \fIev_ref()\fR before 1014unregister, but that nevertheless should not keep \f(CW\*(C`ev_run\*(C'\fR from
1015returning. In such a case, call \f(CW\*(C`ev_unref\*(C'\fR after starting, and \f(CW\*(C`ev_ref\*(C'\fR
859stopping it. 1016before stopping it.
860.Sp 1017.Sp
861As an example, libev itself uses this for its internal signal pipe: It is 1018As an example, libev itself uses this for its internal signal pipe: It
862not visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting 1019is not visible to the libev user and should not keep \f(CW\*(C`ev_run\*(C'\fR from
863if no event watchers registered by it are active. It is also an excellent 1020exiting if no event watchers registered by it are active. It is also an
864way to do this for generic recurring timers or from within third-party 1021excellent way to do this for generic recurring timers or from within
865libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR 1022third-party libraries. Just remember to \fIunref after start\fR and \fIref
866(but only if the watcher wasn't active before, or was active before, 1023before stop\fR (but only if the watcher wasn't active before, or was active
867respectively). 1024before, respectively. Note also that libev might stop watchers itself
1025(e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR
1026in the callback).
868.Sp 1027.Sp
869Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 1028Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_run\*(C'\fR
870running when nothing else is active. 1029running when nothing else is active.
871.Sp 1030.Sp
872.Vb 4 1031.Vb 4
873\& ev_signal exitsig; 1032\& ev_signal exitsig;
874\& ev_signal_init (&exitsig, sig_cb, SIGINT); 1033\& ev_signal_init (&exitsig, sig_cb, SIGINT);
875\& ev_signal_start (loop, &exitsig); 1034\& ev_signal_start (loop, &exitsig);
876\& evf_unref (loop); 1035\& ev_unref (loop);
877.Ve 1036.Ve
878.Sp 1037.Sp
879Example: For some weird reason, unregister the above signal handler again. 1038Example: For some weird reason, unregister the above signal handler again.
880.Sp 1039.Sp
881.Vb 2 1040.Vb 2
906.Sp 1065.Sp
907By setting a higher \fIio collect interval\fR you allow libev to spend more 1066By setting a higher \fIio collect interval\fR you allow libev to spend more
908time collecting I/O events, so you can handle more events per iteration, 1067time collecting I/O events, so you can handle more events per iteration,
909at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and 1068at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
910\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will 1069\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will
911introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. 1070introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
1071sleep time ensures that libev will not poll for I/O events more often then
1072once per this interval, on average.
912.Sp 1073.Sp
913Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 1074Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
914to spend more time collecting timeouts, at the expense of increased 1075to spend more time collecting timeouts, at the expense of increased
915latency/jitter/inexactness (the watcher callback will be called 1076latency/jitter/inexactness (the watcher callback will be called
916later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null 1077later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
918.Sp 1079.Sp
919Many (busy) programs can usually benefit by setting the I/O collect 1080Many (busy) programs can usually benefit by setting the I/O collect
920interval to a value near \f(CW0.1\fR or so, which is often enough for 1081interval to a value near \f(CW0.1\fR or so, which is often enough for
921interactive servers (of course not for games), likewise for timeouts. It 1082interactive servers (of course not for games), likewise for timeouts. It
922usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, 1083usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR,
923as this approaches the timing granularity of most systems. 1084as this approaches the timing granularity of most systems. Note that if
1085you do transactions with the outside world and you can't increase the
1086parallelity, then this setting will limit your transaction rate (if you
1087need to poll once per transaction and the I/O collect interval is 0.01,
1088then you can't do more than 100 transactions per second).
924.Sp 1089.Sp
925Setting the \fItimeout collect interval\fR can improve the opportunity for 1090Setting the \fItimeout collect interval\fR can improve the opportunity for
926saving power, as the program will \*(L"bundle\*(R" timer callback invocations that 1091saving power, as the program will \*(L"bundle\*(R" timer callback invocations that
927are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of 1092are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of
928times the process sleeps and wakes up again. Another useful technique to 1093times the process sleeps and wakes up again. Another useful technique to
929reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure 1094reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure
930they fire on, say, one-second boundaries only. 1095they fire on, say, one-second boundaries only.
1096.Sp
1097Example: we only need 0.1s timeout granularity, and we wish not to poll
1098more often than 100 times per second:
1099.Sp
1100.Vb 2
1101\& ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
1102\& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
1103.Ve
1104.IP "ev_invoke_pending (loop)" 4
1105.IX Item "ev_invoke_pending (loop)"
1106This call will simply invoke all pending watchers while resetting their
1107pending state. Normally, \f(CW\*(C`ev_run\*(C'\fR does this automatically when required,
1108but when overriding the invoke callback this call comes handy. This
1109function can be invoked from a watcher \- this can be useful for example
1110when you want to do some lengthy calculation and want to pass further
1111event handling to another thread (you still have to make sure only one
1112thread executes within \f(CW\*(C`ev_invoke_pending\*(C'\fR or \f(CW\*(C`ev_run\*(C'\fR of course).
1113.IP "int ev_pending_count (loop)" 4
1114.IX Item "int ev_pending_count (loop)"
1115Returns the number of pending watchers \- zero indicates that no watchers
1116are pending.
1117.IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4
1118.IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))"
1119This overrides the invoke pending functionality of the loop: Instead of
1120invoking all pending watchers when there are any, \f(CW\*(C`ev_run\*(C'\fR will call
1121this callback instead. This is useful, for example, when you want to
1122invoke the actual watchers inside another context (another thread etc.).
1123.Sp
1124If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1125callback.
1126.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4
1127.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))"
1128Sometimes you want to share the same loop between multiple threads. This
1129can be done relatively simply by putting mutex_lock/unlock calls around
1130each call to a libev function.
1131.Sp
1132However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1133to wait for it to return. One way around this is to wake up the event
1134loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`av_async_send\*(C'\fR, another way is to set these
1135\&\fIrelease\fR and \fIacquire\fR callbacks on the loop.
1136.Sp
1137When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1138suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1139afterwards.
1140.Sp
1141Ideally, \f(CW\*(C`release\*(C'\fR will just call your mutex_unlock function, and
1142\&\f(CW\*(C`acquire\*(C'\fR will just call the mutex_lock function again.
1143.Sp
1144While event loop modifications are allowed between invocations of
1145\&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no
1146modifications done will affect the event loop, i.e. adding watchers will
1147have no effect on the set of file descriptors being watched, or the time
1148waited. Use an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_run\*(C'\fR when you want it
1149to take note of any changes you made.
1150.Sp
1151In theory, threads executing \f(CW\*(C`ev_run\*(C'\fR will be async-cancel safe between
1152invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR.
1153.Sp
1154See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this
1155document.
1156.IP "ev_set_userdata (loop, void *data)" 4
1157.IX Item "ev_set_userdata (loop, void *data)"
1158.PD 0
1159.IP "void *ev_userdata (loop)" 4
1160.IX Item "void *ev_userdata (loop)"
1161.PD
1162Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When
1163\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns
1164\&\f(CW0\fR.
1165.Sp
1166These two functions can be used to associate arbitrary data with a loop,
1167and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and
1168\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for
1169any other purpose as well.
931.IP "ev_loop_verify (loop)" 4 1170.IP "ev_verify (loop)" 4
932.IX Item "ev_loop_verify (loop)" 1171.IX Item "ev_verify (loop)"
933This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been 1172This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been
934compiled in, which is the default for non-minimal builds. It tries to go 1173compiled in, which is the default for non-minimal builds. It tries to go
935through all internal structures and checks them for validity. If anything 1174through all internal structures and checks them for validity. If anything
936is found to be inconsistent, it will print an error message to standard 1175is found to be inconsistent, it will print an error message to standard
937error and call \f(CW\*(C`abort ()\*(C'\fR. 1176error and call \f(CW\*(C`abort ()\*(C'\fR.
943.IX Header "ANATOMY OF A WATCHER" 1182.IX Header "ANATOMY OF A WATCHER"
944In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the 1183In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the
945watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer 1184watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer
946watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers. 1185watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers.
947.PP 1186.PP
948A watcher is a structure that you create and register to record your 1187A watcher is an opaque structure that you allocate and register to record
949interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 1188your interest in some event. To make a concrete example, imagine you want
950become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: 1189to wait for \s-1STDIN\s0 to become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher
1190for that:
951.PP 1191.PP
952.Vb 5 1192.Vb 5
953\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents) 1193\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
954\& { 1194\& {
955\& ev_io_stop (w); 1195\& ev_io_stop (w);
956\& ev_unloop (loop, EVUNLOOP_ALL); 1196\& ev_break (loop, EVBREAK_ALL);
957\& } 1197\& }
958\& 1198\&
959\& struct ev_loop *loop = ev_default_loop (0); 1199\& struct ev_loop *loop = ev_default_loop (0);
960\& 1200\&
961\& ev_io stdin_watcher; 1201\& ev_io stdin_watcher;
962\& 1202\&
963\& ev_init (&stdin_watcher, my_cb); 1203\& ev_init (&stdin_watcher, my_cb);
964\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 1204\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
965\& ev_io_start (loop, &stdin_watcher); 1205\& ev_io_start (loop, &stdin_watcher);
966\& 1206\&
967\& ev_loop (loop, 0); 1207\& ev_run (loop, 0);
968.Ve 1208.Ve
969.PP 1209.PP
970As you can see, you are responsible for allocating the memory for your 1210As you can see, you are responsible for allocating the memory for your
971watcher structures (and it is \fIusually\fR a bad idea to do this on the 1211watcher structures (and it is \fIusually\fR a bad idea to do this on the
972stack). 1212stack).
973.PP 1213.PP
974Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR 1214Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR
975or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs). 1215or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs).
976.PP 1216.PP
977Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init 1217Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init (watcher
978(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This 1218*, callback)\*(C'\fR, which expects a callback to be provided. This callback is
979callback gets invoked each time the event occurs (or, in the case of I/O 1219invoked each time the event occurs (or, in the case of I/O watchers, each
980watchers, each time the event loop detects that the file descriptor given 1220time the event loop detects that the file descriptor given is readable
981is readable and/or writable). 1221and/or writable).
982.PP 1222.PP
983Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR 1223Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR
984macro to configure it, with arguments specific to the watcher type. There 1224macro to configure it, with arguments specific to the watcher type. There
985is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR. 1225is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR.
986.PP 1226.PP
1008.el .IP "\f(CWEV_WRITE\fR" 4 1248.el .IP "\f(CWEV_WRITE\fR" 4
1009.IX Item "EV_WRITE" 1249.IX Item "EV_WRITE"
1010.PD 1250.PD
1011The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or 1251The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or
1012writable. 1252writable.
1013.ie n .IP """EV_TIMEOUT""" 4 1253.ie n .IP """EV_TIMER""" 4
1014.el .IP "\f(CWEV_TIMEOUT\fR" 4 1254.el .IP "\f(CWEV_TIMER\fR" 4
1015.IX Item "EV_TIMEOUT" 1255.IX Item "EV_TIMER"
1016The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out. 1256The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out.
1017.ie n .IP """EV_PERIODIC""" 4 1257.ie n .IP """EV_PERIODIC""" 4
1018.el .IP "\f(CWEV_PERIODIC\fR" 4 1258.el .IP "\f(CWEV_PERIODIC\fR" 4
1019.IX Item "EV_PERIODIC" 1259.IX Item "EV_PERIODIC"
1020The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out. 1260The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out.
1040.PD 0 1280.PD 0
1041.ie n .IP """EV_CHECK""" 4 1281.ie n .IP """EV_CHECK""" 4
1042.el .IP "\f(CWEV_CHECK\fR" 4 1282.el .IP "\f(CWEV_CHECK\fR" 4
1043.IX Item "EV_CHECK" 1283.IX Item "EV_CHECK"
1044.PD 1284.PD
1045All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_loop\*(C'\fR starts 1285All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts
1046to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1286to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after
1047\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 1287\&\f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it invokes any callbacks for any
1048received events. Callbacks of both watcher types can start and stop as 1288received events. Callbacks of both watcher types can start and stop as
1049many watchers as they want, and all of them will be taken into account 1289many watchers as they want, and all of them will be taken into account
1050(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1290(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep
1051\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 1291\&\f(CW\*(C`ev_run\*(C'\fR from blocking).
1052.ie n .IP """EV_EMBED""" 4 1292.ie n .IP """EV_EMBED""" 4
1053.el .IP "\f(CWEV_EMBED\fR" 4 1293.el .IP "\f(CWEV_EMBED\fR" 4
1054.IX Item "EV_EMBED" 1294.IX Item "EV_EMBED"
1055The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1295The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1056.ie n .IP """EV_FORK""" 4 1296.ie n .IP """EV_FORK""" 4
1057.el .IP "\f(CWEV_FORK\fR" 4 1297.el .IP "\f(CWEV_FORK\fR" 4
1058.IX Item "EV_FORK" 1298.IX Item "EV_FORK"
1059The event loop has been resumed in the child process after fork (see 1299The event loop has been resumed in the child process after fork (see
1060\&\f(CW\*(C`ev_fork\*(C'\fR). 1300\&\f(CW\*(C`ev_fork\*(C'\fR).
1301.ie n .IP """EV_CLEANUP""" 4
1302.el .IP "\f(CWEV_CLEANUP\fR" 4
1303.IX Item "EV_CLEANUP"
1304The event loop is about to be destroyed (see \f(CW\*(C`ev_cleanup\*(C'\fR).
1061.ie n .IP """EV_ASYNC""" 4 1305.ie n .IP """EV_ASYNC""" 4
1062.el .IP "\f(CWEV_ASYNC\fR" 4 1306.el .IP "\f(CWEV_ASYNC\fR" 4
1063.IX Item "EV_ASYNC" 1307.IX Item "EV_ASYNC"
1064The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). 1308The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
1309.ie n .IP """EV_CUSTOM""" 4
1310.el .IP "\f(CWEV_CUSTOM\fR" 4
1311.IX Item "EV_CUSTOM"
1312Not ever sent (or otherwise used) by libev itself, but can be freely used
1313by libev users to signal watchers (e.g. via \f(CW\*(C`ev_feed_event\*(C'\fR).
1065.ie n .IP """EV_ERROR""" 4 1314.ie n .IP """EV_ERROR""" 4
1066.el .IP "\f(CWEV_ERROR\fR" 4 1315.el .IP "\f(CWEV_ERROR\fR" 4
1067.IX Item "EV_ERROR" 1316.IX Item "EV_ERROR"
1068An unspecified error has occurred, the watcher has been stopped. This might 1317An unspecified error has occurred, the watcher has been stopped. This might
1069happen because the watcher could not be properly started because libev 1318happen because the watcher could not be properly started because libev
1079example it might indicate that a fd is readable or writable, and if your 1328example it might indicate that a fd is readable or writable, and if your
1080callbacks is well-written it can just attempt the operation and cope with 1329callbacks is well-written it can just attempt the operation and cope with
1081the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1330the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
1082programs, though, as the fd could already be closed and reused for another 1331programs, though, as the fd could already be closed and reused for another
1083thing, so beware. 1332thing, so beware.
1084.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1333.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
1085.IX Subsection "GENERIC WATCHER FUNCTIONS" 1334.IX Subsection "GENERIC WATCHER FUNCTIONS"
1086.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1335.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1087.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1336.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1088.IX Item "ev_init (ev_TYPE *watcher, callback)" 1337.IX Item "ev_init (ev_TYPE *watcher, callback)"
1089This macro initialises the generic portion of a watcher. The contents 1338This macro initialises the generic portion of a watcher. The contents
1104.Vb 3 1353.Vb 3
1105\& ev_io w; 1354\& ev_io w;
1106\& ev_init (&w, my_cb); 1355\& ev_init (&w, my_cb);
1107\& ev_io_set (&w, STDIN_FILENO, EV_READ); 1356\& ev_io_set (&w, STDIN_FILENO, EV_READ);
1108.Ve 1357.Ve
1109.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 1358.ie n .IP """ev_TYPE_set"" (ev_TYPE *watcher, [args])" 4
1110.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 1359.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *watcher, [args])" 4
1111.IX Item "ev_TYPE_set (ev_TYPE *, [args])" 1360.IX Item "ev_TYPE_set (ev_TYPE *watcher, [args])"
1112This macro initialises the type-specific parts of a watcher. You need to 1361This macro initialises the type-specific parts of a watcher. You need to
1113call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can 1362call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
1114call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this 1363call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this
1115macro on a watcher that is active (it can be pending, however, which is a 1364macro on a watcher that is active (it can be pending, however, which is a
1116difference to the \f(CW\*(C`ev_init\*(C'\fR macro). 1365difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
1129Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step. 1378Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step.
1130.Sp 1379.Sp
1131.Vb 1 1380.Vb 1
1132\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); 1381\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1133.Ve 1382.Ve
1134.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 1383.ie n .IP """ev_TYPE_start"" (loop, ev_TYPE *watcher)" 4
1135.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 1384.el .IP "\f(CWev_TYPE_start\fR (loop, ev_TYPE *watcher)" 4
1136.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" 1385.IX Item "ev_TYPE_start (loop, ev_TYPE *watcher)"
1137Starts (activates) the given watcher. Only active watchers will receive 1386Starts (activates) the given watcher. Only active watchers will receive
1138events. If the watcher is already active nothing will happen. 1387events. If the watcher is already active nothing will happen.
1139.Sp 1388.Sp
1140Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this 1389Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this
1141whole section. 1390whole section.
1142.Sp 1391.Sp
1143.Vb 1 1392.Vb 1
1144\& ev_io_start (EV_DEFAULT_UC, &w); 1393\& ev_io_start (EV_DEFAULT_UC, &w);
1145.Ve 1394.Ve
1146.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 1395.ie n .IP """ev_TYPE_stop"" (loop, ev_TYPE *watcher)" 4
1147.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 1396.el .IP "\f(CWev_TYPE_stop\fR (loop, ev_TYPE *watcher)" 4
1148.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" 1397.IX Item "ev_TYPE_stop (loop, ev_TYPE *watcher)"
1149Stops the given watcher if active, and clears the pending status (whether 1398Stops the given watcher if active, and clears the pending status (whether
1150the watcher was active or not). 1399the watcher was active or not).
1151.Sp 1400.Sp
1152It is possible that stopped watchers are pending \- for example, 1401It is possible that stopped watchers are pending \- for example,
1153non-repeating timers are being stopped when they become pending \- but 1402non-repeating timers are being stopped when they become pending \- but
1172Returns the callback currently set on the watcher. 1421Returns the callback currently set on the watcher.
1173.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1422.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
1174.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1423.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
1175Change the callback. You can change the callback at virtually any time 1424Change the callback. You can change the callback at virtually any time
1176(modulo threads). 1425(modulo threads).
1177.IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 1426.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1178.IX Item "ev_set_priority (ev_TYPE *watcher, priority)" 1427.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1179.PD 0 1428.PD 0
1180.IP "int ev_priority (ev_TYPE *watcher)" 4 1429.IP "int ev_priority (ev_TYPE *watcher)" 4
1181.IX Item "int ev_priority (ev_TYPE *watcher)" 1430.IX Item "int ev_priority (ev_TYPE *watcher)"
1182.PD 1431.PD
1183Set and query the priority of the watcher. The priority is a small 1432Set and query the priority of the watcher. The priority is a small
1184integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR 1433integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
1185(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked 1434(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
1186before watchers with lower priority, but priority will not keep watchers 1435before watchers with lower priority, but priority will not keep watchers
1187from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). 1436from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
1188.Sp 1437.Sp
1189This means that priorities are \fIonly\fR used for ordering callback
1190invocation after new events have been received. This is useful, for
1191example, to reduce latency after idling, or more often, to bind two
1192watchers on the same event and make sure one is called first.
1193.Sp
1194If you need to suppress invocation when higher priority events are pending 1438If you need to suppress invocation when higher priority events are pending
1195you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. 1439you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
1196.Sp 1440.Sp
1197You \fImust not\fR change the priority of a watcher as long as it is active or 1441You \fImust not\fR change the priority of a watcher as long as it is active or
1198pending. 1442pending.
1199.Sp
1200The default priority used by watchers when no priority has been set is
1201always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1202.Sp 1443.Sp
1203Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is 1444Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
1204fine, as long as you do not mind that the priority value you query might 1445fine, as long as you do not mind that the priority value you query might
1205or might not have been clamped to the valid range. 1446or might not have been clamped to the valid range.
1447.Sp
1448The default priority used by watchers when no priority has been set is
1449always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1450.Sp
1451See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of
1452priorities.
1206.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1453.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1207.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1454.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1208Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1455Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1209\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1456\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1210can deal with that fact, as both are simply passed through to the 1457can deal with that fact, as both are simply passed through to the
1215returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the 1462returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
1216watcher isn't pending it does nothing and returns \f(CW0\fR. 1463watcher isn't pending it does nothing and returns \f(CW0\fR.
1217.Sp 1464.Sp
1218Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its 1465Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its
1219callback to be invoked, which can be accomplished with this function. 1466callback to be invoked, which can be accomplished with this function.
1220.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 1467.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4
1221.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 1468.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)"
1222Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 1469Feeds the given event set into the event loop, as if the specified event
1223and read at any time: libev will completely ignore it. This can be used 1470had happened for the specified watcher (which must be a pointer to an
1224to associate arbitrary data with your watcher. If you need more data and 1471initialised but not necessarily started event watcher). Obviously you must
1225don't want to allocate memory and store a pointer to it in that data 1472not free the watcher as long as it has pending events.
1226member, you can also \*(L"subclass\*(R" the watcher type and provide your own 1473.Sp
1227data: 1474Stopping the watcher, letting libev invoke it, or calling
1475\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was
1476not started in the first place.
1477.Sp
1478See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1479functions that do not need a watcher.
1228.PP 1480.PP
1481See also the \*(L"\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0\*(R" and \*(L"\s-1BUILDING\s0 \s-1YOUR\s0
1482\&\s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0\*(R" idioms.
1483.SS "\s-1WATCHER\s0 \s-1STATES\s0"
1484.IX Subsection "WATCHER STATES"
1485There are various watcher states mentioned throughout this manual \-
1486active, pending and so on. In this section these states and the rules to
1487transition between them will be described in more detail \- and while these
1488rules might look complicated, they usually do \*(L"the right thing\*(R".
1489.IP "initialiased" 4
1490.IX Item "initialiased"
1491Before a watcher can be registered with the event looop it has to be
1492initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1493\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1494.Sp
1495In this state it is simply some block of memory that is suitable for use
1496in an event loop. It can be moved around, freed, reused etc. at will.
1497.IP "started/running/active" 4
1498.IX Item "started/running/active"
1499Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1500property of the event loop, and is actively waiting for events. While in
1501this state it cannot be accessed (except in a few documented ways), moved,
1502freed or anything else \- the only legal thing is to keep a pointer to it,
1503and call libev functions on it that are documented to work on active watchers.
1504.IP "pending" 4
1505.IX Item "pending"
1506If a watcher is active and libev determines that an event it is interested
1507in has occurred (such as a timer expiring), it will become pending. It will
1508stay in this pending state until either it is stopped or its callback is
1509about to be invoked, so it is not normally pending inside the watcher
1510callback.
1511.Sp
1512The watcher might or might not be active while it is pending (for example,
1513an expired non-repeating timer can be pending but no longer active). If it
1514is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR),
1515but it is still property of the event loop at this time, so cannot be
1516moved, freed or reused. And if it is active the rules described in the
1517previous item still apply.
1518.Sp
1519It is also possible to feed an event on a watcher that is not active (e.g.
1520via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being
1521active.
1522.IP "stopped" 4
1523.IX Item "stopped"
1524A watcher can be stopped implicitly by libev (in which case it might still
1525be pending), or explicitly by calling its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. The
1526latter will clear any pending state the watcher might be in, regardless
1527of whether it was active or not, so stopping a watcher explicitly before
1528freeing it is often a good idea.
1529.Sp
1530While stopped (and not pending) the watcher is essentially in the
1531initialised state, that is it can be reused, moved, modified in any way
1532you wish.
1533.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0"
1534.IX Subsection "WATCHER PRIORITY MODELS"
1535Many event loops support \fIwatcher priorities\fR, which are usually small
1536integers that influence the ordering of event callback invocation
1537between watchers in some way, all else being equal.
1538.PP
1539In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1540description for the more technical details such as the actual priority
1541range.
1542.PP
1543There are two common ways how these these priorities are being interpreted
1544by event loops:
1545.PP
1546In the more common lock-out model, higher priorities \*(L"lock out\*(R" invocation
1547of lower priority watchers, which means as long as higher priority
1548watchers receive events, lower priority watchers are not being invoked.
1549.PP
1550The less common only-for-ordering model uses priorities solely to order
1551callback invocation within a single event loop iteration: Higher priority
1552watchers are invoked before lower priority ones, but they all get invoked
1553before polling for new events.
1554.PP
1555Libev uses the second (only-for-ordering) model for all its watchers
1556except for idle watchers (which use the lock-out model).
1557.PP
1558The rationale behind this is that implementing the lock-out model for
1559watchers is not well supported by most kernel interfaces, and most event
1560libraries will just poll for the same events again and again as long as
1561their callbacks have not been executed, which is very inefficient in the
1562common case of one high-priority watcher locking out a mass of lower
1563priority ones.
1564.PP
1565Static (ordering) priorities are most useful when you have two or more
1566watchers handling the same resource: a typical usage example is having an
1567\&\f(CW\*(C`ev_io\*(C'\fR watcher to receive data, and an associated \f(CW\*(C`ev_timer\*(C'\fR to handle
1568timeouts. Under load, data might be received while the program handles
1569other jobs, but since timers normally get invoked first, the timeout
1570handler will be executed before checking for data. In that case, giving
1571the timer a lower priority than the I/O watcher ensures that I/O will be
1572handled first even under adverse conditions (which is usually, but not
1573always, what you want).
1574.PP
1575Since idle watchers use the \*(L"lock-out\*(R" model, meaning that idle watchers
1576will only be executed when no same or higher priority watchers have
1577received events, they can be used to implement the \*(L"lock-out\*(R" model when
1578required.
1579.PP
1580For example, to emulate how many other event libraries handle priorities,
1581you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in
1582the normal watcher callback, you just start the idle watcher. The real
1583processing is done in the idle watcher callback. This causes libev to
1584continuously poll and process kernel event data for the watcher, but when
1585the lock-out case is known to be rare (which in turn is rare :), this is
1586workable.
1587.PP
1588Usually, however, the lock-out model implemented that way will perform
1589miserably under the type of load it was designed to handle. In that case,
1590it might be preferable to stop the real watcher before starting the
1591idle watcher, so the kernel will not have to process the event in case
1592the actual processing will be delayed for considerable time.
1593.PP
1594Here is an example of an I/O watcher that should run at a strictly lower
1595priority than the default, and which should only process data when no
1596other events are pending:
1597.PP
1229.Vb 7 1598.Vb 2
1230\& struct my_io 1599\& ev_idle idle; // actual processing watcher
1600\& ev_io io; // actual event watcher
1601\&
1602\& static void
1603\& io_cb (EV_P_ ev_io *w, int revents)
1231\& { 1604\& {
1232\& ev_io io; 1605\& // stop the I/O watcher, we received the event, but
1233\& int otherfd; 1606\& // are not yet ready to handle it.
1234\& void *somedata; 1607\& ev_io_stop (EV_A_ w);
1235\& struct whatever *mostinteresting; 1608\&
1609\& // start the idle watcher to handle the actual event.
1610\& // it will not be executed as long as other watchers
1611\& // with the default priority are receiving events.
1612\& ev_idle_start (EV_A_ &idle);
1236\& }; 1613\& }
1237\& 1614\&
1238\& ... 1615\& static void
1239\& struct my_io w; 1616\& idle_cb (EV_P_ ev_idle *w, int revents)
1240\& ev_io_init (&w.io, my_cb, fd, EV_READ);
1241.Ve
1242.PP
1243And since your callback will be called with a pointer to the watcher, you
1244can cast it back to your own type:
1245.PP
1246.Vb 5
1247\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1248\& { 1617\& {
1249\& struct my_io *w = (struct my_io *)w_; 1618\& // actual processing
1250\& ... 1619\& read (STDIN_FILENO, ...);
1620\&
1621\& // have to start the I/O watcher again, as
1622\& // we have handled the event
1623\& ev_io_start (EV_P_ &io);
1251\& } 1624\& }
1252.Ve
1253.PP
1254More interesting and less C\-conformant ways of casting your callback type
1255instead have been omitted.
1256.PP
1257Another common scenario is to use some data structure with multiple
1258embedded watchers:
1259.PP
1260.Vb 6
1261\& struct my_biggy
1262\& {
1263\& int some_data;
1264\& ev_timer t1;
1265\& ev_timer t2;
1266\& }
1267.Ve
1268.PP
1269In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
1270complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct
1271in the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies), or you need to use
1272some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for real
1273programmers):
1274.PP
1275.Vb 1
1276\& #include <stddef.h>
1277\& 1625\&
1278\& static void 1626\& // initialisation
1279\& t1_cb (EV_P_ ev_timer *w, int revents) 1627\& ev_idle_init (&idle, idle_cb);
1280\& { 1628\& ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1281\& struct my_biggy big = (struct my_biggy * 1629\& ev_io_start (EV_DEFAULT_ &io);
1282\& (((char *)w) \- offsetof (struct my_biggy, t1));
1283\& }
1284\&
1285\& static void
1286\& t2_cb (EV_P_ ev_timer *w, int revents)
1287\& {
1288\& struct my_biggy big = (struct my_biggy *
1289\& (((char *)w) \- offsetof (struct my_biggy, t2));
1290\& }
1291.Ve 1630.Ve
1631.PP
1632In the \*(L"real\*(R" world, it might also be beneficial to start a timer, so that
1633low-priority connections can not be locked out forever under load. This
1634enables your program to keep a lower latency for important connections
1635during short periods of high load, while not completely locking out less
1636important ones.
1292.SH "WATCHER TYPES" 1637.SH "WATCHER TYPES"
1293.IX Header "WATCHER TYPES" 1638.IX Header "WATCHER TYPES"
1294This section describes each watcher in detail, but will not repeat 1639This section describes each watcher in detail, but will not repeat
1295information given in the last section. Any initialisation/set macros, 1640information given in the last section. Any initialisation/set macros,
1296functions and members specific to the watcher type are explained. 1641functions and members specific to the watcher type are explained.
1301watcher is stopped to your hearts content), or \fI[read\-write]\fR, which 1646watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1302means you can expect it to have some sensible content while the watcher 1647means you can expect it to have some sensible content while the watcher
1303is active, but you can also modify it. Modifying it may not do something 1648is active, but you can also modify it. Modifying it may not do something
1304sensible or take immediate effect (or do anything at all), but libev will 1649sensible or take immediate effect (or do anything at all), but libev will
1305not crash or malfunction in any way. 1650not crash or malfunction in any way.
1306.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" 1651.ie n .SS """ev_io"" \- is this file descriptor readable or writable?"
1307.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" 1652.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?"
1308.IX Subsection "ev_io - is this file descriptor readable or writable?" 1653.IX Subsection "ev_io - is this file descriptor readable or writable?"
1309I/O watchers check whether a file descriptor is readable or writable 1654I/O watchers check whether a file descriptor is readable or writable
1310in each iteration of the event loop, or, more precisely, when reading 1655in each iteration of the event loop, or, more precisely, when reading
1311would not block the process and writing would at least be able to write 1656would not block the process and writing would at least be able to write
1312some data. This behaviour is called level-triggering because you keep 1657some data. This behaviour is called level-triggering because you keep
1317In general you can register as many read and/or write event watchers per 1662In general you can register as many read and/or write event watchers per
1318fd as you want (as long as you don't confuse yourself). Setting all file 1663fd as you want (as long as you don't confuse yourself). Setting all file
1319descriptors to non-blocking mode is also usually a good idea (but not 1664descriptors to non-blocking mode is also usually a good idea (but not
1320required if you know what you are doing). 1665required if you know what you are doing).
1321.PP 1666.PP
1322If you cannot use non-blocking mode, then force the use of a
1323known-to-be-good backend (at the time of this writing, this includes only
1324\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
1325.PP
1326Another thing you have to watch out for is that it is quite easy to 1667Another thing you have to watch out for is that it is quite easy to
1327receive \*(L"spurious\*(R" readiness notifications, that is your callback might 1668receive \*(L"spurious\*(R" readiness notifications, that is, your callback might
1328be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block 1669be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
1329because there is no data. Not only are some backends known to create a 1670because there is no data. It is very easy to get into this situation even
1330lot of those (for example Solaris ports), it is very easy to get into 1671with a relatively standard program structure. Thus it is best to always
1331this situation even with a relatively standard program structure. Thus 1672use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning \f(CW\*(C`EAGAIN\*(C'\fR is far
1332it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
1333\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. 1673preferable to a program hanging until some data arrives.
1334.PP 1674.PP
1335If you cannot run the fd in non-blocking mode (for example you should 1675If you cannot run the fd in non-blocking mode (for example you should
1336not play around with an Xlib connection), then you have to separately 1676not play around with an Xlib connection), then you have to separately
1337re-test whether a file descriptor is really ready with a known-to-be good 1677re-test whether a file descriptor is really ready with a known-to-be good
1338interface such as poll (fortunately in our Xlib example, Xlib already 1678interface such as poll (fortunately in the case of Xlib, it already does
1339does this on its own, so its quite safe to use). Some people additionally 1679this on its own, so its quite safe to use). Some people additionally
1340use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block 1680use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block
1341indefinitely. 1681indefinitely.
1342.PP 1682.PP
1343But really, best use non-blocking mode. 1683But really, best use non-blocking mode.
1344.PP 1684.PP
1374.PP 1714.PP
1375There is no workaround possible except not registering events 1715There is no workaround possible except not registering events
1376for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to 1716for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1377\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1717\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1378.PP 1718.PP
1719\fIThe special problem of files\fR
1720.IX Subsection "The special problem of files"
1721.PP
1722Many people try to use \f(CW\*(C`select\*(C'\fR (or libev) on file descriptors
1723representing files, and expect it to become ready when their program
1724doesn't block on disk accesses (which can take a long time on their own).
1725.PP
1726However, this cannot ever work in the \*(L"expected\*(R" way \- you get a readiness
1727notification as soon as the kernel knows whether and how much data is
1728there, and in the case of open files, that's always the case, so you
1729always get a readiness notification instantly, and your read (or possibly
1730write) will still block on the disk I/O.
1731.PP
1732Another way to view it is that in the case of sockets, pipes, character
1733devices and so on, there is another party (the sender) that delivers data
1734on its own, but in the case of files, there is no such thing: the disk
1735will not send data on its own, simply because it doesn't know what you
1736wish to read \- you would first have to request some data.
1737.PP
1738Since files are typically not-so-well supported by advanced notification
1739mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1740to files, even though you should not use it. The reason for this is
1741convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT\s0, which is
1742usually a tty, often a pipe, but also sometimes files or special devices
1743(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1744\&\fI/dev/urandom\fR), and even though the file might better be served with
1745asynchronous I/O instead of with non-blocking I/O, it is still useful when
1746it \*(L"just works\*(R" instead of freezing.
1747.PP
1748So avoid file descriptors pointing to files when you know it (e.g. use
1749libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT\s0, or
1750when you rarely read from a file instead of from a socket, and want to
1751reuse the same code path.
1752.PP
1379\fIThe special problem of fork\fR 1753\fIThe special problem of fork\fR
1380.IX Subsection "The special problem of fork" 1754.IX Subsection "The special problem of fork"
1381.PP 1755.PP
1382Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1756Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit
1383useless behaviour. Libev fully supports fork, but needs to be told about 1757useless behaviour. Libev fully supports fork, but needs to be told about
1384it in the child. 1758it in the child if you want to continue to use it in the child.
1385.PP 1759.PP
1386To support fork in your programs, you either have to call 1760To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1387\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, 1761()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1388enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or 1762\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1389\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1390.PP 1763.PP
1391\fIThe special problem of \s-1SIGPIPE\s0\fR 1764\fIThe special problem of \s-1SIGPIPE\s0\fR
1392.IX Subsection "The special problem of SIGPIPE" 1765.IX Subsection "The special problem of SIGPIPE"
1393.PP 1766.PP
1394While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1767While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1397this is sensible behaviour, for daemons, this is usually undesirable. 1770this is sensible behaviour, for daemons, this is usually undesirable.
1398.PP 1771.PP
1399So when you encounter spurious, unexplained daemon exits, make sure you 1772So when you encounter spurious, unexplained daemon exits, make sure you
1400ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon 1773ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1401somewhere, as that would have given you a big clue). 1774somewhere, as that would have given you a big clue).
1775.PP
1776\fIThe special problem of \fIaccept()\fIing when you can't\fR
1777.IX Subsection "The special problem of accept()ing when you can't"
1778.PP
1779Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
1780found in post\-2004 Linux) have the peculiar behaviour of not removing a
1781connection from the pending queue in all error cases.
1782.PP
1783For example, larger servers often run out of file descriptors (because
1784of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not
1785rejecting the connection, leading to libev signalling readiness on
1786the next iteration again (the connection still exists after all), and
1787typically causing the program to loop at 100% \s-1CPU\s0 usage.
1788.PP
1789Unfortunately, the set of errors that cause this issue differs between
1790operating systems, there is usually little the app can do to remedy the
1791situation, and no known thread-safe method of removing the connection to
1792cope with overload is known (to me).
1793.PP
1794One of the easiest ways to handle this situation is to just ignore it
1795\&\- when the program encounters an overload, it will just loop until the
1796situation is over. While this is a form of busy waiting, no \s-1OS\s0 offers an
1797event-based way to handle this situation, so it's the best one can do.
1798.PP
1799A better way to handle the situation is to log any errors other than
1800\&\f(CW\*(C`EAGAIN\*(C'\fR and \f(CW\*(C`EWOULDBLOCK\*(C'\fR, making sure not to flood the log with such
1801messages, and continue as usual, which at least gives the user an idea of
1802what could be wrong (\*(L"raise the ulimit!\*(R"). For extra points one could stop
1803the \f(CW\*(C`ev_io\*(C'\fR watcher on the listening fd \*(L"for a while\*(R", which reduces \s-1CPU\s0
1804usage.
1805.PP
1806If your program is single-threaded, then you could also keep a dummy file
1807descriptor for overload situations (e.g. by opening \fI/dev/null\fR), and
1808when 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,
1809close that fd, and create a new dummy fd. This will gracefully refuse
1810clients under typical overload conditions.
1811.PP
1812The last way to handle it is to simply log the error and \f(CW\*(C`exit\*(C'\fR, as
1813is often done with \f(CW\*(C`malloc\*(C'\fR failures, but this results in an easy
1814opportunity for a DoS attack.
1402.PP 1815.PP
1403\fIWatcher-Specific Functions\fR 1816\fIWatcher-Specific Functions\fR
1404.IX Subsection "Watcher-Specific Functions" 1817.IX Subsection "Watcher-Specific Functions"
1405.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1818.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
1406.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1819.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
1436\& ... 1849\& ...
1437\& struct ev_loop *loop = ev_default_init (0); 1850\& struct ev_loop *loop = ev_default_init (0);
1438\& ev_io stdin_readable; 1851\& ev_io stdin_readable;
1439\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1852\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1440\& ev_io_start (loop, &stdin_readable); 1853\& ev_io_start (loop, &stdin_readable);
1441\& ev_loop (loop, 0); 1854\& ev_run (loop, 0);
1442.Ve 1855.Ve
1443.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" 1856.ie n .SS """ev_timer"" \- relative and optionally repeating timeouts"
1444.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" 1857.el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
1445.IX Subsection "ev_timer - relative and optionally repeating timeouts" 1858.IX Subsection "ev_timer - relative and optionally repeating timeouts"
1446Timer watchers are simple relative timers that generate an event after a 1859Timer watchers are simple relative timers that generate an event after a
1447given time, and optionally repeating in regular intervals after that. 1860given time, and optionally repeating in regular intervals after that.
1448.PP 1861.PP
1449The timers are based on real time, that is, if you register an event that 1862The timers are based on real time, that is, if you register an event that
1451year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because 1864year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because
1452detecting time jumps is hard, and some inaccuracies are unavoidable (the 1865detecting time jumps is hard, and some inaccuracies are unavoidable (the
1453monotonic clock option helps a lot here). 1866monotonic clock option helps a lot here).
1454.PP 1867.PP
1455The callback is guaranteed to be invoked only \fIafter\fR its timeout has 1868The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1456passed, but if multiple timers become ready during the same loop iteration 1869passed (not \fIat\fR, so on systems with very low-resolution clocks this
1457then order of execution is undefined. 1870might introduce a small delay). If multiple timers become ready during the
1871same loop iteration then the ones with earlier time-out values are invoked
1872before ones of the same priority with later time-out values (but this is
1873no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1458.PP 1874.PP
1459\fIBe smart about timeouts\fR 1875\fIBe smart about timeouts\fR
1460.IX Subsection "Be smart about timeouts" 1876.IX Subsection "Be smart about timeouts"
1461.PP 1877.PP
1462Many real-world problems involve some kind of timeout, usually for error 1878Many real-world problems involve some kind of timeout, usually for error
1509member and \f(CW\*(C`ev_timer_again\*(C'\fR. 1925member and \f(CW\*(C`ev_timer_again\*(C'\fR.
1510.Sp 1926.Sp
1511At start: 1927At start:
1512.Sp 1928.Sp
1513.Vb 3 1929.Vb 3
1514\& ev_timer_init (timer, callback); 1930\& ev_init (timer, callback);
1515\& timer\->repeat = 60.; 1931\& timer\->repeat = 60.;
1516\& ev_timer_again (loop, timer); 1932\& ev_timer_again (loop, timer);
1517.Ve 1933.Ve
1518.Sp 1934.Sp
1519Each time there is some activity: 1935Each time there is some activity:
1556\& ev_tstamp timeout = last_activity + 60.; 1972\& ev_tstamp timeout = last_activity + 60.;
1557\& 1973\&
1558\& // if last_activity + 60. is older than now, we did time out 1974\& // if last_activity + 60. is older than now, we did time out
1559\& if (timeout < now) 1975\& if (timeout < now)
1560\& { 1976\& {
1561\& // timeout occured, take action 1977\& // timeout occurred, take action
1562\& } 1978\& }
1563\& else 1979\& else
1564\& { 1980\& {
1565\& // callback was invoked, but there was some activity, re\-arm 1981\& // callback was invoked, but there was some activity, re\-arm
1566\& // the watcher to fire in last_activity + 60, which is 1982\& // the watcher to fire in last_activity + 60, which is
1588To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR 2004To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR
1589to the current time (meaning we just have some activity :), then call the 2005to the current time (meaning we just have some activity :), then call the
1590callback, which will \*(L"do the right thing\*(R" and start the timer: 2006callback, which will \*(L"do the right thing\*(R" and start the timer:
1591.Sp 2007.Sp
1592.Vb 3 2008.Vb 3
1593\& ev_timer_init (timer, callback); 2009\& ev_init (timer, callback);
1594\& last_activity = ev_now (loop); 2010\& last_activity = ev_now (loop);
1595\& callback (loop, timer, EV_TIMEOUT); 2011\& callback (loop, timer, EV_TIMER);
1596.Ve 2012.Ve
1597.Sp 2013.Sp
1598And when there is some activity, simply store the current time in 2014And when there is some activity, simply store the current time in
1599\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: 2015\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
1600.Sp 2016.Sp
1601.Vb 1 2017.Vb 1
1602\& last_actiivty = ev_now (loop); 2018\& last_activity = ev_now (loop);
1603.Ve 2019.Ve
1604.Sp 2020.Sp
1605This technique is slightly more complex, but in most cases where the 2021This technique is slightly more complex, but in most cases where the
1606time-out is unlikely to be triggered, much more efficient. 2022time-out is unlikely to be triggered, much more efficient.
1607.Sp 2023.Sp
1644\fIThe special problem of time updates\fR 2060\fIThe special problem of time updates\fR
1645.IX Subsection "The special problem of time updates" 2061.IX Subsection "The special problem of time updates"
1646.PP 2062.PP
1647Establishing the current time is a costly operation (it usually takes at 2063Establishing the current time is a costly operation (it usually takes at
1648least two system calls): \s-1EV\s0 therefore updates its idea of the current 2064least two system calls): \s-1EV\s0 therefore updates its idea of the current
1649time only before and after \f(CW\*(C`ev_loop\*(C'\fR collects new events, which causes a 2065time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a
1650growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling 2066growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
1651lots of events in one iteration. 2067lots of events in one iteration.
1652.PP 2068.PP
1653The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2069The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
1654time. This is usually the right thing as this timestamp refers to the time 2070time. This is usually the right thing as this timestamp refers to the time
1661.Ve 2077.Ve
1662.PP 2078.PP
1663If the event loop is suspended for a long time, you can also force an 2079If the event loop is suspended for a long time, you can also force an
1664update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 2080update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
1665()\*(C'\fR. 2081()\*(C'\fR.
2082.PP
2083\fIThe special problems of suspended animation\fR
2084.IX Subsection "The special problems of suspended animation"
2085.PP
2086When you leave the server world it is quite customary to hit machines that
2087can suspend/hibernate \- what happens to the clocks during such a suspend?
2088.PP
2089Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
2090all processes, while the clocks (\f(CW\*(C`times\*(C'\fR, \f(CW\*(C`CLOCK_MONOTONIC\*(C'\fR) continue
2091to run until the system is suspended, but they will not advance while the
2092system is suspended. That means, on resume, it will be as if the program
2093was frozen for a few seconds, but the suspend time will not be counted
2094towards \f(CW\*(C`ev_timer\*(C'\fR when a monotonic clock source is used. The real time
2095clock advanced as expected, but if it is used as sole clocksource, then a
2096long suspend would be detected as a time jump by libev, and timers would
2097be adjusted accordingly.
2098.PP
2099I would not be surprised to see different behaviour in different between
2100operating systems, \s-1OS\s0 versions or even different hardware.
2101.PP
2102The other form of suspend (job control, or sending a \s-1SIGSTOP\s0) will see a
2103time jump in the monotonic clocks and the realtime clock. If the program
2104is suspended for a very long time, and monotonic clock sources are in use,
2105then you can expect \f(CW\*(C`ev_timer\*(C'\fRs to expire as the full suspension time
2106will be counted towards the timers. When no monotonic clock source is in
2107use, then libev will again assume a timejump and adjust accordingly.
2108.PP
2109It might be beneficial for this latter case to call \f(CW\*(C`ev_suspend\*(C'\fR
2110and \f(CW\*(C`ev_resume\*(C'\fR in code that handles \f(CW\*(C`SIGTSTP\*(C'\fR, to at least get
2111deterministic behaviour in this case (you can do nothing against
2112\&\f(CW\*(C`SIGSTOP\*(C'\fR).
1666.PP 2113.PP
1667\fIWatcher-Specific Functions and Data Members\fR 2114\fIWatcher-Specific Functions and Data Members\fR
1668.IX Subsection "Watcher-Specific Functions and Data Members" 2115.IX Subsection "Watcher-Specific Functions and Data Members"
1669.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 2116.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
1670.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2117.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
1695If the timer is repeating, either start it if necessary (with the 2142If the timer is repeating, either start it if necessary (with the
1696\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 2143\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
1697.Sp 2144.Sp
1698This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a 2145This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
1699usage example. 2146usage example.
2147.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
2148.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
2149Returns the remaining time until a timer fires. If the timer is active,
2150then this time is relative to the current event loop time, otherwise it's
2151the timeout value currently configured.
2152.Sp
2153That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns
2154\&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remaining\*(C'\fR
2155will return \f(CW4\fR. When the timer expires and is restarted, it will return
2156roughly \f(CW7\fR (likely slightly less as callback invocation takes some time,
2157too), and so on.
1700.IP "ev_tstamp repeat [read\-write]" 4 2158.IP "ev_tstamp repeat [read\-write]" 4
1701.IX Item "ev_tstamp repeat [read-write]" 2159.IX Item "ev_tstamp repeat [read-write]"
1702The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 2160The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1703or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any), 2161or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any),
1704which is also when any modifications are taken into account. 2162which is also when any modifications are taken into account.
1731\& } 2189\& }
1732\& 2190\&
1733\& ev_timer mytimer; 2191\& ev_timer mytimer;
1734\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 2192\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1735\& ev_timer_again (&mytimer); /* start timer */ 2193\& ev_timer_again (&mytimer); /* start timer */
1736\& ev_loop (loop, 0); 2194\& ev_run (loop, 0);
1737\& 2195\&
1738\& // and in some piece of code that gets executed on any "activity": 2196\& // and in some piece of code that gets executed on any "activity":
1739\& // reset the timeout to start ticking again at 10 seconds 2197\& // reset the timeout to start ticking again at 10 seconds
1740\& ev_timer_again (&mytimer); 2198\& ev_timer_again (&mytimer);
1741.Ve 2199.Ve
1742.ie n .Sh """ev_periodic"" \- to cron or not to cron?" 2200.ie n .SS """ev_periodic"" \- to cron or not to cron?"
1743.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" 2201.el .SS "\f(CWev_periodic\fP \- to cron or not to cron?"
1744.IX Subsection "ev_periodic - to cron or not to cron?" 2202.IX Subsection "ev_periodic - to cron or not to cron?"
1745Periodic watchers are also timers of a kind, but they are very versatile 2203Periodic watchers are also timers of a kind, but they are very versatile
1746(and unfortunately a bit complex). 2204(and unfortunately a bit complex).
1747.PP 2205.PP
1748Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 2206Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
1749but on wall clock time (absolute time). You can tell a periodic watcher 2207relative time, the physical time that passes) but on wall clock time
1750to trigger after some specific point in time. For example, if you tell a 2208(absolute time, the thing you can read on your calender or clock). The
1751periodic watcher to trigger in 10 seconds (by specifying e.g. \f(CW\*(C`ev_now () 2209difference is that wall clock time can run faster or slower than real
1752+ 10.\*(C'\fR, that is, an absolute time not a delay) and then reset your system 2210time, and time jumps are not uncommon (e.g. when you adjust your
1753clock to January of the previous year, then it will take more than year 2211wrist-watch).
1754to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would still trigger
1755roughly 10 seconds later as it uses a relative timeout).
1756.PP 2212.PP
2213You can tell a periodic watcher to trigger after some specific point
2214in time: for example, if you tell a periodic watcher to trigger \*(L"in 10
2215seconds\*(R" (by specifying e.g. \f(CW\*(C`ev_now () + 10.\*(C'\fR, that is, an absolute time
2216not a delay) and then reset your system clock to January of the previous
2217year, then it will take a year or more to trigger the event (unlike an
2218\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2219it, as it uses a relative timeout).
2220.PP
1757\&\f(CW\*(C`ev_periodic\*(C'\fRs can also be used to implement vastly more complex timers, 2221\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
1758such as triggering an event on each \*(L"midnight, local time\*(R", or other 2222timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
1759complicated rules. 2223other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as
2224those cannot react to time jumps.
1760.PP 2225.PP
1761As with timers, the callback is guaranteed to be invoked only when the 2226As with timers, the callback is guaranteed to be invoked only when the
1762time (\f(CW\*(C`at\*(C'\fR) has passed, but if multiple periodic timers become ready 2227point in time where it is supposed to trigger has passed. If multiple
1763during the same loop iteration, then order of execution is undefined. 2228timers become ready during the same loop iteration then the ones with
2229earlier time-out values are invoked before ones with later time-out values
2230(but this is no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1764.PP 2231.PP
1765\fIWatcher-Specific Functions and Data Members\fR 2232\fIWatcher-Specific Functions and Data Members\fR
1766.IX Subsection "Watcher-Specific Functions and Data Members" 2233.IX Subsection "Watcher-Specific Functions and Data Members"
1767.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 2234.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1768.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 2235.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1769.PD 0 2236.PD 0
1770.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 2237.IP "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1771.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 2238.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1772.PD 2239.PD
1773Lots of arguments, lets sort it out... There are basically three modes of 2240Lots of arguments, let's sort it out... There are basically three modes of
1774operation, and we will explain them from simplest to most complex: 2241operation, and we will explain them from simplest to most complex:
1775.RS 4 2242.RS 4
1776.IP "\(bu" 4 2243.IP "\(bu" 4
1777absolute timer (at = time, interval = reschedule_cb = 0) 2244absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1778.Sp 2245.Sp
1779In this configuration the watcher triggers an event after the wall clock 2246In this configuration the watcher triggers an event after the wall clock
1780time \f(CW\*(C`at\*(C'\fR has passed. It will not repeat and will not adjust when a time 2247time \f(CW\*(C`offset\*(C'\fR has passed. It will not repeat and will not adjust when a
1781jump occurs, that is, if it is to be run at January 1st 2011 then it will 2248time jump occurs, that is, if it is to be run at January 1st 2011 then it
1782only run when the system clock reaches or surpasses this time. 2249will be stopped and invoked when the system clock reaches or surpasses
2250this point in time.
1783.IP "\(bu" 4 2251.IP "\(bu" 4
1784repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 2252repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1785.Sp 2253.Sp
1786In this mode the watcher will always be scheduled to time out at the next 2254In this mode the watcher will always be scheduled to time out at the next
1787\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) 2255\&\f(CW\*(C`offset + N * interval\*(C'\fR time (for some integer N, which can also be
1788and then repeat, regardless of any time jumps. 2256negative) and then repeat, regardless of any time jumps. The \f(CW\*(C`offset\*(C'\fR
2257argument is merely an offset into the \f(CW\*(C`interval\*(C'\fR periods.
1789.Sp 2258.Sp
1790This can be used to create timers that do not drift with respect to the 2259This can be used to create timers that do not drift with respect to the
1791system clock, for example, here is a \f(CW\*(C`ev_periodic\*(C'\fR that triggers each 2260system clock, for example, here is an \f(CW\*(C`ev_periodic\*(C'\fR that triggers each
1792hour, on the hour: 2261hour, on the hour (with respect to \s-1UTC\s0):
1793.Sp 2262.Sp
1794.Vb 1 2263.Vb 1
1795\& ev_periodic_set (&periodic, 0., 3600., 0); 2264\& ev_periodic_set (&periodic, 0., 3600., 0);
1796.Ve 2265.Ve
1797.Sp 2266.Sp
1800full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible 2269full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible
1801by 3600. 2270by 3600.
1802.Sp 2271.Sp
1803Another way to think about it (for the mathematically inclined) is that 2272Another way to think about it (for the mathematically inclined) is that
1804\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2273\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
1805time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 2274time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
1806.Sp 2275.Sp
1807For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near 2276For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near
1808\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 2277\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
1809this value, and in fact is often specified as zero. 2278this value, and in fact is often specified as zero.
1810.Sp 2279.Sp
1811Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 2280Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
1812speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability 2281speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
1813will of course deteriorate. Libev itself tries to be exact to be about one 2282will of course deteriorate. Libev itself tries to be exact to be about one
1814millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). 2283millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
1815.IP "\(bu" 4 2284.IP "\(bu" 4
1816manual reschedule mode (at and interval ignored, reschedule_cb = callback) 2285manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1817.Sp 2286.Sp
1818In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 2287In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
1819ignored. Instead, each time the periodic watcher gets scheduled, the 2288ignored. Instead, each time the periodic watcher gets scheduled, the
1820reschedule callback will be called with the watcher as first, and the 2289reschedule callback will be called with the watcher as first, and the
1821current time as second argument. 2290current time as second argument.
1822.Sp 2291.Sp
1823\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, 2292\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever,
1824ever, or make \s-1ANY\s0 event loop modifications whatsoever\fR. 2293or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2294allowed by documentation here\fR.
1825.Sp 2295.Sp
1826If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2296If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
1827it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2297it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
1828only event loop modification you are allowed to do). 2298only event loop modification you are allowed to do).
1829.Sp 2299.Sp
1860when you changed some parameters or the reschedule callback would return 2330when you changed some parameters or the reschedule callback would return
1861a different time than the last time it was called (e.g. in a crond like 2331a different time than the last time it was called (e.g. in a crond like
1862program when the crontabs have changed). 2332program when the crontabs have changed).
1863.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4 2333.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4
1864.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)" 2334.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)"
1865When active, returns the absolute time that the watcher is supposed to 2335When active, returns the absolute time that the watcher is supposed
1866trigger next. 2336to trigger next. This is not the same as the \f(CW\*(C`offset\*(C'\fR argument to
2337\&\f(CW\*(C`ev_periodic_set\*(C'\fR, but indeed works even in interval and manual
2338rescheduling modes.
1867.IP "ev_tstamp offset [read\-write]" 4 2339.IP "ev_tstamp offset [read\-write]" 4
1868.IX Item "ev_tstamp offset [read-write]" 2340.IX Item "ev_tstamp offset [read-write]"
1869When repeating, this contains the offset value, otherwise this is the 2341When repeating, this contains the offset value, otherwise this is the
1870absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). 2342absolute point in time (the \f(CW\*(C`offset\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR,
2343although libev might modify this value for better numerical stability).
1871.Sp 2344.Sp
1872Can be modified any time, but changes only take effect when the periodic 2345Can be modified any time, but changes only take effect when the periodic
1873timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. 2346timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1874.IP "ev_tstamp interval [read\-write]" 4 2347.IP "ev_tstamp interval [read\-write]" 4
1875.IX Item "ev_tstamp interval [read-write]" 2348.IX Item "ev_tstamp interval [read-write]"
1889system time is divisible by 3600. The callback invocation times have 2362system time is divisible by 3600. The callback invocation times have
1890potentially a lot of jitter, but good long-term stability. 2363potentially a lot of jitter, but good long-term stability.
1891.PP 2364.PP
1892.Vb 5 2365.Vb 5
1893\& static void 2366\& static void
1894\& clock_cb (struct ev_loop *loop, ev_io *w, int revents) 2367\& clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1895\& { 2368\& {
1896\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 2369\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1897\& } 2370\& }
1898\& 2371\&
1899\& ev_periodic hourly_tick; 2372\& ev_periodic hourly_tick;
1921\& ev_periodic hourly_tick; 2394\& ev_periodic hourly_tick;
1922\& ev_periodic_init (&hourly_tick, clock_cb, 2395\& ev_periodic_init (&hourly_tick, clock_cb,
1923\& fmod (ev_now (loop), 3600.), 3600., 0); 2396\& fmod (ev_now (loop), 3600.), 3600., 0);
1924\& ev_periodic_start (loop, &hourly_tick); 2397\& ev_periodic_start (loop, &hourly_tick);
1925.Ve 2398.Ve
1926.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" 2399.ie n .SS """ev_signal"" \- signal me when a signal gets signalled!"
1927.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" 2400.el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1928.IX Subsection "ev_signal - signal me when a signal gets signalled!" 2401.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1929Signal watchers will trigger an event when the process receives a specific 2402Signal watchers will trigger an event when the process receives a specific
1930signal one or more times. Even though signals are very asynchronous, libev 2403signal one or more times. Even though signals are very asynchronous, libev
1931will try it's best to deliver signals synchronously, i.e. as part of the 2404will try its best to deliver signals synchronously, i.e. as part of the
1932normal event processing, like any other event. 2405normal event processing, like any other event.
1933.PP 2406.PP
1934If you want signals asynchronously, just use \f(CW\*(C`sigaction\*(C'\fR as you would 2407If you want signals to be delivered truly asynchronously, just use
1935do without libev and forget about sharing the signal. You can even use 2408\&\f(CW\*(C`sigaction\*(C'\fR as you would do without libev and forget about sharing
1936\&\f(CW\*(C`ev_async\*(C'\fR from a signal handler to synchronously wake up an event loop. 2409the signal. You can even use \f(CW\*(C`ev_async\*(C'\fR from a signal handler to
2410synchronously wake up an event loop.
1937.PP 2411.PP
1938You can configure as many watchers as you like per signal. Only when the 2412You can configure as many watchers as you like for the same signal, but
2413only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
2414default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
2415\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
2416the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2417.PP
1939first watcher gets started will libev actually register a signal handler 2418When the first watcher gets started will libev actually register something
1940with the kernel (thus it coexists with your own signal handlers as long as 2419with the kernel (thus it coexists with your own signal handlers as long as
1941you don't register any with libev for the same signal). Similarly, when 2420you don't register any with libev for the same signal).
1942the last signal watcher for a signal is stopped, libev will reset the
1943signal handler to \s-1SIG_DFL\s0 (regardless of what it was set to before).
1944.PP 2421.PP
1945If possible and supported, libev will install its handlers with 2422If possible and supported, libev will install its handlers with
1946\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so system calls should not be unduly 2423\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
1947interrupted. If you have a problem with system calls getting interrupted by 2424not be unduly interrupted. If you have a problem with system calls getting
1948signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock 2425interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
1949them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher. 2426and unblock them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
2427.PP
2428\fIThe special problem of inheritance over fork/execve/pthread_create\fR
2429.IX Subsection "The special problem of inheritance over fork/execve/pthread_create"
2430.PP
2431Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition
2432(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after
2433stopping it again), that is, libev might or might not block the signal,
2434and might or might not set or restore the installed signal handler.
2435.PP
2436While this does not matter for the signal disposition (libev never
2437sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on
2438\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect
2439certain signals to be blocked.
2440.PP
2441This means that before calling \f(CW\*(C`exec\*(C'\fR (from the child) you should reset
2442the signal mask to whatever \*(L"default\*(R" you expect (all clear is a good
2443choice usually).
2444.PP
2445The simplest way to ensure that the signal mask is reset in the child is
2446to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will
2447catch fork calls done by libraries (such as the libc) as well.
2448.PP
2449In current versions of libev, the signal will not be blocked indefinitely
2450unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API\s0 (\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
2451the window of opportunity for problems, it will not go away, as libev
2452\&\fIhas\fR to modify the signal mask, at least temporarily.
2453.PP
2454So I can't stress this enough: \fIIf you do not reset your signal mask when
2455you expect it to be empty, you have a race condition in your code\fR. This
2456is not a libev-specific thing, this is true for most event libraries.
2457.PP
2458\fIThe special problem of threads signal handling\fR
2459.IX Subsection "The special problem of threads signal handling"
2460.PP
2461\&\s-1POSIX\s0 threads has problematic signal handling semantics, specifically,
2462a lot of functionality (sigfd, sigwait etc.) only really works if all
2463threads in a process block signals, which is hard to achieve.
2464.PP
2465When you want to use sigwait (or mix libev signal handling with your own
2466for the same signals), you can tackle this problem by globally blocking
2467all signals before creating any threads (or creating them with a fully set
2468sigprocmask) and also specifying the \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when creating
2469loops. Then designate one thread as \*(L"signal receiver thread\*(R" which handles
2470these signals. You can pass on any signals that libev might be interested
2471in by calling \f(CW\*(C`ev_feed_signal\*(C'\fR.
1950.PP 2472.PP
1951\fIWatcher-Specific Functions and Data Members\fR 2473\fIWatcher-Specific Functions and Data Members\fR
1952.IX Subsection "Watcher-Specific Functions and Data Members" 2474.IX Subsection "Watcher-Specific Functions and Data Members"
1953.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 2475.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
1954.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 2476.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
1969.PP 2491.PP
1970.Vb 5 2492.Vb 5
1971\& static void 2493\& static void
1972\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2494\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1973\& { 2495\& {
1974\& ev_unloop (loop, EVUNLOOP_ALL); 2496\& ev_break (loop, EVBREAK_ALL);
1975\& } 2497\& }
1976\& 2498\&
1977\& ev_signal signal_watcher; 2499\& ev_signal signal_watcher;
1978\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 2500\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1979\& ev_signal_start (loop, &signal_watcher); 2501\& ev_signal_start (loop, &signal_watcher);
1980.Ve 2502.Ve
1981.ie n .Sh """ev_child"" \- watch out for process status changes" 2503.ie n .SS """ev_child"" \- watch out for process status changes"
1982.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 2504.el .SS "\f(CWev_child\fP \- watch out for process status changes"
1983.IX Subsection "ev_child - watch out for process status changes" 2505.IX Subsection "ev_child - watch out for process status changes"
1984Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 2506Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1985some child status changes (most typically when a child of yours dies or 2507some child status changes (most typically when a child of yours dies or
1986exits). It is permissible to install a child watcher \fIafter\fR the child 2508exits). It is permissible to install a child watcher \fIafter\fR the child
1987has been forked (which implies it might have already exited), as long 2509has been forked (which implies it might have already exited), as long
1988as the event loop isn't entered (or is continued from a watcher), i.e., 2510as the event loop isn't entered (or is continued from a watcher), i.e.,
1989forking and then immediately registering a watcher for the child is fine, 2511forking and then immediately registering a watcher for the child is fine,
1990but forking and registering a watcher a few event loop iterations later is 2512but forking and registering a watcher a few event loop iterations later or
1991not. 2513in the next callback invocation is not.
1992.PP 2514.PP
1993Only the default event loop is capable of handling signals, and therefore 2515Only the default event loop is capable of handling signals, and therefore
1994you can only register child watchers in the default event loop. 2516you can only register child watchers in the default event loop.
1995.PP 2517.PP
2518Due to some design glitches inside libev, child watchers will always be
2519handled at maximum priority (their priority is set to \f(CW\*(C`EV_MAXPRI\*(C'\fR by
2520libev)
2521.PP
1996\fIProcess Interaction\fR 2522\fIProcess Interaction\fR
1997.IX Subsection "Process Interaction" 2523.IX Subsection "Process Interaction"
1998.PP 2524.PP
1999Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is 2525Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
2000initialised. This is necessary to guarantee proper behaviour even if 2526initialised. This is necessary to guarantee proper behaviour even if the
2001the first child watcher is started after the child exits. The occurrence 2527first child watcher is started after the child exits. The occurrence
2002of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done 2528of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
2003synchronously as part of the event loop processing. Libev always reaps all 2529synchronously as part of the event loop processing. Libev always reaps all
2004children, even ones not watched. 2530children, even ones not watched.
2005.PP 2531.PP
2006\fIOverriding the Built-In Processing\fR 2532\fIOverriding the Built-In Processing\fR
2018.IX Subsection "Stopping the Child Watcher" 2544.IX Subsection "Stopping the Child Watcher"
2019.PP 2545.PP
2020Currently, the child watcher never gets stopped, even when the 2546Currently, the child watcher never gets stopped, even when the
2021child terminates, so normally one needs to stop the watcher in the 2547child terminates, so normally one needs to stop the watcher in the
2022callback. Future versions of libev might stop the watcher automatically 2548callback. Future versions of libev might stop the watcher automatically
2023when a child exit is detected. 2549when a child exit is detected (calling \f(CW\*(C`ev_child_stop\*(C'\fR twice is not a
2550problem).
2024.PP 2551.PP
2025\fIWatcher-Specific Functions and Data Members\fR 2552\fIWatcher-Specific Functions and Data Members\fR
2026.IX Subsection "Watcher-Specific Functions and Data Members" 2553.IX Subsection "Watcher-Specific Functions and Data Members"
2027.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4 2554.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
2028.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)" 2555.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
2078\& { 2605\& {
2079\& ev_child_init (&cw, child_cb, pid, 0); 2606\& ev_child_init (&cw, child_cb, pid, 0);
2080\& ev_child_start (EV_DEFAULT_ &cw); 2607\& ev_child_start (EV_DEFAULT_ &cw);
2081\& } 2608\& }
2082.Ve 2609.Ve
2083.ie n .Sh """ev_stat"" \- did the file attributes just change?" 2610.ie n .SS """ev_stat"" \- did the file attributes just change?"
2084.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" 2611.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2085.IX Subsection "ev_stat - did the file attributes just change?" 2612.IX Subsection "ev_stat - did the file attributes just change?"
2086This watches a file system path for attribute changes. That is, it calls 2613This watches a file system path for attribute changes. That is, it calls
2087\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) 2614\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2088and sees if it changed compared to the last time, invoking the callback if 2615and sees if it changed compared to the last time, invoking the callback if
2089it did. 2616it did.
2303\& ... 2830\& ...
2304\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); 2831\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
2305\& ev_stat_start (loop, &passwd); 2832\& ev_stat_start (loop, &passwd);
2306\& ev_timer_init (&timer, timer_cb, 0., 1.02); 2833\& ev_timer_init (&timer, timer_cb, 0., 1.02);
2307.Ve 2834.Ve
2308.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 2835.ie n .SS """ev_idle"" \- when you've got nothing better to do..."
2309.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 2836.el .SS "\f(CWev_idle\fP \- when you've got nothing better to do..."
2310.IX Subsection "ev_idle - when you've got nothing better to do..." 2837.IX Subsection "ev_idle - when you've got nothing better to do..."
2311Idle watchers trigger events when no other events of the same or higher 2838Idle watchers trigger events when no other events of the same or higher
2312priority are pending (prepare, check and other idle watchers do not count 2839priority are pending (prepare, check and other idle watchers do not count
2313as receiving \*(L"events\*(R"). 2840as receiving \*(L"events\*(R").
2314.PP 2841.PP
2327\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the 2854\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2328event loop has handled all outstanding events. 2855event loop has handled all outstanding events.
2329.PP 2856.PP
2330\fIWatcher-Specific Functions and Data Members\fR 2857\fIWatcher-Specific Functions and Data Members\fR
2331.IX Subsection "Watcher-Specific Functions and Data Members" 2858.IX Subsection "Watcher-Specific Functions and Data Members"
2332.IP "ev_idle_init (ev_signal *, callback)" 4 2859.IP "ev_idle_init (ev_idle *, callback)" 4
2333.IX Item "ev_idle_init (ev_signal *, callback)" 2860.IX Item "ev_idle_init (ev_idle *, callback)"
2334Initialises and configures the idle watcher \- it has no parameters of any 2861Initialises and configures the idle watcher \- it has no parameters of any
2335kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 2862kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
2336believe me. 2863believe me.
2337.PP 2864.PP
2338\fIExamples\fR 2865\fIExamples\fR
2350\& // no longer anything immediate to do. 2877\& // no longer anything immediate to do.
2351\& } 2878\& }
2352\& 2879\&
2353\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2880\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2354\& ev_idle_init (idle_watcher, idle_cb); 2881\& ev_idle_init (idle_watcher, idle_cb);
2355\& ev_idle_start (loop, idle_cb); 2882\& ev_idle_start (loop, idle_watcher);
2356.Ve 2883.Ve
2357.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" 2884.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
2358.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 2885.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
2359.IX Subsection "ev_prepare and ev_check - customise your event loop!" 2886.IX Subsection "ev_prepare and ev_check - customise your event loop!"
2360Prepare and check watchers are usually (but not always) used in pairs: 2887Prepare and check watchers are usually (but not always) used in pairs:
2361prepare watchers get invoked before the process blocks and check watchers 2888prepare watchers get invoked before the process blocks and check watchers
2362afterwards. 2889afterwards.
2363.PP 2890.PP
2364You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter 2891You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter
2365the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 2892the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
2366watchers. Other loops than the current one are fine, however. The 2893watchers. Other loops than the current one are fine, however. The
2367rationale behind this is that you do not need to check for recursion in 2894rationale behind this is that you do not need to check for recursion in
2368those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 2895those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking,
2369\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 2896\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be
2453\& struct pollfd fds [nfd]; 2980\& struct pollfd fds [nfd];
2454\& // actual code will need to loop here and realloc etc. 2981\& // actual code will need to loop here and realloc etc.
2455\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2982\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2456\& 2983\&
2457\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */ 2984\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
2458\& ev_timer_init (&tw, 0, timeout * 1e\-3); 2985\& ev_timer_init (&tw, 0, timeout * 1e\-3, 0.);
2459\& ev_timer_start (loop, &tw); 2986\& ev_timer_start (loop, &tw);
2460\& 2987\&
2461\& // create one ev_io per pollfd 2988\& // create one ev_io per pollfd
2462\& for (int i = 0; i < nfd; ++i) 2989\& for (int i = 0; i < nfd; ++i)
2463\& { 2990\& {
2541\& 3068\&
2542\& if (timeout >= 0) 3069\& if (timeout >= 0)
2543\& // create/start timer 3070\& // create/start timer
2544\& 3071\&
2545\& // poll 3072\& // poll
2546\& ev_loop (EV_A_ 0); 3073\& ev_run (EV_A_ 0);
2547\& 3074\&
2548\& // stop timer again 3075\& // stop timer again
2549\& if (timeout >= 0) 3076\& if (timeout >= 0)
2550\& ev_timer_stop (EV_A_ &to); 3077\& ev_timer_stop (EV_A_ &to);
2551\& 3078\&
2554\& ev_io_stop (EV_A_ iow [n]); 3081\& ev_io_stop (EV_A_ iow [n]);
2555\& 3082\&
2556\& return got_events; 3083\& return got_events;
2557\& } 3084\& }
2558.Ve 3085.Ve
2559.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 3086.ie n .SS """ev_embed"" \- when one backend isn't enough..."
2560.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 3087.el .SS "\f(CWev_embed\fP \- when one backend isn't enough..."
2561.IX Subsection "ev_embed - when one backend isn't enough..." 3088.IX Subsection "ev_embed - when one backend isn't enough..."
2562This is a rather advanced watcher type that lets you embed one event loop 3089This is a rather advanced watcher type that lets you embed one event loop
2563into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded 3090into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
2564loop, other types of watchers might be handled in a delayed or incorrect 3091loop, other types of watchers might be handled in a delayed or incorrect
2565fashion and must not be used). 3092fashion and must not be used).
2629to invoke it (it will continue to be called until the sweep has been done, 3156to invoke it (it will continue to be called until the sweep has been done,
2630if you do not want that, you need to temporarily stop the embed watcher). 3157if you do not want that, you need to temporarily stop the embed watcher).
2631.IP "ev_embed_sweep (loop, ev_embed *)" 4 3158.IP "ev_embed_sweep (loop, ev_embed *)" 4
2632.IX Item "ev_embed_sweep (loop, ev_embed *)" 3159.IX Item "ev_embed_sweep (loop, ev_embed *)"
2633Make a single, non-blocking sweep over the embedded loop. This works 3160Make a single, non-blocking sweep over the embedded loop. This works
2634similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 3161similarly to \f(CW\*(C`ev_run (embedded_loop, EVRUN_NOWAIT)\*(C'\fR, but in the most
2635appropriate way for embedded loops. 3162appropriate way for embedded loops.
2636.IP "struct ev_loop *other [read\-only]" 4 3163.IP "struct ev_loop *other [read\-only]" 4
2637.IX Item "struct ev_loop *other [read-only]" 3164.IX Item "struct ev_loop *other [read-only]"
2638The embedded event loop. 3165The embedded event loop.
2639.PP 3166.PP
2687\& if (!loop_socket) 3214\& if (!loop_socket)
2688\& loop_socket = loop; 3215\& loop_socket = loop;
2689\& 3216\&
2690\& // now use loop_socket for all sockets, and loop for everything else 3217\& // now use loop_socket for all sockets, and loop for everything else
2691.Ve 3218.Ve
2692.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" 3219.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
2693.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 3220.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2694.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 3221.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2695Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 3222Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2696whoever is a good citizen cared to tell libev about it by calling 3223whoever is a good citizen cared to tell libev about it by calling
2697\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 3224\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the
2698event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 3225event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called,
2699and only in the child after the fork. If whoever good citizen calling 3226and only in the child after the fork. If whoever good citizen calling
2700\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 3227\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
2701handlers will be invoked, too, of course. 3228handlers will be invoked, too, of course.
2702.PP 3229.PP
3230\fIThe special problem of life after fork \- how is it possible?\fR
3231.IX Subsection "The special problem of life after fork - how is it possible?"
3232.PP
3233Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set
3234up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3235sequence should be handled by libev without any problems.
3236.PP
3237This changes when the application actually wants to do event handling
3238in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3239fork.
3240.PP
3241The default mode of operation (for libev, with application help to detect
3242forks) is to duplicate all the state in the child, as would be expected
3243when \fIeither\fR the parent \fIor\fR the child process continues.
3244.PP
3245When both processes want to continue using libev, then this is usually the
3246wrong result. In that case, usually one process (typically the parent) is
3247supposed to continue with all watchers in place as before, while the other
3248process typically wants to start fresh, i.e. without any active watchers.
3249.PP
3250The cleanest and most efficient way to achieve that with libev is to
3251simply create a new event loop, which of course will be \*(L"empty\*(R", and
3252use that for new watchers. This has the advantage of not touching more
3253memory than necessary, and thus avoiding the copy-on-write, and the
3254disadvantage of having to use multiple event loops (which do not support
3255signal watchers).
3256.PP
3257When this is not possible, or you want to use the default loop for
3258other reasons, then in the process that wants to start \*(L"fresh\*(R", call
3259\&\f(CW\*(C`ev_loop_destroy (EV_DEFAULT)\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR.
3260Destroying the default loop will \*(L"orphan\*(R" (not stop) all registered
3261watchers, so you have to be careful not to execute code that modifies
3262those watchers. Note also that in that case, you have to re-register any
3263signal watchers.
3264.PP
2703\fIWatcher-Specific Functions and Data Members\fR 3265\fIWatcher-Specific Functions and Data Members\fR
2704.IX Subsection "Watcher-Specific Functions and Data Members" 3266.IX Subsection "Watcher-Specific Functions and Data Members"
2705.IP "ev_fork_init (ev_signal *, callback)" 4 3267.IP "ev_fork_init (ev_fork *, callback)" 4
2706.IX Item "ev_fork_init (ev_signal *, callback)" 3268.IX Item "ev_fork_init (ev_fork *, callback)"
2707Initialises and configures the fork watcher \- it has no parameters of any 3269Initialises and configures the fork watcher \- it has no parameters of any
2708kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, 3270kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
2709believe me. 3271really.
3272.ie n .SS """ev_cleanup"" \- even the best things end"
3273.el .SS "\f(CWev_cleanup\fP \- even the best things end"
3274.IX Subsection "ev_cleanup - even the best things end"
3275Cleanup watchers are called just before the event loop is being destroyed
3276by a call to \f(CW\*(C`ev_loop_destroy\*(C'\fR.
3277.PP
3278While there is no guarantee that the event loop gets destroyed, cleanup
3279watchers provide a convenient method to install cleanup hooks for your
3280program, worker threads and so on \- you just to make sure to destroy the
3281loop when you want them to be invoked.
3282.PP
3283Cleanup watchers are invoked in the same way as any other watcher. Unlike
3284all other watchers, they do not keep a reference to the event loop (which
3285makes a lot of sense if you think about it). Like all other watchers, you
3286can call libev functions in the callback, except \f(CW\*(C`ev_cleanup_start\*(C'\fR.
3287.PP
3288\fIWatcher-Specific Functions and Data Members\fR
3289.IX Subsection "Watcher-Specific Functions and Data Members"
3290.IP "ev_cleanup_init (ev_cleanup *, callback)" 4
3291.IX Item "ev_cleanup_init (ev_cleanup *, callback)"
3292Initialises and configures the cleanup watcher \- it has no parameters of
3293any kind. There is a \f(CW\*(C`ev_cleanup_set\*(C'\fR macro, but using it is utterly
3294pointless, I assure you.
3295.PP
3296Example: Register an atexit handler to destroy the default loop, so any
3297cleanup functions are called.
3298.PP
3299.Vb 5
3300\& static void
3301\& program_exits (void)
3302\& {
3303\& ev_loop_destroy (EV_DEFAULT_UC);
3304\& }
3305\&
3306\& ...
3307\& atexit (program_exits);
3308.Ve
2710.ie n .Sh """ev_async"" \- how to wake up another event loop" 3309.ie n .SS """ev_async"" \- how to wake up an event loop"
2711.el .Sh "\f(CWev_async\fP \- how to wake up another event loop" 3310.el .SS "\f(CWev_async\fP \- how to wake up an event loop"
2712.IX Subsection "ev_async - how to wake up another event loop" 3311.IX Subsection "ev_async - how to wake up an event loop"
2713In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other 3312In general, you cannot use an \f(CW\*(C`ev_run\*(C'\fR from multiple threads or other
2714asynchronous sources such as signal handlers (as opposed to multiple event 3313asynchronous sources such as signal handlers (as opposed to multiple event
2715loops \- those are of course safe to use in different threads). 3314loops \- those are of course safe to use in different threads).
2716.PP 3315.PP
2717Sometimes, however, you need to wake up another event loop you do not 3316Sometimes, however, you need to wake up an event loop you do not control,
2718control, for example because it belongs to another thread. This is what 3317for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR
2719\&\f(CW\*(C`ev_async\*(C'\fR watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you 3318watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you can signal
2720can signal it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal 3319it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
2721safe.
2722.PP 3320.PP
2723This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3321This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
2724too, are asynchronous in nature, and signals, too, will be compressed 3322too, are asynchronous in nature, and signals, too, will be compressed
2725(i.e. the number of callback invocations may be less than the number of 3323(i.e. the number of callback invocations may be less than the number of
2726\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). 3324\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). In fact, you could use signal watchers as a kind
3325of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3326signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3327even without knowing which loop owns the signal.
2727.PP 3328.PP
2728Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not 3329Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not
2729just the default loop. 3330just the default loop.
2730.PP 3331.PP
2731\fIQueueing\fR 3332\fIQueueing\fR
2732.IX Subsection "Queueing" 3333.IX Subsection "Queueing"
2733.PP 3334.PP
2734\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason 3335\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
2735is that the author does not know of a simple (or any) algorithm for a 3336is that the author does not know of a simple (or any) algorithm for a
2736multiple-writer-single-reader queue that works in all cases and doesn't 3337multiple-writer-single-reader queue that works in all cases and doesn't
2737need elaborate support such as pthreads. 3338need elaborate support such as pthreads or unportable memory access
3339semantics.
2738.PP 3340.PP
2739That means that if you want to queue data, you have to provide your own 3341That means that if you want to queue data, you have to provide your own
2740queue. But at least I can tell you how to implement locking around your 3342queue. But at least I can tell you how to implement locking around your
2741queue: 3343queue:
2742.IP "queueing from a signal handler context" 4 3344.IP "queueing from a signal handler context" 4
2825an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike 3427an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike
2826\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or 3428\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or
2827similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding 3429similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding
2828section below on what exactly this means). 3430section below on what exactly this means).
2829.Sp 3431.Sp
3432Note that, as with other watchers in libev, multiple events might get
3433compressed into a single callback invocation (another way to look at this
3434is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered, set on \f(CW\*(C`ev_async_send\*(C'\fR,
3435reset when the event loop detects that).
3436.Sp
2830This call incurs the overhead of a system call only once per loop iteration, 3437This call incurs the overhead of a system call only once per event loop
2831so while the overhead might be noticeable, it doesn't apply to repeated 3438iteration, so while the overhead might be noticeable, it doesn't apply to
2832calls to \f(CW\*(C`ev_async_send\*(C'\fR. 3439repeated calls to \f(CW\*(C`ev_async_send\*(C'\fR for the same event loop.
2833.IP "bool = ev_async_pending (ev_async *)" 4 3440.IP "bool = ev_async_pending (ev_async *)" 4
2834.IX Item "bool = ev_async_pending (ev_async *)" 3441.IX Item "bool = ev_async_pending (ev_async *)"
2835Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 3442Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
2836watcher but the event has not yet been processed (or even noted) by the 3443watcher but the event has not yet been processed (or even noted) by the
2837event loop. 3444event loop.
2839\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When 3446\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
2840the loop iterates next and checks for the watcher to have become active, 3447the loop iterates next and checks for the watcher to have become active,
2841it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very 3448it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
2842quickly check whether invoking the loop might be a good idea. 3449quickly check whether invoking the loop might be a good idea.
2843.Sp 3450.Sp
2844Not that this does \fInot\fR check whether the watcher itself is pending, only 3451Not that this does \fInot\fR check whether the watcher itself is pending,
2845whether it has been requested to make this watcher pending. 3452only whether it has been requested to make this watcher pending: there
3453is a time window between the event loop checking and resetting the async
3454notification, and the callback being invoked.
2846.SH "OTHER FUNCTIONS" 3455.SH "OTHER FUNCTIONS"
2847.IX Header "OTHER FUNCTIONS" 3456.IX Header "OTHER FUNCTIONS"
2848There are some other functions of possible interest. Described. Here. Now. 3457There are some other functions of possible interest. Described. Here. Now.
2849.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3458.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
2850.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3459.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
2860.Sp 3469.Sp
2861If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be 3470If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be
2862started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and 3471started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and
2863repeat = 0) will be started. \f(CW0\fR is a valid timeout. 3472repeat = 0) will be started. \f(CW0\fR is a valid timeout.
2864.Sp 3473.Sp
2865The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets 3474The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and is
2866passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of 3475passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of
2867\&\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 3476\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
2868value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR 3477value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
2869a timeout and an io event at the same time \- you probably should give io 3478a timeout and an io event at the same time \- you probably should give io
2870events precedence. 3479events precedence.
2871.Sp 3480.Sp
2872Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3481Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0.
2874.Vb 7 3483.Vb 7
2875\& static void stdin_ready (int revents, void *arg) 3484\& static void stdin_ready (int revents, void *arg)
2876\& { 3485\& {
2877\& if (revents & EV_READ) 3486\& if (revents & EV_READ)
2878\& /* stdin might have data for us, joy! */; 3487\& /* stdin might have data for us, joy! */;
2879\& else if (revents & EV_TIMEOUT) 3488\& else if (revents & EV_TIMER)
2880\& /* doh, nothing entered */; 3489\& /* doh, nothing entered */;
2881\& } 3490\& }
2882\& 3491\&
2883\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3492\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2884.Ve 3493.Ve
2885.IP "ev_feed_event (struct ev_loop *, watcher *, int revents)" 4
2886.IX Item "ev_feed_event (struct ev_loop *, watcher *, int revents)"
2887Feeds the given event set into the event loop, as if the specified event
2888had happened for the specified watcher (which must be a pointer to an
2889initialised but not necessarily started event watcher).
2890.IP "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" 4 3494.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
2891.IX Item "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" 3495.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
2892Feed an event on the given fd, as if a file descriptor backend detected 3496Feed an event on the given fd, as if a file descriptor backend detected
2893the given events it. 3497the given events it.
2894.IP "ev_feed_signal_event (struct ev_loop *loop, int signum)" 4 3498.IP "ev_feed_signal_event (loop, int signum)" 4
2895.IX Item "ev_feed_signal_event (struct ev_loop *loop, int signum)" 3499.IX Item "ev_feed_signal_event (loop, int signum)"
2896Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default 3500Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
2897loop!). 3501which is async-safe.
3502.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3503.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3504This section explains some common idioms that are not immediately
3505obvious. Note that examples are sprinkled over the whole manual, and this
3506section only contains stuff that wouldn't fit anywhere else.
3507.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
3508.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3509Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3510or modify at any time: libev will completely ignore it. This can be used
3511to associate arbitrary data with your watcher. If you need more data and
3512don't want to allocate memory separately and store a pointer to it in that
3513data member, you can also \*(L"subclass\*(R" the watcher type and provide your own
3514data:
3515.PP
3516.Vb 7
3517\& struct my_io
3518\& {
3519\& ev_io io;
3520\& int otherfd;
3521\& void *somedata;
3522\& struct whatever *mostinteresting;
3523\& };
3524\&
3525\& ...
3526\& struct my_io w;
3527\& ev_io_init (&w.io, my_cb, fd, EV_READ);
3528.Ve
3529.PP
3530And since your callback will be called with a pointer to the watcher, you
3531can cast it back to your own type:
3532.PP
3533.Vb 5
3534\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
3535\& {
3536\& struct my_io *w = (struct my_io *)w_;
3537\& ...
3538\& }
3539.Ve
3540.PP
3541More interesting and less C\-conformant ways of casting your callback
3542function type instead have been omitted.
3543.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0"
3544.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3545Another common scenario is to use some data structure with multiple
3546embedded watchers, in effect creating your own watcher that combines
3547multiple libev event sources into one \*(L"super-watcher\*(R":
3548.PP
3549.Vb 6
3550\& struct my_biggy
3551\& {
3552\& int some_data;
3553\& ev_timer t1;
3554\& ev_timer t2;
3555\& }
3556.Ve
3557.PP
3558In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
3559complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct in
3560the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies or \*(C+ coders), or you need
3561to use some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for
3562real programmers):
3563.PP
3564.Vb 1
3565\& #include <stddef.h>
3566\&
3567\& static void
3568\& t1_cb (EV_P_ ev_timer *w, int revents)
3569\& {
3570\& struct my_biggy big = (struct my_biggy *)
3571\& (((char *)w) \- offsetof (struct my_biggy, t1));
3572\& }
3573\&
3574\& static void
3575\& t2_cb (EV_P_ ev_timer *w, int revents)
3576\& {
3577\& struct my_biggy big = (struct my_biggy *)
3578\& (((char *)w) \- offsetof (struct my_biggy, t2));
3579\& }
3580.Ve
3581.SS "\s-1MODEL/NESTED\s0 \s-1EVENT\s0 \s-1LOOP\s0 \s-1INVOCATIONS\s0 \s-1AND\s0 \s-1EXIT\s0 \s-1CONDITIONS\s0"
3582.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3583Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3584\&\fImodal\fR interaction, which is most easily implemented by recursively
3585invoking \f(CW\*(C`ev_run\*(C'\fR.
3586.PP
3587This brings the problem of exiting \- a callback might want to finish the
3588main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
3589a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
3590and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3591other combination: In these cases, \f(CW\*(C`ev_break\*(C'\fR will not work alone.
3592.PP
3593The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3594invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3595triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3596.PP
3597.Vb 2
3598\& // main loop
3599\& int exit_main_loop = 0;
3600\&
3601\& while (!exit_main_loop)
3602\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3603\&
3604\& // in a model watcher
3605\& int exit_nested_loop = 0;
3606\&
3607\& while (!exit_nested_loop)
3608\& ev_run (EV_A_ EVRUN_ONCE);
3609.Ve
3610.PP
3611To exit from any of these loops, just set the corresponding exit variable:
3612.PP
3613.Vb 2
3614\& // exit modal loop
3615\& exit_nested_loop = 1;
3616\&
3617\& // exit main program, after modal loop is finished
3618\& exit_main_loop = 1;
3619\&
3620\& // exit both
3621\& exit_main_loop = exit_nested_loop = 1;
3622.Ve
3623.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0"
3624.IX Subsection "THREAD LOCKING EXAMPLE"
3625Here is a fictitious example of how to run an event loop in a different
3626thread from where callbacks are being invoked and watchers are
3627created/added/removed.
3628.PP
3629For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
3630which uses exactly this technique (which is suited for many high-level
3631languages).
3632.PP
3633The example uses a pthread mutex to protect the loop data, a condition
3634variable to wait for callback invocations, an async watcher to notify the
3635event loop thread and an unspecified mechanism to wake up the main thread.
3636.PP
3637First, you need to associate some data with the event loop:
3638.PP
3639.Vb 6
3640\& typedef struct {
3641\& mutex_t lock; /* global loop lock */
3642\& ev_async async_w;
3643\& thread_t tid;
3644\& cond_t invoke_cv;
3645\& } userdata;
3646\&
3647\& void prepare_loop (EV_P)
3648\& {
3649\& // for simplicity, we use a static userdata struct.
3650\& static userdata u;
3651\&
3652\& ev_async_init (&u\->async_w, async_cb);
3653\& ev_async_start (EV_A_ &u\->async_w);
3654\&
3655\& pthread_mutex_init (&u\->lock, 0);
3656\& pthread_cond_init (&u\->invoke_cv, 0);
3657\&
3658\& // now associate this with the loop
3659\& ev_set_userdata (EV_A_ u);
3660\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3661\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3662\&
3663\& // then create the thread running ev_loop
3664\& pthread_create (&u\->tid, 0, l_run, EV_A);
3665\& }
3666.Ve
3667.PP
3668The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3669solely to wake up the event loop so it takes notice of any new watchers
3670that might have been added:
3671.PP
3672.Vb 5
3673\& static void
3674\& async_cb (EV_P_ ev_async *w, int revents)
3675\& {
3676\& // just used for the side effects
3677\& }
3678.Ve
3679.PP
3680The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
3681protecting the loop data, respectively.
3682.PP
3683.Vb 6
3684\& static void
3685\& l_release (EV_P)
3686\& {
3687\& userdata *u = ev_userdata (EV_A);
3688\& pthread_mutex_unlock (&u\->lock);
3689\& }
3690\&
3691\& static void
3692\& l_acquire (EV_P)
3693\& {
3694\& userdata *u = ev_userdata (EV_A);
3695\& pthread_mutex_lock (&u\->lock);
3696\& }
3697.Ve
3698.PP
3699The event loop thread first acquires the mutex, and then jumps straight
3700into \f(CW\*(C`ev_run\*(C'\fR:
3701.PP
3702.Vb 4
3703\& void *
3704\& l_run (void *thr_arg)
3705\& {
3706\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
3707\&
3708\& l_acquire (EV_A);
3709\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
3710\& ev_run (EV_A_ 0);
3711\& l_release (EV_A);
3712\&
3713\& return 0;
3714\& }
3715.Ve
3716.PP
3717Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
3718signal the main thread via some unspecified mechanism (signals? pipe
3719writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
3720have been called (in a while loop because a) spurious wakeups are possible
3721and b) skipping inter-thread-communication when there are no pending
3722watchers is very beneficial):
3723.PP
3724.Vb 4
3725\& static void
3726\& l_invoke (EV_P)
3727\& {
3728\& userdata *u = ev_userdata (EV_A);
3729\&
3730\& while (ev_pending_count (EV_A))
3731\& {
3732\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
3733\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
3734\& }
3735\& }
3736.Ve
3737.PP
3738Now, whenever the main thread gets told to invoke pending watchers, it
3739will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
3740thread to continue:
3741.PP
3742.Vb 4
3743\& static void
3744\& real_invoke_pending (EV_P)
3745\& {
3746\& userdata *u = ev_userdata (EV_A);
3747\&
3748\& pthread_mutex_lock (&u\->lock);
3749\& ev_invoke_pending (EV_A);
3750\& pthread_cond_signal (&u\->invoke_cv);
3751\& pthread_mutex_unlock (&u\->lock);
3752\& }
3753.Ve
3754.PP
3755Whenever you want to start/stop a watcher or do other modifications to an
3756event loop, you will now have to lock:
3757.PP
3758.Vb 2
3759\& ev_timer timeout_watcher;
3760\& userdata *u = ev_userdata (EV_A);
3761\&
3762\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
3763\&
3764\& pthread_mutex_lock (&u\->lock);
3765\& ev_timer_start (EV_A_ &timeout_watcher);
3766\& ev_async_send (EV_A_ &u\->async_w);
3767\& pthread_mutex_unlock (&u\->lock);
3768.Ve
3769.PP
3770Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
3771an event loop currently blocking in the kernel will have no knowledge
3772about the newly added timer. By waking up the loop it will pick up any new
3773watchers in the next event loop iteration.
3774.SS "\s-1THREADS\s0, \s-1COROUTINES\s0, \s-1CONTINUATIONS\s0, \s-1QUEUES\s0... \s-1INSTEAD\s0 \s-1OF\s0 \s-1CALLBACKS\s0"
3775.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
3776While the overhead of a callback that e.g. schedules a thread is small, it
3777is still an overhead. If you embed libev, and your main usage is with some
3778kind of threads or coroutines, you might want to customise libev so that
3779doesn't need callbacks anymore.
3780.PP
3781Imagine you have coroutines that you can switch to using a function
3782\&\f(CW\*(C`switch_to (coro)\*(C'\fR, that libev runs in a coroutine called \f(CW\*(C`libev_coro\*(C'\fR
3783and that due to some magic, the currently active coroutine is stored in a
3784global called \f(CW\*(C`current_coro\*(C'\fR. Then you can build your own \*(L"wait for libev
3785event\*(R" primitive by changing \f(CW\*(C`EV_CB_DECLARE\*(C'\fR and \f(CW\*(C`EV_CB_INVOKE\*(C'\fR (note
3786the differing \f(CW\*(C`;\*(C'\fR conventions):
3787.PP
3788.Vb 2
3789\& #define EV_CB_DECLARE(type) struct my_coro *cb;
3790\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
3791.Ve
3792.PP
3793That means instead of having a C callback function, you store the
3794coroutine to switch to in each watcher, and instead of having libev call
3795your callback, you instead have it switch to that coroutine.
3796.PP
3797A coroutine might now wait for an event with a function called
3798\&\f(CW\*(C`wait_for_event\*(C'\fR. (the watcher needs to be started, as always, but it doesn't
3799matter when, or whether the watcher is active or not when this function is
3800called):
3801.PP
3802.Vb 6
3803\& void
3804\& wait_for_event (ev_watcher *w)
3805\& {
3806\& ev_cb_set (w) = current_coro;
3807\& switch_to (libev_coro);
3808\& }
3809.Ve
3810.PP
3811That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
3812continues the libev coroutine, which, when appropriate, switches back to
3813this or any other coroutine. I am sure if you sue this your own :)
3814.PP
3815You can do similar tricks if you have, say, threads with an event queue \-
3816instead of storing a coroutine, you store the queue object and instead of
3817switching to a coroutine, you push the watcher onto the queue and notify
3818any waiters.
3819.PP
3820To embed libev, see \s-1EMBEDDING\s0, but in short, it's easiest to create two
3821files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
3822.PP
3823.Vb 4
3824\& // my_ev.h
3825\& #define EV_CB_DECLARE(type) struct my_coro *cb;
3826\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb);
3827\& #include "../libev/ev.h"
3828\&
3829\& // my_ev.c
3830\& #define EV_H "my_ev.h"
3831\& #include "../libev/ev.c"
3832.Ve
3833.PP
3834And then use \fImy_ev.h\fR when you would normally use \fIev.h\fR, and compile
3835\&\fImy_ev.c\fR into your project. When properly specifying include paths, you
3836can even use \fIev.h\fR as header file name directly.
2898.SH "LIBEVENT EMULATION" 3837.SH "LIBEVENT EMULATION"
2899.IX Header "LIBEVENT EMULATION" 3838.IX Header "LIBEVENT EMULATION"
2900Libev offers a compatibility emulation layer for libevent. It cannot 3839Libev offers a compatibility emulation layer for libevent. It cannot
2901emulate the internals of libevent, so here are some usage hints: 3840emulate the internals of libevent, so here are some usage hints:
3841.IP "\(bu" 4
3842Only the libevent\-1.4.1\-beta \s-1API\s0 is being emulated.
3843.Sp
3844This was the newest libevent version available when libev was implemented,
3845and is still mostly unchanged in 2010.
2902.IP "\(bu" 4 3846.IP "\(bu" 4
2903Use it by including <event.h>, as usual. 3847Use it by including <event.h>, as usual.
2904.IP "\(bu" 4 3848.IP "\(bu" 4
2905The following members are fully supported: ev_base, ev_callback, 3849The following members are fully supported: ev_base, ev_callback,
2906ev_arg, ev_fd, ev_res, ev_events. 3850ev_arg, ev_fd, ev_res, ev_events.
2912Priorities are not currently supported. Initialising priorities 3856Priorities are not currently supported. Initialising priorities
2913will fail and all watchers will have the same priority, even though there 3857will fail and all watchers will have the same priority, even though there
2914is an ev_pri field. 3858is an ev_pri field.
2915.IP "\(bu" 4 3859.IP "\(bu" 4
2916In libevent, the last base created gets the signals, in libev, the 3860In libevent, the last base created gets the signals, in libev, the
2917first base created (== the default loop) gets the signals. 3861base that registered the signal gets the signals.
2918.IP "\(bu" 4 3862.IP "\(bu" 4
2919Other members are not supported. 3863Other members are not supported.
2920.IP "\(bu" 4 3864.IP "\(bu" 4
2921The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 3865The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
2922to use the libev header file and library. 3866to use the libev header file and library.
2940Care has been taken to keep the overhead low. The only data member the \*(C+ 3884Care has been taken to keep the overhead low. The only data member the \*(C+
2941classes add (compared to plain C\-style watchers) is the event loop pointer 3885classes add (compared to plain C\-style watchers) is the event loop pointer
2942that the watcher is associated with (or no additional members at all if 3886that the watcher is associated with (or no additional members at all if
2943you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). 3887you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
2944.PP 3888.PP
2945Currently, functions, and static and non-static member functions can be 3889Currently, functions, static and non-static member functions and classes
2946used as callbacks. Other types should be easy to add as long as they only 3890with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
2947need one additional pointer for context. If you need support for other 3891to add as long as they only need one additional pointer for context. If
2948types of functors please contact the author (preferably after implementing 3892you need support for other types of functors please contact the author
2949it). 3893(preferably after implementing it).
2950.PP 3894.PP
2951Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 3895Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
2952.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 3896.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
2953.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 3897.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
2954.IX Item "ev::READ, ev::WRITE etc." 3898.IX Item "ev::READ, ev::WRITE etc."
2955These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. 3899These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc.
2956macros from \fIev.h\fR. 3900macros from \fIev.h\fR.
2957.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 3901.ie n .IP """ev::tstamp"", ""ev::now""" 4
2958.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 3902.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4
2959.IX Item "ev::tstamp, ev::now" 3903.IX Item "ev::tstamp, ev::now"
2960Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. 3904Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix.
2961.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 3905.ie n .IP """ev::io"", ""ev::timer"", ""ev::periodic"", ""ev::idle"", ""ev::sig"" etc." 4
2962.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 3906.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
2963.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 3907.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
2964For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 3908For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
2965the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 3909the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
2966which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 3910which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
2969All of those classes have these methods: 3913All of those classes have these methods:
2970.RS 4 3914.RS 4
2971.IP "ev::TYPE::TYPE ()" 4 3915.IP "ev::TYPE::TYPE ()" 4
2972.IX Item "ev::TYPE::TYPE ()" 3916.IX Item "ev::TYPE::TYPE ()"
2973.PD 0 3917.PD 0
2974.IP "ev::TYPE::TYPE (struct ev_loop *)" 4 3918.IP "ev::TYPE::TYPE (loop)" 4
2975.IX Item "ev::TYPE::TYPE (struct ev_loop *)" 3919.IX Item "ev::TYPE::TYPE (loop)"
2976.IP "ev::TYPE::~TYPE" 4 3920.IP "ev::TYPE::~TYPE" 4
2977.IX Item "ev::TYPE::~TYPE" 3921.IX Item "ev::TYPE::~TYPE"
2978.PD 3922.PD
2979The constructor (optionally) takes an event loop to associate the watcher 3923The constructor (optionally) takes an event loop to associate the watcher
2980with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. 3924with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
3014\& ev::io iow; 3958\& ev::io iow;
3015\& iow.set <myclass, &myclass::io_cb> (&obj); 3959\& iow.set <myclass, &myclass::io_cb> (&obj);
3016.Ve 3960.Ve
3017.IP "w\->set (object *)" 4 3961.IP "w\->set (object *)" 4
3018.IX Item "w->set (object *)" 3962.IX Item "w->set (object *)"
3019This is an \fBexperimental\fR feature that might go away in a future version.
3020.Sp
3021This is a variation of a method callback \- leaving out the method to call 3963This is a variation of a method callback \- leaving out the method to call
3022will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use 3964will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use
3023functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all 3965functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all
3024the time. Incidentally, you can then also leave out the template argument 3966the time. Incidentally, you can then also leave out the template argument
3025list. 3967list.
3059.Sp 4001.Sp
3060.Vb 2 4002.Vb 2
3061\& static void io_cb (ev::io &w, int revents) { } 4003\& static void io_cb (ev::io &w, int revents) { }
3062\& iow.set <io_cb> (); 4004\& iow.set <io_cb> ();
3063.Ve 4005.Ve
3064.IP "w\->set (struct ev_loop *)" 4 4006.IP "w\->set (loop)" 4
3065.IX Item "w->set (struct ev_loop *)" 4007.IX Item "w->set (loop)"
3066Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4008Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
3067do this when the watcher is inactive (and not pending either). 4009do this when the watcher is inactive (and not pending either).
3068.IP "w\->set ([arguments])" 4 4010.IP "w\->set ([arguments])" 4
3069.IX Item "w->set ([arguments])" 4011.IX Item "w->set ([arguments])"
3070Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Must be 4012Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this
3071called at least once. Unlike the C counterpart, an active watcher gets 4013method or a suitable start method must be called at least once. Unlike the
3072automatically stopped and restarted when reconfiguring it with this 4014C counterpart, an active watcher gets automatically stopped and restarted
3073method. 4015when reconfiguring it with this method.
3074.IP "w\->start ()" 4 4016.IP "w\->start ()" 4
3075.IX Item "w->start ()" 4017.IX Item "w->start ()"
3076Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4018Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
3077constructor already stores the event loop. 4019constructor already stores the event loop.
4020.IP "w\->start ([arguments])" 4
4021.IX Item "w->start ([arguments])"
4022Instead of calling \f(CW\*(C`set\*(C'\fR and \f(CW\*(C`start\*(C'\fR methods separately, it is often
4023convenient to wrap them in one call. Uses the same type of arguments as
4024the configure \f(CW\*(C`set\*(C'\fR method of the watcher.
3078.IP "w\->stop ()" 4 4025.IP "w\->stop ()" 4
3079.IX Item "w->stop ()" 4026.IX Item "w->stop ()"
3080Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 4027Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
3081.ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4 4028.ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4
3082.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 4029.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4
3083.IX Item "w->again () (ev::timer, ev::periodic only)" 4030.IX Item "w->again () (ev::timer, ev::periodic only)"
3084For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding 4031For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding
3085\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. 4032\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
3086.ie n .IP "w\->sweep () (""ev::embed"" only)" 4 4033.ie n .IP "w\->sweep () (""ev::embed"" only)" 4
3093Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. 4040Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
3094.RE 4041.RE
3095.RS 4 4042.RS 4
3096.RE 4043.RE
3097.PP 4044.PP
3098Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 4045Example: Define a class with two I/O and idle watchers, start the I/O
3099the constructor. 4046watchers in the constructor.
3100.PP 4047.PP
3101.Vb 4 4048.Vb 5
3102\& class myclass 4049\& class myclass
3103\& { 4050\& {
3104\& ev::io io ; void io_cb (ev::io &w, int revents); 4051\& ev::io io ; void io_cb (ev::io &w, int revents);
4052\& ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3105\& ev::idle idle; void idle_cb (ev::idle &w, int revents); 4053\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
3106\& 4054\&
3107\& myclass (int fd) 4055\& myclass (int fd)
3108\& { 4056\& {
3109\& io .set <myclass, &myclass::io_cb > (this); 4057\& io .set <myclass, &myclass::io_cb > (this);
4058\& io2 .set <myclass, &myclass::io2_cb > (this);
3110\& idle.set <myclass, &myclass::idle_cb> (this); 4059\& idle.set <myclass, &myclass::idle_cb> (this);
3111\& 4060\&
3112\& io.start (fd, ev::READ); 4061\& io.set (fd, ev::WRITE); // configure the watcher
4062\& io.start (); // start it whenever convenient
4063\&
4064\& io2.start (fd, ev::READ); // set + start in one call
3113\& } 4065\& }
3114\& }; 4066\& };
3115.Ve 4067.Ve
3116.SH "OTHER LANGUAGE BINDINGS" 4068.SH "OTHER LANGUAGE BINDINGS"
3117.IX Header "OTHER LANGUAGE BINDINGS" 4069.IX Header "OTHER LANGUAGE BINDINGS"
3131It can be found and installed via \s-1CPAN\s0, its homepage is at 4083It can be found and installed via \s-1CPAN\s0, its homepage is at
3132<http://software.schmorp.de/pkg/EV>. 4084<http://software.schmorp.de/pkg/EV>.
3133.IP "Python" 4 4085.IP "Python" 4
3134.IX Item "Python" 4086.IX Item "Python"
3135Python bindings can be found at <http://code.google.com/p/pyev/>. It 4087Python bindings can be found at <http://code.google.com/p/pyev/>. It
3136seems to be quite complete and well-documented. Note, however, that the 4088seems to be quite complete and well-documented.
3137patch they require for libev is outright dangerous as it breaks the \s-1ABI\s0
3138for everybody else, and therefore, should never be applied in an installed
3139libev (if python requires an incompatible \s-1ABI\s0 then it needs to embed
3140libev).
3141.IP "Ruby" 4 4089.IP "Ruby" 4
3142.IX Item "Ruby" 4090.IX Item "Ruby"
3143Tony Arcieri has written a ruby extension that offers access to a subset 4091Tony Arcieri has written a ruby extension that offers access to a subset
3144of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and 4092of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and
3145more on top of it. It can be found via gem servers. Its homepage is at 4093more on top of it. It can be found via gem servers. Its homepage is at
3146<http://rev.rubyforge.org/>. 4094<http://rev.rubyforge.org/>.
3147.Sp 4095.Sp
3148Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR 4096Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
3149makes rev work even on mingw. 4097makes rev work even on mingw.
4098.IP "Haskell" 4
4099.IX Item "Haskell"
4100A haskell binding to libev is available at
4101<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
3150.IP "D" 4 4102.IP "D" 4
3151.IX Item "D" 4103.IX Item "D"
3152Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4104Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
3153be found at <http://proj.llucax.com.ar/wiki/evd>. 4105be found at <http://proj.llucax.com.ar/wiki/evd>.
3154.IP "Ocaml" 4 4106.IP "Ocaml" 4
3155.IX Item "Ocaml" 4107.IX Item "Ocaml"
3156Erkki Seppala has written Ocaml bindings for libev, to be found at 4108Erkki Seppala has written Ocaml bindings for libev, to be found at
3157<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. 4109<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4110.IP "Lua" 4
4111.IX Item "Lua"
4112Brian Maher has written a partial interface to libev for lua (at the
4113time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4114<http://github.com/brimworks/lua\-ev>.
3158.SH "MACRO MAGIC" 4115.SH "MACRO MAGIC"
3159.IX Header "MACRO MAGIC" 4116.IX Header "MACRO MAGIC"
3160Libev can be compiled with a variety of options, the most fundamental 4117Libev can be compiled with a variety of options, the most fundamental
3161of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 4118of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
3162functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 4119functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
3163.PP 4120.PP
3164To make it easier to write programs that cope with either variant, the 4121To make it easier to write programs that cope with either variant, the
3165following macros are defined: 4122following macros are defined:
3166.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 4123.ie n .IP """EV_A"", ""EV_A_""" 4
3167.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 4124.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
3168.IX Item "EV_A, EV_A_" 4125.IX Item "EV_A, EV_A_"
3169This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev 4126This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
3170loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, 4127loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
3171\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: 4128\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
3172.Sp 4129.Sp
3173.Vb 3 4130.Vb 3
3174\& ev_unref (EV_A); 4131\& ev_unref (EV_A);
3175\& ev_timer_add (EV_A_ watcher); 4132\& ev_timer_add (EV_A_ watcher);
3176\& ev_loop (EV_A_ 0); 4133\& ev_run (EV_A_ 0);
3177.Ve 4134.Ve
3178.Sp 4135.Sp
3179It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, 4136It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
3180which is often provided by the following macro. 4137which is often provided by the following macro.
3181.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 4138.ie n .IP """EV_P"", ""EV_P_""" 4
3182.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 4139.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
3183.IX Item "EV_P, EV_P_" 4140.IX Item "EV_P, EV_P_"
3184This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev 4141This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
3185loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, 4142loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
3186\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: 4143\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
3193\& static void cb (EV_P_ ev_timer *w, int revents) 4150\& static void cb (EV_P_ ev_timer *w, int revents)
3194.Ve 4151.Ve
3195.Sp 4152.Sp
3196It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite 4153It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
3197suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 4154suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
3198.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 4155.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
3199.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 4156.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
3200.IX Item "EV_DEFAULT, EV_DEFAULT_" 4157.IX Item "EV_DEFAULT, EV_DEFAULT_"
3201Similar to the other two macros, this gives you the value of the default 4158Similar to the other two macros, this gives you the value of the default
3202loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 4159loop, if multiple loops are supported (\*(L"ev loop default\*(R").
3203.ie n .IP """EV_DEFAULT_UC""\fR, \f(CW""EV_DEFAULT_UC_""" 4 4160.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
3204.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 4161.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
3205.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" 4162.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
3206Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the 4163Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
3207default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour 4164default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
3208is undefined when the default loop has not been initialised by a previous 4165is undefined when the default loop has not been initialised by a previous
3223\& } 4180\& }
3224\& 4181\&
3225\& ev_check check; 4182\& ev_check check;
3226\& ev_check_init (&check, check_cb); 4183\& ev_check_init (&check, check_cb);
3227\& ev_check_start (EV_DEFAULT_ &check); 4184\& ev_check_start (EV_DEFAULT_ &check);
3228\& ev_loop (EV_DEFAULT_ 0); 4185\& ev_run (EV_DEFAULT_ 0);
3229.Ve 4186.Ve
3230.SH "EMBEDDING" 4187.SH "EMBEDDING"
3231.IX Header "EMBEDDING" 4188.IX Header "EMBEDDING"
3232Libev can (and often is) directly embedded into host 4189Libev can (and often is) directly embedded into host
3233applications. Examples of applications that embed it include the Deliantra 4190applications. Examples of applications that embed it include the Deliantra
3236.PP 4193.PP
3237The goal is to enable you to just copy the necessary files into your 4194The goal is to enable you to just copy the necessary files into your
3238source directory without having to change even a single line in them, so 4195source directory without having to change even a single line in them, so
3239you can easily upgrade by simply copying (or having a checked-out copy of 4196you can easily upgrade by simply copying (or having a checked-out copy of
3240libev somewhere in your source tree). 4197libev somewhere in your source tree).
3241.Sh "\s-1FILESETS\s0" 4198.SS "\s-1FILESETS\s0"
3242.IX Subsection "FILESETS" 4199.IX Subsection "FILESETS"
3243Depending on what features you need you need to include one or more sets of files 4200Depending on what features you need you need to include one or more sets of files
3244in your application. 4201in your application.
3245.PP 4202.PP
3246\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4203\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
3325For this of course you need the m4 file: 4282For this of course you need the m4 file:
3326.PP 4283.PP
3327.Vb 1 4284.Vb 1
3328\& libev.m4 4285\& libev.m4
3329.Ve 4286.Ve
3330.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4287.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
3331.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4288.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
3332Libev can be configured via a variety of preprocessor symbols you have to 4289Libev can be configured via a variety of preprocessor symbols you have to
3333define before including any of its files. The default in the absence of 4290define before including (or compiling) any of its files. The default in
3334autoconf is documented for every option. 4291the absence of autoconf is documented for every option.
4292.PP
4293Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different
4294values when compiling libev vs. including \fIev.h\fR, so it is permissible
4295to redefine them before including \fIev.h\fR without breaking compatibility
4296to a compiled library. All other symbols change the \s-1ABI\s0, which means all
4297users of libev and the libev code itself must be compiled with compatible
4298settings.
4299.IP "\s-1EV_COMPAT3\s0 (h)" 4
4300.IX Item "EV_COMPAT3 (h)"
4301Backwards compatibility is a major concern for libev. This is why this
4302release of libev comes with wrappers for the functions and symbols that
4303have been renamed between libev version 3 and 4.
4304.Sp
4305You can disable these wrappers (to test compatibility with future
4306versions) by defining \f(CW\*(C`EV_COMPAT3\*(C'\fR to \f(CW0\fR when compiling your
4307sources. This has the additional advantage that you can drop the \f(CW\*(C`struct\*(C'\fR
4308from \f(CW\*(C`struct ev_loop\*(C'\fR declarations, as libev will provide an \f(CW\*(C`ev_loop\*(C'\fR
4309typedef in that case.
4310.Sp
4311In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR,
4312and in some even more future version the compatibility code will be
4313removed completely.
3335.IP "\s-1EV_STANDALONE\s0" 4 4314.IP "\s-1EV_STANDALONE\s0 (h)" 4
3336.IX Item "EV_STANDALONE" 4315.IX Item "EV_STANDALONE (h)"
3337Must always be \f(CW1\fR if you do not use autoconf configuration, which 4316Must always be \f(CW1\fR if you do not use autoconf configuration, which
3338keeps libev from including \fIconfig.h\fR, and it also defines dummy 4317keeps libev from including \fIconfig.h\fR, and it also defines dummy
3339implementations for some libevent functions (such as logging, which is not 4318implementations for some libevent functions (such as logging, which is not
3340supported). It will also not define any of the structs usually found in 4319supported). It will also not define any of the structs usually found in
3341\&\fIevent.h\fR that are not directly supported by the libev core alone. 4320\&\fIevent.h\fR that are not directly supported by the libev core alone.
3342.Sp 4321.Sp
3343In stanbdalone mode, libev will still try to automatically deduce the 4322In standalone mode, libev will still try to automatically deduce the
3344configuration, but has to be more conservative. 4323configuration, but has to be more conservative.
3345.IP "\s-1EV_USE_MONOTONIC\s0" 4 4324.IP "\s-1EV_USE_MONOTONIC\s0" 4
3346.IX Item "EV_USE_MONOTONIC" 4325.IX Item "EV_USE_MONOTONIC"
3347If defined to be \f(CW1\fR, libev will try to detect the availability of the 4326If defined to be \f(CW1\fR, libev will try to detect the availability of the
3348monotonic clock option at both compile time and runtime. Otherwise no 4327monotonic clock option at both compile time and runtime. Otherwise no
3352to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR 4331to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
3353function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR. 4332function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
3354.IP "\s-1EV_USE_REALTIME\s0" 4 4333.IP "\s-1EV_USE_REALTIME\s0" 4
3355.IX Item "EV_USE_REALTIME" 4334.IX Item "EV_USE_REALTIME"
3356If defined to be \f(CW1\fR, libev will try to detect the availability of the 4335If defined to be \f(CW1\fR, libev will try to detect the availability of the
3357real-time clock option at compile time (and assume its availability at 4336real-time clock option at compile time (and assume its availability
3358runtime if successful). Otherwise no use of the real-time clock option will 4337at runtime if successful). Otherwise no use of the real-time clock
3359be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get 4338option will be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR
3360(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the 4339by \f(CW\*(C`clock_get (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect
3361note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. 4340correctness. See the note about libraries in the description of
4341\&\f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. Defaults to the opposite value of
4342\&\f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
3362.IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4 4343.IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4
3363.IX Item "EV_USE_CLOCK_SYSCALL" 4344.IX Item "EV_USE_CLOCK_SYSCALL"
3364If defined to be \f(CW1\fR, libev will try to use a direct syscall instead 4345If defined to be \f(CW1\fR, libev will try to use a direct syscall instead
3365of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option 4346of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option
3366exists 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 4347exists 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
3402wants osf handles on win32 (this is the case when the select to 4383wants osf handles on win32 (this is the case when the select to
3403be used is the winsock select). This means that it will call 4384be used is the winsock select). This means that it will call
3404\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, 4385\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
3405it is assumed that all these functions actually work on fds, even 4386it is assumed that all these functions actually work on fds, even
3406on win32. Should not be defined on non\-win32 platforms. 4387on win32. Should not be defined on non\-win32 platforms.
3407.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0" 4 4388.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0(fd)" 4
3408.IX Item "EV_FD_TO_WIN32_HANDLE" 4389.IX Item "EV_FD_TO_WIN32_HANDLE(fd)"
3409If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map 4390If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map
3410file descriptors to socket handles. When not defining this symbol (the 4391file descriptors to socket handles. When not defining this symbol (the
3411default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually 4392default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually
3412correct. In some cases, programs use their own file descriptor management, 4393correct. In some cases, programs use their own file descriptor management,
3413in which case they can provide this function to map fds to socket handles. 4394in which case they can provide this function to map fds to socket handles.
4395.IP "\s-1EV_WIN32_HANDLE_TO_FD\s0(handle)" 4
4396.IX Item "EV_WIN32_HANDLE_TO_FD(handle)"
4397If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR then libev maps handles to file descriptors
4398using the standard \f(CW\*(C`_open_osfhandle\*(C'\fR function. For programs implementing
4399their own fd to handle mapping, overwriting this function makes it easier
4400to do so. This can be done by defining this macro to an appropriate value.
4401.IP "\s-1EV_WIN32_CLOSE_FD\s0(fd)" 4
4402.IX Item "EV_WIN32_CLOSE_FD(fd)"
4403If programs implement their own fd to handle mapping on win32, then this
4404macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4405file descriptors again. Note that the replacement function has to close
4406the underlying \s-1OS\s0 handle.
3414.IP "\s-1EV_USE_POLL\s0" 4 4407.IP "\s-1EV_USE_POLL\s0" 4
3415.IX Item "EV_USE_POLL" 4408.IX Item "EV_USE_POLL"
3416If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4409If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
3417backend. Otherwise it will be enabled on non\-win32 platforms. It 4410backend. Otherwise it will be enabled on non\-win32 platforms. It
3418takes precedence over select. 4411takes precedence over select.
3457that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" 4450that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R"
3458as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. 4451as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers.
3459.Sp 4452.Sp
3460In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4453In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
3461(from \fIsignal.h\fR), which is usually good enough on most platforms. 4454(from \fIsignal.h\fR), which is usually good enough on most platforms.
3462.IP "\s-1EV_H\s0" 4 4455.IP "\s-1EV_H\s0 (h)" 4
3463.IX Item "EV_H" 4456.IX Item "EV_H (h)"
3464The name of the \fIev.h\fR header file used to include it. The default if 4457The name of the \fIev.h\fR header file used to include it. The default if
3465undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 4458undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
3466used to virtually rename the \fIev.h\fR header file in case of conflicts. 4459used to virtually rename the \fIev.h\fR header file in case of conflicts.
3467.IP "\s-1EV_CONFIG_H\s0" 4 4460.IP "\s-1EV_CONFIG_H\s0 (h)" 4
3468.IX Item "EV_CONFIG_H" 4461.IX Item "EV_CONFIG_H (h)"
3469If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 4462If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
3470\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 4463\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
3471\&\f(CW\*(C`EV_H\*(C'\fR, above. 4464\&\f(CW\*(C`EV_H\*(C'\fR, above.
3472.IP "\s-1EV_EVENT_H\s0" 4 4465.IP "\s-1EV_EVENT_H\s0 (h)" 4
3473.IX Item "EV_EVENT_H" 4466.IX Item "EV_EVENT_H (h)"
3474Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 4467Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
3475of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR. 4468of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
3476.IP "\s-1EV_PROTOTYPES\s0" 4 4469.IP "\s-1EV_PROTOTYPES\s0 (h)" 4
3477.IX Item "EV_PROTOTYPES" 4470.IX Item "EV_PROTOTYPES (h)"
3478If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 4471If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
3479prototypes, but still define all the structs and other symbols. This is 4472prototypes, but still define all the structs and other symbols. This is
3480occasionally useful if you want to provide your own wrapper functions 4473occasionally useful if you want to provide your own wrapper functions
3481around libev functions. 4474around libev functions.
3482.IP "\s-1EV_MULTIPLICITY\s0" 4 4475.IP "\s-1EV_MULTIPLICITY\s0" 4
3502and time, so using the defaults of five priorities (\-2 .. +2) is usually 4495and time, so using the defaults of five priorities (\-2 .. +2) is usually
3503fine. 4496fine.
3504.Sp 4497.Sp
3505If your embedding application does not need any priorities, defining these 4498If your embedding application does not need any priorities, defining these
3506both to \f(CW0\fR will save some memory and \s-1CPU\s0. 4499both to \f(CW0\fR will save some memory and \s-1CPU\s0.
3507.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 4500.IP "\s-1EV_PERIODIC_ENABLE\s0, \s-1EV_IDLE_ENABLE\s0, \s-1EV_EMBED_ENABLE\s0, \s-1EV_STAT_ENABLE\s0, \s-1EV_PREPARE_ENABLE\s0, \s-1EV_CHECK_ENABLE\s0, \s-1EV_FORK_ENABLE\s0, \s-1EV_SIGNAL_ENABLE\s0, \s-1EV_ASYNC_ENABLE\s0, \s-1EV_CHILD_ENABLE\s0." 4
3508.IX Item "EV_PERIODIC_ENABLE" 4501.IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE."
3509If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 4502If undefined or defined to be \f(CW1\fR (and the platform supports it), then
3510defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 4503the respective watcher type is supported. If defined to be \f(CW0\fR, then it
3511code. 4504is not. Disabling watcher types mainly saves code size.
3512.IP "\s-1EV_IDLE_ENABLE\s0" 4
3513.IX Item "EV_IDLE_ENABLE"
3514If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If
3515defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
3516code.
3517.IP "\s-1EV_EMBED_ENABLE\s0" 4
3518.IX Item "EV_EMBED_ENABLE"
3519If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
3520defined to be \f(CW0\fR, then they are not. Embed watchers rely on most other
3521watcher types, which therefore must not be disabled.
3522.IP "\s-1EV_STAT_ENABLE\s0" 4 4505.IP "\s-1EV_FEATURES\s0" 4
3523.IX Item "EV_STAT_ENABLE" 4506.IX Item "EV_FEATURES"
3524If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
3525defined to be \f(CW0\fR, then they are not.
3526.IP "\s-1EV_FORK_ENABLE\s0" 4
3527.IX Item "EV_FORK_ENABLE"
3528If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
3529defined to be \f(CW0\fR, then they are not.
3530.IP "\s-1EV_ASYNC_ENABLE\s0" 4
3531.IX Item "EV_ASYNC_ENABLE"
3532If undefined or defined to be \f(CW1\fR, then async watchers are supported. If
3533defined to be \f(CW0\fR, then they are not.
3534.IP "\s-1EV_MINIMAL\s0" 4
3535.IX Item "EV_MINIMAL"
3536If you need to shave off some kilobytes of code at the expense of some 4507If you need to shave off some kilobytes of code at the expense of some
3537speed, define this symbol to \f(CW1\fR. Currently this is used to override some 4508speed (but with the full \s-1API\s0), you can define this symbol to request
3538inlining decisions, saves roughly 30% code size on amd64. It also selects a 4509certain subsets of functionality. The default is to enable all features
3539much smaller 2\-heap for timer management over the default 4\-heap. 4510that can be enabled on the platform.
4511.Sp
4512A typical way to use this symbol is to define it to \f(CW0\fR (or to a bitset
4513with some broad features you want) and then selectively re-enable
4514additional parts you want, for example if you want everything minimal,
4515but multiple event loop support, async and child watchers and the poll
4516backend, use this:
4517.Sp
4518.Vb 5
4519\& #define EV_FEATURES 0
4520\& #define EV_MULTIPLICITY 1
4521\& #define EV_USE_POLL 1
4522\& #define EV_CHILD_ENABLE 1
4523\& #define EV_ASYNC_ENABLE 1
4524.Ve
4525.Sp
4526The actual value is a bitset, it can be a combination of the following
4527values:
4528.RS 4
4529.ie n .IP "1 \- faster/larger code" 4
4530.el .IP "\f(CW1\fR \- faster/larger code" 4
4531.IX Item "1 - faster/larger code"
4532Use larger code to speed up some operations.
4533.Sp
4534Currently this is used to override some inlining decisions (enlarging the
4535code size by roughly 30% on amd64).
4536.Sp
4537When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4538gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4539assertions.
4540.ie n .IP "2 \- faster/larger data structures" 4
4541.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4542.IX Item "2 - faster/larger data structures"
4543Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4544hash table sizes and so on. This will usually further increase code size
4545and can additionally have an effect on the size of data structures at
4546runtime.
4547.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4548.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4549.IX Item "4 - full API configuration"
4550This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4551enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4552.ie n .IP "8 \- full \s-1API\s0" 4
4553.el .IP "\f(CW8\fR \- full \s-1API\s0" 4
4554.IX Item "8 - full API"
4555This enables a lot of the \*(L"lesser used\*(R" \s-1API\s0 functions. See \f(CW\*(C`ev.h\*(C'\fR for
4556details on which parts of the \s-1API\s0 are still available without this
4557feature, and do not complain if this subset changes over time.
4558.ie n .IP "16 \- enable all optional watcher types" 4
4559.el .IP "\f(CW16\fR \- enable all optional watcher types" 4
4560.IX Item "16 - enable all optional watcher types"
4561Enables all optional watcher types. If you want to selectively enable
4562only some watcher types other than I/O and timers (e.g. prepare,
4563embed, async, child...) you can enable them manually by defining
4564\&\f(CW\*(C`EV_watchertype_ENABLE\*(C'\fR to \f(CW1\fR instead.
4565.ie n .IP "32 \- enable all backends" 4
4566.el .IP "\f(CW32\fR \- enable all backends" 4
4567.IX Item "32 - enable all backends"
4568This enables all backends \- without this feature, you need to enable at
4569least one backend manually (\f(CW\*(C`EV_USE_SELECT\*(C'\fR is a good choice).
4570.ie n .IP "64 \- enable OS-specific ""helper"" APIs" 4
4571.el .IP "\f(CW64\fR \- enable OS-specific ``helper'' APIs" 4
4572.IX Item "64 - enable OS-specific helper APIs"
4573Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
4574default.
4575.RE
4576.RS 4
4577.Sp
4578Compiling with \f(CW\*(C`gcc \-Os \-DEV_STANDALONE \-DEV_USE_EPOLL=1 \-DEV_FEATURES=0\*(C'\fR
4579reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
4580code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
4581watchers, timers and monotonic clock support.
4582.Sp
4583With an intelligent-enough linker (gcc+binutils are intelligent enough
4584when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by
4585your program might be left out as well \- a binary starting a timer and an
4586I/O watcher then might come out at only 5Kb.
4587.RE
4588.IP "\s-1EV_AVOID_STDIO\s0" 4
4589.IX Item "EV_AVOID_STDIO"
4590If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio
4591functions (printf, scanf, perror etc.). This will increase the code size
4592somewhat, but if your program doesn't otherwise depend on stdio and your
4593libc allows it, this avoids linking in the stdio library which is quite
4594big.
4595.Sp
4596Note that error messages might become less precise when this option is
4597enabled.
4598.IP "\s-1EV_NSIG\s0" 4
4599.IX Item "EV_NSIG"
4600The highest supported signal number, +1 (or, the number of
4601signals): Normally, libev tries to deduce the maximum number of signals
4602automatically, but sometimes this fails, in which case it can be
4603specified. Also, using a lower number than detected (\f(CW32\fR should be
4604good for about any system in existence) can save some memory, as libev
4605statically allocates some 12\-24 bytes per signal number.
3540.IP "\s-1EV_PID_HASHSIZE\s0" 4 4606.IP "\s-1EV_PID_HASHSIZE\s0" 4
3541.IX Item "EV_PID_HASHSIZE" 4607.IX Item "EV_PID_HASHSIZE"
3542\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 4608\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
3543pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 4609pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR disabled),
3544than enough. If you need to manage thousands of children you might want to 4610usually more than enough. If you need to manage thousands of children you
3545increase this value (\fImust\fR be a power of two). 4611might want to increase this value (\fImust\fR be a power of two).
3546.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 4612.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
3547.IX Item "EV_INOTIFY_HASHSIZE" 4613.IX Item "EV_INOTIFY_HASHSIZE"
3548\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by 4614\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
3549inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), 4615inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR
3550usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR 4616disabled), usually more than enough. If you need to manage thousands of
3551watchers you might want to increase this value (\fImust\fR be a power of 4617\&\f(CW\*(C`ev_stat\*(C'\fR watchers you might want to increase this value (\fImust\fR be a
3552two). 4618power of two).
3553.IP "\s-1EV_USE_4HEAP\s0" 4 4619.IP "\s-1EV_USE_4HEAP\s0" 4
3554.IX Item "EV_USE_4HEAP" 4620.IX Item "EV_USE_4HEAP"
3555Heaps are not very cache-efficient. To improve the cache-efficiency of the 4621Heaps are not very cache-efficient. To improve the cache-efficiency of the
3556timer and periodics heaps, libev uses a 4\-heap when this symbol is defined 4622timer and periodics heaps, libev uses a 4\-heap when this symbol is defined
3557to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably 4623to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably
3558faster performance with many (thousands) of watchers. 4624faster performance with many (thousands) of watchers.
3559.Sp 4625.Sp
3560The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR 4626The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
3561(disabled). 4627will be \f(CW0\fR.
3562.IP "\s-1EV_HEAP_CACHE_AT\s0" 4 4628.IP "\s-1EV_HEAP_CACHE_AT\s0" 4
3563.IX Item "EV_HEAP_CACHE_AT" 4629.IX Item "EV_HEAP_CACHE_AT"
3564Heaps are not very cache-efficient. To improve the cache-efficiency of the 4630Heaps are not very cache-efficient. To improve the cache-efficiency of the
3565timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within 4631timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within
3566the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR), 4632the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR),
3567which uses 8\-12 bytes more per watcher and a few hundred bytes more code, 4633which uses 8\-12 bytes more per watcher and a few hundred bytes more code,
3568but avoids random read accesses on heap changes. This improves performance 4634but avoids random read accesses on heap changes. This improves performance
3569noticeably with many (hundreds) of watchers. 4635noticeably with many (hundreds) of watchers.
3570.Sp 4636.Sp
3571The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR 4637The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
3572(disabled). 4638will be \f(CW0\fR.
3573.IP "\s-1EV_VERIFY\s0" 4 4639.IP "\s-1EV_VERIFY\s0" 4
3574.IX Item "EV_VERIFY" 4640.IX Item "EV_VERIFY"
3575Controls how much internal verification (see \f(CW\*(C`ev_loop_verify ()\*(C'\fR) will 4641Controls how much internal verification (see \f(CW\*(C`ev_verify ()\*(C'\fR) will
3576be done: If set to \f(CW0\fR, no internal verification code will be compiled 4642be done: If set to \f(CW0\fR, no internal verification code will be compiled
3577in. If set to \f(CW1\fR, then verification code will be compiled in, but not 4643in. If set to \f(CW1\fR, then verification code will be compiled in, but not
3578called. If set to \f(CW2\fR, then the internal verification code will be 4644called. If set to \f(CW2\fR, then the internal verification code will be
3579called once per loop, which can slow down libev. If set to \f(CW3\fR, then the 4645called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
3580verification code will be called very frequently, which will slow down 4646verification code will be called very frequently, which will slow down
3581libev considerably. 4647libev considerably.
3582.Sp 4648.Sp
3583The default is \f(CW1\fR, unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set, in which case it will be 4649The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
3584\&\f(CW0\fR. 4650will be \f(CW0\fR.
3585.IP "\s-1EV_COMMON\s0" 4 4651.IP "\s-1EV_COMMON\s0" 4
3586.IX Item "EV_COMMON" 4652.IX Item "EV_COMMON"
3587By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 4653By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
3588this macro to a something else you can include more and other types of 4654this macro to something else you can include more and other types of
3589members. You have to define it each time you include one of the files, 4655members. You have to define it each time you include one of the files,
3590though, and it must be identical each time. 4656though, and it must be identical each time.
3591.Sp 4657.Sp
3592For example, the perl \s-1EV\s0 module uses something like this: 4658For example, the perl \s-1EV\s0 module uses something like this:
3593.Sp 4659.Sp
3608and the way callbacks are invoked and set. Must expand to a struct member 4674and the way callbacks are invoked and set. Must expand to a struct member
3609definition and a statement, respectively. See the \fIev.h\fR header file for 4675definition and a statement, respectively. See the \fIev.h\fR header file for
3610their default definitions. One possible use for overriding these is to 4676their default definitions. One possible use for overriding these is to
3611avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 4677avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
3612method calls instead of plain function calls in \*(C+. 4678method calls instead of plain function calls in \*(C+.
3613.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 4679.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
3614.IX Subsection "EXPORTED API SYMBOLS" 4680.IX Subsection "EXPORTED API SYMBOLS"
3615If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 4681If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
3616exported symbols, you can use the provided \fISymbol.*\fR files which list 4682exported symbols, you can use the provided \fISymbol.*\fR files which list
3617all public symbols, one per line: 4683all public symbols, one per line:
3618.PP 4684.PP
3638\& #define ev_backend myprefix_ev_backend 4704\& #define ev_backend myprefix_ev_backend
3639\& #define ev_check_start myprefix_ev_check_start 4705\& #define ev_check_start myprefix_ev_check_start
3640\& #define ev_check_stop myprefix_ev_check_stop 4706\& #define ev_check_stop myprefix_ev_check_stop
3641\& ... 4707\& ...
3642.Ve 4708.Ve
3643.Sh "\s-1EXAMPLES\s0" 4709.SS "\s-1EXAMPLES\s0"
3644.IX Subsection "EXAMPLES" 4710.IX Subsection "EXAMPLES"
3645For a real-world example of a program the includes libev 4711For a real-world example of a program the includes libev
3646verbatim, you can have a look at the \s-1EV\s0 perl module 4712verbatim, you can have a look at the \s-1EV\s0 perl module
3647(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in 4713(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
3648the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public 4714the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
3651file. 4717file.
3652.PP 4718.PP
3653The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 4719The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
3654that everybody includes and which overrides some configure choices: 4720that everybody includes and which overrides some configure choices:
3655.PP 4721.PP
3656.Vb 9 4722.Vb 8
3657\& #define EV_MINIMAL 1 4723\& #define EV_FEATURES 8
3658\& #define EV_USE_POLL 0 4724\& #define EV_USE_SELECT 1
3659\& #define EV_MULTIPLICITY 0
3660\& #define EV_PERIODIC_ENABLE 0 4725\& #define EV_PREPARE_ENABLE 1
4726\& #define EV_IDLE_ENABLE 1
3661\& #define EV_STAT_ENABLE 0 4727\& #define EV_SIGNAL_ENABLE 1
3662\& #define EV_FORK_ENABLE 0 4728\& #define EV_CHILD_ENABLE 1
4729\& #define EV_USE_STDEXCEPT 0
3663\& #define EV_CONFIG_H <config.h> 4730\& #define EV_CONFIG_H <config.h>
3664\& #define EV_MINPRI 0
3665\& #define EV_MAXPRI 0
3666\& 4731\&
3667\& #include "ev++.h" 4732\& #include "ev++.h"
3668.Ve 4733.Ve
3669.PP 4734.PP
3670And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 4735And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
3671.PP 4736.PP
3672.Vb 2 4737.Vb 2
3673\& #include "ev_cpp.h" 4738\& #include "ev_cpp.h"
3674\& #include "ev.c" 4739\& #include "ev.c"
3675.Ve 4740.Ve
3676.SH "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" 4741.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
3677.IX Header "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" 4742.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
3678.Sh "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 4743.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0"
3679.IX Subsection "THREADS AND COROUTINES" 4744.IX Subsection "THREADS AND COROUTINES"
3680\fI\s-1THREADS\s0\fR 4745\fI\s-1THREADS\s0\fR
3681.IX Subsection "THREADS" 4746.IX Subsection "THREADS"
3682.PP 4747.PP
3683All libev functions are reentrant and thread-safe unless explicitly 4748All libev functions are reentrant and thread-safe unless explicitly
3729An example use would be to communicate signals or other events that only 4794An example use would be to communicate signals or other events that only
3730work in the default loop by registering the signal watcher with the 4795work in the default loop by registering the signal watcher with the
3731default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 4796default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
3732watcher callback into the event loop interested in the signal. 4797watcher callback into the event loop interested in the signal.
3733.PP 4798.PP
4799See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R".
4800.PP
3734\fI\s-1COROUTINES\s0\fR 4801\fI\s-1COROUTINES\s0\fR
3735.IX Subsection "COROUTINES" 4802.IX Subsection "COROUTINES"
3736.PP 4803.PP
3737Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 4804Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
3738libev fully supports nesting calls to its functions from different 4805libev fully supports nesting calls to its functions from different
3739coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two 4806coroutines (e.g. you can call \f(CW\*(C`ev_run\*(C'\fR on the same loop from two
3740different coroutines, and switch freely between both coroutines running the 4807different coroutines, and switch freely between both coroutines running
3741loop, as long as you don't confuse yourself). The only exception is that 4808the loop, as long as you don't confuse yourself). The only exception is
3742you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 4809that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
3743.PP 4810.PP
3744Care has been taken to ensure that libev does not keep local state inside 4811Care has been taken to ensure that libev does not keep local state inside
3745\&\f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow for coroutine switches as 4812\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
3746they do not call any callbacks. 4813they do not call any callbacks.
3747.Sh "\s-1COMPILER\s0 \s-1WARNINGS\s0" 4814.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0"
3748.IX Subsection "COMPILER WARNINGS" 4815.IX Subsection "COMPILER WARNINGS"
3749Depending on your compiler and compiler settings, you might get no or a 4816Depending on your compiler and compiler settings, you might get no or a
3750lot of warnings when compiling libev code. Some people are apparently 4817lot of warnings when compiling libev code. Some people are apparently
3751scared by this. 4818scared by this.
3752.PP 4819.PP
3760maintainable. 4827maintainable.
3761.PP 4828.PP
3762And of course, some compiler warnings are just plain stupid, or simply 4829And of course, some compiler warnings are just plain stupid, or simply
3763wrong (because they don't actually warn about the condition their message 4830wrong (because they don't actually warn about the condition their message
3764seems to warn about). For example, certain older gcc versions had some 4831seems to warn about). For example, certain older gcc versions had some
3765warnings that resulted an extreme number of false positives. These have 4832warnings that resulted in an extreme number of false positives. These have
3766been fixed, but some people still insist on making code warn-free with 4833been fixed, but some people still insist on making code warn-free with
3767such buggy versions. 4834such buggy versions.
3768.PP 4835.PP
3769While libev is written to generate as few warnings as possible, 4836While libev is written to generate as few warnings as possible,
3770\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev 4837\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
3771with any compiler warnings enabled unless you are prepared to cope with 4838with any compiler warnings enabled unless you are prepared to cope with
3772them (e.g. by ignoring them). Remember that warnings are just that: 4839them (e.g. by ignoring them). Remember that warnings are just that:
3773warnings, not errors, or proof of bugs. 4840warnings, not errors, or proof of bugs.
3774.Sh "\s-1VALGRIND\s0" 4841.SS "\s-1VALGRIND\s0"
3775.IX Subsection "VALGRIND" 4842.IX Subsection "VALGRIND"
3776Valgrind has a special section here because it is a popular tool that is 4843Valgrind has a special section here because it is a popular tool that is
3777highly useful. Unfortunately, valgrind reports are very hard to interpret. 4844highly useful. Unfortunately, valgrind reports are very hard to interpret.
3778.PP 4845.PP
3779If you think you found a bug (memory leak, uninitialised data access etc.) 4846If you think you found a bug (memory leak, uninitialised data access etc.)
3804.PP 4871.PP
3805If you need, for some reason, empty reports from valgrind for your project 4872If you need, for some reason, empty reports from valgrind for your project
3806I suggest using suppression lists. 4873I suggest using suppression lists.
3807.SH "PORTABILITY NOTES" 4874.SH "PORTABILITY NOTES"
3808.IX Header "PORTABILITY NOTES" 4875.IX Header "PORTABILITY NOTES"
4876.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0"
4877.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
4878GNU/Linux is the only common platform that supports 64 bit file/large file
4879interfaces but \fIdisables\fR them by default.
4880.PP
4881That means that libev compiled in the default environment doesn't support
4882files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
4883.PP
4884Unfortunately, many programs try to work around this GNU/Linux issue
4885by enabling the large file \s-1API\s0, which makes them incompatible with the
4886standard libev compiled for their system.
4887.PP
4888Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
4889suddenly make it incompatible to the default compile time environment,
4890i.e. all programs not using special compile switches.
4891.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0"
4892.IX Subsection "OS/X AND DARWIN BUGS"
4893The whole thing is a bug if you ask me \- basically any system interface
4894you touch is broken, whether it is locales, poll, kqueue or even the
4895OpenGL drivers.
4896.PP
4897\fI\f(CI\*(C`kqueue\*(C'\fI is buggy\fR
4898.IX Subsection "kqueue is buggy"
4899.PP
4900The kqueue syscall is broken in all known versions \- most versions support
4901only sockets, many support pipes.
4902.PP
4903Libev tries to work around this by not using \f(CW\*(C`kqueue\*(C'\fR by default on this
4904rotten platform, but of course you can still ask for it when creating a
4905loop \- embedding a socket-only kqueue loop into a select-based one is
4906probably going to work well.
4907.PP
4908\fI\f(CI\*(C`poll\*(C'\fI is buggy\fR
4909.IX Subsection "poll is buggy"
4910.PP
4911Instead of fixing \f(CW\*(C`kqueue\*(C'\fR, Apple replaced their (working) \f(CW\*(C`poll\*(C'\fR
4912implementation by something calling \f(CW\*(C`kqueue\*(C'\fR internally around the 10.5.6
4913release, so now \f(CW\*(C`kqueue\*(C'\fR \fIand\fR \f(CW\*(C`poll\*(C'\fR are broken.
4914.PP
4915Libev tries to work around this by not using \f(CW\*(C`poll\*(C'\fR by default on
4916this rotten platform, but of course you can still ask for it when creating
4917a loop.
4918.PP
4919\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
4920.IX Subsection "select is buggy"
4921.PP
4922All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
4923one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file
4924descriptors you can pass in to 1024 \- your program suddenly crashes when
4925you use more.
4926.PP
4927There is an undocumented \*(L"workaround\*(R" for this \- defining
4928\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
4929work on \s-1OS/X\s0.
4930.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0"
4931.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
4932\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
4933.IX Subsection "errno reentrancy"
4934.PP
4935The default compile environment on Solaris is unfortunately so
4936thread-unsafe that you can't even use components/libraries compiled
4937without \f(CW\*(C`\-D_REENTRANT\*(C'\fR in a threaded program, which, of course, isn't
4938defined by default. A valid, if stupid, implementation choice.
4939.PP
4940If you want to use libev in threaded environments you have to make sure
4941it's compiled with \f(CW\*(C`_REENTRANT\*(C'\fR defined.
4942.PP
4943\fIEvent port backend\fR
4944.IX Subsection "Event port backend"
4945.PP
4946The scalable event interface for Solaris is called \*(L"event
4947ports\*(R". Unfortunately, this mechanism is very buggy in all major
4948releases. If you run into high \s-1CPU\s0 usage, your program freezes or you get
4949a large number of spurious wakeups, make sure you have all the relevant
4950and latest kernel patches applied. No, I don't know which ones, but there
4951are multiple ones to apply, and afterwards, event ports actually work
4952great.
4953.PP
4954If you can't get it to work, you can try running the program by setting
4955the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
4956\&\f(CW\*(C`select\*(C'\fR backends.
4957.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0"
4958.IX Subsection "AIX POLL BUG"
4959\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
4960this by trying to avoid the poll backend altogether (i.e. it's not even
4961compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
4962with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway.
3809.Sh "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 4963.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0"
3810.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 4964.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
4965\fIGeneral issues\fR
4966.IX Subsection "General issues"
4967.PP
3811Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 4968Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
3812requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 4969requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
3813model. Libev still offers limited functionality on this platform in 4970model. Libev still offers limited functionality on this platform in
3814the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 4971the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
3815descriptors. This only applies when using Win32 natively, not when using 4972descriptors. This only applies when using Win32 natively, not when using
3816e.g. cygwin. 4973e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4974as every compielr comes with a slightly differently broken/incompatible
4975environment.
3817.PP 4976.PP
3818Lifting these limitations would basically require the full 4977Lifting these limitations would basically require the full
3819re-implementation of the I/O system. If you are into these kinds of 4978re-implementation of the I/O system. If you are into this kind of thing,
3820things, then note that glib does exactly that for you in a very portable 4979then note that glib does exactly that for you in a very portable way (note
3821way (note also that glib is the slowest event library known to man). 4980also that glib is the slowest event library known to man).
3822.PP 4981.PP
3823There is no supported compilation method available on windows except 4982There is no supported compilation method available on windows except
3824embedding it into other applications. 4983embedding it into other applications.
4984.PP
4985Sensible signal handling is officially unsupported by Microsoft \- libev
4986tries its best, but under most conditions, signals will simply not work.
3825.PP 4987.PP
3826Not a libev limitation but worth mentioning: windows apparently doesn't 4988Not a libev limitation but worth mentioning: windows apparently doesn't
3827accept large writes: instead of resulting in a partial write, windows will 4989accept large writes: instead of resulting in a partial write, windows will
3828either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large, 4990either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large,
3829so make sure you only write small amounts into your sockets (less than a 4991so make sure you only write small amounts into your sockets (less than a
3834the abysmal performance of winsockets, using a large number of sockets 4996the abysmal performance of winsockets, using a large number of sockets
3835is not recommended (and not reasonable). If your program needs to use 4997is not recommended (and not reasonable). If your program needs to use
3836more than a hundred or so sockets, then likely it needs to use a totally 4998more than a hundred or so sockets, then likely it needs to use a totally
3837different implementation for windows, as libev offers the \s-1POSIX\s0 readiness 4999different implementation for windows, as libev offers the \s-1POSIX\s0 readiness
3838notification model, which cannot be implemented efficiently on windows 5000notification model, which cannot be implemented efficiently on windows
3839(Microsoft monopoly games). 5001(due to Microsoft monopoly games).
3840.PP 5002.PP
3841A typical way to use libev under windows is to embed it (see the embedding 5003A typical way to use libev under windows is to embed it (see the embedding
3842section for details) and use the following \fIevwrap.h\fR header file instead 5004section for details) and use the following \fIevwrap.h\fR header file instead
3843of \fIev.h\fR: 5005of \fIev.h\fR:
3844.PP 5006.PP
3854.PP 5016.PP
3855.Vb 2 5017.Vb 2
3856\& #include "evwrap.h" 5018\& #include "evwrap.h"
3857\& #include "ev.c" 5019\& #include "ev.c"
3858.Ve 5020.Ve
3859.IP "The winsocket select function" 4 5021.PP
5022\fIThe winsocket \f(CI\*(C`select\*(C'\fI function\fR
3860.IX Item "The winsocket select function" 5023.IX Subsection "The winsocket select function"
5024.PP
3861The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it 5025The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
3862requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is 5026requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
3863also extremely buggy). This makes select very inefficient, and also 5027also extremely buggy). This makes select very inefficient, and also
3864requires a mapping from file descriptors to socket handles (the Microsoft 5028requires a mapping from file descriptors to socket handles (the Microsoft
3865C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the 5029C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
3866discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and 5030discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
3867\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info. 5031\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
3868.Sp 5032.PP
3869The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime 5033The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime
3870libraries and raw winsocket select is: 5034libraries and raw winsocket select is:
3871.Sp 5035.PP
3872.Vb 2 5036.Vb 2
3873\& #define EV_USE_SELECT 1 5037\& #define EV_USE_SELECT 1
3874\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5038\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3875.Ve 5039.Ve
3876.Sp 5040.PP
3877Note that winsockets handling of fd sets is O(n), so you can easily get a 5041Note that winsockets handling of fd sets is O(n), so you can easily get a
3878complexity in the O(nA\*^X) range when using win32. 5042complexity in the O(nA\*^X) range when using win32.
5043.PP
3879.IP "Limited number of file descriptors" 4 5044\fILimited number of file descriptors\fR
3880.IX Item "Limited number of file descriptors" 5045.IX Subsection "Limited number of file descriptors"
5046.PP
3881Windows has numerous arbitrary (and low) limits on things. 5047Windows has numerous arbitrary (and low) limits on things.
3882.Sp 5048.PP
3883Early versions of winsocket's select only supported waiting for a maximum 5049Early versions of winsocket's select only supported waiting for a maximum
3884of \f(CW64\fR handles (probably owning to the fact that all windows kernels 5050of \f(CW64\fR handles (probably owning to the fact that all windows kernels
3885can only wait for \f(CW64\fR things at the same time internally; Microsoft 5051can only wait for \f(CW64\fR things at the same time internally; Microsoft
3886recommends spawning a chain of threads and wait for 63 handles and the 5052recommends spawning a chain of threads and wait for 63 handles and the
3887previous thread in each. Great). 5053previous thread in each. Sounds great!).
3888.Sp 5054.PP
3889Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR 5055Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
3890to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select 5056to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
3891call (which might be in libev or elsewhere, for example, perl does its own 5057call (which might be in libev or elsewhere, for example, perl and many
3892select emulation on windows). 5058other interpreters do their own select emulation on windows).
3893.Sp 5059.PP
3894Another limit is the number of file descriptors in the Microsoft runtime 5060Another limit is the number of file descriptors in the Microsoft runtime
3895libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish 5061libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR
3896or something like this inside Microsoft). You can increase this by calling 5062fetish or something like this inside Microsoft). You can increase this
3897\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another 5063by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
3898arbitrary limit), but is broken in many versions of the Microsoft runtime 5064(another arbitrary limit), but is broken in many versions of the Microsoft
3899libraries.
3900.Sp
3901This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on 5065runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
3902windows version and/or the phase of the moon). To get more, you need to 5066(depending on windows version and/or the phase of the moon). To get more,
3903wrap all I/O functions and provide your own fd management, but the cost of 5067you need to wrap all I/O functions and provide your own fd management, but
3904calling select (O(nA\*^X)) will likely make this unworkable. 5068the cost of calling select (O(nA\*^X)) will likely make this unworkable.
3905.Sh "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5069.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0"
3906.IX Subsection "PORTABILITY REQUIREMENTS" 5070.IX Subsection "PORTABILITY REQUIREMENTS"
3907In addition to a working ISO-C implementation and of course the 5071In addition to a working ISO-C implementation and of course the
3908backend-specific APIs, libev relies on a few additional extensions: 5072backend-specific APIs, libev relies on a few additional extensions:
3909.ie n .IP """void (*)(ev_watcher_type *, int revents)""\fR must have compatible calling conventions regardless of \f(CW""ev_watcher_type *""." 4 5073.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
3910.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5074.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
3911.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5075.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
3912Libev assumes not only that all watcher pointers have the same internal 5076Libev assumes not only that all watcher pointers have the same internal
3913structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5077structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also
3914assumes that the same (machine) code can be used to call any watcher 5078assumes that the same (machine) code can be used to call any watcher
3915callback: The watcher callbacks have different type signatures, but libev 5079callback: The watcher callbacks have different type signatures, but libev
3916calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5080calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5081.IP "pointer accesses must be thread-atomic" 4
5082.IX Item "pointer accesses must be thread-atomic"
5083Accessing a pointer value must be atomic, it must both be readable and
5084writable in one piece \- this is the case on all current architectures.
3917.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5085.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
3918.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4 5086.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
3919.IX Item "sig_atomic_t volatile must be thread-atomic as well" 5087.IX Item "sig_atomic_t volatile must be thread-atomic as well"
3920The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as 5088The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
3921\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different 5089\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different
3944watchers. 5112watchers.
3945.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5113.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
3946.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4 5114.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
3947.IX Item "double must hold a time value in seconds with enough accuracy" 5115.IX Item "double must hold a time value in seconds with enough accuracy"
3948The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5116The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
3949have at least 51 bits of mantissa (and 9 bits of exponent), which is good 5117have at least 51 bits of mantissa (and 9 bits of exponent), which is
3950enough for at least into the year 4000. This requirement is fulfilled by 5118good enough for at least into the year 4000 with millisecond accuracy
5119(the design goal for libev). This requirement is overfulfilled by
3951implementations implementing \s-1IEEE\s0 754 (basically all existing ones). 5120implementations using \s-1IEEE\s0 754, which is basically all existing ones. With
5121\&\s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least 2200.
3952.PP 5122.PP
3953If you know of other additional requirements drop me a note. 5123If you know of other additional requirements drop me a note.
3954.SH "ALGORITHMIC COMPLEXITIES" 5124.SH "ALGORITHMIC COMPLEXITIES"
3955.IX Header "ALGORITHMIC COMPLEXITIES" 5125.IX Header "ALGORITHMIC COMPLEXITIES"
3956In this section the complexities of (many of) the algorithms used inside 5126In this section the complexities of (many of) the algorithms used inside
4012.IX Item "Processing signals: O(max_signal_number)" 5182.IX Item "Processing signals: O(max_signal_number)"
4013.PD 5183.PD
4014Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 5184Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
4015calls in the current loop iteration. Checking for async and signal events 5185calls in the current loop iteration. Checking for async and signal events
4016involves iterating over all running async watchers or all signal numbers. 5186involves iterating over all running async watchers or all signal numbers.
5187.SH "PORTING FROM LIBEV 3.X TO 4.X"
5188.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5189The major version 4 introduced some incompatible changes to the \s-1API\s0.
5190.PP
5191At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5192for all changes, so most programs should still compile. The compatibility
5193layer might be removed in later versions of libev, so better update to the
5194new \s-1API\s0 early than late.
5195.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5196.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5197.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5198The backward compatibility mechanism can be controlled by
5199\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1MACROS\s0\*(R" in \s-1PREPROCESSOR\s0 \s-1SYMBOLS\s0 in the \s-1EMBEDDING\s0
5200section.
5201.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5202.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5203.IX Item "ev_default_destroy and ev_default_fork have been removed"
5204These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5205.Sp
5206.Vb 2
5207\& ev_loop_destroy (EV_DEFAULT_UC);
5208\& ev_loop_fork (EV_DEFAULT);
5209.Ve
5210.IP "function/symbol renames" 4
5211.IX Item "function/symbol renames"
5212A number of functions and symbols have been renamed:
5213.Sp
5214.Vb 3
5215\& ev_loop => ev_run
5216\& EVLOOP_NONBLOCK => EVRUN_NOWAIT
5217\& EVLOOP_ONESHOT => EVRUN_ONCE
5218\&
5219\& ev_unloop => ev_break
5220\& EVUNLOOP_CANCEL => EVBREAK_CANCEL
5221\& EVUNLOOP_ONE => EVBREAK_ONE
5222\& EVUNLOOP_ALL => EVBREAK_ALL
5223\&
5224\& EV_TIMEOUT => EV_TIMER
5225\&
5226\& ev_loop_count => ev_iteration
5227\& ev_loop_depth => ev_depth
5228\& ev_loop_verify => ev_verify
5229.Ve
5230.Sp
5231Most functions working on \f(CW\*(C`struct ev_loop\*(C'\fR objects don't have an
5232\&\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
5233associated constants have been renamed to not collide with the \f(CW\*(C`struct
5234ev_loop\*(C'\fR anymore and \f(CW\*(C`EV_TIMER\*(C'\fR now follows the same naming scheme
5235as all other watcher types. Note that \f(CW\*(C`ev_loop_fork\*(C'\fR is still called
5236\&\f(CW\*(C`ev_loop_fork\*(C'\fR because it would otherwise clash with the \f(CW\*(C`ev_fork\*(C'\fR
5237typedef.
5238.ie n .IP """EV_MINIMAL"" mechanism replaced by ""EV_FEATURES""" 4
5239.el .IP "\f(CWEV_MINIMAL\fR mechanism replaced by \f(CWEV_FEATURES\fR" 4
5240.IX Item "EV_MINIMAL mechanism replaced by EV_FEATURES"
5241The preprocessor symbol \f(CW\*(C`EV_MINIMAL\*(C'\fR has been replaced by a different
5242mechanism, \f(CW\*(C`EV_FEATURES\*(C'\fR. Programs using \f(CW\*(C`EV_MINIMAL\*(C'\fR usually compile
5243and work, but the library code will of course be larger.
5244.SH "GLOSSARY"
5245.IX Header "GLOSSARY"
5246.IP "active" 4
5247.IX Item "active"
5248A watcher is active as long as it has been started and not yet stopped.
5249See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details.
5250.IP "application" 4
5251.IX Item "application"
5252In this document, an application is whatever is using libev.
5253.IP "backend" 4
5254.IX Item "backend"
5255The part of the code dealing with the operating system interfaces.
5256.IP "callback" 4
5257.IX Item "callback"
5258The address of a function that is called when some event has been
5259detected. Callbacks are being passed the event loop, the watcher that
5260received the event, and the actual event bitset.
5261.IP "callback/watcher invocation" 4
5262.IX Item "callback/watcher invocation"
5263The act of calling the callback associated with a watcher.
5264.IP "event" 4
5265.IX Item "event"
5266A change of state of some external event, such as data now being available
5267for reading on a file descriptor, time having passed or simply not having
5268any other events happening anymore.
5269.Sp
5270In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or
5271\&\f(CW\*(C`EV_TIMER\*(C'\fR).
5272.IP "event library" 4
5273.IX Item "event library"
5274A software package implementing an event model and loop.
5275.IP "event loop" 4
5276.IX Item "event loop"
5277An entity that handles and processes external events and converts them
5278into callback invocations.
5279.IP "event model" 4
5280.IX Item "event model"
5281The model used to describe how an event loop handles and processes
5282watchers and events.
5283.IP "pending" 4
5284.IX Item "pending"
5285A watcher is pending as soon as the corresponding event has been
5286detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details.
5287.IP "real time" 4
5288.IX Item "real time"
5289The physical time that is observed. It is apparently strictly monotonic :)
5290.IP "wall-clock time" 4
5291.IX Item "wall-clock time"
5292The time and date as shown on clocks. Unlike real time, it can actually
5293be wrong and jump forwards and backwards, e.g. when the you adjust your
5294clock.
5295.IP "watcher" 4
5296.IX Item "watcher"
5297A data structure that describes interest in certain events. Watchers need
5298to be started (attached to an event loop) before they can receive events.
4017.SH "AUTHOR" 5299.SH "AUTHOR"
4018.IX Header "AUTHOR" 5300.IX Header "AUTHOR"
4019Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. 5301Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5302Magnusson and Emanuele Giaquinta.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines