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

Comparing libev/ev.3 (file contents):
Revision 1.79 by root, Fri Jul 17 14:43:38 2009 UTC vs.
Revision 1.102 by root, Fri Sep 5 16:00:17 2014 UTC

1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) 1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
36.el\{\ 36.el\{\
37. ds -- \|\(em\| 37. ds -- \|\(em\|
38. ds PI \(*p 38. ds PI \(*p
39. ds L" `` 39. ds L" ``
40. ds R" '' 40. ds R" ''
41. ds C`
42. ds C'
41'br\} 43'br\}
42.\" 44.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
45.el .ds Aq ' 47.el .ds Aq '
46.\" 48.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
51.ie \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
52. de IX 55.de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54.. 56..
55. nr % 0 57.nr rF 0
56. rr F 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
60. if \nF \{
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
63..
64. if !\nF==2 \{
65. nr % 0
66. nr F 2
67. \}
68. \}
57.\} 69.\}
58.el \{\ 70.rr rF
59. de IX
60..
61.\}
62.\" 71.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
66.if n \{\ 75.if n \{\
122.\} 131.\}
123.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
124.\" ======================================================================== 133.\" ========================================================================
125.\" 134.\"
126.IX Title "LIBEV 3" 135.IX Title "LIBEV 3"
127.TH LIBEV 3 "2009-07-15" "libev-3.7" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2014-09-05" "libev-4.15" "libev - high performance full featured event loop"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
130.if n .ad l 139.if n .ad l
131.nh 140.nh
132.SH "NAME" 141.SH "NAME"
134.SH "SYNOPSIS" 143.SH "SYNOPSIS"
135.IX Header "SYNOPSIS" 144.IX Header "SYNOPSIS"
136.Vb 1 145.Vb 1
137\& #include <ev.h> 146\& #include <ev.h>
138.Ve 147.Ve
139.SS "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 148.SS "\s-1EXAMPLE PROGRAM\s0"
140.IX Subsection "EXAMPLE PROGRAM" 149.IX Subsection "EXAMPLE PROGRAM"
141.Vb 2 150.Vb 2
142\& // a single header file is required 151\& // a single header file is required
143\& #include <ev.h> 152\& #include <ev.h>
144\& 153\&
157\& puts ("stdin ready"); 166\& puts ("stdin ready");
158\& // for one\-shot events, one must manually stop the watcher 167\& // for one\-shot events, one must manually stop the watcher
159\& // with its corresponding stop function. 168\& // with its corresponding stop function.
160\& ev_io_stop (EV_A_ w); 169\& ev_io_stop (EV_A_ w);
161\& 170\&
162\& // this causes all nested ev_loop\*(Aqs to stop iterating 171\& // this causes all nested ev_run\*(Aqs to stop iterating
163\& ev_unloop (EV_A_ EVUNLOOP_ALL); 172\& ev_break (EV_A_ EVBREAK_ALL);
164\& } 173\& }
165\& 174\&
166\& // another callback, this time for a time\-out 175\& // another callback, this time for a time\-out
167\& static void 176\& static void
168\& timeout_cb (EV_P_ ev_timer *w, int revents) 177\& timeout_cb (EV_P_ ev_timer *w, int revents)
169\& { 178\& {
170\& puts ("timeout"); 179\& puts ("timeout");
171\& // this causes the innermost ev_loop to stop iterating 180\& // this causes the innermost ev_run to stop iterating
172\& ev_unloop (EV_A_ EVUNLOOP_ONE); 181\& ev_break (EV_A_ EVBREAK_ONE);
173\& } 182\& }
174\& 183\&
175\& int 184\& int
176\& main (void) 185\& main (void)
177\& { 186\& {
178\& // use the default event loop unless you have special needs 187\& // use the default event loop unless you have special needs
179\& struct ev_loop *loop = ev_default_loop (0); 188\& struct ev_loop *loop = EV_DEFAULT;
180\& 189\&
181\& // initialise an io watcher, then start it 190\& // initialise an io watcher, then start it
182\& // this one will watch for stdin to become readable 191\& // this one will watch for stdin to become readable
183\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 192\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
184\& ev_io_start (loop, &stdin_watcher); 193\& ev_io_start (loop, &stdin_watcher);
187\& // simple non\-repeating 5.5 second timeout 196\& // simple non\-repeating 5.5 second timeout
188\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 197\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
189\& ev_timer_start (loop, &timeout_watcher); 198\& ev_timer_start (loop, &timeout_watcher);
190\& 199\&
191\& // now wait for events to arrive 200\& // now wait for events to arrive
192\& ev_loop (loop, 0); 201\& ev_run (loop, 0);
193\& 202\&
194\& // unloop was called, so exit 203\& // break was called, so exit
195\& return 0; 204\& return 0;
196\& } 205\& }
197.Ve 206.Ve
198.SH "ABOUT THIS DOCUMENT" 207.SH "ABOUT THIS DOCUMENT"
199.IX Header "ABOUT THIS DOCUMENT" 208.IX Header "ABOUT THIS DOCUMENT"
206While this document tries to be as complete as possible in documenting 215While 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 216libev, its usage and the rationale behind its design, it is not a tutorial
208on event-based programming, nor will it introduce event-based programming 217on event-based programming, nor will it introduce event-based programming
209with libev. 218with libev.
210.PP 219.PP
211Familarity with event based programming techniques in general is assumed 220Familiarity with event based programming techniques in general is assumed
212throughout this document. 221throughout this document.
222.SH "WHAT TO READ WHEN IN A HURRY"
223.IX Header "WHAT TO READ WHEN IN A HURRY"
224This manual tries to be very detailed, but unfortunately, this also makes
225it very long. If you just want to know the basics of libev, I suggest
226reading \*(L"\s-1ANATOMY OF A WATCHER\*(R"\s0, then the \*(L"\s-1EXAMPLE PROGRAM\*(R"\s0 above and
227look up the missing functions in \*(L"\s-1GLOBAL FUNCTIONS\*(R"\s0 and the \f(CW\*(C`ev_io\*(C'\fR and
228\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER TYPES\*(R"\s0.
213.SH "ABOUT LIBEV" 229.SH "ABOUT LIBEV"
214.IX Header "ABOUT LIBEV" 230.IX Header "ABOUT LIBEV"
215Libev is an event loop: you register interest in certain events (such as a 231Libev is an event loop: you register interest in certain events (such as a
216file descriptor being readable or a timeout occurring), and it will manage 232file descriptor being readable or a timeout occurring), and it will manage
217these event sources and provide your program with events. 233these event sources and provide your program with events.
227.SS "\s-1FEATURES\s0" 243.SS "\s-1FEATURES\s0"
228.IX Subsection "FEATURES" 244.IX Subsection "FEATURES"
229Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 245Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
230BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 246BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
231for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 247for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
232(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers 248(for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner
233with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals 249inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative
234(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event 250timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling
235watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, 251(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status
236\&\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 252change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event
237file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events 253loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and
238(\f(CW\*(C`ev_fork\*(C'\fR). 254\&\f(CW\*(C`ev_check\*(C'\fR watchers) as well as file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even
255limited support for fork events (\f(CW\*(C`ev_fork\*(C'\fR).
239.PP 256.PP
240It also is quite fast (see this 257It also is quite fast (see this
241<benchmark> comparing it to libevent 258benchmark <http://libev.schmorp.de/bench.html> comparing it to libevent
242for example). 259for example).
243.SS "\s-1CONVENTIONS\s0" 260.SS "\s-1CONVENTIONS\s0"
244.IX Subsection "CONVENTIONS" 261.IX Subsection "CONVENTIONS"
245Libev is very configurable. In this manual the default (and most common) 262Libev is very configurable. In this manual the default (and most common)
246configuration will be described, which supports multiple event loops. For 263configuration will be described, which supports multiple event loops. For
247more info about various configuration options please have a look at 264more info about various configuration options please have a look at
248\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support 265\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
249for multiple event loops, then all functions taking an initial argument of 266for multiple event loops, then all functions taking an initial argument of
250name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`ev_loop *\*(C'\fR) will not have 267name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
251this argument. 268this argument.
252.SS "\s-1TIME\s0 \s-1REPRESENTATION\s0" 269.SS "\s-1TIME REPRESENTATION\s0"
253.IX Subsection "TIME REPRESENTATION" 270.IX Subsection "TIME REPRESENTATION"
254Libev represents time as a single floating point number, representing 271Libev represents time as a single floating point number, representing
255the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere 272the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice
256near the beginning of 1970, details are complicated, don't ask). This 273somewhere near the beginning of 1970, details are complicated, don't
257type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually 274ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use
258aliases to the \f(CW\*(C`double\*(C'\fR type in C. When you need to do any calculations 275too. It usually aliases to the \f(CW\*(C`double\*(C'\fR type in C. When you need to do
259on it, you should treat it as some floating point value. Unlike the name 276any calculations on it, you should treat it as some floating point value.
277.PP
260component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences 278Unlike the name component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for
261throughout libev. 279time differences (e.g. delays) throughout libev.
262.SH "ERROR HANDLING" 280.SH "ERROR HANDLING"
263.IX Header "ERROR HANDLING" 281.IX Header "ERROR HANDLING"
264Libev knows three classes of errors: operating system errors, usage errors 282Libev knows three classes of errors: operating system errors, usage errors
265and internal errors (bugs). 283and internal errors (bugs).
266.PP 284.PP
284library in any way. 302library in any way.
285.IP "ev_tstamp ev_time ()" 4 303.IP "ev_tstamp ev_time ()" 4
286.IX Item "ev_tstamp ev_time ()" 304.IX Item "ev_tstamp ev_time ()"
287Returns the current time as libev would use it. Please note that the 305Returns the current time as libev would use it. Please note that the
288\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp 306\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp
289you actually want to know. 307you actually want to know. Also interesting is the combination of
308\&\f(CW\*(C`ev_now_update\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR.
290.IP "ev_sleep (ev_tstamp interval)" 4 309.IP "ev_sleep (ev_tstamp interval)" 4
291.IX Item "ev_sleep (ev_tstamp interval)" 310.IX Item "ev_sleep (ev_tstamp interval)"
292Sleep for the given interval: The current thread will be blocked until 311Sleep for the given interval: The current thread will be blocked
293either it is interrupted or the given time interval has passed. Basically 312until either it is interrupted or the given time interval has
313passed (approximately \- it might return a bit earlier even if not
314interrupted). Returns immediately if \f(CW\*(C`interval <= 0\*(C'\fR.
315.Sp
294this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR. 316Basically this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR.
317.Sp
318The range of the \f(CW\*(C`interval\*(C'\fR is limited \- libev only guarantees to work
319with sleep times of up to one day (\f(CW\*(C`interval <= 86400\*(C'\fR).
295.IP "int ev_version_major ()" 4 320.IP "int ev_version_major ()" 4
296.IX Item "int ev_version_major ()" 321.IX Item "int ev_version_major ()"
297.PD 0 322.PD 0
298.IP "int ev_version_minor ()" 4 323.IP "int ev_version_minor ()" 4
299.IX Item "int ev_version_minor ()" 324.IX Item "int ev_version_minor ()"
311as this indicates an incompatible change. Minor versions are usually 336as this indicates an incompatible change. Minor versions are usually
312compatible to older versions, so a larger minor version alone is usually 337compatible to older versions, so a larger minor version alone is usually
313not a problem. 338not a problem.
314.Sp 339.Sp
315Example: Make sure we haven't accidentally been linked against the wrong 340Example: Make sure we haven't accidentally been linked against the wrong
316version. 341version (note, however, that this will not detect other \s-1ABI\s0 mismatches,
342such as \s-1LFS\s0 or reentrancy).
317.Sp 343.Sp
318.Vb 3 344.Vb 3
319\& assert (("libev version mismatch", 345\& assert (("libev version mismatch",
320\& ev_version_major () == EV_VERSION_MAJOR 346\& ev_version_major () == EV_VERSION_MAJOR
321\& && ev_version_minor () >= EV_VERSION_MINOR)); 347\& && ev_version_minor () >= EV_VERSION_MINOR));
334\& assert (("sorry, no epoll, no sex", 360\& assert (("sorry, no epoll, no sex",
335\& ev_supported_backends () & EVBACKEND_EPOLL)); 361\& ev_supported_backends () & EVBACKEND_EPOLL));
336.Ve 362.Ve
337.IP "unsigned int ev_recommended_backends ()" 4 363.IP "unsigned int ev_recommended_backends ()" 4
338.IX Item "unsigned int ev_recommended_backends ()" 364.IX Item "unsigned int ev_recommended_backends ()"
339Return the set of all backends compiled into this binary of libev and also 365Return the set of all backends compiled into this binary of libev and
340recommended for this platform. This set is often smaller than the one 366also recommended for this platform, meaning it will work for most file
367descriptor types. This set is often smaller than the one returned by
341returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on 368\&\f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on most BSDs
342most BSDs and will not be auto-detected unless you explicitly request it 369and will not be auto-detected unless you explicitly request it (assuming
343(assuming you know what you are doing). This is the set of backends that 370you know what you are doing). This is the set of backends that libev will
344libev will probe for if you specify no backends explicitly. 371probe for if you specify no backends explicitly.
345.IP "unsigned int ev_embeddable_backends ()" 4 372.IP "unsigned int ev_embeddable_backends ()" 4
346.IX Item "unsigned int ev_embeddable_backends ()" 373.IX Item "unsigned int ev_embeddable_backends ()"
347Returns the set of backends that are embeddable in other event loops. This 374Returns the set of backends that are embeddable in other event loops. This
348is the theoretical, all-platform, value. To find which backends 375value is platform-specific but can include backends not available on the
349might be supported on the current system, you would need to look at 376current system. To find which embeddable backends might be supported on
350\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 377the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
351recommended ones. 378& ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
352.Sp 379.Sp
353See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 380See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
354.IP "ev_set_allocator (void *(*cb)(void *ptr, long size)) [\s-1NOT\s0 \s-1REENTRANT\s0]" 4 381.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4
355.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]" 382.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())"
356Sets the allocation function to use (the prototype is similar \- the 383Sets the allocation function to use (the prototype is similar \- the
357semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is 384semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
358used to allocate and free memory (no surprises here). If it returns zero 385used to allocate and free memory (no surprises here). If it returns zero
359when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort 386when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
360or take some potentially destructive action. 387or take some potentially destructive action.
386\& } 413\& }
387\& 414\&
388\& ... 415\& ...
389\& ev_set_allocator (persistent_realloc); 416\& ev_set_allocator (persistent_realloc);
390.Ve 417.Ve
391.IP "ev_set_syserr_cb (void (*cb)(const char *msg)); [\s-1NOT\s0 \s-1REENTRANT\s0]" 4 418.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
392.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]" 419.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())"
393Set the callback function to call on a retryable system call error (such 420Set the callback function to call on a retryable system call error (such
394as failed select, poll, epoll_wait). The message is a printable string 421as failed select, poll, epoll_wait). The message is a printable string
395indicating the system call or subsystem causing the problem. If this 422indicating the system call or subsystem causing the problem. If this
396callback is set, then libev will expect it to remedy the situation, no 423callback is set, then libev will expect it to remedy the situation, no
397matter what, when it returns. That is, libev will generally retry the 424matter what, when it returns. That is, libev will generally retry the
409\& } 436\& }
410\& 437\&
411\& ... 438\& ...
412\& ev_set_syserr_cb (fatal_error); 439\& ev_set_syserr_cb (fatal_error);
413.Ve 440.Ve
441.IP "ev_feed_signal (int signum)" 4
442.IX Item "ev_feed_signal (int signum)"
443This function can be used to \*(L"simulate\*(R" a signal receive. It is completely
444safe to call this function at any time, from any context, including signal
445handlers or random threads.
446.Sp
447Its main use is to customise signal handling in your process, especially
448in the presence of threads. For example, you could block signals
449by default in all threads (and specifying \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when
450creating any loops), and in one thread, use \f(CW\*(C`sigwait\*(C'\fR or any other
451mechanism to wait for signals, then \*(L"deliver\*(R" them to libev by calling
452\&\f(CW\*(C`ev_feed_signal\*(C'\fR.
414.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 453.SH "FUNCTIONS CONTROLLING EVENT LOOPS"
415.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 454.IX Header "FUNCTIONS CONTROLLING EVENT LOOPS"
416An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR 455An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR is
417is \fInot\fR optional in this case, as there is also an \f(CW\*(C`ev_loop\*(C'\fR 456\&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as
418\&\fIfunction\fR). 457libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name).
419.PP 458.PP
420The library knows two types of such loops, the \fIdefault\fR loop, which 459The library knows two types of such loops, the \fIdefault\fR loop, which
421supports signals and child events, and dynamically created loops which do 460supports child process events, and dynamically created event loops which
422not. 461do not.
423.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 462.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
424.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 463.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
425This will initialise the default event loop if it hasn't been initialised 464This returns the \*(L"default\*(R" event loop object, which is what you should
426yet and return it. If the default loop could not be initialised, returns 465normally use when you just need \*(L"the event loop\*(R". Event loop objects and
427false. If it already was initialised it simply returns it (and ignores the 466the \f(CW\*(C`flags\*(C'\fR parameter are described in more detail in the entry for
428flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). 467\&\f(CW\*(C`ev_loop_new\*(C'\fR.
468.Sp
469If the default loop is already initialised then this function simply
470returns it (and ignores the flags. If that is troubling you, check
471\&\f(CW\*(C`ev_backend ()\*(C'\fR afterwards). Otherwise it will create it with the given
472flags, which should almost always be \f(CW0\fR, unless the caller is also the
473one calling \f(CW\*(C`ev_run\*(C'\fR or otherwise qualifies as \*(L"the main program\*(R".
429.Sp 474.Sp
430If you don't know what event loop to use, use the one returned from this 475If you don't know what event loop to use, use the one returned from this
431function. 476function (or via the \f(CW\*(C`EV_DEFAULT\*(C'\fR macro).
432.Sp 477.Sp
433Note that this function is \fInot\fR thread-safe, so if you want to use it 478Note that this function is \fInot\fR thread-safe, so if you want to use it
434from multiple threads, you have to lock (note also that this is unlikely, 479from multiple threads, you have to employ some kind of mutex (note also
435as loops cannot be shared easily between threads anyway). 480that this case is unlikely, as loops cannot be shared easily between
481threads anyway).
436.Sp 482.Sp
437The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and 483The default loop is the only loop that can handle \f(CW\*(C`ev_child\*(C'\fR watchers,
438\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler 484and to do this, it always registers a handler for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is
439for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your application you can either 485a problem for your application you can either create a dynamic loop with
440create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you 486\&\f(CW\*(C`ev_loop_new\*(C'\fR which doesn't do that, or you can simply overwrite the
441can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling 487\&\f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling \f(CW\*(C`ev_default_init\*(C'\fR.
442\&\f(CW\*(C`ev_default_init\*(C'\fR. 488.Sp
489Example: This is the most typical usage.
490.Sp
491.Vb 2
492\& if (!ev_default_loop (0))
493\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
494.Ve
495.Sp
496Example: Restrict libev to the select and poll backends, and do not allow
497environment settings to be taken into account:
498.Sp
499.Vb 1
500\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
501.Ve
502.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
503.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
504This will create and initialise a new event loop object. If the loop
505could not be initialised, returns false.
506.Sp
507This function is thread-safe, and one common way to use libev with
508threads is indeed to create one loop per thread, and using the default
509loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
443.Sp 510.Sp
444The flags argument can be used to specify special behaviour or specific 511The flags argument can be used to specify special behaviour or specific
445backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). 512backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
446.Sp 513.Sp
447The following flags are supported: 514The following flags are supported:
456.IX Item "EVFLAG_NOENV" 523.IX Item "EVFLAG_NOENV"
457If this flag bit is or'ed into the flag value (or the program runs setuid 524If this flag bit is or'ed into the flag value (or the program runs setuid
458or setgid) then libev will \fInot\fR look at the environment variable 525or setgid) then libev will \fInot\fR look at the environment variable
459\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 526\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
460override the flags completely if it is found in the environment. This is 527override the flags completely if it is found in the environment. This is
461useful to try out specific backends to test their performance, or to work 528useful to try out specific backends to test their performance, to work
462around bugs. 529around bugs, or to make libev threadsafe (accessing environment variables
530cannot be done in a threadsafe way, but usually it works if no other
531thread modifies them).
463.ie n .IP """EVFLAG_FORKCHECK""" 4 532.ie n .IP """EVFLAG_FORKCHECK""" 4
464.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 533.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
465.IX Item "EVFLAG_FORKCHECK" 534.IX Item "EVFLAG_FORKCHECK"
466Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after 535Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
467a fork, you can also make libev check for a fork in each iteration by 536make libev check for a fork in each iteration by enabling this flag.
468enabling this flag.
469.Sp 537.Sp
470This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 538This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
471and thus this might slow down your event loop if you do a lot of loop 539and thus this might slow down your event loop if you do a lot of loop
472iterations and little real work, but is usually not noticeable (on my 540iterations and little real work, but is usually not noticeable (on my
473GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 541GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
478forget about forgetting to tell libev about forking) when you use this 546forget about forgetting to tell libev about forking) when you use this
479flag. 547flag.
480.Sp 548.Sp
481This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 549This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
482environment variable. 550environment variable.
551.ie n .IP """EVFLAG_NOINOTIFY""" 4
552.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
553.IX Item "EVFLAG_NOINOTIFY"
554When this flag is specified, then libev will not attempt to use the
555\&\fIinotify\fR \s-1API\s0 for its \f(CW\*(C`ev_stat\*(C'\fR watchers. Apart from debugging and
556testing, this flag can be useful to conserve inotify file descriptors, as
557otherwise each loop using \f(CW\*(C`ev_stat\*(C'\fR watchers consumes one inotify handle.
558.ie n .IP """EVFLAG_SIGNALFD""" 4
559.el .IP "\f(CWEVFLAG_SIGNALFD\fR" 4
560.IX Item "EVFLAG_SIGNALFD"
561When this flag is specified, then libev will attempt to use the
562\&\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
563delivers signals synchronously, which makes it both faster and might make
564it possible to get the queued signal data. It can also simplify signal
565handling with threads, as long as you properly block signals in your
566threads that are not interested in handling them.
567.Sp
568Signalfd will not be used by default as this changes your signal mask, and
569there are a lot of shoddy libraries and programs (glib's threadpool for
570example) that can't properly initialise their signal masks.
571.ie n .IP """EVFLAG_NOSIGMASK""" 4
572.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4
573.IX Item "EVFLAG_NOSIGMASK"
574When this flag is specified, then libev will avoid to modify the signal
575mask. Specifically, this means you have to make sure signals are unblocked
576when you want to receive them.
577.Sp
578This behaviour is useful when you want to do your own signal handling, or
579want to handle signals only in specific threads and want to avoid libev
580unblocking the signals.
581.Sp
582It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
583\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
584.Sp
585This flag's behaviour will become the default in future versions of libev.
483.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 586.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
484.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 587.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
485.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 588.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
486This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 589This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
487libev tries to roll its own fd_set with no limits on the number of fds, 590libev tries to roll its own fd_set with no limits on the number of fds,
488but if that fails, expect a fairly low limit on the number of fds when 591but if that fails, expect a fairly low limit on the number of fds when
489using this backend. It doesn't scale too well (O(highest_fd)), but its 592using this backend. It doesn't scale too well (O(highest_fd)), but its
490usually the fastest backend for a low number of (low-numbered :) fds. 593usually the fastest backend for a low number of (low-numbered :) fds.
499This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the 602This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the
500\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the 603\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
501\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). 604\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
502.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 605.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
503.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 606.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
504.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 607.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
505And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 608And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
506than select, but handles sparse fds better and has no artificial 609than select, but handles sparse fds better and has no artificial
507limit on the number of fds you can use (except it will slow down 610limit on the number of fds you can use (except it will slow down
508considerably with a lot of inactive fds). It scales similarly to select, 611considerably with a lot of inactive fds). It scales similarly to select,
509i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for 612i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
511.Sp 614.Sp
512This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 615This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
513\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 616\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
514.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 617.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
515.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 618.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
516.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 619.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
620Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
621kernels).
622.Sp
517For few fds, this backend is a bit little slower than poll and select, 623For few fds, this backend is a bit little slower than poll and select, but
518but it scales phenomenally better. While poll and select usually scale 624it scales phenomenally better. While poll and select usually scale like
519like O(total_fds) where n is the total number of fds (or the highest fd), 625O(total_fds) where total_fds is the total number of fds (or the highest
520epoll scales either O(1) or O(active_fds). 626fd), epoll scales either O(1) or O(active_fds).
521.Sp 627.Sp
522The epoll mechanism deserves honorable mention as the most misdesigned 628The epoll mechanism deserves honorable mention as the most misdesigned
523of the more advanced event mechanisms: mere annoyances include silently 629of the more advanced event mechanisms: mere annoyances include silently
524dropping file descriptors, requiring a system call per change per file 630dropping file descriptors, requiring a system call per change per file
525descriptor (and unnecessary guessing of parameters), problems with dup and 631descriptor (and unnecessary guessing of parameters), problems with dup,
632returning before the timeout value, resulting in additional iterations
633(and only giving 5ms accuracy while select on the same platform gives
526so on. The biggest issue is fork races, however \- if a program forks then 6340.1ms) and so on. The biggest issue is fork races, however \- if a program
527\&\fIboth\fR parent and child process have to recreate the epoll set, which can 635forks then \fIboth\fR parent and child process have to recreate the epoll
528take considerable time (one syscall per file descriptor) and is of course 636set, which can take considerable time (one syscall per file descriptor)
529hard to detect. 637and is of course hard to detect.
530.Sp 638.Sp
531Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but 639Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work,
532of course \fIdoesn't\fR, and epoll just loves to report events for totally 640but of course \fIdoesn't\fR, and epoll just loves to report events for
533\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot 641totally \fIdifferent\fR file descriptors (even already closed ones, so
534even remove them from the set) than registered in the set (especially 642one cannot even remove them from the set) than registered in the set
535on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by 643(especially on \s-1SMP\s0 systems). Libev tries to counter these spurious
536employing an additional generation counter and comparing that against the 644notifications by employing an additional generation counter and comparing
537events to filter out spurious ones, recreating the set when required. 645that against the events to filter out spurious ones, recreating the set
646when required. Epoll also erroneously rounds down timeouts, but gives you
647no way to know when and by how much, so sometimes you have to busy-wait
648because epoll returns immediately despite a nonzero timeout. And last
649not least, it also refuses to work with some file descriptors which work
650perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...).
651.Sp
652Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
653cobbled together in a hurry, no thought to design or interaction with
654others. Oh, the pain, will it ever stop...
538.Sp 655.Sp
539While stopping, setting and starting an I/O watcher in the same iteration 656While stopping, setting and starting an I/O watcher in the same iteration
540will result in some caching, there is still a system call per such 657will result in some caching, there is still a system call per such
541incident (because the same \fIfile descriptor\fR could point to a different 658incident (because the same \fIfile descriptor\fR could point to a different
542\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed 659\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
560.Sp 677.Sp
561This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 678This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
562\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 679\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
563.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 680.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
564.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 681.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
565.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 682.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
566Kqueue deserves special mention, as at the time of this writing, it 683Kqueue deserves special mention, as at the time of this writing, it
567was broken on all BSDs except NetBSD (usually it doesn't work reliably 684was broken on all BSDs except NetBSD (usually it doesn't work reliably
568with anything but sockets and pipes, except on Darwin, where of course 685with anything but sockets and pipes, except on Darwin, where of course
569it's completely useless). Unlike epoll, however, whose brokenness 686it's completely useless). Unlike epoll, however, whose brokenness
570is by design, these kqueue bugs can (and eventually will) be fixed 687is by design, these kqueue bugs can (and eventually will) be fixed
579.Sp 696.Sp
580It scales in the same way as the epoll backend, but the interface to the 697It scales in the same way as the epoll backend, but the interface to the
581kernel is more efficient (which says nothing about its actual speed, of 698kernel is more efficient (which says nothing about its actual speed, of
582course). While stopping, setting and starting an I/O watcher does never 699course). While stopping, setting and starting an I/O watcher does never
583cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 700cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
584two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but 701two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
585sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 702might have to leak fd's on fork, but it's more sane than epoll) and it
586cases 703drops fds silently in similarly hard-to-detect cases.
587.Sp 704.Sp
588This backend usually performs well under most conditions. 705This backend usually performs well under most conditions.
589.Sp 706.Sp
590While nominally embeddable in other event loops, this doesn't work 707While nominally embeddable in other event loops, this doesn't work
591everywhere, so you might need to test for this. And since it is broken 708everywhere, so you might need to test for this. And since it is broken
592almost everywhere, you should only use it when you have a lot of sockets 709almost everywhere, you should only use it when you have a lot of sockets
593(for which it usually works), by embedding it into another event loop 710(for which it usually works), by embedding it into another event loop
594(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course 711(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course
595also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. 712also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
596.Sp 713.Sp
597This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 714This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
598\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with 715\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with
599\&\f(CW\*(C`NOTE_EOF\*(C'\fR. 716\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
600.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 717.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
604implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets 721implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
605and is not embeddable, which would limit the usefulness of this backend 722and is not embeddable, which would limit the usefulness of this backend
606immensely. 723immensely.
607.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 724.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
608.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 725.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
609.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 726.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
610This uses the Solaris 10 event port mechanism. As with everything on Solaris, 727This uses the Solaris 10 event port mechanism. As with everything on Solaris,
611it's really slow, but it still scales very well (O(active_fds)). 728it's really slow, but it still scales very well (O(active_fds)).
612.Sp
613Please note that Solaris event ports can deliver a lot of spurious
614notifications, so you need to use non-blocking I/O or other means to avoid
615blocking when no data (or space) is available.
616.Sp 729.Sp
617While this backend scales well, it requires one system call per active 730While this backend scales well, it requires one system call per active
618file descriptor per loop iteration. For small and medium numbers of file 731file descriptor per loop iteration. For small and medium numbers of file
619descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend 732descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
620might perform better. 733might perform better.
621.Sp 734.Sp
622On the positive side, with the exception of the spurious readiness 735On the positive side, this backend actually performed fully to
623notifications, this backend actually performed fully to specification
624in all tests and is fully embeddable, which is a rare feat among the 736specification in all tests and is fully embeddable, which is a rare feat
625OS-specific backends (I vastly prefer correctness over speed hacks). 737among the OS-specific backends (I vastly prefer correctness over speed
738hacks).
739.Sp
740On the negative side, the interface is \fIbizarre\fR \- so bizarre that
741even sun itself gets it wrong in their code examples: The event polling
742function sometimes returns events to the caller even though an error
743occurred, but with no indication whether it has done so or not (yes, it's
744even documented that way) \- deadly for edge-triggered interfaces where you
745absolutely have to know whether an event occurred or not because you have
746to re-arm the watcher.
747.Sp
748Fortunately libev seems to be able to work around these idiocies.
626.Sp 749.Sp
627This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 750This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
628\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 751\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
629.ie n .IP """EVBACKEND_ALL""" 4 752.ie n .IP """EVBACKEND_ALL""" 4
630.el .IP "\f(CWEVBACKEND_ALL\fR" 4 753.el .IP "\f(CWEVBACKEND_ALL\fR" 4
631.IX Item "EVBACKEND_ALL" 754.IX Item "EVBACKEND_ALL"
632Try all backends (even potentially broken ones that wouldn't be tried 755Try all backends (even potentially broken ones that wouldn't be tried
633with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 756with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
634\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. 757\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.
635.Sp 758.Sp
636It is definitely not recommended to use this flag. 759It is definitely not recommended to use this flag, use whatever
760\&\f(CW\*(C`ev_recommended_backends ()\*(C'\fR returns, or simply do not specify a backend
761at all.
762.ie n .IP """EVBACKEND_MASK""" 4
763.el .IP "\f(CWEVBACKEND_MASK\fR" 4
764.IX Item "EVBACKEND_MASK"
765Not a backend at all, but a mask to select all backend bits from a
766\&\f(CW\*(C`flags\*(C'\fR value, in case you want to mask out any backends from a flags
767value (e.g. when modifying the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR environment variable).
637.RE 768.RE
638.RS 4 769.RS 4
639.Sp 770.Sp
640If one or more of these are or'ed into the flags value, then only these 771If one or more of the backend flags are or'ed into the flags value,
641backends will be tried (in the reverse order as listed here). If none are 772then only these backends will be tried (in the reverse order as listed
642specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried. 773here). If none are specified, all backends in \f(CW\*(C`ev_recommended_backends
643.Sp 774()\*(C'\fR will be tried.
644Example: This is the most typical usage.
645.Sp
646.Vb 2
647\& if (!ev_default_loop (0))
648\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
649.Ve
650.Sp
651Example: Restrict libev to the select and poll backends, and do not allow
652environment settings to be taken into account:
653.Sp
654.Vb 1
655\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
656.Ve
657.Sp
658Example: Use whatever libev has to offer, but make sure that kqueue is
659used if available (warning, breaks stuff, best use only with your own
660private event loop and only if you know the \s-1OS\s0 supports your types of
661fds):
662.Sp
663.Vb 1
664\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
665.Ve
666.RE
667.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
668.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
669Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
670always distinct from the default loop. Unlike the default loop, it cannot
671handle signal and child watchers, and attempts to do so will be greeted by
672undefined behaviour (or a failed assertion if assertions are enabled).
673.Sp
674Note that this function \fIis\fR thread-safe, and the recommended way to use
675libev with threads is indeed to create one loop per thread, and using the
676default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
677.Sp 775.Sp
678Example: Try to create a event loop that uses epoll and nothing else. 776Example: Try to create a event loop that uses epoll and nothing else.
679.Sp 777.Sp
680.Vb 3 778.Vb 3
681\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 779\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
682\& if (!epoller) 780\& if (!epoller)
683\& fatal ("no epoll found here, maybe it hides under your chair"); 781\& fatal ("no epoll found here, maybe it hides under your chair");
684.Ve 782.Ve
783.Sp
784Example: Use whatever libev has to offer, but make sure that kqueue is
785used if available.
786.Sp
787.Vb 1
788\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
789.Ve
790.RE
685.IP "ev_default_destroy ()" 4 791.IP "ev_loop_destroy (loop)" 4
686.IX Item "ev_default_destroy ()" 792.IX Item "ev_loop_destroy (loop)"
687Destroys the default loop again (frees all memory and kernel state 793Destroys an event loop object (frees all memory and kernel state
688etc.). None of the active event watchers will be stopped in the normal 794etc.). None of the active event watchers will be stopped in the normal
689sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your 795sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your
690responsibility to either stop all watchers cleanly yourself \fIbefore\fR 796responsibility to either stop all watchers cleanly yourself \fIbefore\fR
691calling this function, or cope with the fact afterwards (which is usually 797calling this function, or cope with the fact afterwards (which is usually
692the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them 798the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
694.Sp 800.Sp
695Note that certain global state, such as signal state (and installed signal 801Note that certain global state, such as signal state (and installed signal
696handlers), will not be freed by this function, and related watchers (such 802handlers), will not be freed by this function, and related watchers (such
697as signal and child watchers) would need to be stopped manually. 803as signal and child watchers) would need to be stopped manually.
698.Sp 804.Sp
699In general it is not advisable to call this function except in the 805This function is normally used on loop objects allocated by
700rare occasion where you really need to free e.g. the signal handling 806\&\f(CW\*(C`ev_loop_new\*(C'\fR, but it can also be used on the default loop returned by
701pipe fds. If you need dynamically allocated loops it is better to use 807\&\f(CW\*(C`ev_default_loop\*(C'\fR, in which case it is not thread-safe.
702\&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR).
703.IP "ev_loop_destroy (loop)" 4
704.IX Item "ev_loop_destroy (loop)"
705Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an
706earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR.
707.IP "ev_default_fork ()" 4
708.IX Item "ev_default_fork ()"
709This function sets a flag that causes subsequent \f(CW\*(C`ev_loop\*(C'\fR iterations
710to reinitialise the kernel state for backends that have one. Despite the
711name, you can call it anytime, but it makes most sense after forking, in
712the child process (or both child and parent, but that again makes little
713sense). You \fImust\fR call it in the child before using any of the libev
714functions, and it will only take effect at the next \f(CW\*(C`ev_loop\*(C'\fR iteration.
715.Sp 808.Sp
716On the other hand, you only need to call this function in the child 809Note that it is not advisable to call this function on the default loop
717process if and only if you want to use the event library in the child. If 810except in the rare occasion where you really need to free its resources.
718you just fork+exec, you don't have to call it at all. 811If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
719.Sp 812and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
720The function itself is quite fast and it's usually not a problem to call
721it just in case after a fork. To make this easy, the function will fit in
722quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR:
723.Sp
724.Vb 1
725\& pthread_atfork (0, 0, ev_default_fork);
726.Ve
727.IP "ev_loop_fork (loop)" 4 813.IP "ev_loop_fork (loop)" 4
728.IX Item "ev_loop_fork (loop)" 814.IX Item "ev_loop_fork (loop)"
729Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 815This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations
730\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 816to reinitialise the kernel state for backends that have one. Despite
731after fork that you want to re-use in the child, and how you do this is 817the name, you can call it anytime you are allowed to start or stop
732entirely your own problem. 818watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most
819sense after forking, in the child process. You \fImust\fR call it (or use
820\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
821.Sp
822Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
823a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
824because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
825during fork.
826.Sp
827On the other hand, you only need to call this function in the child
828process if and only if you want to use the event loop in the child. If
829you just fork+exec or create a new loop in the child, you don't have to
830call it at all (in fact, \f(CW\*(C`epoll\*(C'\fR is so badly broken that it makes a
831difference, but libev will usually detect this case on its own and do a
832costly reset of the backend).
833.Sp
834The function itself is quite fast and it's usually not a problem to call
835it just in case after a fork.
836.Sp
837Example: Automate calling \f(CW\*(C`ev_loop_fork\*(C'\fR on the default loop when
838using pthreads.
839.Sp
840.Vb 5
841\& static void
842\& post_fork_child (void)
843\& {
844\& ev_loop_fork (EV_DEFAULT);
845\& }
846\&
847\& ...
848\& pthread_atfork (0, 0, post_fork_child);
849.Ve
733.IP "int ev_is_default_loop (loop)" 4 850.IP "int ev_is_default_loop (loop)" 4
734.IX Item "int ev_is_default_loop (loop)" 851.IX Item "int ev_is_default_loop (loop)"
735Returns true when the given loop is, in fact, the default loop, and false 852Returns true when the given loop is, in fact, the default loop, and false
736otherwise. 853otherwise.
737.IP "unsigned int ev_loop_count (loop)" 4 854.IP "unsigned int ev_iteration (loop)" 4
738.IX Item "unsigned int ev_loop_count (loop)" 855.IX Item "unsigned int ev_iteration (loop)"
739Returns the count of loop iterations for the loop, which is identical to 856Returns the current iteration count for the event loop, which is identical
740the number of times libev did poll for new events. It starts at \f(CW0\fR and 857to the number of times libev did poll for new events. It starts at \f(CW0\fR
741happily wraps around with enough iterations. 858and happily wraps around with enough iterations.
742.Sp 859.Sp
743This value can sometimes be useful as a generation counter of sorts (it 860This value can sometimes be useful as a generation counter of sorts (it
744\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with 861\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
745\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. 862\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the
863prepare and check phases.
746.IP "unsigned int ev_loop_depth (loop)" 4 864.IP "unsigned int ev_depth (loop)" 4
747.IX Item "unsigned int ev_loop_depth (loop)" 865.IX Item "unsigned int ev_depth (loop)"
748Returns the number of times \f(CW\*(C`ev_loop\*(C'\fR was entered minus the number of 866Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of
749times \f(CW\*(C`ev_loop\*(C'\fR was exited, in other words, the recursion depth. 867times \f(CW\*(C`ev_run\*(C'\fR was exited normally, in other words, the recursion depth.
750.Sp 868.Sp
751Outside \f(CW\*(C`ev_loop\*(C'\fR, this number is zero. In a callback, this number is 869Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is
752\&\f(CW1\fR, unless \f(CW\*(C`ev_loop\*(C'\fR was invoked recursively (or from another thread), 870\&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread),
753in which case it is higher. 871in which case it is higher.
754.Sp 872.Sp
755Leaving \f(CW\*(C`ev_loop\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread 873Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread,
756etc.), doesn't count as exit. 874throwing an exception etc.), doesn't count as \*(L"exit\*(R" \- consider this
875as a hint to avoid such ungentleman-like behaviour unless it's really
876convenient, in which case it is fully supported.
757.IP "unsigned int ev_backend (loop)" 4 877.IP "unsigned int ev_backend (loop)" 4
758.IX Item "unsigned int ev_backend (loop)" 878.IX Item "unsigned int ev_backend (loop)"
759Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 879Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
760use. 880use.
761.IP "ev_tstamp ev_now (loop)" 4 881.IP "ev_tstamp ev_now (loop)" 4
767event occurring (or more correctly, libev finding out about it). 887event occurring (or more correctly, libev finding out about it).
768.IP "ev_now_update (loop)" 4 888.IP "ev_now_update (loop)" 4
769.IX Item "ev_now_update (loop)" 889.IX Item "ev_now_update (loop)"
770Establishes the current time by querying the kernel, updating the time 890Establishes the current time by querying the kernel, updating the time
771returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and 891returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and
772is usually done automatically within \f(CW\*(C`ev_loop ()\*(C'\fR. 892is usually done automatically within \f(CW\*(C`ev_run ()\*(C'\fR.
773.Sp 893.Sp
774This function is rarely useful, but when some event callback runs for a 894This function is rarely useful, but when some event callback runs for a
775very long time without entering the event loop, updating libev's idea of 895very long time without entering the event loop, updating libev's idea of
776the current time is a good idea. 896the current time is a good idea.
777.Sp 897.Sp
780.IX Item "ev_suspend (loop)" 900.IX Item "ev_suspend (loop)"
781.PD 0 901.PD 0
782.IP "ev_resume (loop)" 4 902.IP "ev_resume (loop)" 4
783.IX Item "ev_resume (loop)" 903.IX Item "ev_resume (loop)"
784.PD 904.PD
785These two functions suspend and resume a loop, for use when the loop is 905These two functions suspend and resume an event loop, for use when the
786not used for a while and timeouts should not be processed. 906loop is not used for a while and timeouts should not be processed.
787.Sp 907.Sp
788A typical use case would be an interactive program such as a game: When 908A typical use case would be an interactive program such as a game: When
789the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it 909the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it
790would be best to handle timeouts as if no time had actually passed while 910would be best to handle timeouts as if no time had actually passed while
791the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR 911the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR
793\&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing. 913\&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing.
794.Sp 914.Sp
795Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend 915Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend
796between \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 916between \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
797will be rescheduled (that is, they will lose any events that would have 917will be rescheduled (that is, they will lose any events that would have
798occured while suspended). 918occurred while suspended).
799.Sp 919.Sp
800After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the 920After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the
801given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR 921given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
802without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR. 922without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
803.Sp 923.Sp
804Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the 924Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
805event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR). 925event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
806.IP "ev_loop (loop, int flags)" 4 926.IP "bool ev_run (loop, int flags)" 4
807.IX Item "ev_loop (loop, int flags)" 927.IX Item "bool ev_run (loop, int flags)"
808Finally, this is it, the event handler. This function usually is called 928Finally, this is it, the event handler. This function usually is called
809after you initialised all your watchers and you want to start handling 929after you have initialised all your watchers and you want to start
810events. 930handling events. It will ask the operating system for any new events, call
931the watcher callbacks, and then repeat the whole process indefinitely: This
932is why event loops are called \fIloops\fR.
811.Sp 933.Sp
812If the flags argument is specified as \f(CW0\fR, it will not return until 934If the flags argument is specified as \f(CW0\fR, it will keep handling events
813either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. 935until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
936called.
814.Sp 937.Sp
938The return value is false if there are no more active watchers (which
939usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
940(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
941.Sp
815Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than 942Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
816relying on all watchers to be stopped when deciding when a program has 943relying on all watchers to be stopped when deciding when a program has
817finished (especially in interactive programs), but having a program 944finished (especially in interactive programs), but having a program
818that automatically loops as long as it has to and no longer by virtue 945that automatically loops as long as it has to and no longer by virtue
819of relying on its watchers stopping correctly, that is truly a thing of 946of relying on its watchers stopping correctly, that is truly a thing of
820beauty. 947beauty.
821.Sp 948.Sp
949This function is \fImostly\fR exception-safe \- you can break out of a
950\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
951exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
952will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
953.Sp
822A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle 954A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
823those events and any already outstanding ones, but will not block your 955those events and any already outstanding ones, but will not wait and
824process in case there are no events and will return after one iteration of 956block your process in case there are no events and will return after one
825the loop. 957iteration of the loop. This is sometimes useful to poll and handle new
958events while doing lengthy calculations, to keep the program responsive.
826.Sp 959.Sp
827A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if 960A flags value of \f(CW\*(C`EVRUN_ONCE\*(C'\fR will look for new events (waiting if
828necessary) and will handle those and any already outstanding ones. It 961necessary) and will handle those and any already outstanding ones. It
829will block your process until at least one new event arrives (which could 962will block your process until at least one new event arrives (which could
830be an event internal to libev itself, so there is no guarantee that a 963be an event internal to libev itself, so there is no guarantee that a
831user-registered callback will be called), and will return after one 964user-registered callback will be called), and will return after one
832iteration of the loop. 965iteration of the loop.
833.Sp 966.Sp
834This is useful if you are waiting for some external event in conjunction 967This is useful if you are waiting for some external event in conjunction
835with something not expressible using other libev watchers (i.e. "roll your 968with something not expressible using other libev watchers (i.e. "roll your
836own \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 969own \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
837usually a better approach for this kind of thing. 970usually a better approach for this kind of thing.
838.Sp 971.Sp
839Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 972Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does (this is for your
973understanding, not a guarantee that things will work exactly like this in
974future versions):
840.Sp 975.Sp
841.Vb 10 976.Vb 10
977\& \- Increment loop depth.
978\& \- Reset the ev_break status.
842\& \- Before the first iteration, call any pending watchers. 979\& \- Before the first iteration, call any pending watchers.
980\& LOOP:
843\& * If EVFLAG_FORKCHECK was used, check for a fork. 981\& \- If EVFLAG_FORKCHECK was used, check for a fork.
844\& \- If a fork was detected (by any means), queue and call all fork watchers. 982\& \- If a fork was detected (by any means), queue and call all fork watchers.
845\& \- Queue and call all prepare watchers. 983\& \- Queue and call all prepare watchers.
984\& \- If ev_break was called, goto FINISH.
846\& \- If we have been forked, detach and recreate the kernel state 985\& \- If we have been forked, detach and recreate the kernel state
847\& as to not disturb the other process. 986\& as to not disturb the other process.
848\& \- Update the kernel state with all outstanding changes. 987\& \- Update the kernel state with all outstanding changes.
849\& \- Update the "event loop time" (ev_now ()). 988\& \- Update the "event loop time" (ev_now ()).
850\& \- Calculate for how long to sleep or block, if at all 989\& \- Calculate for how long to sleep or block, if at all
851\& (active idle watchers, EVLOOP_NONBLOCK or not having 990\& (active idle watchers, EVRUN_NOWAIT or not having
852\& any active watchers at all will result in not sleeping). 991\& any active watchers at all will result in not sleeping).
853\& \- Sleep if the I/O and timer collect interval say so. 992\& \- Sleep if the I/O and timer collect interval say so.
993\& \- Increment loop iteration counter.
854\& \- Block the process, waiting for any events. 994\& \- Block the process, waiting for any events.
855\& \- Queue all outstanding I/O (fd) events. 995\& \- Queue all outstanding I/O (fd) events.
856\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments. 996\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments.
857\& \- Queue all expired timers. 997\& \- Queue all expired timers.
858\& \- Queue all expired periodics. 998\& \- Queue all expired periodics.
859\& \- Unless any events are pending now, queue all idle watchers. 999\& \- Queue all idle watchers with priority higher than that of pending events.
860\& \- Queue all check watchers. 1000\& \- Queue all check watchers.
861\& \- Call all queued watchers in reverse order (i.e. check watchers first). 1001\& \- Call all queued watchers in reverse order (i.e. check watchers first).
862\& Signals and child watchers are implemented as I/O watchers, and will 1002\& Signals and child watchers are implemented as I/O watchers, and will
863\& be handled here by queueing them when their watcher gets executed. 1003\& be handled here by queueing them when their watcher gets executed.
864\& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 1004\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
865\& were used, or there are no active watchers, return, otherwise 1005\& were used, or there are no active watchers, goto FINISH, otherwise
866\& continue with step *. 1006\& continue with step LOOP.
1007\& FINISH:
1008\& \- Reset the ev_break status iff it was EVBREAK_ONE.
1009\& \- Decrement the loop depth.
1010\& \- Return.
867.Ve 1011.Ve
868.Sp 1012.Sp
869Example: Queue some jobs and then loop until no events are outstanding 1013Example: Queue some jobs and then loop until no events are outstanding
870anymore. 1014anymore.
871.Sp 1015.Sp
872.Vb 4 1016.Vb 4
873\& ... queue jobs here, make sure they register event watchers as long 1017\& ... queue jobs here, make sure they register event watchers as long
874\& ... as they still have work to do (even an idle watcher will do..) 1018\& ... as they still have work to do (even an idle watcher will do..)
875\& ev_loop (my_loop, 0); 1019\& ev_run (my_loop, 0);
876\& ... jobs done or somebody called unloop. yeah! 1020\& ... jobs done or somebody called break. yeah!
877.Ve 1021.Ve
878.IP "ev_unloop (loop, how)" 4 1022.IP "ev_break (loop, how)" 4
879.IX Item "ev_unloop (loop, how)" 1023.IX Item "ev_break (loop, how)"
880Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it 1024Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it
881has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 1025has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
882\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or 1026\&\f(CW\*(C`EVBREAK_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_run\*(C'\fR call return, or
883\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. 1027\&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return.
884.Sp 1028.Sp
885This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again. 1029This \*(L"break state\*(R" will be cleared on the next call to \f(CW\*(C`ev_run\*(C'\fR.
886.Sp 1030.Sp
887It is safe to call \f(CW\*(C`ev_unloop\*(C'\fR from otuside any \f(CW\*(C`ev_loop\*(C'\fR calls. 1031It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too, in
1032which case it will have no effect.
888.IP "ev_ref (loop)" 4 1033.IP "ev_ref (loop)" 4
889.IX Item "ev_ref (loop)" 1034.IX Item "ev_ref (loop)"
890.PD 0 1035.PD 0
891.IP "ev_unref (loop)" 4 1036.IP "ev_unref (loop)" 4
892.IX Item "ev_unref (loop)" 1037.IX Item "ev_unref (loop)"
893.PD 1038.PD
894Ref/unref can be used to add or remove a reference count on the event 1039Ref/unref can be used to add or remove a reference count on the event
895loop: Every watcher keeps one reference, and as long as the reference 1040loop: Every watcher keeps one reference, and as long as the reference
896count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own. 1041count is nonzero, \f(CW\*(C`ev_run\*(C'\fR will not return on its own.
897.Sp 1042.Sp
898If you have a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR 1043This is useful when you have a watcher that you never intend to
899from returning, call \fIev_unref()\fR after starting, and \fIev_ref()\fR before 1044unregister, but that nevertheless should not keep \f(CW\*(C`ev_run\*(C'\fR from
1045returning. In such a case, call \f(CW\*(C`ev_unref\*(C'\fR after starting, and \f(CW\*(C`ev_ref\*(C'\fR
900stopping it. 1046before stopping it.
901.Sp 1047.Sp
902As an example, libev itself uses this for its internal signal pipe: It 1048As an example, libev itself uses this for its internal signal pipe: It
903is not visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from 1049is not visible to the libev user and should not keep \f(CW\*(C`ev_run\*(C'\fR from
904exiting if no event watchers registered by it are active. It is also an 1050exiting if no event watchers registered by it are active. It is also an
905excellent way to do this for generic recurring timers or from within 1051excellent way to do this for generic recurring timers or from within
906third-party libraries. Just remember to \fIunref after start\fR and \fIref 1052third-party libraries. Just remember to \fIunref after start\fR and \fIref
907before stop\fR (but only if the watcher wasn't active before, or was active 1053before stop\fR (but only if the watcher wasn't active before, or was active
908before, respectively. Note also that libev might stop watchers itself 1054before, respectively. Note also that libev might stop watchers itself
909(e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR 1055(e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR
910in the callback). 1056in the callback).
911.Sp 1057.Sp
912Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 1058Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_run\*(C'\fR
913running when nothing else is active. 1059running when nothing else is active.
914.Sp 1060.Sp
915.Vb 4 1061.Vb 4
916\& ev_signal exitsig; 1062\& ev_signal exitsig;
917\& ev_signal_init (&exitsig, sig_cb, SIGINT); 1063\& ev_signal_init (&exitsig, sig_cb, SIGINT);
918\& ev_signal_start (loop, &exitsig); 1064\& ev_signal_start (loop, &exitsig);
919\& evf_unref (loop); 1065\& ev_unref (loop);
920.Ve 1066.Ve
921.Sp 1067.Sp
922Example: For some weird reason, unregister the above signal handler again. 1068Example: For some weird reason, unregister the above signal handler again.
923.Sp 1069.Sp
924.Vb 2 1070.Vb 2
948overhead for the actual polling but can deliver many events at once. 1094overhead for the actual polling but can deliver many events at once.
949.Sp 1095.Sp
950By setting a higher \fIio collect interval\fR you allow libev to spend more 1096By setting a higher \fIio collect interval\fR you allow libev to spend more
951time collecting I/O events, so you can handle more events per iteration, 1097time collecting I/O events, so you can handle more events per iteration,
952at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and 1098at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
953\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will 1099\&\f(CW\*(C`ev_timer\*(C'\fR) will not be affected. Setting this to a non-null value will
954introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The 1100introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
955sleep time ensures that libev will not poll for I/O events more often then 1101sleep time ensures that libev will not poll for I/O events more often then
956once per this interval, on average. 1102once per this interval, on average (as long as the host time resolution is
1103good enough).
957.Sp 1104.Sp
958Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 1105Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
959to spend more time collecting timeouts, at the expense of increased 1106to spend more time collecting timeouts, at the expense of increased
960latency/jitter/inexactness (the watcher callback will be called 1107latency/jitter/inexactness (the watcher callback will be called
961later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null 1108later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
967usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, 1114usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR,
968as this approaches the timing granularity of most systems. Note that if 1115as this approaches the timing granularity of most systems. Note that if
969you do transactions with the outside world and you can't increase the 1116you do transactions with the outside world and you can't increase the
970parallelity, then this setting will limit your transaction rate (if you 1117parallelity, then this setting will limit your transaction rate (if you
971need to poll once per transaction and the I/O collect interval is 0.01, 1118need to poll once per transaction and the I/O collect interval is 0.01,
972then you can't do more than 100 transations per second). 1119then you can't do more than 100 transactions per second).
973.Sp 1120.Sp
974Setting the \fItimeout collect interval\fR can improve the opportunity for 1121Setting the \fItimeout collect interval\fR can improve the opportunity for
975saving power, as the program will \*(L"bundle\*(R" timer callback invocations that 1122saving power, as the program will \*(L"bundle\*(R" timer callback invocations that
976are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of 1123are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of
977times the process sleeps and wakes up again. Another useful technique to 1124times the process sleeps and wakes up again. Another useful technique to
986\& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); 1133\& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
987.Ve 1134.Ve
988.IP "ev_invoke_pending (loop)" 4 1135.IP "ev_invoke_pending (loop)" 4
989.IX Item "ev_invoke_pending (loop)" 1136.IX Item "ev_invoke_pending (loop)"
990This call will simply invoke all pending watchers while resetting their 1137This call will simply invoke all pending watchers while resetting their
991pending state. Normally, \f(CW\*(C`ev_loop\*(C'\fR does this automatically when required, 1138pending state. Normally, \f(CW\*(C`ev_run\*(C'\fR does this automatically when required,
992but when overriding the invoke callback this call comes handy. 1139but when overriding the invoke callback this call comes handy. This
1140function can be invoked from a watcher \- this can be useful for example
1141when you want to do some lengthy calculation and want to pass further
1142event handling to another thread (you still have to make sure only one
1143thread executes within \f(CW\*(C`ev_invoke_pending\*(C'\fR or \f(CW\*(C`ev_run\*(C'\fR of course).
993.IP "int ev_pending_count (loop)" 4 1144.IP "int ev_pending_count (loop)" 4
994.IX Item "int ev_pending_count (loop)" 1145.IX Item "int ev_pending_count (loop)"
995Returns the number of pending watchers \- zero indicates that no watchers 1146Returns the number of pending watchers \- zero indicates that no watchers
996are pending. 1147are pending.
997.IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4 1148.IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4
998.IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))" 1149.IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))"
999This overrides the invoke pending functionality of the loop: Instead of 1150This overrides the invoke pending functionality of the loop: Instead of
1000invoking all pending watchers when there are any, \f(CW\*(C`ev_loop\*(C'\fR will call 1151invoking all pending watchers when there are any, \f(CW\*(C`ev_run\*(C'\fR will call
1001this callback instead. This is useful, for example, when you want to 1152this callback instead. This is useful, for example, when you want to
1002invoke the actual watchers inside another context (another thread etc.). 1153invoke the actual watchers inside another context (another thread etc.).
1003.Sp 1154.Sp
1004If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new 1155If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1005callback. 1156callback.
1006.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4 1157.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
1007.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))" 1158.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
1008Sometimes you want to share the same loop between multiple threads. This 1159Sometimes you want to share the same loop between multiple threads. This
1009can be done relatively simply by putting mutex_lock/unlock calls around 1160can be done relatively simply by putting mutex_lock/unlock calls around
1010each call to a libev function. 1161each call to a libev function.
1011.Sp 1162.Sp
1012However, \f(CW\*(C`ev_loop\*(C'\fR can run an indefinite time, so it is not feasible to 1163However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1013wait for it to return. One way around this is to wake up the loop via 1164to wait for it to return. One way around this is to wake up the event
1014\&\f(CW\*(C`ev_unloop\*(C'\fR and \f(CW\*(C`av_async_send\*(C'\fR, another way is to set these \fIrelease\fR 1165loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`ev_async_send\*(C'\fR, another way is to set these
1015and \fIacquire\fR callbacks on the loop. 1166\&\fIrelease\fR and \fIacquire\fR callbacks on the loop.
1016.Sp 1167.Sp
1017When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is 1168When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1018suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just 1169suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1019afterwards. 1170afterwards.
1020.Sp 1171.Sp
1023.Sp 1174.Sp
1024While event loop modifications are allowed between invocations of 1175While event loop modifications are allowed between invocations of
1025\&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no 1176\&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no
1026modifications done will affect the event loop, i.e. adding watchers will 1177modifications done will affect the event loop, i.e. adding watchers will
1027have no effect on the set of file descriptors being watched, or the time 1178have no effect on the set of file descriptors being watched, or the time
1028waited. USe an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_loop\*(C'\fR when you want it 1179waited. Use an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_run\*(C'\fR when you want it
1029to take note of any changes you made. 1180to take note of any changes you made.
1030.Sp 1181.Sp
1031In theory, threads executing \f(CW\*(C`ev_loop\*(C'\fR will be async-cancel safe between 1182In theory, threads executing \f(CW\*(C`ev_run\*(C'\fR will be async-cancel safe between
1032invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR. 1183invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR.
1033.Sp 1184.Sp
1034See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this 1185See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this
1035document. 1186document.
1036.IP "ev_set_userdata (loop, void *data)" 4 1187.IP "ev_set_userdata (loop, void *data)" 4
1037.IX Item "ev_set_userdata (loop, void *data)" 1188.IX Item "ev_set_userdata (loop, void *data)"
1038.PD 0 1189.PD 0
1039.IP "ev_userdata (loop)" 4 1190.IP "void *ev_userdata (loop)" 4
1040.IX Item "ev_userdata (loop)" 1191.IX Item "void *ev_userdata (loop)"
1041.PD 1192.PD
1042Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When 1193Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When
1043\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns 1194\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns
1044\&\f(CW0.\fR 1195\&\f(CW0\fR.
1045.Sp 1196.Sp
1046These two functions can be used to associate arbitrary data with a loop, 1197These two functions can be used to associate arbitrary data with a loop,
1047and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and 1198and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and
1048\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for 1199\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for
1049any other purpose as well. 1200any other purpose as well.
1050.IP "ev_loop_verify (loop)" 4 1201.IP "ev_verify (loop)" 4
1051.IX Item "ev_loop_verify (loop)" 1202.IX Item "ev_verify (loop)"
1052This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been 1203This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been
1053compiled in, which is the default for non-minimal builds. It tries to go 1204compiled in, which is the default for non-minimal builds. It tries to go
1054through all internal structures and checks them for validity. If anything 1205through all internal structures and checks them for validity. If anything
1055is found to be inconsistent, it will print an error message to standard 1206is found to be inconsistent, it will print an error message to standard
1056error and call \f(CW\*(C`abort ()\*(C'\fR. 1207error and call \f(CW\*(C`abort ()\*(C'\fR.
1062.IX Header "ANATOMY OF A WATCHER" 1213.IX Header "ANATOMY OF A WATCHER"
1063In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the 1214In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the
1064watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer 1215watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer
1065watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers. 1216watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers.
1066.PP 1217.PP
1067A watcher is a structure that you create and register to record your 1218A watcher is an opaque structure that you allocate and register to record
1068interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 1219your interest in some event. To make a concrete example, imagine you want
1069become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: 1220to wait for \s-1STDIN\s0 to become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher
1221for that:
1070.PP 1222.PP
1071.Vb 5 1223.Vb 5
1072\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents) 1224\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
1073\& { 1225\& {
1074\& ev_io_stop (w); 1226\& ev_io_stop (w);
1075\& ev_unloop (loop, EVUNLOOP_ALL); 1227\& ev_break (loop, EVBREAK_ALL);
1076\& } 1228\& }
1077\& 1229\&
1078\& struct ev_loop *loop = ev_default_loop (0); 1230\& struct ev_loop *loop = ev_default_loop (0);
1079\& 1231\&
1080\& ev_io stdin_watcher; 1232\& ev_io stdin_watcher;
1081\& 1233\&
1082\& ev_init (&stdin_watcher, my_cb); 1234\& ev_init (&stdin_watcher, my_cb);
1083\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 1235\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
1084\& ev_io_start (loop, &stdin_watcher); 1236\& ev_io_start (loop, &stdin_watcher);
1085\& 1237\&
1086\& ev_loop (loop, 0); 1238\& ev_run (loop, 0);
1087.Ve 1239.Ve
1088.PP 1240.PP
1089As you can see, you are responsible for allocating the memory for your 1241As you can see, you are responsible for allocating the memory for your
1090watcher structures (and it is \fIusually\fR a bad idea to do this on the 1242watcher structures (and it is \fIusually\fR a bad idea to do this on the
1091stack). 1243stack).
1092.PP 1244.PP
1093Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR 1245Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR
1094or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs). 1246or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs).
1095.PP 1247.PP
1096Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init 1248Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init (watcher
1097(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This 1249*, callback)\*(C'\fR, which expects a callback to be provided. This callback is
1098callback gets invoked each time the event occurs (or, in the case of I/O 1250invoked each time the event occurs (or, in the case of I/O watchers, each
1099watchers, each time the event loop detects that the file descriptor given 1251time the event loop detects that the file descriptor given is readable
1100is readable and/or writable). 1252and/or writable).
1101.PP 1253.PP
1102Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR 1254Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR
1103macro to configure it, with arguments specific to the watcher type. There 1255macro to configure it, with arguments specific to the watcher type. There
1104is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR. 1256is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR.
1105.PP 1257.PP
1127.el .IP "\f(CWEV_WRITE\fR" 4 1279.el .IP "\f(CWEV_WRITE\fR" 4
1128.IX Item "EV_WRITE" 1280.IX Item "EV_WRITE"
1129.PD 1281.PD
1130The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or 1282The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or
1131writable. 1283writable.
1132.ie n .IP """EV_TIMEOUT""" 4 1284.ie n .IP """EV_TIMER""" 4
1133.el .IP "\f(CWEV_TIMEOUT\fR" 4 1285.el .IP "\f(CWEV_TIMER\fR" 4
1134.IX Item "EV_TIMEOUT" 1286.IX Item "EV_TIMER"
1135The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out. 1287The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out.
1136.ie n .IP """EV_PERIODIC""" 4 1288.ie n .IP """EV_PERIODIC""" 4
1137.el .IP "\f(CWEV_PERIODIC\fR" 4 1289.el .IP "\f(CWEV_PERIODIC\fR" 4
1138.IX Item "EV_PERIODIC" 1290.IX Item "EV_PERIODIC"
1139The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out. 1291The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out.
1159.PD 0 1311.PD 0
1160.ie n .IP """EV_CHECK""" 4 1312.ie n .IP """EV_CHECK""" 4
1161.el .IP "\f(CWEV_CHECK\fR" 4 1313.el .IP "\f(CWEV_CHECK\fR" 4
1162.IX Item "EV_CHECK" 1314.IX Item "EV_CHECK"
1163.PD 1315.PD
1164All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_loop\*(C'\fR starts 1316All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
1165to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1317gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
1166\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 1318just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1319for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1320watchers invoked before the event loop sleeps or polls for new events, and
1321\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1322or lower priority within an event loop iteration.
1323.Sp
1167received events. Callbacks of both watcher types can start and stop as 1324Callbacks of both watcher types can start and stop as many watchers as
1168many watchers as they want, and all of them will be taken into account 1325they want, and all of them will be taken into account (for example, a
1169(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1326\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
1170\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 1327blocking).
1171.ie n .IP """EV_EMBED""" 4 1328.ie n .IP """EV_EMBED""" 4
1172.el .IP "\f(CWEV_EMBED\fR" 4 1329.el .IP "\f(CWEV_EMBED\fR" 4
1173.IX Item "EV_EMBED" 1330.IX Item "EV_EMBED"
1174The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1331The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1175.ie n .IP """EV_FORK""" 4 1332.ie n .IP """EV_FORK""" 4
1176.el .IP "\f(CWEV_FORK\fR" 4 1333.el .IP "\f(CWEV_FORK\fR" 4
1177.IX Item "EV_FORK" 1334.IX Item "EV_FORK"
1178The event loop has been resumed in the child process after fork (see 1335The event loop has been resumed in the child process after fork (see
1179\&\f(CW\*(C`ev_fork\*(C'\fR). 1336\&\f(CW\*(C`ev_fork\*(C'\fR).
1337.ie n .IP """EV_CLEANUP""" 4
1338.el .IP "\f(CWEV_CLEANUP\fR" 4
1339.IX Item "EV_CLEANUP"
1340The event loop is about to be destroyed (see \f(CW\*(C`ev_cleanup\*(C'\fR).
1180.ie n .IP """EV_ASYNC""" 4 1341.ie n .IP """EV_ASYNC""" 4
1181.el .IP "\f(CWEV_ASYNC\fR" 4 1342.el .IP "\f(CWEV_ASYNC\fR" 4
1182.IX Item "EV_ASYNC" 1343.IX Item "EV_ASYNC"
1183The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). 1344The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
1184.ie n .IP """EV_CUSTOM""" 4 1345.ie n .IP """EV_CUSTOM""" 4
1203example it might indicate that a fd is readable or writable, and if your 1364example it might indicate that a fd is readable or writable, and if your
1204callbacks is well-written it can just attempt the operation and cope with 1365callbacks is well-written it can just attempt the operation and cope with
1205the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1366the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
1206programs, though, as the fd could already be closed and reused for another 1367programs, though, as the fd could already be closed and reused for another
1207thing, so beware. 1368thing, so beware.
1208.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1369.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1209.IX Subsection "GENERIC WATCHER FUNCTIONS" 1370.IX Subsection "GENERIC WATCHER FUNCTIONS"
1210.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1371.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1211.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1372.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1212.IX Item "ev_init (ev_TYPE *watcher, callback)" 1373.IX Item "ev_init (ev_TYPE *watcher, callback)"
1213This macro initialises the generic portion of a watcher. The contents 1374This macro initialises the generic portion of a watcher. The contents
1228.Vb 3 1389.Vb 3
1229\& ev_io w; 1390\& ev_io w;
1230\& ev_init (&w, my_cb); 1391\& ev_init (&w, my_cb);
1231\& ev_io_set (&w, STDIN_FILENO, EV_READ); 1392\& ev_io_set (&w, STDIN_FILENO, EV_READ);
1232.Ve 1393.Ve
1233.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 1394.ie n .IP """ev_TYPE_set"" (ev_TYPE *watcher, [args])" 4
1234.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 1395.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *watcher, [args])" 4
1235.IX Item "ev_TYPE_set (ev_TYPE *, [args])" 1396.IX Item "ev_TYPE_set (ev_TYPE *watcher, [args])"
1236This macro initialises the type-specific parts of a watcher. You need to 1397This macro initialises the type-specific parts of a watcher. You need to
1237call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can 1398call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
1238call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this 1399call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this
1239macro on a watcher that is active (it can be pending, however, which is a 1400macro on a watcher that is active (it can be pending, however, which is a
1240difference to the \f(CW\*(C`ev_init\*(C'\fR macro). 1401difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
1253Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step. 1414Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step.
1254.Sp 1415.Sp
1255.Vb 1 1416.Vb 1
1256\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); 1417\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1257.Ve 1418.Ve
1258.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 1419.ie n .IP """ev_TYPE_start"" (loop, ev_TYPE *watcher)" 4
1259.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 1420.el .IP "\f(CWev_TYPE_start\fR (loop, ev_TYPE *watcher)" 4
1260.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" 1421.IX Item "ev_TYPE_start (loop, ev_TYPE *watcher)"
1261Starts (activates) the given watcher. Only active watchers will receive 1422Starts (activates) the given watcher. Only active watchers will receive
1262events. If the watcher is already active nothing will happen. 1423events. If the watcher is already active nothing will happen.
1263.Sp 1424.Sp
1264Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this 1425Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this
1265whole section. 1426whole section.
1266.Sp 1427.Sp
1267.Vb 1 1428.Vb 1
1268\& ev_io_start (EV_DEFAULT_UC, &w); 1429\& ev_io_start (EV_DEFAULT_UC, &w);
1269.Ve 1430.Ve
1270.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 1431.ie n .IP """ev_TYPE_stop"" (loop, ev_TYPE *watcher)" 4
1271.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 1432.el .IP "\f(CWev_TYPE_stop\fR (loop, ev_TYPE *watcher)" 4
1272.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" 1433.IX Item "ev_TYPE_stop (loop, ev_TYPE *watcher)"
1273Stops the given watcher if active, and clears the pending status (whether 1434Stops the given watcher if active, and clears the pending status (whether
1274the watcher was active or not). 1435the watcher was active or not).
1275.Sp 1436.Sp
1276It is possible that stopped watchers are pending \- for example, 1437It is possible that stopped watchers are pending \- for example,
1277non-repeating timers are being stopped when they become pending \- but 1438non-repeating timers are being stopped when they become pending \- but
1292make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR 1453make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1293it). 1454it).
1294.IP "callback ev_cb (ev_TYPE *watcher)" 4 1455.IP "callback ev_cb (ev_TYPE *watcher)" 4
1295.IX Item "callback ev_cb (ev_TYPE *watcher)" 1456.IX Item "callback ev_cb (ev_TYPE *watcher)"
1296Returns the callback currently set on the watcher. 1457Returns the callback currently set on the watcher.
1297.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1458.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
1298.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1459.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
1299Change the callback. You can change the callback at virtually any time 1460Change the callback. You can change the callback at virtually any time
1300(modulo threads). 1461(modulo threads).
1301.IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 1462.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1302.IX Item "ev_set_priority (ev_TYPE *watcher, priority)" 1463.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1303.PD 0 1464.PD 0
1304.IP "int ev_priority (ev_TYPE *watcher)" 4 1465.IP "int ev_priority (ev_TYPE *watcher)" 4
1305.IX Item "int ev_priority (ev_TYPE *watcher)" 1466.IX Item "int ev_priority (ev_TYPE *watcher)"
1306.PD 1467.PD
1307Set and query the priority of the watcher. The priority is a small 1468Set and query the priority of the watcher. The priority is a small
1321or might not have been clamped to the valid range. 1482or might not have been clamped to the valid range.
1322.Sp 1483.Sp
1323The default priority used by watchers when no priority has been set is 1484The default priority used by watchers when no priority has been set is
1324always \f(CW0\fR, which is supposed to not be too high and not be too low :). 1485always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1325.Sp 1486.Sp
1326See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1487See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1327priorities. 1488priorities.
1328.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1489.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1329.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1490.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1330Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1491Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1331\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1492\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1337returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the 1498returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
1338watcher isn't pending it does nothing and returns \f(CW0\fR. 1499watcher isn't pending it does nothing and returns \f(CW0\fR.
1339.Sp 1500.Sp
1340Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its 1501Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its
1341callback to be invoked, which can be accomplished with this function. 1502callback to be invoked, which can be accomplished with this function.
1342.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 1503.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4
1343.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 1504.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)"
1344Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 1505Feeds the given event set into the event loop, as if the specified event
1345and read at any time: libev will completely ignore it. This can be used 1506had happened for the specified watcher (which must be a pointer to an
1346to associate arbitrary data with your watcher. If you need more data and 1507initialised but not necessarily started event watcher). Obviously you must
1347don't want to allocate memory and store a pointer to it in that data 1508not free the watcher as long as it has pending events.
1348member, you can also \*(L"subclass\*(R" the watcher type and provide your own 1509.Sp
1349data: 1510Stopping the watcher, letting libev invoke it, or calling
1511\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was
1512not started in the first place.
1513.Sp
1514See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1515functions that do not need a watcher.
1350.PP 1516.PP
1351.Vb 7 1517See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1352\& struct my_io 1518OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1353\& { 1519.SS "\s-1WATCHER STATES\s0"
1354\& ev_io io; 1520.IX Subsection "WATCHER STATES"
1355\& int otherfd; 1521There are various watcher states mentioned throughout this manual \-
1356\& void *somedata; 1522active, pending and so on. In this section these states and the rules to
1357\& struct whatever *mostinteresting; 1523transition between them will be described in more detail \- and while these
1358\& }; 1524rules might look complicated, they usually do \*(L"the right thing\*(R".
1359\& 1525.IP "initialised" 4
1360\& ... 1526.IX Item "initialised"
1361\& struct my_io w; 1527Before a watcher can be registered with the event loop it has to be
1362\& ev_io_init (&w.io, my_cb, fd, EV_READ); 1528initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1363.Ve 1529\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1364.PP 1530.Sp
1365And since your callback will be called with a pointer to the watcher, you 1531In this state it is simply some block of memory that is suitable for
1366can cast it back to your own type: 1532use in an event loop. It can be moved around, freed, reused etc. at
1367.PP 1533will \- as long as you either keep the memory contents intact, or call
1368.Vb 5 1534\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again.
1369\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents) 1535.IP "started/running/active" 4
1370\& { 1536.IX Item "started/running/active"
1371\& struct my_io *w = (struct my_io *)w_; 1537Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1372\& ... 1538property of the event loop, and is actively waiting for events. While in
1373\& } 1539this state it cannot be accessed (except in a few documented ways), moved,
1374.Ve 1540freed or anything else \- the only legal thing is to keep a pointer to it,
1375.PP 1541and call libev functions on it that are documented to work on active watchers.
1376More interesting and less C\-conformant ways of casting your callback type 1542.IP "pending" 4
1377instead have been omitted. 1543.IX Item "pending"
1378.PP 1544If a watcher is active and libev determines that an event it is interested
1379Another common scenario is to use some data structure with multiple 1545in has occurred (such as a timer expiring), it will become pending. It will
1380embedded watchers: 1546stay in this pending state until either it is stopped or its callback is
1381.PP 1547about to be invoked, so it is not normally pending inside the watcher
1382.Vb 6 1548callback.
1383\& struct my_biggy 1549.Sp
1384\& { 1550The watcher might or might not be active while it is pending (for example,
1385\& int some_data; 1551an expired non-repeating timer can be pending but no longer active). If it
1386\& ev_timer t1; 1552is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR),
1387\& ev_timer t2; 1553but it is still property of the event loop at this time, so cannot be
1388\& } 1554moved, freed or reused. And if it is active the rules described in the
1389.Ve 1555previous item still apply.
1390.PP 1556.Sp
1391In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more 1557It is also possible to feed an event on a watcher that is not active (e.g.
1392complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct 1558via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being
1393in the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies), or you need to use 1559active.
1394some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for real 1560.IP "stopped" 4
1395programmers): 1561.IX Item "stopped"
1396.PP 1562A watcher can be stopped implicitly by libev (in which case it might still
1397.Vb 1 1563be pending), or explicitly by calling its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. The
1398\& #include <stddef.h> 1564latter will clear any pending state the watcher might be in, regardless
1399\& 1565of whether it was active or not, so stopping a watcher explicitly before
1400\& static void 1566freeing it is often a good idea.
1401\& t1_cb (EV_P_ ev_timer *w, int revents) 1567.Sp
1402\& { 1568While stopped (and not pending) the watcher is essentially in the
1403\& struct my_biggy big = (struct my_biggy *) 1569initialised state, that is, it can be reused, moved, modified in any way
1404\& (((char *)w) \- offsetof (struct my_biggy, t1)); 1570you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1405\& } 1571it again).
1406\&
1407\& static void
1408\& t2_cb (EV_P_ ev_timer *w, int revents)
1409\& {
1410\& struct my_biggy big = (struct my_biggy *)
1411\& (((char *)w) \- offsetof (struct my_biggy, t2));
1412\& }
1413.Ve
1414.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1572.SS "\s-1WATCHER PRIORITY MODELS\s0"
1415.IX Subsection "WATCHER PRIORITY MODELS" 1573.IX Subsection "WATCHER PRIORITY MODELS"
1416Many event loops support \fIwatcher priorities\fR, which are usually small 1574Many event loops support \fIwatcher priorities\fR, which are usually small
1417integers that influence the ordering of event callback invocation 1575integers that influence the ordering of event callback invocation
1418between watchers in some way, all else being equal. 1576between watchers in some way, all else being equal.
1419.PP 1577.PP
1460.PP 1618.PP
1461For example, to emulate how many other event libraries handle priorities, 1619For example, to emulate how many other event libraries handle priorities,
1462you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in 1620you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in
1463the normal watcher callback, you just start the idle watcher. The real 1621the normal watcher callback, you just start the idle watcher. The real
1464processing is done in the idle watcher callback. This causes libev to 1622processing is done in the idle watcher callback. This causes libev to
1465continously poll and process kernel event data for the watcher, but when 1623continuously poll and process kernel event data for the watcher, but when
1466the lock-out case is known to be rare (which in turn is rare :), this is 1624the lock-out case is known to be rare (which in turn is rare :), this is
1467workable. 1625workable.
1468.PP 1626.PP
1469Usually, however, the lock-out model implemented that way will perform 1627Usually, however, the lock-out model implemented that way will perform
1470miserably under the type of load it was designed to handle. In that case, 1628miserably under the type of load it was designed to handle. In that case,
1485\& { 1643\& {
1486\& // stop the I/O watcher, we received the event, but 1644\& // stop the I/O watcher, we received the event, but
1487\& // are not yet ready to handle it. 1645\& // are not yet ready to handle it.
1488\& ev_io_stop (EV_A_ w); 1646\& ev_io_stop (EV_A_ w);
1489\& 1647\&
1490\& // start the idle watcher to ahndle the actual event. 1648\& // start the idle watcher to handle the actual event.
1491\& // it will not be executed as long as other watchers 1649\& // it will not be executed as long as other watchers
1492\& // with the default priority are receiving events. 1650\& // with the default priority are receiving events.
1493\& ev_idle_start (EV_A_ &idle); 1651\& ev_idle_start (EV_A_ &idle);
1494\& } 1652\& }
1495\& 1653\&
1543In general you can register as many read and/or write event watchers per 1701In general you can register as many read and/or write event watchers per
1544fd as you want (as long as you don't confuse yourself). Setting all file 1702fd as you want (as long as you don't confuse yourself). Setting all file
1545descriptors to non-blocking mode is also usually a good idea (but not 1703descriptors to non-blocking mode is also usually a good idea (but not
1546required if you know what you are doing). 1704required if you know what you are doing).
1547.PP 1705.PP
1548If you cannot use non-blocking mode, then force the use of a
1549known-to-be-good backend (at the time of this writing, this includes only
1550\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR). The same applies to file
1551descriptors for which non-blocking operation makes no sense (such as
1552files) \- libev doesn't guarentee any specific behaviour in that case.
1553.PP
1554Another thing you have to watch out for is that it is quite easy to 1706Another thing you have to watch out for is that it is quite easy to
1555receive \*(L"spurious\*(R" readiness notifications, that is your callback might 1707receive \*(L"spurious\*(R" readiness notifications, that is, your callback might
1556be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block 1708be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
1557because there is no data. Not only are some backends known to create a 1709because there is no data. It is very easy to get into this situation even
1558lot of those (for example Solaris ports), it is very easy to get into 1710with a relatively standard program structure. Thus it is best to always
1559this situation even with a relatively standard program structure. Thus 1711use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning \f(CW\*(C`EAGAIN\*(C'\fR is far
1560it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
1561\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. 1712preferable to a program hanging until some data arrives.
1562.PP 1713.PP
1563If you cannot run the fd in non-blocking mode (for example you should 1714If you cannot run the fd in non-blocking mode (for example you should
1564not play around with an Xlib connection), then you have to separately 1715not play around with an Xlib connection), then you have to separately
1565re-test whether a file descriptor is really ready with a known-to-be good 1716re-test whether a file descriptor is really ready with a known-to-be good
1566interface such as poll (fortunately in our Xlib example, Xlib already 1717interface such as poll (fortunately in the case of Xlib, it already does
1567does this on its own, so its quite safe to use). Some people additionally 1718this on its own, so its quite safe to use). Some people additionally
1568use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block 1719use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block
1569indefinitely. 1720indefinitely.
1570.PP 1721.PP
1571But really, best use non-blocking mode. 1722But really, best use non-blocking mode.
1572.PP 1723.PP
1602.PP 1753.PP
1603There is no workaround possible except not registering events 1754There is no workaround possible except not registering events
1604for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to 1755for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1605\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1756\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1606.PP 1757.PP
1758\fIThe special problem of files\fR
1759.IX Subsection "The special problem of files"
1760.PP
1761Many people try to use \f(CW\*(C`select\*(C'\fR (or libev) on file descriptors
1762representing files, and expect it to become ready when their program
1763doesn't block on disk accesses (which can take a long time on their own).
1764.PP
1765However, this cannot ever work in the \*(L"expected\*(R" way \- you get a readiness
1766notification as soon as the kernel knows whether and how much data is
1767there, and in the case of open files, that's always the case, so you
1768always get a readiness notification instantly, and your read (or possibly
1769write) will still block on the disk I/O.
1770.PP
1771Another way to view it is that in the case of sockets, pipes, character
1772devices and so on, there is another party (the sender) that delivers data
1773on its own, but in the case of files, there is no such thing: the disk
1774will not send data on its own, simply because it doesn't know what you
1775wish to read \- you would first have to request some data.
1776.PP
1777Since files are typically not-so-well supported by advanced notification
1778mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1779to files, even though you should not use it. The reason for this is
1780convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1781usually a tty, often a pipe, but also sometimes files or special devices
1782(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1783\&\fI/dev/urandom\fR), and even though the file might better be served with
1784asynchronous I/O instead of with non-blocking I/O, it is still useful when
1785it \*(L"just works\*(R" instead of freezing.
1786.PP
1787So avoid file descriptors pointing to files when you know it (e.g. use
1788libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1789when you rarely read from a file instead of from a socket, and want to
1790reuse the same code path.
1791.PP
1607\fIThe special problem of fork\fR 1792\fIThe special problem of fork\fR
1608.IX Subsection "The special problem of fork" 1793.IX Subsection "The special problem of fork"
1609.PP 1794.PP
1610Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1795Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit
1611useless behaviour. Libev fully supports fork, but needs to be told about 1796useless behaviour. Libev fully supports fork, but needs to be told about
1612it in the child. 1797it in the child if you want to continue to use it in the child.
1613.PP 1798.PP
1614To support fork in your programs, you either have to call 1799To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1615\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, 1800()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1616enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or 1801\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1617\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1618.PP 1802.PP
1619\fIThe special problem of \s-1SIGPIPE\s0\fR 1803\fIThe special problem of \s-1SIGPIPE\s0\fR
1620.IX Subsection "The special problem of SIGPIPE" 1804.IX Subsection "The special problem of SIGPIPE"
1621.PP 1805.PP
1622While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1806While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1623when writing to a pipe whose other end has been closed, your program gets 1807when writing to a pipe whose other end has been closed, your program gets
1624sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs 1808sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1625this is sensible behaviour, for daemons, this is usually undesirable. 1809this is sensible behaviour, for daemons, this is usually undesirable.
1626.PP 1810.PP
1627So when you encounter spurious, unexplained daemon exits, make sure you 1811So when you encounter spurious, unexplained daemon exits, make sure you
1628ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon 1812ignore \s-1SIGPIPE \s0(and maybe make sure you log the exit status of your daemon
1629somewhere, as that would have given you a big clue). 1813somewhere, as that would have given you a big clue).
1814.PP
1815\fIThe special problem of \fIaccept()\fIing when you can't\fR
1816.IX Subsection "The special problem of accept()ing when you can't"
1817.PP
1818Many implementations of the \s-1POSIX \s0\f(CW\*(C`accept\*(C'\fR function (for example,
1819found in post\-2004 Linux) have the peculiar behaviour of not removing a
1820connection from the pending queue in all error cases.
1821.PP
1822For example, larger servers often run out of file descriptors (because
1823of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not
1824rejecting the connection, leading to libev signalling readiness on
1825the next iteration again (the connection still exists after all), and
1826typically causing the program to loop at 100% \s-1CPU\s0 usage.
1827.PP
1828Unfortunately, the set of errors that cause this issue differs between
1829operating systems, there is usually little the app can do to remedy the
1830situation, and no known thread-safe method of removing the connection to
1831cope with overload is known (to me).
1832.PP
1833One of the easiest ways to handle this situation is to just ignore it
1834\&\- when the program encounters an overload, it will just loop until the
1835situation is over. While this is a form of busy waiting, no \s-1OS\s0 offers an
1836event-based way to handle this situation, so it's the best one can do.
1837.PP
1838A better way to handle the situation is to log any errors other than
1839\&\f(CW\*(C`EAGAIN\*(C'\fR and \f(CW\*(C`EWOULDBLOCK\*(C'\fR, making sure not to flood the log with such
1840messages, and continue as usual, which at least gives the user an idea of
1841what could be wrong (\*(L"raise the ulimit!\*(R"). For extra points one could stop
1842the \f(CW\*(C`ev_io\*(C'\fR watcher on the listening fd \*(L"for a while\*(R", which reduces \s-1CPU\s0
1843usage.
1844.PP
1845If your program is single-threaded, then you could also keep a dummy file
1846descriptor for overload situations (e.g. by opening \fI/dev/null\fR), and
1847when 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,
1848close that fd, and create a new dummy fd. This will gracefully refuse
1849clients under typical overload conditions.
1850.PP
1851The last way to handle it is to simply log the error and \f(CW\*(C`exit\*(C'\fR, as
1852is often done with \f(CW\*(C`malloc\*(C'\fR failures, but this results in an easy
1853opportunity for a DoS attack.
1630.PP 1854.PP
1631\fIWatcher-Specific Functions\fR 1855\fIWatcher-Specific Functions\fR
1632.IX Subsection "Watcher-Specific Functions" 1856.IX Subsection "Watcher-Specific Functions"
1633.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1857.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
1634.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1858.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
1664\& ... 1888\& ...
1665\& struct ev_loop *loop = ev_default_init (0); 1889\& struct ev_loop *loop = ev_default_init (0);
1666\& ev_io stdin_readable; 1890\& ev_io stdin_readable;
1667\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1891\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1668\& ev_io_start (loop, &stdin_readable); 1892\& ev_io_start (loop, &stdin_readable);
1669\& ev_loop (loop, 0); 1893\& ev_run (loop, 0);
1670.Ve 1894.Ve
1671.ie n .SS """ev_timer"" \- relative and optionally repeating timeouts" 1895.ie n .SS """ev_timer"" \- relative and optionally repeating timeouts"
1672.el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts" 1896.el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
1673.IX Subsection "ev_timer - relative and optionally repeating timeouts" 1897.IX Subsection "ev_timer - relative and optionally repeating timeouts"
1674Timer watchers are simple relative timers that generate an event after a 1898Timer watchers are simple relative timers that generate an event after a
1680detecting time jumps is hard, and some inaccuracies are unavoidable (the 1904detecting time jumps is hard, and some inaccuracies are unavoidable (the
1681monotonic clock option helps a lot here). 1905monotonic clock option helps a lot here).
1682.PP 1906.PP
1683The callback is guaranteed to be invoked only \fIafter\fR its timeout has 1907The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1684passed (not \fIat\fR, so on systems with very low-resolution clocks this 1908passed (not \fIat\fR, so on systems with very low-resolution clocks this
1685might introduce a small delay). If multiple timers become ready during the 1909might introduce a small delay, see \*(L"the special problem of being too
1910early\*(R", below). If multiple timers become ready during the same loop
1686same loop iteration then the ones with earlier time-out values are invoked 1911iteration then the ones with earlier time-out values are invoked before
1687before ones of the same priority with later time-out values (but this is 1912ones of the same priority with later time-out values (but this is no
1688no longer true when a callback calls \f(CW\*(C`ev_loop\*(C'\fR recursively). 1913longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
1689.PP 1914.PP
1690\fIBe smart about timeouts\fR 1915\fIBe smart about timeouts\fR
1691.IX Subsection "Be smart about timeouts" 1916.IX Subsection "Be smart about timeouts"
1692.PP 1917.PP
1693Many real-world problems involve some kind of timeout, usually for error 1918Many real-world problems involve some kind of timeout, usually for error
1775.Sp 2000.Sp
1776In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, 2001In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
1777but remember the time of last activity, and check for a real timeout only 2002but remember the time of last activity, and check for a real timeout only
1778within the callback: 2003within the callback:
1779.Sp 2004.Sp
1780.Vb 1 2005.Vb 3
2006\& ev_tstamp timeout = 60.;
1781\& ev_tstamp last_activity; // time of last activity 2007\& ev_tstamp last_activity; // time of last activity
2008\& ev_timer timer;
1782\& 2009\&
1783\& static void 2010\& static void
1784\& callback (EV_P_ ev_timer *w, int revents) 2011\& callback (EV_P_ ev_timer *w, int revents)
1785\& { 2012\& {
1786\& ev_tstamp now = ev_now (EV_A); 2013\& // calculate when the timeout would happen
1787\& ev_tstamp timeout = last_activity + 60.; 2014\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
1788\& 2015\&
1789\& // if last_activity + 60. is older than now, we did time out 2016\& // if negative, it means we the timeout already occurred
1790\& if (timeout < now) 2017\& if (after < 0.)
1791\& { 2018\& {
1792\& // timeout occured, take action 2019\& // timeout occurred, take action
1793\& } 2020\& }
1794\& else 2021\& else
1795\& { 2022\& {
1796\& // callback was invoked, but there was some activity, re\-arm 2023\& // callback was invoked, but there was some recent
1797\& // the watcher to fire in last_activity + 60, which is 2024\& // activity. simply restart the timer to time out
1798\& // guaranteed to be in the future, so "again" is positive: 2025\& // after "after" seconds, which is the earliest time
1799\& w\->repeat = timeout \- now; 2026\& // the timeout can occur.
2027\& ev_timer_set (w, after, 0.);
1800\& ev_timer_again (EV_A_ w); 2028\& ev_timer_start (EV_A_ w);
1801\& } 2029\& }
1802\& } 2030\& }
1803.Ve 2031.Ve
1804.Sp 2032.Sp
1805To summarise the callback: first calculate the real timeout (defined 2033To summarise the callback: first calculate in how many seconds the
1806as \*(L"60 seconds after the last activity\*(R"), then check if that time has 2034timeout will occur (by calculating the absolute time when it would occur,
1807been reached, which means something \fIdid\fR, in fact, time out. Otherwise 2035\&\f(CW\*(C`last_activity + timeout\*(C'\fR, and subtracting the current time, \f(CW\*(C`ev_now
1808the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so 2036(EV_A)\*(C'\fR from that).
1809re-schedule the timer to fire at that future time, to see if maybe we have
1810a timeout then.
1811.Sp 2037.Sp
1812Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the 2038If this value is negative, then we are already past the timeout, i.e. we
1813\&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running. 2039timed out, and need to do whatever is needed in this case.
2040.Sp
2041Otherwise, we now the earliest time at which the timeout would trigger,
2042and simply start the timer with this timeout value.
2043.Sp
2044In other words, each time the callback is invoked it will check whether
2045the timeout occurred. If not, it will simply reschedule itself to check
2046again at the earliest time it could time out. Rinse. Repeat.
1814.Sp 2047.Sp
1815This scheme causes more callback invocations (about one every 60 seconds 2048This scheme causes more callback invocations (about one every 60 seconds
1816minus half the average time between activity), but virtually no calls to 2049minus half the average time between activity), but virtually no calls to
1817libev to change the timeout. 2050libev to change the timeout.
1818.Sp 2051.Sp
1819To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR 2052To start the machinery, simply initialise the watcher and set
1820to the current time (meaning we just have some activity :), then call the 2053\&\f(CW\*(C`last_activity\*(C'\fR to the current time (meaning there was some activity just
1821callback, which will \*(L"do the right thing\*(R" and start the timer: 2054now), then call the callback, which will \*(L"do the right thing\*(R" and start
2055the timer:
1822.Sp 2056.Sp
1823.Vb 3 2057.Vb 3
2058\& last_activity = ev_now (EV_A);
1824\& ev_init (timer, callback); 2059\& ev_init (&timer, callback);
1825\& last_activity = ev_now (loop); 2060\& callback (EV_A_ &timer, 0);
1826\& callback (loop, timer, EV_TIMEOUT);
1827.Ve 2061.Ve
1828.Sp 2062.Sp
1829And when there is some activity, simply store the current time in 2063When there is some activity, simply store the current time in
1830\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: 2064\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
1831.Sp 2065.Sp
1832.Vb 1 2066.Vb 2
2067\& if (activity detected)
1833\& last_actiivty = ev_now (loop); 2068\& last_activity = ev_now (EV_A);
2069.Ve
2070.Sp
2071When your timeout value changes, then the timeout can be changed by simply
2072providing a new value, stopping the timer and calling the callback, which
2073will again do the right thing (for example, time out immediately :).
2074.Sp
2075.Vb 3
2076\& timeout = new_value;
2077\& ev_timer_stop (EV_A_ &timer);
2078\& callback (EV_A_ &timer, 0);
1834.Ve 2079.Ve
1835.Sp 2080.Sp
1836This technique is slightly more complex, but in most cases where the 2081This technique is slightly more complex, but in most cases where the
1837time-out is unlikely to be triggered, much more efficient. 2082time-out is unlikely to be triggered, much more efficient.
1838.Sp
1839Changing the timeout is trivial as well (if it isn't hard-coded in the
1840callback :) \- just change the timeout and invoke the callback, which will
1841fix things for you.
1842.IP "4. Wee, just use a double-linked list for your timeouts." 4 2083.IP "4. Wee, just use a double-linked list for your timeouts." 4
1843.IX Item "4. Wee, just use a double-linked list for your timeouts." 2084.IX Item "4. Wee, just use a double-linked list for your timeouts."
1844If there is not one request, but many thousands (millions...), all 2085If there is not one request, but many thousands (millions...), all
1845employing some kind of timeout with the same timeout value, then one can 2086employing some kind of timeout with the same timeout value, then one can
1846do even better: 2087do even better:
1870Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2111Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1871rather complicated, but extremely efficient, something that really pays 2112rather complicated, but extremely efficient, something that really pays
1872off after the first million or so of active timers, i.e. it's usually 2113off after the first million or so of active timers, i.e. it's usually
1873overkill :) 2114overkill :)
1874.PP 2115.PP
2116\fIThe special problem of being too early\fR
2117.IX Subsection "The special problem of being too early"
2118.PP
2119If you ask a timer to call your callback after three seconds, then
2120you expect it to be invoked after three seconds \- but of course, this
2121cannot be guaranteed to infinite precision. Less obviously, it cannot be
2122guaranteed to any precision by libev \- imagine somebody suspending the
2123process with a \s-1STOP\s0 signal for a few hours for example.
2124.PP
2125So, libev tries to invoke your callback as soon as possible \fIafter\fR the
2126delay has occurred, but cannot guarantee this.
2127.PP
2128A less obvious failure mode is calling your callback too early: many event
2129loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but
2130this can cause your callback to be invoked much earlier than you would
2131expect.
2132.PP
2133To see why, imagine a system with a clock that only offers full second
2134resolution (think windows if you can't come up with a broken enough \s-1OS\s0
2135yourself). If you schedule a one-second timer at the time 500.9, then the
2136event loop will schedule your timeout to elapse at a system time of 500
2137(500.9 truncated to the resolution) + 1, or 501.
2138.PP
2139If an event library looks at the timeout 0.1s later, it will see \*(L"501 >=
2140501\*(R" and invoke the callback 0.1s after it was started, even though a
2141one-second delay was requested \- this is being \*(L"too early\*(R", despite best
2142intentions.
2143.PP
2144This is the reason why libev will never invoke the callback if the elapsed
2145delay equals the requested delay, but only when the elapsed delay is
2146larger than the requested delay. In the example above, libev would only invoke
2147the callback at system time 502, or 1.1s after the timer was started.
2148.PP
2149So, while libev cannot guarantee that your callback will be invoked
2150exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested
2151delay has actually elapsed, or in other words, it always errs on the \*(L"too
2152late\*(R" side of things.
2153.PP
1875\fIThe special problem of time updates\fR 2154\fIThe special problem of time updates\fR
1876.IX Subsection "The special problem of time updates" 2155.IX Subsection "The special problem of time updates"
1877.PP 2156.PP
1878Establishing the current time is a costly operation (it usually takes at 2157Establishing the current time is a costly operation (it usually takes
1879least two system calls): \s-1EV\s0 therefore updates its idea of the current 2158at least one system call): \s-1EV\s0 therefore updates its idea of the current
1880time only before and after \f(CW\*(C`ev_loop\*(C'\fR collects new events, which causes a 2159time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a
1881growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling 2160growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
1882lots of events in one iteration. 2161lots of events in one iteration.
1883.PP 2162.PP
1884The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2163The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
1885time. This is usually the right thing as this timestamp refers to the time 2164time. This is usually the right thing as this timestamp refers to the time
1886of the event triggering whatever timeout you are modifying/starting. If 2165of the event triggering whatever timeout you are modifying/starting. If
1887you suspect event processing to be delayed and you \fIneed\fR to base the 2166you suspect event processing to be delayed and you \fIneed\fR to base the
1888timeout on the current time, use something like this to adjust for this: 2167timeout on the current time, use something like the following to adjust
2168for it:
1889.PP 2169.PP
1890.Vb 1 2170.Vb 1
1891\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 2171\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
1892.Ve 2172.Ve
1893.PP 2173.PP
1894If the event loop is suspended for a long time, you can also force an 2174If the event loop is suspended for a long time, you can also force an
1895update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 2175update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
1896()\*(C'\fR. 2176()\*(C'\fR, although that will push the event time of all outstanding events
2177further into the future.
2178.PP
2179\fIThe special problem of unsynchronised clocks\fR
2180.IX Subsection "The special problem of unsynchronised clocks"
2181.PP
2182Modern systems have a variety of clocks \- libev itself uses the normal
2183\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time
2184jumps).
2185.PP
2186Neither of these clocks is synchronised with each other or any other clock
2187on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time
2188than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example,
2189a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher
2190than a directly following call to \f(CW\*(C`time\*(C'\fR.
2191.PP
2192The moral of this is to only compare libev-related timestamps with
2193\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than
2194a second or so.
2195.PP
2196One more problem arises due to this lack of synchronisation: if libev uses
2197the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR
2198or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is
2199invoked, you will find that sometimes the callback is a bit \*(L"early\*(R".
2200.PP
2201This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so
2202libev makes sure your callback is not invoked before the delay happened,
2203\&\fImeasured according to the real time\fR, not the system clock.
2204.PP
2205If your timeouts are based on a physical timescale (e.g. \*(L"time out this
2206connection after 100 seconds\*(R") then this shouldn't bother you as it is
2207exactly the right behaviour.
2208.PP
2209If you want to compare wall clock/system timestamps to your timers, then
2210you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock
2211time, where your comparisons will always generate correct results.
1897.PP 2212.PP
1898\fIThe special problems of suspended animation\fR 2213\fIThe special problems of suspended animation\fR
1899.IX Subsection "The special problems of suspended animation" 2214.IX Subsection "The special problems of suspended animation"
1900.PP 2215.PP
1901When you leave the server world it is quite customary to hit machines that 2216When you leave the server world it is quite customary to hit machines that
1945trigger at exactly 10 second intervals. If, however, your program cannot 2260trigger at exactly 10 second intervals. If, however, your program cannot
1946keep up with the timer (because it takes longer than those 10 seconds to 2261keep up with the timer (because it takes longer than those 10 seconds to
1947do stuff) the timer will not fire more than once per event loop iteration. 2262do stuff) the timer will not fire more than once per event loop iteration.
1948.IP "ev_timer_again (loop, ev_timer *)" 4 2263.IP "ev_timer_again (loop, ev_timer *)" 4
1949.IX Item "ev_timer_again (loop, ev_timer *)" 2264.IX Item "ev_timer_again (loop, ev_timer *)"
1950This will act as if the timer timed out and restart it again if it is 2265This will act as if the timer timed out, and restarts it again if it is
1951repeating. The exact semantics are: 2266repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the
2267timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR.
1952.Sp 2268.Sp
2269The exact semantics are as in the following rules, all of which will be
2270applied to the watcher:
2271.RS 4
1953If the timer is pending, its pending status is cleared. 2272.IP "If the timer is pending, the pending status is always cleared." 4
1954.Sp 2273.IX Item "If the timer is pending, the pending status is always cleared."
2274.PD 0
1955If the timer is started but non-repeating, stop it (as if it timed out). 2275.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4
1956.Sp 2276.IX Item "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)."
1957If the timer is repeating, either start it if necessary (with the 2277.ie n .IP "If the timer is repeating, make the ""repeat"" value the new timeout and start the timer, if necessary." 4
1958\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 2278.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4
2279.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary."
2280.RE
2281.RS 4
2282.PD
1959.Sp 2283.Sp
1960This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a 2284This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
1961usage example. 2285usage example.
2286.RE
1962.IP "ev_timer_remaining (loop, ev_timer *)" 4 2287.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4
1963.IX Item "ev_timer_remaining (loop, ev_timer *)" 2288.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)"
1964Returns the remaining time until a timer fires. If the timer is active, 2289Returns the remaining time until a timer fires. If the timer is active,
1965then this time is relative to the current event loop time, otherwise it's 2290then this time is relative to the current event loop time, otherwise it's
1966the timeout value currently configured. 2291the timeout value currently configured.
1967.Sp 2292.Sp
1968That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns 2293That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns
1969\&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remain\*(C'\fR 2294\&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remaining\*(C'\fR
1970will return \f(CW4\fR. When the timer expires and is restarted, it will return 2295will return \f(CW4\fR. When the timer expires and is restarted, it will return
1971roughly \f(CW7\fR (likely slightly less as callback invocation takes some time, 2296roughly \f(CW7\fR (likely slightly less as callback invocation takes some time,
1972too), and so on. 2297too), and so on.
1973.IP "ev_tstamp repeat [read\-write]" 4 2298.IP "ev_tstamp repeat [read\-write]" 4
1974.IX Item "ev_tstamp repeat [read-write]" 2299.IX Item "ev_tstamp repeat [read-write]"
2004\& } 2329\& }
2005\& 2330\&
2006\& ev_timer mytimer; 2331\& ev_timer mytimer;
2007\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 2332\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
2008\& ev_timer_again (&mytimer); /* start timer */ 2333\& ev_timer_again (&mytimer); /* start timer */
2009\& ev_loop (loop, 0); 2334\& ev_run (loop, 0);
2010\& 2335\&
2011\& // and in some piece of code that gets executed on any "activity": 2336\& // and in some piece of code that gets executed on any "activity":
2012\& // reset the timeout to start ticking again at 10 seconds 2337\& // reset the timeout to start ticking again at 10 seconds
2013\& ev_timer_again (&mytimer); 2338\& ev_timer_again (&mytimer);
2014.Ve 2339.Ve
2040.PP 2365.PP
2041As with timers, the callback is guaranteed to be invoked only when the 2366As with timers, the callback is guaranteed to be invoked only when the
2042point in time where it is supposed to trigger has passed. If multiple 2367point in time where it is supposed to trigger has passed. If multiple
2043timers become ready during the same loop iteration then the ones with 2368timers become ready during the same loop iteration then the ones with
2044earlier time-out values are invoked before ones with later time-out values 2369earlier time-out values are invoked before ones with later time-out values
2045(but this is no longer true when a callback calls \f(CW\*(C`ev_loop\*(C'\fR recursively). 2370(but this is no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively).
2046.PP 2371.PP
2047\fIWatcher-Specific Functions and Data Members\fR 2372\fIWatcher-Specific Functions and Data Members\fR
2048.IX Subsection "Watcher-Specific Functions and Data Members" 2373.IX Subsection "Watcher-Specific Functions and Data Members"
2049.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4 2374.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
2050.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 2375.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
2086.Sp 2411.Sp
2087Another way to think about it (for the mathematically inclined) is that 2412Another way to think about it (for the mathematically inclined) is that
2088\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2413\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
2089time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps. 2414time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
2090.Sp 2415.Sp
2091For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near 2416The \f(CW\*(C`interval\*(C'\fR \fI\s-1MUST\s0\fR be positive, and for numerical stability, the
2092\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 2417interval value should be higher than \f(CW\*(C`1/8192\*(C'\fR (which is around 100
2093this value, and in fact is often specified as zero. 2418microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have
2419at most a similar magnitude as the current time (say, within a factor of
2420ten). Typical values for offset are, in fact, \f(CW0\fR or something between
2421\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range.
2094.Sp 2422.Sp
2095Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 2423Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
2096speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability 2424speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
2097will of course deteriorate. Libev itself tries to be exact to be about one 2425will of course deteriorate. Libev itself tries to be exact to be about one
2098millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). 2426millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
2102In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being 2430In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
2103ignored. Instead, each time the periodic watcher gets scheduled, the 2431ignored. Instead, each time the periodic watcher gets scheduled, the
2104reschedule callback will be called with the watcher as first, and the 2432reschedule callback will be called with the watcher as first, and the
2105current time as second argument. 2433current time as second argument.
2106.Sp 2434.Sp
2107\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2435\&\s-1NOTE: \s0\fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
2108or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly 2436or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2109allowed by documentation here\fR. 2437allowed by documentation here\fR.
2110.Sp 2438.Sp
2111If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2439If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2112it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2440it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2126It must return the next time to trigger, based on the passed time value 2454It must return the next time to trigger, based on the passed time value
2127(that is, the lowest time value larger than to the second argument). It 2455(that is, the lowest time value larger than to the second argument). It
2128will usually be called just before the callback will be triggered, but 2456will usually be called just before the callback will be triggered, but
2129might be called at other times, too. 2457might be called at other times, too.
2130.Sp 2458.Sp
2131\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2459\&\s-1NOTE: \s0\fIThis callback must always return a time that is higher than or
2132equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. 2460equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2133.Sp 2461.Sp
2134This can be used to create very complex timers, such as a timer that 2462This can be used to create very complex timers, such as a timer that
2135triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the 2463triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the
2136next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2464next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How
2177system time is divisible by 3600. The callback invocation times have 2505system time is divisible by 3600. The callback invocation times have
2178potentially a lot of jitter, but good long-term stability. 2506potentially a lot of jitter, but good long-term stability.
2179.PP 2507.PP
2180.Vb 5 2508.Vb 5
2181\& static void 2509\& static void
2182\& clock_cb (struct ev_loop *loop, ev_io *w, int revents) 2510\& clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2183\& { 2511\& {
2184\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 2512\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
2185\& } 2513\& }
2186\& 2514\&
2187\& ev_periodic hourly_tick; 2515\& ev_periodic hourly_tick;
2214.ie n .SS """ev_signal"" \- signal me when a signal gets signalled!" 2542.ie n .SS """ev_signal"" \- signal me when a signal gets signalled!"
2215.el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!" 2543.el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
2216.IX Subsection "ev_signal - signal me when a signal gets signalled!" 2544.IX Subsection "ev_signal - signal me when a signal gets signalled!"
2217Signal watchers will trigger an event when the process receives a specific 2545Signal watchers will trigger an event when the process receives a specific
2218signal one or more times. Even though signals are very asynchronous, libev 2546signal one or more times. Even though signals are very asynchronous, libev
2219will try it's best to deliver signals synchronously, i.e. as part of the 2547will try its best to deliver signals synchronously, i.e. as part of the
2220normal event processing, like any other event. 2548normal event processing, like any other event.
2221.PP 2549.PP
2222If you want signals asynchronously, just use \f(CW\*(C`sigaction\*(C'\fR as you would 2550If you want signals to be delivered truly asynchronously, just use
2223do without libev and forget about sharing the signal. You can even use 2551\&\f(CW\*(C`sigaction\*(C'\fR as you would do without libev and forget about sharing
2224\&\f(CW\*(C`ev_async\*(C'\fR from a signal handler to synchronously wake up an event loop. 2552the signal. You can even use \f(CW\*(C`ev_async\*(C'\fR from a signal handler to
2553synchronously wake up an event loop.
2225.PP 2554.PP
2226You can configure as many watchers as you like per signal. Only when the 2555You can configure as many watchers as you like for the same signal, but
2227first watcher gets started will libev actually register a signal handler 2556only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
2228with the kernel (thus it coexists with your own signal handlers as long as 2557default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
2229you don't register any with libev for the same signal). Similarly, when 2558\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
2230the last signal watcher for a signal is stopped, libev will reset the 2559the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2231signal handler to \s-1SIG_DFL\s0 (regardless of what it was set to before). 2560.PP
2561Only after the first watcher for a signal is started will libev actually
2562register something with the kernel. It thus coexists with your own signal
2563handlers as long as you don't register any with libev for the same signal.
2232.PP 2564.PP
2233If possible and supported, libev will install its handlers with 2565If possible and supported, libev will install its handlers with
2234\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so system calls should not be unduly 2566\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
2235interrupted. If you have a problem with system calls getting interrupted by 2567not be unduly interrupted. If you have a problem with system calls getting
2236signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock 2568interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2237them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher. 2569and unblock them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
2570.PP
2571\fIThe special problem of inheritance over fork/execve/pthread_create\fR
2572.IX Subsection "The special problem of inheritance over fork/execve/pthread_create"
2573.PP
2574Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition
2575(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after
2576stopping it again), that is, libev might or might not block the signal,
2577and might or might not set or restore the installed signal handler (but
2578see \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR).
2579.PP
2580While this does not matter for the signal disposition (libev never
2581sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on
2582\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect
2583certain signals to be blocked.
2584.PP
2585This means that before calling \f(CW\*(C`exec\*(C'\fR (from the child) you should reset
2586the signal mask to whatever \*(L"default\*(R" you expect (all clear is a good
2587choice usually).
2588.PP
2589The simplest way to ensure that the signal mask is reset in the child is
2590to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will
2591catch fork calls done by libraries (such as the libc) as well.
2592.PP
2593In current versions of libev, the signal will not be blocked indefinitely
2594unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API \s0(\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
2595the window of opportunity for problems, it will not go away, as libev
2596\&\fIhas\fR to modify the signal mask, at least temporarily.
2597.PP
2598So I can't stress this enough: \fIIf you do not reset your signal mask when
2599you expect it to be empty, you have a race condition in your code\fR. This
2600is not a libev-specific thing, this is true for most event libraries.
2601.PP
2602\fIThe special problem of threads signal handling\fR
2603.IX Subsection "The special problem of threads signal handling"
2604.PP
2605\&\s-1POSIX\s0 threads has problematic signal handling semantics, specifically,
2606a lot of functionality (sigfd, sigwait etc.) only really works if all
2607threads in a process block signals, which is hard to achieve.
2608.PP
2609When you want to use sigwait (or mix libev signal handling with your own
2610for the same signals), you can tackle this problem by globally blocking
2611all signals before creating any threads (or creating them with a fully set
2612sigprocmask) and also specifying the \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when creating
2613loops. Then designate one thread as \*(L"signal receiver thread\*(R" which handles
2614these signals. You can pass on any signals that libev might be interested
2615in by calling \f(CW\*(C`ev_feed_signal\*(C'\fR.
2238.PP 2616.PP
2239\fIWatcher-Specific Functions and Data Members\fR 2617\fIWatcher-Specific Functions and Data Members\fR
2240.IX Subsection "Watcher-Specific Functions and Data Members" 2618.IX Subsection "Watcher-Specific Functions and Data Members"
2241.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 2619.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
2242.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 2620.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
2251The signal the watcher watches out for. 2629The signal the watcher watches out for.
2252.PP 2630.PP
2253\fIExamples\fR 2631\fIExamples\fR
2254.IX Subsection "Examples" 2632.IX Subsection "Examples"
2255.PP 2633.PP
2256Example: Try to exit cleanly on \s-1SIGINT\s0. 2634Example: Try to exit cleanly on \s-1SIGINT.\s0
2257.PP 2635.PP
2258.Vb 5 2636.Vb 5
2259\& static void 2637\& static void
2260\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2638\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2261\& { 2639\& {
2262\& ev_unloop (loop, EVUNLOOP_ALL); 2640\& ev_break (loop, EVBREAK_ALL);
2263\& } 2641\& }
2264\& 2642\&
2265\& ev_signal signal_watcher; 2643\& ev_signal signal_watcher;
2266\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 2644\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2267\& ev_signal_start (loop, &signal_watcher); 2645\& ev_signal_start (loop, &signal_watcher);
2287.PP 2665.PP
2288\fIProcess Interaction\fR 2666\fIProcess Interaction\fR
2289.IX Subsection "Process Interaction" 2667.IX Subsection "Process Interaction"
2290.PP 2668.PP
2291Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is 2669Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
2292initialised. This is necessary to guarantee proper behaviour even if 2670initialised. This is necessary to guarantee proper behaviour even if the
2293the first child watcher is started after the child exits. The occurrence 2671first child watcher is started after the child exits. The occurrence
2294of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done 2672of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
2295synchronously as part of the event loop processing. Libev always reaps all 2673synchronously as part of the event loop processing. Libev always reaps all
2296children, even ones not watched. 2674children, even ones not watched.
2297.PP 2675.PP
2298\fIOverriding the Built-In Processing\fR 2676\fIOverriding the Built-In Processing\fR
2310.IX Subsection "Stopping the Child Watcher" 2688.IX Subsection "Stopping the Child Watcher"
2311.PP 2689.PP
2312Currently, the child watcher never gets stopped, even when the 2690Currently, the child watcher never gets stopped, even when the
2313child terminates, so normally one needs to stop the watcher in the 2691child terminates, so normally one needs to stop the watcher in the
2314callback. Future versions of libev might stop the watcher automatically 2692callback. Future versions of libev might stop the watcher automatically
2315when a child exit is detected. 2693when a child exit is detected (calling \f(CW\*(C`ev_child_stop\*(C'\fR twice is not a
2694problem).
2316.PP 2695.PP
2317\fIWatcher-Specific Functions and Data Members\fR 2696\fIWatcher-Specific Functions and Data Members\fR
2318.IX Subsection "Watcher-Specific Functions and Data Members" 2697.IX Subsection "Watcher-Specific Functions and Data Members"
2319.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4 2698.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
2320.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)" 2699.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
2375.ie n .SS """ev_stat"" \- did the file attributes just change?" 2754.ie n .SS """ev_stat"" \- did the file attributes just change?"
2376.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2755.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2377.IX Subsection "ev_stat - did the file attributes just change?" 2756.IX Subsection "ev_stat - did the file attributes just change?"
2378This watches a file system path for attribute changes. That is, it calls 2757This watches a file system path for attribute changes. That is, it calls
2379\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) 2758\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2380and sees if it changed compared to the last time, invoking the callback if 2759and sees if it changed compared to the last time, invoking the callback
2381it did. 2760if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2761happen after the watcher has been started will be reported.
2382.PP 2762.PP
2383The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2763The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
2384not exist\*(R" is a status change like any other. The condition \*(L"path does not 2764not exist\*(R" is a status change like any other. The condition \*(L"path does not
2385exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the 2765exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
2386\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at 2766\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
2416compilation environment, which means that on systems with large file 2796compilation environment, which means that on systems with large file
2417support disabled by default, you get the 32 bit version of the stat 2797support disabled by default, you get the 32 bit version of the stat
2418structure. When using the library from programs that change the \s-1ABI\s0 to 2798structure. When using the library from programs that change the \s-1ABI\s0 to
2419use 64 bit file offsets the programs will fail. In that case you have to 2799use 64 bit file offsets the programs will fail. In that case you have to
2420compile libev with the same flags to get binary compatibility. This is 2800compile libev with the same flags to get binary compatibility. This is
2421obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2801obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2422most noticeably displayed with ev_stat and large file support. 2802most noticeably displayed with ev_stat and large file support.
2423.PP 2803.PP
2424The solution for this is to lobby your distribution maker to make large 2804The solution for this is to lobby your distribution maker to make large
2425file interfaces available by default (as e.g. FreeBSD does) and not 2805file interfaces available by default (as e.g. FreeBSD does) and not
2426optional. Libev cannot simply switch on large file support because it has 2806optional. Libev cannot simply switch on large file support because it has
2617Apart from keeping your process non-blocking (which is a useful 2997Apart from keeping your process non-blocking (which is a useful
2618effect on its own sometimes), idle watchers are a good place to do 2998effect on its own sometimes), idle watchers are a good place to do
2619\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the 2999\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2620event loop has handled all outstanding events. 3000event loop has handled all outstanding events.
2621.PP 3001.PP
3002\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3003.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3004.PP
3005As long as there is at least one active idle watcher, libev will never
3006sleep unnecessarily. Or in other words, it will loop as fast as possible.
3007For this to work, the idle watcher doesn't need to be invoked at all \- the
3008lowest priority will do.
3009.PP
3010This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3011to do something on each event loop iteration \- for example to balance load
3012between different connections.
3013.PP
3014See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3015example.
3016.PP
2622\fIWatcher-Specific Functions and Data Members\fR 3017\fIWatcher-Specific Functions and Data Members\fR
2623.IX Subsection "Watcher-Specific Functions and Data Members" 3018.IX Subsection "Watcher-Specific Functions and Data Members"
2624.IP "ev_idle_init (ev_idle *, callback)" 4 3019.IP "ev_idle_init (ev_idle *, callback)" 4
2625.IX Item "ev_idle_init (ev_idle *, callback)" 3020.IX Item "ev_idle_init (ev_idle *, callback)"
2626Initialises and configures the idle watcher \- it has no parameters of any 3021Initialises and configures the idle watcher \- it has no parameters of any
2631.IX Subsection "Examples" 3026.IX Subsection "Examples"
2632.PP 3027.PP
2633Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 3028Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
2634callback, free it. Also, use no error checking, as usual. 3029callback, free it. Also, use no error checking, as usual.
2635.PP 3030.PP
2636.Vb 7 3031.Vb 5
2637\& static void 3032\& static void
2638\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3033\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2639\& { 3034\& {
3035\& // stop the watcher
3036\& ev_idle_stop (loop, w);
3037\&
3038\& // now we can free it
2640\& free (w); 3039\& free (w);
3040\&
2641\& // now do something you wanted to do when the program has 3041\& // now do something you wanted to do when the program has
2642\& // no longer anything immediate to do. 3042\& // no longer anything immediate to do.
2643\& } 3043\& }
2644\& 3044\&
2645\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3045\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2647\& ev_idle_start (loop, idle_watcher); 3047\& ev_idle_start (loop, idle_watcher);
2648.Ve 3048.Ve
2649.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" 3049.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
2650.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 3050.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
2651.IX Subsection "ev_prepare and ev_check - customise your event loop!" 3051.IX Subsection "ev_prepare and ev_check - customise your event loop!"
2652Prepare and check watchers are usually (but not always) used in pairs: 3052Prepare and check watchers are often (but not always) used in pairs:
2653prepare watchers get invoked before the process blocks and check watchers 3053prepare watchers get invoked before the process blocks and check watchers
2654afterwards. 3054afterwards.
2655.PP 3055.PP
2656You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter 3056You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the
2657the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 3057current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or
2658watchers. Other loops than the current one are fine, however. The 3058\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine,
2659rationale behind this is that you do not need to check for recursion in 3059however. The rationale behind this is that you do not need to check
2660those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 3060for recursion in those watchers, i.e. the sequence will always be
2661\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 3061\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each
2662called in pairs bracketing the blocking call. 3062kind they will always be called in pairs bracketing the blocking call.
2663.PP 3063.PP
2664Their main purpose is to integrate other event mechanisms into libev and 3064Their main purpose is to integrate other event mechanisms into libev and
2665their use is somewhat advanced. They could be used, for example, to track 3065their use is somewhat advanced. They could be used, for example, to track
2666variable changes, implement your own watchers, integrate net-snmp or a 3066variable changes, implement your own watchers, integrate net-snmp or a
2667coroutine library and lots more. They are also occasionally useful if 3067coroutine library and lots more. They are also occasionally useful if
2685with priority higher than or equal to the event loop and one coroutine 3085with priority higher than or equal to the event loop and one coroutine
2686of lower priority, but only once, using idle watchers to keep the event 3086of lower priority, but only once, using idle watchers to keep the event
2687loop from blocking if lower-priority coroutines are active, thus mapping 3087loop from blocking if lower-priority coroutines are active, thus mapping
2688low-priority coroutines to idle/background tasks). 3088low-priority coroutines to idle/background tasks).
2689.PP 3089.PP
2690It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 3090When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
2691priority, to ensure that they are being run before any other watchers 3091highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
2692after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers). 3092any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3093watchers).
2693.PP 3094.PP
2694Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not 3095Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
2695activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they 3096activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
2696might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As 3097might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
2697\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event 3098\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
2698loops those other event loops might be in an unusable state until their 3099loops those other event loops might be in an unusable state until their
2699\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with 3100\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
2700others). 3101others).
3102.PP
3103\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3104.IX Subsection "Abusing an ev_check watcher for its side-effect"
3105.PP
3106\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3107useful because they are called once per event loop iteration. For
3108example, if you want to handle a large number of connections fairly, you
3109normally only do a bit of work for each active connection, and if there
3110is more work to do, you wait for the next event loop iteration, so other
3111connections have a chance of making progress.
3112.PP
3113Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3114next event loop iteration. However, that isn't as soon as possible \-
3115without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3116.PP
3117This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3118single global idle watcher that is active as long as you have one active
3119\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3120will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3121invoked. Neither watcher alone can do that.
2701.PP 3122.PP
2702\fIWatcher-Specific Functions and Data Members\fR 3123\fIWatcher-Specific Functions and Data Members\fR
2703.IX Subsection "Watcher-Specific Functions and Data Members" 3124.IX Subsection "Watcher-Specific Functions and Data Members"
2704.IP "ev_prepare_init (ev_prepare *, callback)" 4 3125.IP "ev_prepare_init (ev_prepare *, callback)" 4
2705.IX Item "ev_prepare_init (ev_prepare *, callback)" 3126.IX Item "ev_prepare_init (ev_prepare *, callback)"
2816.Ve 3237.Ve
2817.PP 3238.PP
2818Method 4: Do not use a prepare or check watcher because the module you 3239Method 4: Do not use a prepare or check watcher because the module you
2819want to embed is not flexible enough to support it. Instead, you can 3240want to embed is not flexible enough to support it. Instead, you can
2820override their poll function. The drawback with this solution is that the 3241override their poll function. The drawback with this solution is that the
2821main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses 3242main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
2822this approach, effectively embedding \s-1EV\s0 as a client into the horrible 3243this approach, effectively embedding \s-1EV\s0 as a client into the horrible
2823libglib event loop. 3244libglib event loop.
2824.PP 3245.PP
2825.Vb 4 3246.Vb 4
2826\& static gint 3247\& static gint
2833\& 3254\&
2834\& if (timeout >= 0) 3255\& if (timeout >= 0)
2835\& // create/start timer 3256\& // create/start timer
2836\& 3257\&
2837\& // poll 3258\& // poll
2838\& ev_loop (EV_A_ 0); 3259\& ev_run (EV_A_ 0);
2839\& 3260\&
2840\& // stop timer again 3261\& // stop timer again
2841\& if (timeout >= 0) 3262\& if (timeout >= 0)
2842\& ev_timer_stop (EV_A_ &to); 3263\& ev_timer_stop (EV_A_ &to);
2843\& 3264\&
2910\fIWatcher-Specific Functions and Data Members\fR 3331\fIWatcher-Specific Functions and Data Members\fR
2911.IX Subsection "Watcher-Specific Functions and Data Members" 3332.IX Subsection "Watcher-Specific Functions and Data Members"
2912.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3333.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
2913.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3334.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
2914.PD 0 3335.PD 0
2915.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3336.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
2916.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3337.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
2917.PD 3338.PD
2918Configures the watcher to embed the given loop, which must be 3339Configures the watcher to embed the given loop, which must be
2919embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3340embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
2920invoked automatically, otherwise it is the responsibility of the callback 3341invoked automatically, otherwise it is the responsibility of the callback
2921to invoke it (it will continue to be called until the sweep has been done, 3342to invoke it (it will continue to be called until the sweep has been done,
2922if you do not want that, you need to temporarily stop the embed watcher). 3343if you do not want that, you need to temporarily stop the embed watcher).
2923.IP "ev_embed_sweep (loop, ev_embed *)" 4 3344.IP "ev_embed_sweep (loop, ev_embed *)" 4
2924.IX Item "ev_embed_sweep (loop, ev_embed *)" 3345.IX Item "ev_embed_sweep (loop, ev_embed *)"
2925Make a single, non-blocking sweep over the embedded loop. This works 3346Make a single, non-blocking sweep over the embedded loop. This works
2926similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 3347similarly to \f(CW\*(C`ev_run (embedded_loop, EVRUN_NOWAIT)\*(C'\fR, but in the most
2927appropriate way for embedded loops. 3348appropriate way for embedded loops.
2928.IP "struct ev_loop *other [read\-only]" 4 3349.IP "struct ev_loop *other [read\-only]" 4
2929.IX Item "struct ev_loop *other [read-only]" 3350.IX Item "struct ev_loop *other [read-only]"
2930The embedded event loop. 3351The embedded event loop.
2931.PP 3352.PP
2940.PP 3361.PP
2941.Vb 3 3362.Vb 3
2942\& struct ev_loop *loop_hi = ev_default_init (0); 3363\& struct ev_loop *loop_hi = ev_default_init (0);
2943\& struct ev_loop *loop_lo = 0; 3364\& struct ev_loop *loop_lo = 0;
2944\& ev_embed embed; 3365\& ev_embed embed;
2945\& 3366\&
2946\& // see if there is a chance of getting one that works 3367\& // see if there is a chance of getting one that works
2947\& // (remember that a flags value of 0 means autodetection) 3368\& // (remember that a flags value of 0 means autodetection)
2948\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3369\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2949\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3370\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2950\& : 0; 3371\& : 0;
2966.PP 3387.PP
2967.Vb 3 3388.Vb 3
2968\& struct ev_loop *loop = ev_default_init (0); 3389\& struct ev_loop *loop = ev_default_init (0);
2969\& struct ev_loop *loop_socket = 0; 3390\& struct ev_loop *loop_socket = 0;
2970\& ev_embed embed; 3391\& ev_embed embed;
2971\& 3392\&
2972\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3393\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2973\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3394\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2974\& { 3395\& {
2975\& ev_embed_init (&embed, 0, loop_socket); 3396\& ev_embed_init (&embed, 0, loop_socket);
2976\& ev_embed_start (loop, &embed); 3397\& ev_embed_start (loop, &embed);
2984.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3405.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
2985.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 3406.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2986.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 3407.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2987Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 3408Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2988whoever is a good citizen cared to tell libev about it by calling 3409whoever is a good citizen cared to tell libev about it by calling
2989\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 3410\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
2990event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 3411and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
2991and only in the child after the fork. If whoever good citizen calling 3412after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
2992\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 3413and calls it in the wrong process, the fork handlers will be invoked, too,
2993handlers will be invoked, too, of course. 3414of course.
2994.PP 3415.PP
2995\fIThe special problem of life after fork \- how is it possible?\fR 3416\fIThe special problem of life after fork \- how is it possible?\fR
2996.IX Subsection "The special problem of life after fork - how is it possible?" 3417.IX Subsection "The special problem of life after fork - how is it possible?"
2997.PP 3418.PP
2998Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to ste 3419Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set
2999up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This 3420up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3000sequence should be handled by libev without any problems. 3421sequence should be handled by libev without any problems.
3001.PP 3422.PP
3002This changes when the application actually wants to do event handling 3423This changes when the application actually wants to do event handling
3003in the child, or both parent in child, in effect \*(L"continuing\*(R" after the 3424in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3019disadvantage of having to use multiple event loops (which do not support 3440disadvantage of having to use multiple event loops (which do not support
3020signal watchers). 3441signal watchers).
3021.PP 3442.PP
3022When this is not possible, or you want to use the default loop for 3443When this is not possible, or you want to use the default loop for
3023other reasons, then in the process that wants to start \*(L"fresh\*(R", call 3444other reasons, then in the process that wants to start \*(L"fresh\*(R", call
3024\&\f(CW\*(C`ev_default_destroy ()\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR. Destroying 3445\&\f(CW\*(C`ev_loop_destroy (EV_DEFAULT)\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR.
3025the default loop will \*(L"orphan\*(R" (not stop) all registered watchers, so you 3446Destroying the default loop will \*(L"orphan\*(R" (not stop) all registered
3026have to be careful not to execute code that modifies those watchers. Note 3447watchers, so you have to be careful not to execute code that modifies
3027also that in that case, you have to re-register any signal watchers. 3448those watchers. Note also that in that case, you have to re-register any
3449signal watchers.
3028.PP 3450.PP
3029\fIWatcher-Specific Functions and Data Members\fR 3451\fIWatcher-Specific Functions and Data Members\fR
3030.IX Subsection "Watcher-Specific Functions and Data Members" 3452.IX Subsection "Watcher-Specific Functions and Data Members"
3031.IP "ev_fork_init (ev_signal *, callback)" 4 3453.IP "ev_fork_init (ev_fork *, callback)" 4
3032.IX Item "ev_fork_init (ev_signal *, callback)" 3454.IX Item "ev_fork_init (ev_fork *, callback)"
3033Initialises and configures the fork watcher \- it has no parameters of any 3455Initialises and configures the fork watcher \- it has no parameters of any
3034kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, 3456kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
3035believe me. 3457really.
3458.ie n .SS """ev_cleanup"" \- even the best things end"
3459.el .SS "\f(CWev_cleanup\fP \- even the best things end"
3460.IX Subsection "ev_cleanup - even the best things end"
3461Cleanup watchers are called just before the event loop is being destroyed
3462by a call to \f(CW\*(C`ev_loop_destroy\*(C'\fR.
3463.PP
3464While there is no guarantee that the event loop gets destroyed, cleanup
3465watchers provide a convenient method to install cleanup hooks for your
3466program, worker threads and so on \- you just to make sure to destroy the
3467loop when you want them to be invoked.
3468.PP
3469Cleanup watchers are invoked in the same way as any other watcher. Unlike
3470all other watchers, they do not keep a reference to the event loop (which
3471makes a lot of sense if you think about it). Like all other watchers, you
3472can call libev functions in the callback, except \f(CW\*(C`ev_cleanup_start\*(C'\fR.
3473.PP
3474\fIWatcher-Specific Functions and Data Members\fR
3475.IX Subsection "Watcher-Specific Functions and Data Members"
3476.IP "ev_cleanup_init (ev_cleanup *, callback)" 4
3477.IX Item "ev_cleanup_init (ev_cleanup *, callback)"
3478Initialises and configures the cleanup watcher \- it has no parameters of
3479any kind. There is a \f(CW\*(C`ev_cleanup_set\*(C'\fR macro, but using it is utterly
3480pointless, I assure you.
3481.PP
3482Example: Register an atexit handler to destroy the default loop, so any
3483cleanup functions are called.
3484.PP
3485.Vb 5
3486\& static void
3487\& program_exits (void)
3488\& {
3489\& ev_loop_destroy (EV_DEFAULT_UC);
3490\& }
3491\&
3492\& ...
3493\& atexit (program_exits);
3494.Ve
3036.ie n .SS """ev_async"" \- how to wake up another event loop" 3495.ie n .SS """ev_async"" \- how to wake up an event loop"
3037.el .SS "\f(CWev_async\fP \- how to wake up another event loop" 3496.el .SS "\f(CWev_async\fP \- how to wake up an event loop"
3038.IX Subsection "ev_async - how to wake up another event loop" 3497.IX Subsection "ev_async - how to wake up an event loop"
3039In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other 3498In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
3040asynchronous sources such as signal handlers (as opposed to multiple event 3499asynchronous sources such as signal handlers (as opposed to multiple event
3041loops \- those are of course safe to use in different threads). 3500loops \- those are of course safe to use in different threads).
3042.PP 3501.PP
3043Sometimes, however, you need to wake up another event loop you do not 3502Sometimes, however, you need to wake up an event loop you do not control,
3044control, for example because it belongs to another thread. This is what 3503for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR
3045\&\f(CW\*(C`ev_async\*(C'\fR watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you 3504watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you can signal
3046can signal it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal 3505it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3047safe.
3048.PP 3506.PP
3049This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3507This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
3050too, are asynchronous in nature, and signals, too, will be compressed 3508too, are asynchronous in nature, and signals, too, will be compressed
3051(i.e. the number of callback invocations may be less than the number of 3509(i.e. the number of callback invocations may be less than the number of
3052\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). 3510\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
3053.PP 3511of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3054Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not 3512signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3055just the default loop. 3513even without knowing which loop owns the signal.
3056.PP 3514.PP
3057\fIQueueing\fR 3515\fIQueueing\fR
3058.IX Subsection "Queueing" 3516.IX Subsection "Queueing"
3059.PP 3517.PP
3060\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason 3518\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
3061is that the author does not know of a simple (or any) algorithm for a 3519is that the author does not know of a simple (or any) algorithm for a
3062multiple-writer-single-reader queue that works in all cases and doesn't 3520multiple-writer-single-reader queue that works in all cases and doesn't
3063need elaborate support such as pthreads. 3521need elaborate support such as pthreads or unportable memory access
3522semantics.
3064.PP 3523.PP
3065That means that if you want to queue data, you have to provide your own 3524That means that if you want to queue data, you have to provide your own
3066queue. But at least I can tell you how to implement locking around your 3525queue. But at least I can tell you how to implement locking around your
3067queue: 3526queue:
3068.IP "queueing from a signal handler context" 4 3527.IP "queueing from a signal handler context" 4
3146kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless, 3605kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless,
3147trust me. 3606trust me.
3148.IP "ev_async_send (loop, ev_async *)" 4 3607.IP "ev_async_send (loop, ev_async *)" 4
3149.IX Item "ev_async_send (loop, ev_async *)" 3608.IX Item "ev_async_send (loop, ev_async *)"
3150Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds 3609Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
3151an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike 3610an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop, and instantly
3611returns.
3612.Sp
3152\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or 3613Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads,
3153similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding 3614signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the
3154section below on what exactly this means). 3615embedding section below on what exactly this means).
3155.Sp 3616.Sp
3156Note that, as with other watchers in libev, multiple events might get 3617Note that, as with other watchers in libev, multiple events might get
3157compressed into a single callback invocation (another way to look at this 3618compressed into a single callback invocation (another way to look at
3158is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered, set on \f(CW\*(C`ev_async_send\*(C'\fR, 3619this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on
3159reset when the event loop detects that). 3620\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that).
3160.Sp 3621.Sp
3161This call incurs the overhead of a system call only once per event loop 3622This call incurs the overhead of at most one extra system call per event
3162iteration, so while the overhead might be noticeable, it doesn't apply to 3623loop iteration, if the event loop is blocked, and no syscall at all if
3163repeated calls to \f(CW\*(C`ev_async_send\*(C'\fR for the same event loop. 3624the event loop (or your program) is processing events. That means that
3625repeated calls are basically free (there is no need to avoid calls for
3626performance reasons) and that the overhead becomes smaller (typically
3627zero) under load.
3164.IP "bool = ev_async_pending (ev_async *)" 4 3628.IP "bool = ev_async_pending (ev_async *)" 4
3165.IX Item "bool = ev_async_pending (ev_async *)" 3629.IX Item "bool = ev_async_pending (ev_async *)"
3166Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 3630Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
3167watcher but the event has not yet been processed (or even noted) by the 3631watcher but the event has not yet been processed (or even noted) by the
3168event loop. 3632event loop.
3193.Sp 3657.Sp
3194If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be 3658If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be
3195started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and 3659started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and
3196repeat = 0) will be started. \f(CW0\fR is a valid timeout. 3660repeat = 0) will be started. \f(CW0\fR is a valid timeout.
3197.Sp 3661.Sp
3198The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets 3662The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and is
3199passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of 3663passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of
3200\&\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 3664\&\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
3201value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR 3665value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3202a timeout and an io event at the same time \- you probably should give io 3666a timeout and an io event at the same time \- you probably should give io
3203events precedence. 3667events precedence.
3204.Sp 3668.Sp
3205Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3669Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3206.Sp 3670.Sp
3207.Vb 7 3671.Vb 7
3208\& static void stdin_ready (int revents, void *arg) 3672\& static void stdin_ready (int revents, void *arg)
3209\& { 3673\& {
3210\& if (revents & EV_READ) 3674\& if (revents & EV_READ)
3211\& /* stdin might have data for us, joy! */; 3675\& /* stdin might have data for us, joy! */;
3212\& else if (revents & EV_TIMEOUT) 3676\& else if (revents & EV_TIMER)
3213\& /* doh, nothing entered */; 3677\& /* doh, nothing entered */;
3214\& } 3678\& }
3215\& 3679\&
3216\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3680\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3217.Ve 3681.Ve
3218.IP "ev_feed_event (struct ev_loop *, watcher *, int revents)" 4
3219.IX Item "ev_feed_event (struct ev_loop *, watcher *, int revents)"
3220Feeds the given event set into the event loop, as if the specified event
3221had happened for the specified watcher (which must be a pointer to an
3222initialised but not necessarily started event watcher).
3223.IP "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" 4 3682.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
3224.IX Item "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" 3683.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
3225Feed an event on the given fd, as if a file descriptor backend detected 3684Feed an event on the given fd, as if a file descriptor backend detected
3226the given events it. 3685the given events.
3227.IP "ev_feed_signal_event (struct ev_loop *loop, int signum)" 4 3686.IP "ev_feed_signal_event (loop, int signum)" 4
3228.IX Item "ev_feed_signal_event (struct ev_loop *loop, int signum)" 3687.IX Item "ev_feed_signal_event (loop, int signum)"
3229Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default 3688Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR,
3230loop!). 3689which is async-safe.
3690.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3691.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3692This section explains some common idioms that are not immediately
3693obvious. Note that examples are sprinkled over the whole manual, and this
3694section only contains stuff that wouldn't fit anywhere else.
3695.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3696.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3697Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3698or modify at any time: libev will completely ignore it. This can be used
3699to associate arbitrary data with your watcher. If you need more data and
3700don't want to allocate memory separately and store a pointer to it in that
3701data member, you can also \*(L"subclass\*(R" the watcher type and provide your own
3702data:
3703.PP
3704.Vb 7
3705\& struct my_io
3706\& {
3707\& ev_io io;
3708\& int otherfd;
3709\& void *somedata;
3710\& struct whatever *mostinteresting;
3711\& };
3712\&
3713\& ...
3714\& struct my_io w;
3715\& ev_io_init (&w.io, my_cb, fd, EV_READ);
3716.Ve
3717.PP
3718And since your callback will be called with a pointer to the watcher, you
3719can cast it back to your own type:
3720.PP
3721.Vb 5
3722\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
3723\& {
3724\& struct my_io *w = (struct my_io *)w_;
3725\& ...
3726\& }
3727.Ve
3728.PP
3729More interesting and less C\-conformant ways of casting your callback
3730function type instead have been omitted.
3731.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3732.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3733Another common scenario is to use some data structure with multiple
3734embedded watchers, in effect creating your own watcher that combines
3735multiple libev event sources into one \*(L"super-watcher\*(R":
3736.PP
3737.Vb 6
3738\& struct my_biggy
3739\& {
3740\& int some_data;
3741\& ev_timer t1;
3742\& ev_timer t2;
3743\& }
3744.Ve
3745.PP
3746In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
3747complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct in
3748the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies or \*(C+ coders), or you need
3749to use some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for
3750real programmers):
3751.PP
3752.Vb 1
3753\& #include <stddef.h>
3754\&
3755\& static void
3756\& t1_cb (EV_P_ ev_timer *w, int revents)
3757\& {
3758\& struct my_biggy big = (struct my_biggy *)
3759\& (((char *)w) \- offsetof (struct my_biggy, t1));
3760\& }
3761\&
3762\& static void
3763\& t2_cb (EV_P_ ev_timer *w, int revents)
3764\& {
3765\& struct my_biggy big = (struct my_biggy *)
3766\& (((char *)w) \- offsetof (struct my_biggy, t2));
3767\& }
3768.Ve
3769.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3770.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3771Often you have structures like this in event-based programs:
3772.PP
3773.Vb 4
3774\& callback ()
3775\& {
3776\& free (request);
3777\& }
3778\&
3779\& request = start_new_request (..., callback);
3780.Ve
3781.PP
3782The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be
3783used to cancel the operation, or do other things with it.
3784.PP
3785It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that
3786immediately invoke the callback, for example, to report errors. Or you add
3787some caching layer that finds that it can skip the lengthy aspects of the
3788operation and simply invoke the callback with the result.
3789.PP
3790The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR
3791has returned, so \f(CW\*(C`request\*(C'\fR is not set.
3792.PP
3793Even if you pass the request by some safer means to the callback, you
3794might want to do something to the request after starting it, such as
3795canceling it, which probably isn't working so well when the callback has
3796already been invoked.
3797.PP
3798A common way around all these issues is to make sure that
3799\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3800\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3801delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3802example, or more sneakily, by reusing an existing (stopped) watcher and
3803pushing it into the pending queue:
3804.PP
3805.Vb 2
3806\& ev_set_cb (watcher, callback);
3807\& ev_feed_event (EV_A_ watcher, 0);
3808.Ve
3809.PP
3810This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3811invoked, while not delaying callback invocation too much.
3812.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3813.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3814Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3815\&\fImodal\fR interaction, which is most easily implemented by recursively
3816invoking \f(CW\*(C`ev_run\*(C'\fR.
3817.PP
3818This brings the problem of exiting \- a callback might want to finish the
3819main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
3820a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
3821and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3822other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3823.PP
3824The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3825invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3826triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3827.PP
3828.Vb 2
3829\& // main loop
3830\& int exit_main_loop = 0;
3831\&
3832\& while (!exit_main_loop)
3833\& ev_run (EV_DEFAULT_ EVRUN_ONCE);
3834\&
3835\& // in a modal watcher
3836\& int exit_nested_loop = 0;
3837\&
3838\& while (!exit_nested_loop)
3839\& ev_run (EV_A_ EVRUN_ONCE);
3840.Ve
3841.PP
3842To exit from any of these loops, just set the corresponding exit variable:
3843.PP
3844.Vb 2
3845\& // exit modal loop
3846\& exit_nested_loop = 1;
3847\&
3848\& // exit main program, after modal loop is finished
3849\& exit_main_loop = 1;
3850\&
3851\& // exit both
3852\& exit_main_loop = exit_nested_loop = 1;
3853.Ve
3854.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3855.IX Subsection "THREAD LOCKING EXAMPLE"
3856Here is a fictitious example of how to run an event loop in a different
3857thread from where callbacks are being invoked and watchers are
3858created/added/removed.
3859.PP
3860For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
3861which uses exactly this technique (which is suited for many high-level
3862languages).
3863.PP
3864The example uses a pthread mutex to protect the loop data, a condition
3865variable to wait for callback invocations, an async watcher to notify the
3866event loop thread and an unspecified mechanism to wake up the main thread.
3867.PP
3868First, you need to associate some data with the event loop:
3869.PP
3870.Vb 6
3871\& typedef struct {
3872\& mutex_t lock; /* global loop lock */
3873\& ev_async async_w;
3874\& thread_t tid;
3875\& cond_t invoke_cv;
3876\& } userdata;
3877\&
3878\& void prepare_loop (EV_P)
3879\& {
3880\& // for simplicity, we use a static userdata struct.
3881\& static userdata u;
3882\&
3883\& ev_async_init (&u\->async_w, async_cb);
3884\& ev_async_start (EV_A_ &u\->async_w);
3885\&
3886\& pthread_mutex_init (&u\->lock, 0);
3887\& pthread_cond_init (&u\->invoke_cv, 0);
3888\&
3889\& // now associate this with the loop
3890\& ev_set_userdata (EV_A_ u);
3891\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3892\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3893\&
3894\& // then create the thread running ev_run
3895\& pthread_create (&u\->tid, 0, l_run, EV_A);
3896\& }
3897.Ve
3898.PP
3899The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3900solely to wake up the event loop so it takes notice of any new watchers
3901that might have been added:
3902.PP
3903.Vb 5
3904\& static void
3905\& async_cb (EV_P_ ev_async *w, int revents)
3906\& {
3907\& // just used for the side effects
3908\& }
3909.Ve
3910.PP
3911The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
3912protecting the loop data, respectively.
3913.PP
3914.Vb 6
3915\& static void
3916\& l_release (EV_P)
3917\& {
3918\& userdata *u = ev_userdata (EV_A);
3919\& pthread_mutex_unlock (&u\->lock);
3920\& }
3921\&
3922\& static void
3923\& l_acquire (EV_P)
3924\& {
3925\& userdata *u = ev_userdata (EV_A);
3926\& pthread_mutex_lock (&u\->lock);
3927\& }
3928.Ve
3929.PP
3930The event loop thread first acquires the mutex, and then jumps straight
3931into \f(CW\*(C`ev_run\*(C'\fR:
3932.PP
3933.Vb 4
3934\& void *
3935\& l_run (void *thr_arg)
3936\& {
3937\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
3938\&
3939\& l_acquire (EV_A);
3940\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
3941\& ev_run (EV_A_ 0);
3942\& l_release (EV_A);
3943\&
3944\& return 0;
3945\& }
3946.Ve
3947.PP
3948Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
3949signal the main thread via some unspecified mechanism (signals? pipe
3950writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
3951have been called (in a while loop because a) spurious wakeups are possible
3952and b) skipping inter-thread-communication when there are no pending
3953watchers is very beneficial):
3954.PP
3955.Vb 4
3956\& static void
3957\& l_invoke (EV_P)
3958\& {
3959\& userdata *u = ev_userdata (EV_A);
3960\&
3961\& while (ev_pending_count (EV_A))
3962\& {
3963\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
3964\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
3965\& }
3966\& }
3967.Ve
3968.PP
3969Now, whenever the main thread gets told to invoke pending watchers, it
3970will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
3971thread to continue:
3972.PP
3973.Vb 4
3974\& static void
3975\& real_invoke_pending (EV_P)
3976\& {
3977\& userdata *u = ev_userdata (EV_A);
3978\&
3979\& pthread_mutex_lock (&u\->lock);
3980\& ev_invoke_pending (EV_A);
3981\& pthread_cond_signal (&u\->invoke_cv);
3982\& pthread_mutex_unlock (&u\->lock);
3983\& }
3984.Ve
3985.PP
3986Whenever you want to start/stop a watcher or do other modifications to an
3987event loop, you will now have to lock:
3988.PP
3989.Vb 2
3990\& ev_timer timeout_watcher;
3991\& userdata *u = ev_userdata (EV_A);
3992\&
3993\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
3994\&
3995\& pthread_mutex_lock (&u\->lock);
3996\& ev_timer_start (EV_A_ &timeout_watcher);
3997\& ev_async_send (EV_A_ &u\->async_w);
3998\& pthread_mutex_unlock (&u\->lock);
3999.Ve
4000.PP
4001Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
4002an event loop currently blocking in the kernel will have no knowledge
4003about the newly added timer. By waking up the loop it will pick up any new
4004watchers in the next event loop iteration.
4005.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
4006.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
4007While the overhead of a callback that e.g. schedules a thread is small, it
4008is still an overhead. If you embed libev, and your main usage is with some
4009kind of threads or coroutines, you might want to customise libev so that
4010doesn't need callbacks anymore.
4011.PP
4012Imagine you have coroutines that you can switch to using a function
4013\&\f(CW\*(C`switch_to (coro)\*(C'\fR, that libev runs in a coroutine called \f(CW\*(C`libev_coro\*(C'\fR
4014and that due to some magic, the currently active coroutine is stored in a
4015global called \f(CW\*(C`current_coro\*(C'\fR. Then you can build your own \*(L"wait for libev
4016event\*(R" primitive by changing \f(CW\*(C`EV_CB_DECLARE\*(C'\fR and \f(CW\*(C`EV_CB_INVOKE\*(C'\fR (note
4017the differing \f(CW\*(C`;\*(C'\fR conventions):
4018.PP
4019.Vb 2
4020\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4021\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
4022.Ve
4023.PP
4024That means instead of having a C callback function, you store the
4025coroutine to switch to in each watcher, and instead of having libev call
4026your callback, you instead have it switch to that coroutine.
4027.PP
4028A coroutine might now wait for an event with a function called
4029\&\f(CW\*(C`wait_for_event\*(C'\fR. (the watcher needs to be started, as always, but it doesn't
4030matter when, or whether the watcher is active or not when this function is
4031called):
4032.PP
4033.Vb 6
4034\& void
4035\& wait_for_event (ev_watcher *w)
4036\& {
4037\& ev_set_cb (w, current_coro);
4038\& switch_to (libev_coro);
4039\& }
4040.Ve
4041.PP
4042That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
4043continues the libev coroutine, which, when appropriate, switches back to
4044this or any other coroutine.
4045.PP
4046You can do similar tricks if you have, say, threads with an event queue \-
4047instead of storing a coroutine, you store the queue object and instead of
4048switching to a coroutine, you push the watcher onto the queue and notify
4049any waiters.
4050.PP
4051To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
4052files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
4053.PP
4054.Vb 4
4055\& // my_ev.h
4056\& #define EV_CB_DECLARE(type) struct my_coro *cb;
4057\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb);
4058\& #include "../libev/ev.h"
4059\&
4060\& // my_ev.c
4061\& #define EV_H "my_ev.h"
4062\& #include "../libev/ev.c"
4063.Ve
4064.PP
4065And then use \fImy_ev.h\fR when you would normally use \fIev.h\fR, and compile
4066\&\fImy_ev.c\fR into your project. When properly specifying include paths, you
4067can even use \fIev.h\fR as header file name directly.
3231.SH "LIBEVENT EMULATION" 4068.SH "LIBEVENT EMULATION"
3232.IX Header "LIBEVENT EMULATION" 4069.IX Header "LIBEVENT EMULATION"
3233Libev offers a compatibility emulation layer for libevent. It cannot 4070Libev offers a compatibility emulation layer for libevent. It cannot
3234emulate the internals of libevent, so here are some usage hints: 4071emulate the internals of libevent, so here are some usage hints:
4072.IP "\(bu" 4
4073Only the libevent\-1.4.1\-beta \s-1API\s0 is being emulated.
4074.Sp
4075This was the newest libevent version available when libev was implemented,
4076and is still mostly unchanged in 2010.
3235.IP "\(bu" 4 4077.IP "\(bu" 4
3236Use it by including <event.h>, as usual. 4078Use it by including <event.h>, as usual.
3237.IP "\(bu" 4 4079.IP "\(bu" 4
3238The following members are fully supported: ev_base, ev_callback, 4080The following members are fully supported: ev_base, ev_callback,
3239ev_arg, ev_fd, ev_res, ev_events. 4081ev_arg, ev_fd, ev_res, ev_events.
3245Priorities are not currently supported. Initialising priorities 4087Priorities are not currently supported. Initialising priorities
3246will fail and all watchers will have the same priority, even though there 4088will fail and all watchers will have the same priority, even though there
3247is an ev_pri field. 4089is an ev_pri field.
3248.IP "\(bu" 4 4090.IP "\(bu" 4
3249In libevent, the last base created gets the signals, in libev, the 4091In libevent, the last base created gets the signals, in libev, the
3250first base created (== the default loop) gets the signals. 4092base that registered the signal gets the signals.
3251.IP "\(bu" 4 4093.IP "\(bu" 4
3252Other members are not supported. 4094Other members are not supported.
3253.IP "\(bu" 4 4095.IP "\(bu" 4
3254The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 4096The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
3255to use the libev header file and library. 4097to use the libev header file and library.
3256.SH "\*(C+ SUPPORT" 4098.SH "\*(C+ SUPPORT"
3257.IX Header " SUPPORT" 4099.IX Header " SUPPORT"
4100.SS "C \s-1API\s0"
4101.IX Subsection "C API"
4102The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4103libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4104will work fine.
4105.PP
4106Proper exception specifications might have to be added to callbacks passed
4107to libev: exceptions may be thrown only from watcher callbacks, all
4108other callbacks (allocator, syserr, loop acquire/release and periodic
4109reschedule callbacks) must not throw exceptions, and might need a \f(CW\*(C`throw
4110()\*(C'\fR specification. If you have code that needs to be compiled as both C
4111and \*(C+ you can use the \f(CW\*(C`EV_THROW\*(C'\fR macro for this:
4112.PP
4113.Vb 6
4114\& static void
4115\& fatal_error (const char *msg) EV_THROW
4116\& {
4117\& perror (msg);
4118\& abort ();
4119\& }
4120\&
4121\& ...
4122\& ev_set_syserr_cb (fatal_error);
4123.Ve
4124.PP
4125The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4126\&\f(CW\*(C`ev_invoke\*(C'\fR, \f(CW\*(C`ev_invoke_pending\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR (the latter
4127because it runs cleanup watchers).
4128.PP
4129Throwing exceptions in watcher callbacks is only supported if libev itself
4130is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4131throwing exceptions through C libraries (most do).
4132.SS "\*(C+ \s-1API\s0"
4133.IX Subsection " API"
3258Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4134Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
3259you to use some convenience methods to start/stop watchers and also change 4135you to use some convenience methods to start/stop watchers and also change
3260the callback model to a model using method callbacks on objects. 4136the callback model to a model using method callbacks on objects.
3261.PP 4137.PP
3262To use it, 4138To use it,
3273Care has been taken to keep the overhead low. The only data member the \*(C+ 4149Care has been taken to keep the overhead low. The only data member the \*(C+
3274classes add (compared to plain C\-style watchers) is the event loop pointer 4150classes add (compared to plain C\-style watchers) is the event loop pointer
3275that the watcher is associated with (or no additional members at all if 4151that the watcher is associated with (or no additional members at all if
3276you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). 4152you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
3277.PP 4153.PP
3278Currently, functions, and static and non-static member functions can be 4154Currently, functions, static and non-static member functions and classes
3279used as callbacks. Other types should be easy to add as long as they only 4155with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
3280need one additional pointer for context. If you need support for other 4156to add as long as they only need one additional pointer for context. If
3281types of functors please contact the author (preferably after implementing 4157you need support for other types of functors please contact the author
3282it). 4158(preferably after implementing it).
4159.PP
4160For all this to work, your \*(C+ compiler either has to use the same calling
4161conventions as your C compiler (for static member functions), or you have
4162to embed libev and compile libev itself as \*(C+.
3283.PP 4163.PP
3284Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4164Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
3285.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4 4165.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
3286.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4166.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
3287.IX Item "ev::READ, ev::WRITE etc." 4167.IX Item "ev::READ, ev::WRITE etc."
3295.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 4175.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
3296.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 4176.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
3297For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 4177For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
3298the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 4178the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
3299which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 4179which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
3300defines by many implementations. 4180defined by many implementations.
3301.Sp 4181.Sp
3302All of those classes have these methods: 4182All of those classes have these methods:
3303.RS 4 4183.RS 4
3304.IP "ev::TYPE::TYPE ()" 4 4184.IP "ev::TYPE::TYPE ()" 4
3305.IX Item "ev::TYPE::TYPE ()" 4185.IX Item "ev::TYPE::TYPE ()"
3306.PD 0 4186.PD 0
3307.IP "ev::TYPE::TYPE (struct ev_loop *)" 4 4187.IP "ev::TYPE::TYPE (loop)" 4
3308.IX Item "ev::TYPE::TYPE (struct ev_loop *)" 4188.IX Item "ev::TYPE::TYPE (loop)"
3309.IP "ev::TYPE::~TYPE" 4 4189.IP "ev::TYPE::~TYPE" 4
3310.IX Item "ev::TYPE::~TYPE" 4190.IX Item "ev::TYPE::~TYPE"
3311.PD 4191.PD
3312The constructor (optionally) takes an event loop to associate the watcher 4192The constructor (optionally) takes an event loop to associate the watcher
3313with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. 4193with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
3347\& ev::io iow; 4227\& ev::io iow;
3348\& iow.set <myclass, &myclass::io_cb> (&obj); 4228\& iow.set <myclass, &myclass::io_cb> (&obj);
3349.Ve 4229.Ve
3350.IP "w\->set (object *)" 4 4230.IP "w\->set (object *)" 4
3351.IX Item "w->set (object *)" 4231.IX Item "w->set (object *)"
3352This is an \fBexperimental\fR feature that might go away in a future version.
3353.Sp
3354This is a variation of a method callback \- leaving out the method to call 4232This is a variation of a method callback \- leaving out the method to call
3355will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use 4233will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use
3356functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all 4234functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all
3357the time. Incidentally, you can then also leave out the template argument 4235the time. Incidentally, you can then also leave out the template argument
3358list. 4236list.
3370\& void operator() (ev::io &w, int revents) 4248\& void operator() (ev::io &w, int revents)
3371\& { 4249\& {
3372\& ... 4250\& ...
3373\& } 4251\& }
3374\& } 4252\& }
3375\& 4253\&
3376\& myfunctor f; 4254\& myfunctor f;
3377\& 4255\&
3378\& ev::io w; 4256\& ev::io w;
3379\& w.set (&f); 4257\& w.set (&f);
3380.Ve 4258.Ve
3392.Sp 4270.Sp
3393.Vb 2 4271.Vb 2
3394\& static void io_cb (ev::io &w, int revents) { } 4272\& static void io_cb (ev::io &w, int revents) { }
3395\& iow.set <io_cb> (); 4273\& iow.set <io_cb> ();
3396.Ve 4274.Ve
3397.IP "w\->set (struct ev_loop *)" 4 4275.IP "w\->set (loop)" 4
3398.IX Item "w->set (struct ev_loop *)" 4276.IX Item "w->set (loop)"
3399Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4277Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
3400do this when the watcher is inactive (and not pending either). 4278do this when the watcher is inactive (and not pending either).
3401.IP "w\->set ([arguments])" 4 4279.IP "w\->set ([arguments])" 4
3402.IX Item "w->set ([arguments])" 4280.IX Item "w->set ([arguments])"
3403Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Must be 4281Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4282with the same arguments. Either this method or a suitable start method
3404called at least once. Unlike the C counterpart, an active watcher gets 4283must be called at least once. Unlike the C counterpart, an active watcher
3405automatically stopped and restarted when reconfiguring it with this 4284gets automatically stopped and restarted when reconfiguring it with this
3406method. 4285method.
4286.Sp
4287For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4288clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
3407.IP "w\->start ()" 4 4289.IP "w\->start ()" 4
3408.IX Item "w->start ()" 4290.IX Item "w->start ()"
3409Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4291Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
3410constructor already stores the event loop. 4292constructor already stores the event loop.
4293.IP "w\->start ([arguments])" 4
4294.IX Item "w->start ([arguments])"
4295Instead of calling \f(CW\*(C`set\*(C'\fR and \f(CW\*(C`start\*(C'\fR methods separately, it is often
4296convenient to wrap them in one call. Uses the same type of arguments as
4297the configure \f(CW\*(C`set\*(C'\fR method of the watcher.
3411.IP "w\->stop ()" 4 4298.IP "w\->stop ()" 4
3412.IX Item "w->stop ()" 4299.IX Item "w->stop ()"
3413Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 4300Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
3414.ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4 4301.ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4
3415.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 4302.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4
3426Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. 4313Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
3427.RE 4314.RE
3428.RS 4 4315.RS 4
3429.RE 4316.RE
3430.PP 4317.PP
3431Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 4318Example: Define a class with two I/O and idle watchers, start the I/O
3432the constructor. 4319watchers in the constructor.
3433.PP 4320.PP
3434.Vb 4 4321.Vb 5
3435\& class myclass 4322\& class myclass
3436\& { 4323\& {
3437\& ev::io io ; void io_cb (ev::io &w, int revents); 4324\& ev::io io ; void io_cb (ev::io &w, int revents);
4325\& ev::io io2 ; void io2_cb (ev::io &w, int revents);
3438\& ev::idle idle; void idle_cb (ev::idle &w, int revents); 4326\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
3439\& 4327\&
3440\& myclass (int fd) 4328\& myclass (int fd)
3441\& { 4329\& {
3442\& io .set <myclass, &myclass::io_cb > (this); 4330\& io .set <myclass, &myclass::io_cb > (this);
4331\& io2 .set <myclass, &myclass::io2_cb > (this);
3443\& idle.set <myclass, &myclass::idle_cb> (this); 4332\& idle.set <myclass, &myclass::idle_cb> (this);
3444\& 4333\&
3445\& io.start (fd, ev::READ); 4334\& io.set (fd, ev::WRITE); // configure the watcher
4335\& io.start (); // start it whenever convenient
4336\&
4337\& io2.start (fd, ev::READ); // set + start in one call
3446\& } 4338\& }
3447\& }; 4339\& };
3448.Ve 4340.Ve
3449.SH "OTHER LANGUAGE BINDINGS" 4341.SH "OTHER LANGUAGE BINDINGS"
3450.IX Header "OTHER LANGUAGE BINDINGS" 4342.IX Header "OTHER LANGUAGE BINDINGS"
3459there are additional modules that implement libev-compatible interfaces 4351there are additional modules that implement libev-compatible interfaces
3460to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), 4352to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
3461\&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR 4353\&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR
3462and \f(CW\*(C`EV::Glib\*(C'\fR). 4354and \f(CW\*(C`EV::Glib\*(C'\fR).
3463.Sp 4355.Sp
3464It can be found and installed via \s-1CPAN\s0, its homepage is at 4356It can be found and installed via \s-1CPAN,\s0 its homepage is at
3465<http://software.schmorp.de/pkg/EV>. 4357<http://software.schmorp.de/pkg/EV>.
3466.IP "Python" 4 4358.IP "Python" 4
3467.IX Item "Python" 4359.IX Item "Python"
3468Python bindings can be found at <http://code.google.com/p/pyev/>. It 4360Python bindings can be found at <http://code.google.com/p/pyev/>. It
3469seems to be quite complete and well-documented. 4361seems to be quite complete and well-documented.
3481A haskell binding to libev is available at 4373A haskell binding to libev is available at
3482<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>. 4374<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
3483.IP "D" 4 4375.IP "D" 4
3484.IX Item "D" 4376.IX Item "D"
3485Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4377Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
3486be found at <http://proj.llucax.com.ar/wiki/evd>. 4378be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
3487.IP "Ocaml" 4 4379.IP "Ocaml" 4
3488.IX Item "Ocaml" 4380.IX Item "Ocaml"
3489Erkki Seppala has written Ocaml bindings for libev, to be found at 4381Erkki Seppala has written Ocaml bindings for libev, to be found at
3490<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. 4382<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4383.IP "Lua" 4
4384.IX Item "Lua"
4385Brian Maher has written a partial interface to libev for lua (at the
4386time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4387<http://github.com/brimworks/lua\-ev>.
4388.IP "Javascript" 4
4389.IX Item "Javascript"
4390Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4391.IP "Others" 4
4392.IX Item "Others"
4393There are others, and I stopped counting.
3491.SH "MACRO MAGIC" 4394.SH "MACRO MAGIC"
3492.IX Header "MACRO MAGIC" 4395.IX Header "MACRO MAGIC"
3493Libev can be compiled with a variety of options, the most fundamental 4396Libev can be compiled with a variety of options, the most fundamental
3494of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 4397of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
3495functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 4398functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
3504\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: 4407\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
3505.Sp 4408.Sp
3506.Vb 3 4409.Vb 3
3507\& ev_unref (EV_A); 4410\& ev_unref (EV_A);
3508\& ev_timer_add (EV_A_ watcher); 4411\& ev_timer_add (EV_A_ watcher);
3509\& ev_loop (EV_A_ 0); 4412\& ev_run (EV_A_ 0);
3510.Ve 4413.Ve
3511.Sp 4414.Sp
3512It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, 4415It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
3513which is often provided by the following macro. 4416which is often provided by the following macro.
3514.ie n .IP """EV_P"", ""EV_P_""" 4 4417.ie n .IP """EV_P"", ""EV_P_""" 4
3530suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 4433suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
3531.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4 4434.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
3532.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 4435.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
3533.IX Item "EV_DEFAULT, EV_DEFAULT_" 4436.IX Item "EV_DEFAULT, EV_DEFAULT_"
3534Similar to the other two macros, this gives you the value of the default 4437Similar to the other two macros, this gives you the value of the default
3535loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 4438loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop
4439will be initialised if it isn't already initialised.
4440.Sp
4441For non-multiplicity builds, these macros do nothing, so you always have
4442to initialise the loop somewhere.
3536.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4 4443.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
3537.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 4444.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
3538.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" 4445.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
3539Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the 4446Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
3540default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour 4447default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
3556\& } 4463\& }
3557\& 4464\&
3558\& ev_check check; 4465\& ev_check check;
3559\& ev_check_init (&check, check_cb); 4466\& ev_check_init (&check, check_cb);
3560\& ev_check_start (EV_DEFAULT_ &check); 4467\& ev_check_start (EV_DEFAULT_ &check);
3561\& ev_loop (EV_DEFAULT_ 0); 4468\& ev_run (EV_DEFAULT_ 0);
3562.Ve 4469.Ve
3563.SH "EMBEDDING" 4470.SH "EMBEDDING"
3564.IX Header "EMBEDDING" 4471.IX Header "EMBEDDING"
3565Libev can (and often is) directly embedded into host 4472Libev can (and often is) directly embedded into host
3566applications. Examples of applications that embed it include the Deliantra 4473applications. Examples of applications that embed it include the Deliantra
3574.SS "\s-1FILESETS\s0" 4481.SS "\s-1FILESETS\s0"
3575.IX Subsection "FILESETS" 4482.IX Subsection "FILESETS"
3576Depending on what features you need you need to include one or more sets of files 4483Depending on what features you need you need to include one or more sets of files
3577in your application. 4484in your application.
3578.PP 4485.PP
3579\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4486\fI\s-1CORE EVENT LOOP\s0\fR
3580.IX Subsection "CORE EVENT LOOP" 4487.IX Subsection "CORE EVENT LOOP"
3581.PP 4488.PP
3582To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4489To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
3583configuration (no autoconf): 4490configuration (no autoconf):
3584.PP 4491.PP
3587\& #include "ev.c" 4494\& #include "ev.c"
3588.Ve 4495.Ve
3589.PP 4496.PP
3590This will automatically include \fIev.h\fR, too, and should be done in a 4497This will automatically include \fIev.h\fR, too, and should be done in a
3591single C source file only to provide the function implementations. To use 4498single C source file only to provide the function implementations. To use
3592it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best 4499it, do the same for \fIev.h\fR in all files wishing to use this \s-1API \s0(best
3593done by writing a wrapper around \fIev.h\fR that you can include instead and 4500done by writing a wrapper around \fIev.h\fR that you can include instead and
3594where you can put other configuration options): 4501where you can put other configuration options):
3595.PP 4502.PP
3596.Vb 2 4503.Vb 2
3597\& #define EV_STANDALONE 1 4504\& #define EV_STANDALONE 1
3621.Ve 4528.Ve
3622.PP 4529.PP
3623\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4530\&\fIev.c\fR includes the backend files directly when enabled, so you only need
3624to compile this single file. 4531to compile this single file.
3625.PP 4532.PP
3626\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4533\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
3627.IX Subsection "LIBEVENT COMPATIBILITY API" 4534.IX Subsection "LIBEVENT COMPATIBILITY API"
3628.PP 4535.PP
3629To include the libevent compatibility \s-1API\s0, also include: 4536To include the libevent compatibility \s-1API,\s0 also include:
3630.PP 4537.PP
3631.Vb 1 4538.Vb 1
3632\& #include "event.c" 4539\& #include "event.c"
3633.Ve 4540.Ve
3634.PP 4541.PP
3636.PP 4543.PP
3637.Vb 1 4544.Vb 1
3638\& #include "event.h" 4545\& #include "event.h"
3639.Ve 4546.Ve
3640.PP 4547.PP
3641in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4548in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
3642.PP 4549.PP
3643You need the following additional files for this: 4550You need the following additional files for this:
3644.PP 4551.PP
3645.Vb 2 4552.Vb 2
3646\& event.h 4553\& event.h
3647\& event.c 4554\& event.c
3648.Ve 4555.Ve
3649.PP 4556.PP
3650\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4557\fI\s-1AUTOCONF SUPPORT\s0\fR
3651.IX Subsection "AUTOCONF SUPPORT" 4558.IX Subsection "AUTOCONF SUPPORT"
3652.PP 4559.PP
3653Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4560Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
3654whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4561whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
3655\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4562\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
3658For this of course you need the m4 file: 4565For this of course you need the m4 file:
3659.PP 4566.PP
3660.Vb 1 4567.Vb 1
3661\& libev.m4 4568\& libev.m4
3662.Ve 4569.Ve
3663.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4570.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
3664.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4571.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
3665Libev can be configured via a variety of preprocessor symbols you have to 4572Libev can be configured via a variety of preprocessor symbols you have to
3666define before including any of its files. The default in the absence of 4573define before including (or compiling) any of its files. The default in
3667autoconf is documented for every option. 4574the absence of autoconf is documented for every option.
4575.PP
4576Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4577values when compiling libev vs. including \fIev.h\fR, so it is permissible
4578to redefine them before including \fIev.h\fR without breaking compatibility
4579to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4580users of libev and the libev code itself must be compiled with compatible
4581settings.
4582.IP "\s-1EV_COMPAT3 \s0(h)" 4
4583.IX Item "EV_COMPAT3 (h)"
4584Backwards compatibility is a major concern for libev. This is why this
4585release of libev comes with wrappers for the functions and symbols that
4586have been renamed between libev version 3 and 4.
4587.Sp
4588You can disable these wrappers (to test compatibility with future
4589versions) by defining \f(CW\*(C`EV_COMPAT3\*(C'\fR to \f(CW0\fR when compiling your
4590sources. This has the additional advantage that you can drop the \f(CW\*(C`struct\*(C'\fR
4591from \f(CW\*(C`struct ev_loop\*(C'\fR declarations, as libev will provide an \f(CW\*(C`ev_loop\*(C'\fR
4592typedef in that case.
4593.Sp
4594In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR,
4595and in some even more future version the compatibility code will be
4596removed completely.
3668.IP "\s-1EV_STANDALONE\s0" 4 4597.IP "\s-1EV_STANDALONE \s0(h)" 4
3669.IX Item "EV_STANDALONE" 4598.IX Item "EV_STANDALONE (h)"
3670Must always be \f(CW1\fR if you do not use autoconf configuration, which 4599Must always be \f(CW1\fR if you do not use autoconf configuration, which
3671keeps libev from including \fIconfig.h\fR, and it also defines dummy 4600keeps libev from including \fIconfig.h\fR, and it also defines dummy
3672implementations for some libevent functions (such as logging, which is not 4601implementations for some libevent functions (such as logging, which is not
3673supported). It will also not define any of the structs usually found in 4602supported). It will also not define any of the structs usually found in
3674\&\fIevent.h\fR that are not directly supported by the libev core alone. 4603\&\fIevent.h\fR that are not directly supported by the libev core alone.
3675.Sp 4604.Sp
3676In stanbdalone mode, libev will still try to automatically deduce the 4605In standalone mode, libev will still try to automatically deduce the
3677configuration, but has to be more conservative. 4606configuration, but has to be more conservative.
4607.IP "\s-1EV_USE_FLOOR\s0" 4
4608.IX Item "EV_USE_FLOOR"
4609If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its
4610periodic reschedule calculations, otherwise libev will fall back on a
4611portable (slower) implementation. If you enable this, you usually have to
4612link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR
4613function is not available will fail, so the safe default is to not enable
4614this.
3678.IP "\s-1EV_USE_MONOTONIC\s0" 4 4615.IP "\s-1EV_USE_MONOTONIC\s0" 4
3679.IX Item "EV_USE_MONOTONIC" 4616.IX Item "EV_USE_MONOTONIC"
3680If defined to be \f(CW1\fR, libev will try to detect the availability of the 4617If defined to be \f(CW1\fR, libev will try to detect the availability of the
3681monotonic clock option at both compile time and runtime. Otherwise no 4618monotonic clock option at both compile time and runtime. Otherwise no
3682use of the monotonic clock option will be attempted. If you enable this, 4619use of the monotonic clock option will be attempted. If you enable this,
3737wants osf handles on win32 (this is the case when the select to 4674wants osf handles on win32 (this is the case when the select to
3738be used is the winsock select). This means that it will call 4675be used is the winsock select). This means that it will call
3739\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, 4676\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
3740it is assumed that all these functions actually work on fds, even 4677it is assumed that all these functions actually work on fds, even
3741on win32. Should not be defined on non\-win32 platforms. 4678on win32. Should not be defined on non\-win32 platforms.
3742.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0" 4 4679.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0(fd)" 4
3743.IX Item "EV_FD_TO_WIN32_HANDLE" 4680.IX Item "EV_FD_TO_WIN32_HANDLE(fd)"
3744If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map 4681If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map
3745file descriptors to socket handles. When not defining this symbol (the 4682file descriptors to socket handles. When not defining this symbol (the
3746default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually 4683default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually
3747correct. In some cases, programs use their own file descriptor management, 4684correct. In some cases, programs use their own file descriptor management,
3748in which case they can provide this function to map fds to socket handles. 4685in which case they can provide this function to map fds to socket handles.
4686.IP "\s-1EV_WIN32_HANDLE_TO_FD\s0(handle)" 4
4687.IX Item "EV_WIN32_HANDLE_TO_FD(handle)"
4688If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR then libev maps handles to file descriptors
4689using the standard \f(CW\*(C`_open_osfhandle\*(C'\fR function. For programs implementing
4690their own fd to handle mapping, overwriting this function makes it easier
4691to do so. This can be done by defining this macro to an appropriate value.
4692.IP "\s-1EV_WIN32_CLOSE_FD\s0(fd)" 4
4693.IX Item "EV_WIN32_CLOSE_FD(fd)"
4694If programs implement their own fd to handle mapping on win32, then this
4695macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4696file descriptors again. Note that the replacement function has to close
4697the underlying \s-1OS\s0 handle.
4698.IP "\s-1EV_USE_WSASOCKET\s0" 4
4699.IX Item "EV_USE_WSASOCKET"
4700If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4701communication socket, which works better in some environments. Otherwise,
4702the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4703environments.
3749.IP "\s-1EV_USE_POLL\s0" 4 4704.IP "\s-1EV_USE_POLL\s0" 4
3750.IX Item "EV_USE_POLL" 4705.IX Item "EV_USE_POLL"
3751If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4706If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
3752backend. Otherwise it will be enabled on non\-win32 platforms. It 4707backend. Otherwise it will be enabled on non\-win32 platforms. It
3753takes precedence over select. 4708takes precedence over select.
3782.IX Item "EV_USE_INOTIFY" 4737.IX Item "EV_USE_INOTIFY"
3783If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 4738If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
3784interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 4739interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
3785be detected at runtime. If undefined, it will be enabled if the headers 4740be detected at runtime. If undefined, it will be enabled if the headers
3786indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4741indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4742.IP "\s-1EV_NO_SMP\s0" 4
4743.IX Item "EV_NO_SMP"
4744If defined to be \f(CW1\fR, libev will assume that memory is always coherent
4745between threads, that is, threads can be used, but threads never run on
4746different cpus (or different cpu cores). This reduces dependencies
4747and makes libev faster.
4748.IP "\s-1EV_NO_THREADS\s0" 4
4749.IX Item "EV_NO_THREADS"
4750If defined to be \f(CW1\fR, libev will assume that it will never be called from
4751different threads (that includes signal handlers), which is a stronger
4752assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4753libev faster.
3787.IP "\s-1EV_ATOMIC_T\s0" 4 4754.IP "\s-1EV_ATOMIC_T\s0" 4
3788.IX Item "EV_ATOMIC_T" 4755.IX Item "EV_ATOMIC_T"
3789Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4756Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
3790access is atomic with respect to other threads or signal contexts. No such 4757access is atomic with respect to other threads or signal contexts. No
3791type is easily found in the C language, so you can provide your own type 4758such type is easily found in the C language, so you can provide your own
3792that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" 4759type that you know is safe for your purposes. It is used both for signal
3793as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. 4760handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4761watchers.
3794.Sp 4762.Sp
3795In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4763In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
3796(from \fIsignal.h\fR), which is usually good enough on most platforms. 4764(from \fIsignal.h\fR), which is usually good enough on most platforms.
3797.IP "\s-1EV_H\s0" 4 4765.IP "\s-1EV_H \s0(h)" 4
3798.IX Item "EV_H" 4766.IX Item "EV_H (h)"
3799The name of the \fIev.h\fR header file used to include it. The default if 4767The name of the \fIev.h\fR header file used to include it. The default if
3800undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 4768undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
3801used to virtually rename the \fIev.h\fR header file in case of conflicts. 4769used to virtually rename the \fIev.h\fR header file in case of conflicts.
3802.IP "\s-1EV_CONFIG_H\s0" 4 4770.IP "\s-1EV_CONFIG_H \s0(h)" 4
3803.IX Item "EV_CONFIG_H" 4771.IX Item "EV_CONFIG_H (h)"
3804If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 4772If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
3805\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 4773\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
3806\&\f(CW\*(C`EV_H\*(C'\fR, above. 4774\&\f(CW\*(C`EV_H\*(C'\fR, above.
3807.IP "\s-1EV_EVENT_H\s0" 4 4775.IP "\s-1EV_EVENT_H \s0(h)" 4
3808.IX Item "EV_EVENT_H" 4776.IX Item "EV_EVENT_H (h)"
3809Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 4777Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
3810of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR. 4778of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
3811.IP "\s-1EV_PROTOTYPES\s0" 4 4779.IP "\s-1EV_PROTOTYPES \s0(h)" 4
3812.IX Item "EV_PROTOTYPES" 4780.IX Item "EV_PROTOTYPES (h)"
3813If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 4781If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
3814prototypes, but still define all the structs and other symbols. This is 4782prototypes, but still define all the structs and other symbols. This is
3815occasionally useful if you want to provide your own wrapper functions 4783occasionally useful if you want to provide your own wrapper functions
3816around libev functions. 4784around libev functions.
3817.IP "\s-1EV_MULTIPLICITY\s0" 4 4785.IP "\s-1EV_MULTIPLICITY\s0" 4
3819If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 4787If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
3820will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 4788will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
3821additional independent event loops. Otherwise there will be no support 4789additional independent event loops. Otherwise there will be no support
3822for multiple event loops and there is no first event loop pointer 4790for multiple event loops and there is no first event loop pointer
3823argument. Instead, all functions act on the single default loop. 4791argument. Instead, all functions act on the single default loop.
4792.Sp
4793Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a
4794default loop when multiplicity is switched off \- you always have to
4795initialise the loop manually in this case.
3824.IP "\s-1EV_MINPRI\s0" 4 4796.IP "\s-1EV_MINPRI\s0" 4
3825.IX Item "EV_MINPRI" 4797.IX Item "EV_MINPRI"
3826.PD 0 4798.PD 0
3827.IP "\s-1EV_MAXPRI\s0" 4 4799.IP "\s-1EV_MAXPRI\s0" 4
3828.IX Item "EV_MAXPRI" 4800.IX Item "EV_MAXPRI"
3836all the priorities, so having many of them (hundreds) uses a lot of space 4808all the priorities, so having many of them (hundreds) uses a lot of space
3837and time, so using the defaults of five priorities (\-2 .. +2) is usually 4809and time, so using the defaults of five priorities (\-2 .. +2) is usually
3838fine. 4810fine.
3839.Sp 4811.Sp
3840If your embedding application does not need any priorities, defining these 4812If your embedding application does not need any priorities, defining these
3841both to \f(CW0\fR will save some memory and \s-1CPU\s0. 4813both to \f(CW0\fR will save some memory and \s-1CPU.\s0
3842.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 4814.IP "\s-1EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE.\s0" 4
3843.IX Item "EV_PERIODIC_ENABLE" 4815.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."
3844If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 4816If undefined or defined to be \f(CW1\fR (and the platform supports it), then
3845defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 4817the respective watcher type is supported. If defined to be \f(CW0\fR, then it
3846code. 4818is not. Disabling watcher types mainly saves code size.
3847.IP "\s-1EV_IDLE_ENABLE\s0" 4
3848.IX Item "EV_IDLE_ENABLE"
3849If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If
3850defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
3851code.
3852.IP "\s-1EV_EMBED_ENABLE\s0" 4
3853.IX Item "EV_EMBED_ENABLE"
3854If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
3855defined to be \f(CW0\fR, then they are not. Embed watchers rely on most other
3856watcher types, which therefore must not be disabled.
3857.IP "\s-1EV_STAT_ENABLE\s0" 4 4819.IP "\s-1EV_FEATURES\s0" 4
3858.IX Item "EV_STAT_ENABLE" 4820.IX Item "EV_FEATURES"
3859If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
3860defined to be \f(CW0\fR, then they are not.
3861.IP "\s-1EV_FORK_ENABLE\s0" 4
3862.IX Item "EV_FORK_ENABLE"
3863If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
3864defined to be \f(CW0\fR, then they are not.
3865.IP "\s-1EV_ASYNC_ENABLE\s0" 4
3866.IX Item "EV_ASYNC_ENABLE"
3867If undefined or defined to be \f(CW1\fR, then async watchers are supported. If
3868defined to be \f(CW0\fR, then they are not.
3869.IP "\s-1EV_MINIMAL\s0" 4
3870.IX Item "EV_MINIMAL"
3871If you need to shave off some kilobytes of code at the expense of some 4821If you need to shave off some kilobytes of code at the expense of some
3872speed (but with the full \s-1API\s0), define this symbol to \f(CW1\fR. Currently this 4822speed (but with the full \s-1API\s0), you can define this symbol to request
3873is used to override some inlining decisions, saves roughly 30% code size 4823certain subsets of functionality. The default is to enable all features
3874on amd64. It also selects a much smaller 2\-heap for timer management over 4824that can be enabled on the platform.
3875the default 4\-heap.
3876.Sp 4825.Sp
3877You can save even more by disabling watcher types you do not need 4826A typical way to use this symbol is to define it to \f(CW0\fR (or to a bitset
3878and setting \f(CW\*(C`EV_MAXPRI\*(C'\fR == \f(CW\*(C`EV_MINPRI\*(C'\fR. Also, disabling \f(CW\*(C`assert\*(C'\fR 4827with some broad features you want) and then selectively re-enable
3879(\f(CW\*(C`\-DNDEBUG\*(C'\fR) will usually reduce code size a lot. 4828additional parts you want, for example if you want everything minimal,
4829but multiple event loop support, async and child watchers and the poll
4830backend, use this:
3880.Sp 4831.Sp
3881Defining \f(CW\*(C`EV_MINIMAL\*(C'\fR to \f(CW2\fR will additionally reduce the core \s-1API\s0 to 4832.Vb 5
3882provide a bare-bones event library. See \f(CW\*(C`ev.h\*(C'\fR for details on what parts 4833\& #define EV_FEATURES 0
3883of the \s-1API\s0 are still available, and do not complain if this subset changes 4834\& #define EV_MULTIPLICITY 1
3884over time. 4835\& #define EV_USE_POLL 1
4836\& #define EV_CHILD_ENABLE 1
4837\& #define EV_ASYNC_ENABLE 1
4838.Ve
4839.Sp
4840The actual value is a bitset, it can be a combination of the following
4841values (by default, all of these are enabled):
4842.RS 4
4843.ie n .IP "1 \- faster/larger code" 4
4844.el .IP "\f(CW1\fR \- faster/larger code" 4
4845.IX Item "1 - faster/larger code"
4846Use larger code to speed up some operations.
4847.Sp
4848Currently this is used to override some inlining decisions (enlarging the
4849code size by roughly 30% on amd64).
4850.Sp
4851When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4852gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4853assertions.
4854.Sp
4855The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4856(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4857.ie n .IP "2 \- faster/larger data structures" 4
4858.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4859.IX Item "2 - faster/larger data structures"
4860Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4861hash table sizes and so on. This will usually further increase code size
4862and can additionally have an effect on the size of data structures at
4863runtime.
4864.Sp
4865The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4866(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4867.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4868.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4869.IX Item "4 - full API configuration"
4870This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4871enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4872.ie n .IP "8 \- full \s-1API\s0" 4
4873.el .IP "\f(CW8\fR \- full \s-1API\s0" 4
4874.IX Item "8 - full API"
4875This enables a lot of the \*(L"lesser used\*(R" \s-1API\s0 functions. See \f(CW\*(C`ev.h\*(C'\fR for
4876details on which parts of the \s-1API\s0 are still available without this
4877feature, and do not complain if this subset changes over time.
4878.ie n .IP "16 \- enable all optional watcher types" 4
4879.el .IP "\f(CW16\fR \- enable all optional watcher types" 4
4880.IX Item "16 - enable all optional watcher types"
4881Enables all optional watcher types. If you want to selectively enable
4882only some watcher types other than I/O and timers (e.g. prepare,
4883embed, async, child...) you can enable them manually by defining
4884\&\f(CW\*(C`EV_watchertype_ENABLE\*(C'\fR to \f(CW1\fR instead.
4885.ie n .IP "32 \- enable all backends" 4
4886.el .IP "\f(CW32\fR \- enable all backends" 4
4887.IX Item "32 - enable all backends"
4888This enables all backends \- without this feature, you need to enable at
4889least one backend manually (\f(CW\*(C`EV_USE_SELECT\*(C'\fR is a good choice).
4890.ie n .IP "64 \- enable OS-specific ""helper"" APIs" 4
4891.el .IP "\f(CW64\fR \- enable OS-specific ``helper'' APIs" 4
4892.IX Item "64 - enable OS-specific helper APIs"
4893Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
4894default.
4895.RE
4896.RS 4
4897.Sp
4898Compiling with \f(CW\*(C`gcc \-Os \-DEV_STANDALONE \-DEV_USE_EPOLL=1 \-DEV_FEATURES=0\*(C'\fR
4899reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
4900code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
4901watchers, timers and monotonic clock support.
4902.Sp
4903With an intelligent-enough linker (gcc+binutils are intelligent enough
4904when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by
4905your program might be left out as well \- a binary starting a timer and an
4906I/O watcher then might come out at only 5Kb.
4907.RE
4908.IP "\s-1EV_API_STATIC\s0" 4
4909.IX Item "EV_API_STATIC"
4910If this symbol is defined (by default it is not), then all identifiers
4911will have static linkage. This means that libev will not export any
4912identifiers, and you cannot link against libev anymore. This can be useful
4913when you embed libev, only want to use libev functions in a single file,
4914and do not want its identifiers to be visible.
4915.Sp
4916To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that
4917wants to use libev.
4918.Sp
4919This option only works when libev is compiled with a C compiler, as \*(C+
4920doesn't support the required declaration syntax.
4921.IP "\s-1EV_AVOID_STDIO\s0" 4
4922.IX Item "EV_AVOID_STDIO"
4923If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio
4924functions (printf, scanf, perror etc.). This will increase the code size
4925somewhat, but if your program doesn't otherwise depend on stdio and your
4926libc allows it, this avoids linking in the stdio library which is quite
4927big.
4928.Sp
4929Note that error messages might become less precise when this option is
4930enabled.
4931.IP "\s-1EV_NSIG\s0" 4
4932.IX Item "EV_NSIG"
4933The highest supported signal number, +1 (or, the number of
4934signals): Normally, libev tries to deduce the maximum number of signals
4935automatically, but sometimes this fails, in which case it can be
4936specified. Also, using a lower number than detected (\f(CW32\fR should be
4937good for about any system in existence) can save some memory, as libev
4938statically allocates some 12\-24 bytes per signal number.
3885.IP "\s-1EV_PID_HASHSIZE\s0" 4 4939.IP "\s-1EV_PID_HASHSIZE\s0" 4
3886.IX Item "EV_PID_HASHSIZE" 4940.IX Item "EV_PID_HASHSIZE"
3887\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 4941\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
3888pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 4942pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR disabled),
3889than enough. If you need to manage thousands of children you might want to 4943usually more than enough. If you need to manage thousands of children you
3890increase this value (\fImust\fR be a power of two). 4944might want to increase this value (\fImust\fR be a power of two).
3891.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 4945.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
3892.IX Item "EV_INOTIFY_HASHSIZE" 4946.IX Item "EV_INOTIFY_HASHSIZE"
3893\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by 4947\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
3894inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), 4948inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR
3895usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR 4949disabled), usually more than enough. If you need to manage thousands of
3896watchers you might want to increase this value (\fImust\fR be a power of 4950\&\f(CW\*(C`ev_stat\*(C'\fR watchers you might want to increase this value (\fImust\fR be a
3897two). 4951power of two).
3898.IP "\s-1EV_USE_4HEAP\s0" 4 4952.IP "\s-1EV_USE_4HEAP\s0" 4
3899.IX Item "EV_USE_4HEAP" 4953.IX Item "EV_USE_4HEAP"
3900Heaps are not very cache-efficient. To improve the cache-efficiency of the 4954Heaps are not very cache-efficient. To improve the cache-efficiency of the
3901timer and periodics heaps, libev uses a 4\-heap when this symbol is defined 4955timer and periodics heaps, libev uses a 4\-heap when this symbol is defined
3902to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably 4956to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably
3903faster performance with many (thousands) of watchers. 4957faster performance with many (thousands) of watchers.
3904.Sp 4958.Sp
3905The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR 4959The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
3906(disabled). 4960will be \f(CW0\fR.
3907.IP "\s-1EV_HEAP_CACHE_AT\s0" 4 4961.IP "\s-1EV_HEAP_CACHE_AT\s0" 4
3908.IX Item "EV_HEAP_CACHE_AT" 4962.IX Item "EV_HEAP_CACHE_AT"
3909Heaps are not very cache-efficient. To improve the cache-efficiency of the 4963Heaps are not very cache-efficient. To improve the cache-efficiency of the
3910timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within 4964timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within
3911the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR), 4965the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR),
3912which uses 8\-12 bytes more per watcher and a few hundred bytes more code, 4966which uses 8\-12 bytes more per watcher and a few hundred bytes more code,
3913but avoids random read accesses on heap changes. This improves performance 4967but avoids random read accesses on heap changes. This improves performance
3914noticeably with many (hundreds) of watchers. 4968noticeably with many (hundreds) of watchers.
3915.Sp 4969.Sp
3916The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR 4970The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
3917(disabled). 4971will be \f(CW0\fR.
3918.IP "\s-1EV_VERIFY\s0" 4 4972.IP "\s-1EV_VERIFY\s0" 4
3919.IX Item "EV_VERIFY" 4973.IX Item "EV_VERIFY"
3920Controls how much internal verification (see \f(CW\*(C`ev_loop_verify ()\*(C'\fR) will 4974Controls how much internal verification (see \f(CW\*(C`ev_verify ()\*(C'\fR) will
3921be done: If set to \f(CW0\fR, no internal verification code will be compiled 4975be done: If set to \f(CW0\fR, no internal verification code will be compiled
3922in. If set to \f(CW1\fR, then verification code will be compiled in, but not 4976in. If set to \f(CW1\fR, then verification code will be compiled in, but not
3923called. If set to \f(CW2\fR, then the internal verification code will be 4977called. If set to \f(CW2\fR, then the internal verification code will be
3924called once per loop, which can slow down libev. If set to \f(CW3\fR, then the 4978called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
3925verification code will be called very frequently, which will slow down 4979verification code will be called very frequently, which will slow down
3926libev considerably. 4980libev considerably.
3927.Sp 4981.Sp
3928The default is \f(CW1\fR, unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set, in which case it will be 4982The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
3929\&\f(CW0\fR. 4983will be \f(CW0\fR.
3930.IP "\s-1EV_COMMON\s0" 4 4984.IP "\s-1EV_COMMON\s0" 4
3931.IX Item "EV_COMMON" 4985.IX Item "EV_COMMON"
3932By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 4986By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
3933this macro to a something else you can include more and other types of 4987this macro to something else you can include more and other types of
3934members. You have to define it each time you include one of the files, 4988members. You have to define it each time you include one of the files,
3935though, and it must be identical each time. 4989though, and it must be identical each time.
3936.Sp 4990.Sp
3937For example, the perl \s-1EV\s0 module uses something like this: 4991For example, the perl \s-1EV\s0 module uses something like this:
3938.Sp 4992.Sp
3939.Vb 3 4993.Vb 3
3940\& #define EV_COMMON \e 4994\& #define EV_COMMON \e
3941\& SV *self; /* contains this struct */ \e 4995\& SV *self; /* contains this struct */ \e
3942\& SV *cb_sv, *fh /* note no trailing ";" */ 4996\& SV *cb_sv, *fh /* note no trailing ";" */
3943.Ve 4997.Ve
3944.IP "\s-1EV_CB_DECLARE\s0 (type)" 4 4998.IP "\s-1EV_CB_DECLARE \s0(type)" 4
3945.IX Item "EV_CB_DECLARE (type)" 4999.IX Item "EV_CB_DECLARE (type)"
3946.PD 0 5000.PD 0
3947.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 5001.IP "\s-1EV_CB_INVOKE \s0(watcher, revents)" 4
3948.IX Item "EV_CB_INVOKE (watcher, revents)" 5002.IX Item "EV_CB_INVOKE (watcher, revents)"
3949.IP "ev_set_cb (ev, cb)" 4 5003.IP "ev_set_cb (ev, cb)" 4
3950.IX Item "ev_set_cb (ev, cb)" 5004.IX Item "ev_set_cb (ev, cb)"
3951.PD 5005.PD
3952Can be used to change the callback member declaration in each watcher, 5006Can be used to change the callback member declaration in each watcher,
3953and the way callbacks are invoked and set. Must expand to a struct member 5007and the way callbacks are invoked and set. Must expand to a struct member
3954definition and a statement, respectively. See the \fIev.h\fR header file for 5008definition and a statement, respectively. See the \fIev.h\fR header file for
3955their default definitions. One possible use for overriding these is to 5009their default definitions. One possible use for overriding these is to
3956avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5010avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
3957method calls instead of plain function calls in \*(C+. 5011method calls instead of plain function calls in \*(C+.
3958.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5012.SS "\s-1EXPORTED API SYMBOLS\s0"
3959.IX Subsection "EXPORTED API SYMBOLS" 5013.IX Subsection "EXPORTED API SYMBOLS"
3960If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 5014If you need to re-export the \s-1API \s0(e.g. via a \s-1DLL\s0) and you need a list of
3961exported symbols, you can use the provided \fISymbol.*\fR files which list 5015exported symbols, you can use the provided \fISymbol.*\fR files which list
3962all public symbols, one per line: 5016all public symbols, one per line:
3963.PP 5017.PP
3964.Vb 2 5018.Vb 2
3965\& Symbols.ev for libev proper 5019\& Symbols.ev for libev proper
3996file. 5050file.
3997.PP 5051.PP
3998The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 5052The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
3999that everybody includes and which overrides some configure choices: 5053that everybody includes and which overrides some configure choices:
4000.PP 5054.PP
4001.Vb 9 5055.Vb 8
4002\& #define EV_MINIMAL 1 5056\& #define EV_FEATURES 8
4003\& #define EV_USE_POLL 0 5057\& #define EV_USE_SELECT 1
4004\& #define EV_MULTIPLICITY 0
4005\& #define EV_PERIODIC_ENABLE 0 5058\& #define EV_PREPARE_ENABLE 1
5059\& #define EV_IDLE_ENABLE 1
4006\& #define EV_STAT_ENABLE 0 5060\& #define EV_SIGNAL_ENABLE 1
4007\& #define EV_FORK_ENABLE 0 5061\& #define EV_CHILD_ENABLE 1
5062\& #define EV_USE_STDEXCEPT 0
4008\& #define EV_CONFIG_H <config.h> 5063\& #define EV_CONFIG_H <config.h>
4009\& #define EV_MINPRI 0
4010\& #define EV_MAXPRI 0
4011\& 5064\&
4012\& #include "ev++.h" 5065\& #include "ev++.h"
4013.Ve 5066.Ve
4014.PP 5067.PP
4015And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 5068And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
4016.PP 5069.PP
4017.Vb 2 5070.Vb 2
4018\& #include "ev_cpp.h" 5071\& #include "ev_cpp.h"
4019\& #include "ev.c" 5072\& #include "ev.c"
4020.Ve 5073.Ve
4021.SH "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" 5074.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4022.IX Header "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" 5075.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4023.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5076.SS "\s-1THREADS AND COROUTINES\s0"
4024.IX Subsection "THREADS AND COROUTINES" 5077.IX Subsection "THREADS AND COROUTINES"
4025\fI\s-1THREADS\s0\fR 5078\fI\s-1THREADS\s0\fR
4026.IX Subsection "THREADS" 5079.IX Subsection "THREADS"
4027.PP 5080.PP
4028All libev functions are reentrant and thread-safe unless explicitly 5081All libev functions are reentrant and thread-safe unless explicitly
4074An example use would be to communicate signals or other events that only 5127An example use would be to communicate signals or other events that only
4075work in the default loop by registering the signal watcher with the 5128work in the default loop by registering the signal watcher with the
4076default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 5129default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
4077watcher callback into the event loop interested in the signal. 5130watcher callback into the event loop interested in the signal.
4078.PP 5131.PP
4079\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0 5132See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
4080.IX Subsection "THREAD LOCKING EXAMPLE"
4081.PP
4082Here is a fictitious example of how to run an event loop in a different
4083thread than where callbacks are being invoked and watchers are
4084created/added/removed.
4085.PP
4086For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
4087which uses exactly this technique (which is suited for many high-level
4088languages).
4089.PP
4090The example uses a pthread mutex to protect the loop data, a condition
4091variable to wait for callback invocations, an async watcher to notify the
4092event loop thread and an unspecified mechanism to wake up the main thread.
4093.PP
4094First, you need to associate some data with the event loop:
4095.PP
4096.Vb 6
4097\& typedef struct {
4098\& mutex_t lock; /* global loop lock */
4099\& ev_async async_w;
4100\& thread_t tid;
4101\& cond_t invoke_cv;
4102\& } userdata;
4103\&
4104\& void prepare_loop (EV_P)
4105\& {
4106\& // for simplicity, we use a static userdata struct.
4107\& static userdata u;
4108\&
4109\& ev_async_init (&u\->async_w, async_cb);
4110\& ev_async_start (EV_A_ &u\->async_w);
4111\&
4112\& pthread_mutex_init (&u\->lock, 0);
4113\& pthread_cond_init (&u\->invoke_cv, 0);
4114\&
4115\& // now associate this with the loop
4116\& ev_set_userdata (EV_A_ u);
4117\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
4118\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4119\&
4120\& // then create the thread running ev_loop
4121\& pthread_create (&u\->tid, 0, l_run, EV_A);
4122\& }
4123.Ve
4124.PP
4125The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
4126solely to wake up the event loop so it takes notice of any new watchers
4127that might have been added:
4128.PP
4129.Vb 5
4130\& static void
4131\& async_cb (EV_P_ ev_async *w, int revents)
4132\& {
4133\& // just used for the side effects
4134\& }
4135.Ve
4136.PP
4137The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
4138protecting the loop data, respectively.
4139.PP
4140.Vb 6
4141\& static void
4142\& l_release (EV_P)
4143\& {
4144\& userdata *u = ev_userdata (EV_A);
4145\& pthread_mutex_unlock (&u\->lock);
4146\& }
4147\&
4148\& static void
4149\& l_acquire (EV_P)
4150\& {
4151\& userdata *u = ev_userdata (EV_A);
4152\& pthread_mutex_lock (&u\->lock);
4153\& }
4154.Ve
4155.PP
4156The event loop thread first acquires the mutex, and then jumps straight
4157into \f(CW\*(C`ev_loop\*(C'\fR:
4158.PP
4159.Vb 4
4160\& void *
4161\& l_run (void *thr_arg)
4162\& {
4163\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
4164\&
4165\& l_acquire (EV_A);
4166\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4167\& ev_loop (EV_A_ 0);
4168\& l_release (EV_A);
4169\&
4170\& return 0;
4171\& }
4172.Ve
4173.PP
4174Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
4175signal the main thread via some unspecified mechanism (signals? pipe
4176writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
4177have been called (in a while loop because a) spurious wakeups are possible
4178and b) skipping inter-thread-communication when there are no pending
4179watchers is very beneficial):
4180.PP
4181.Vb 4
4182\& static void
4183\& l_invoke (EV_P)
4184\& {
4185\& userdata *u = ev_userdata (EV_A);
4186\&
4187\& while (ev_pending_count (EV_A))
4188\& {
4189\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4190\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
4191\& }
4192\& }
4193.Ve
4194.PP
4195Now, whenever the main thread gets told to invoke pending watchers, it
4196will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
4197thread to continue:
4198.PP
4199.Vb 4
4200\& static void
4201\& real_invoke_pending (EV_P)
4202\& {
4203\& userdata *u = ev_userdata (EV_A);
4204\&
4205\& pthread_mutex_lock (&u\->lock);
4206\& ev_invoke_pending (EV_A);
4207\& pthread_cond_signal (&u\->invoke_cv);
4208\& pthread_mutex_unlock (&u\->lock);
4209\& }
4210.Ve
4211.PP
4212Whenever you want to start/stop a watcher or do other modifications to an
4213event loop, you will now have to lock:
4214.PP
4215.Vb 2
4216\& ev_timer timeout_watcher;
4217\& userdata *u = ev_userdata (EV_A);
4218\&
4219\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4220\&
4221\& pthread_mutex_lock (&u\->lock);
4222\& ev_timer_start (EV_A_ &timeout_watcher);
4223\& ev_async_send (EV_A_ &u\->async_w);
4224\& pthread_mutex_unlock (&u\->lock);
4225.Ve
4226.PP
4227Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
4228an event loop currently blocking in the kernel will have no knowledge
4229about the newly added timer. By waking up the loop it will pick up any new
4230watchers in the next event loop iteration.
4231.PP 5133.PP
4232\fI\s-1COROUTINES\s0\fR 5134\fI\s-1COROUTINES\s0\fR
4233.IX Subsection "COROUTINES" 5135.IX Subsection "COROUTINES"
4234.PP 5136.PP
4235Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5137Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
4236libev fully supports nesting calls to its functions from different 5138libev fully supports nesting calls to its functions from different
4237coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two 5139coroutines (e.g. you can call \f(CW\*(C`ev_run\*(C'\fR on the same loop from two
4238different coroutines, and switch freely between both coroutines running 5140different coroutines, and switch freely between both coroutines running
4239the loop, as long as you don't confuse yourself). The only exception is 5141the loop, as long as you don't confuse yourself). The only exception is
4240that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 5142that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
4241.PP 5143.PP
4242Care has been taken to ensure that libev does not keep local state inside 5144Care has been taken to ensure that libev does not keep local state inside
4243\&\f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow for coroutine switches as 5145\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
4244they do not call any callbacks. 5146they do not call any callbacks.
4245.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5147.SS "\s-1COMPILER WARNINGS\s0"
4246.IX Subsection "COMPILER WARNINGS" 5148.IX Subsection "COMPILER WARNINGS"
4247Depending on your compiler and compiler settings, you might get no or a 5149Depending on your compiler and compiler settings, you might get no or a
4248lot of warnings when compiling libev code. Some people are apparently 5150lot of warnings when compiling libev code. Some people are apparently
4249scared by this. 5151scared by this.
4250.PP 5152.PP
4258maintainable. 5160maintainable.
4259.PP 5161.PP
4260And of course, some compiler warnings are just plain stupid, or simply 5162And of course, some compiler warnings are just plain stupid, or simply
4261wrong (because they don't actually warn about the condition their message 5163wrong (because they don't actually warn about the condition their message
4262seems to warn about). For example, certain older gcc versions had some 5164seems to warn about). For example, certain older gcc versions had some
4263warnings that resulted an extreme number of false positives. These have 5165warnings that resulted in an extreme number of false positives. These have
4264been fixed, but some people still insist on making code warn-free with 5166been fixed, but some people still insist on making code warn-free with
4265such buggy versions. 5167such buggy versions.
4266.PP 5168.PP
4267While libev is written to generate as few warnings as possible, 5169While libev is written to generate as few warnings as possible,
4268\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev 5170\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
4302.PP 5204.PP
4303If you need, for some reason, empty reports from valgrind for your project 5205If you need, for some reason, empty reports from valgrind for your project
4304I suggest using suppression lists. 5206I suggest using suppression lists.
4305.SH "PORTABILITY NOTES" 5207.SH "PORTABILITY NOTES"
4306.IX Header "PORTABILITY NOTES" 5208.IX Header "PORTABILITY NOTES"
4307.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5209.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
5210.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
5211GNU/Linux is the only common platform that supports 64 bit file/large file
5212interfaces but \fIdisables\fR them by default.
5213.PP
5214That means that libev compiled in the default environment doesn't support
5215files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
5216.PP
5217Unfortunately, many programs try to work around this GNU/Linux issue
5218by enabling the large file \s-1API,\s0 which makes them incompatible with the
5219standard libev compiled for their system.
5220.PP
5221Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
5222suddenly make it incompatible to the default compile time environment,
5223i.e. all programs not using special compile switches.
5224.SS "\s-1OS/X AND DARWIN BUGS\s0"
5225.IX Subsection "OS/X AND DARWIN BUGS"
5226The whole thing is a bug if you ask me \- basically any system interface
5227you touch is broken, whether it is locales, poll, kqueue or even the
5228OpenGL drivers.
5229.PP
5230\fI\f(CI\*(C`kqueue\*(C'\fI is buggy\fR
5231.IX Subsection "kqueue is buggy"
5232.PP
5233The kqueue syscall is broken in all known versions \- most versions support
5234only sockets, many support pipes.
5235.PP
5236Libev tries to work around this by not using \f(CW\*(C`kqueue\*(C'\fR by default on this
5237rotten platform, but of course you can still ask for it when creating a
5238loop \- embedding a socket-only kqueue loop into a select-based one is
5239probably going to work well.
5240.PP
5241\fI\f(CI\*(C`poll\*(C'\fI is buggy\fR
5242.IX Subsection "poll is buggy"
5243.PP
5244Instead of fixing \f(CW\*(C`kqueue\*(C'\fR, Apple replaced their (working) \f(CW\*(C`poll\*(C'\fR
5245implementation by something calling \f(CW\*(C`kqueue\*(C'\fR internally around the 10.5.6
5246release, so now \f(CW\*(C`kqueue\*(C'\fR \fIand\fR \f(CW\*(C`poll\*(C'\fR are broken.
5247.PP
5248Libev tries to work around this by not using \f(CW\*(C`poll\*(C'\fR by default on
5249this rotten platform, but of course you can still ask for it when creating
5250a loop.
5251.PP
5252\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
5253.IX Subsection "select is buggy"
5254.PP
5255All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
5256one up as well: On \s-1OS/X, \s0\f(CW\*(C`select\*(C'\fR actively limits the number of file
5257descriptors you can pass in to 1024 \- your program suddenly crashes when
5258you use more.
5259.PP
5260There is an undocumented \*(L"workaround\*(R" for this \- defining
5261\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
5262work on \s-1OS/X.\s0
5263.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
5264.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
5265\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
5266.IX Subsection "errno reentrancy"
5267.PP
5268The default compile environment on Solaris is unfortunately so
5269thread-unsafe that you can't even use components/libraries compiled
5270without \f(CW\*(C`\-D_REENTRANT\*(C'\fR in a threaded program, which, of course, isn't
5271defined by default. A valid, if stupid, implementation choice.
5272.PP
5273If you want to use libev in threaded environments you have to make sure
5274it's compiled with \f(CW\*(C`_REENTRANT\*(C'\fR defined.
5275.PP
5276\fIEvent port backend\fR
5277.IX Subsection "Event port backend"
5278.PP
5279The scalable event interface for Solaris is called \*(L"event
5280ports\*(R". Unfortunately, this mechanism is very buggy in all major
5281releases. If you run into high \s-1CPU\s0 usage, your program freezes or you get
5282a large number of spurious wakeups, make sure you have all the relevant
5283and latest kernel patches applied. No, I don't know which ones, but there
5284are multiple ones to apply, and afterwards, event ports actually work
5285great.
5286.PP
5287If you can't get it to work, you can try running the program by setting
5288the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
5289\&\f(CW\*(C`select\*(C'\fR backends.
5290.SS "\s-1AIX POLL BUG\s0"
5291.IX Subsection "AIX POLL BUG"
5292\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
5293this by trying to avoid the poll backend altogether (i.e. it's not even
5294compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
5295with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
5296.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
4308.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5297.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
5298\fIGeneral issues\fR
5299.IX Subsection "General issues"
5300.PP
4309Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5301Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
4310requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 5302requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
4311model. Libev still offers limited functionality on this platform in 5303model. Libev still offers limited functionality on this platform in
4312the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 5304the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
4313descriptors. This only applies when using Win32 natively, not when using 5305descriptors. This only applies when using Win32 natively, not when using
4314e.g. cygwin. 5306e.g. cygwin. Actually, it only applies to the microsofts own compilers,
5307as every compiler comes with a slightly differently broken/incompatible
5308environment.
4315.PP 5309.PP
4316Lifting these limitations would basically require the full 5310Lifting these limitations would basically require the full
4317re-implementation of the I/O system. If you are into these kinds of 5311re-implementation of the I/O system. If you are into this kind of thing,
4318things, then note that glib does exactly that for you in a very portable 5312then note that glib does exactly that for you in a very portable way (note
4319way (note also that glib is the slowest event library known to man). 5313also that glib is the slowest event library known to man).
4320.PP 5314.PP
4321There is no supported compilation method available on windows except 5315There is no supported compilation method available on windows except
4322embedding it into other applications. 5316embedding it into other applications.
4323.PP 5317.PP
4324Sensible signal handling is officially unsupported by Microsoft \- libev 5318Sensible signal handling is officially unsupported by Microsoft \- libev
4355.PP 5349.PP
4356.Vb 2 5350.Vb 2
4357\& #include "evwrap.h" 5351\& #include "evwrap.h"
4358\& #include "ev.c" 5352\& #include "ev.c"
4359.Ve 5353.Ve
4360.IP "The winsocket select function" 4 5354.PP
5355\fIThe winsocket \f(CI\*(C`select\*(C'\fI function\fR
4361.IX Item "The winsocket select function" 5356.IX Subsection "The winsocket select function"
5357.PP
4362The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it 5358The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
4363requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is 5359requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
4364also extremely buggy). This makes select very inefficient, and also 5360also extremely buggy). This makes select very inefficient, and also
4365requires a mapping from file descriptors to socket handles (the Microsoft 5361requires a mapping from file descriptors to socket handles (the Microsoft
4366C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the 5362C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
4367discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and 5363discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
4368\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info. 5364\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
4369.Sp 5365.PP
4370The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime 5366The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime
4371libraries and raw winsocket select is: 5367libraries and raw winsocket select is:
4372.Sp 5368.PP
4373.Vb 2 5369.Vb 2
4374\& #define EV_USE_SELECT 1 5370\& #define EV_USE_SELECT 1
4375\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5371\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4376.Ve 5372.Ve
4377.Sp 5373.PP
4378Note that winsockets handling of fd sets is O(n), so you can easily get a 5374Note that winsockets handling of fd sets is O(n), so you can easily get a
4379complexity in the O(nA\*^X) range when using win32. 5375complexity in the O(nX) range when using win32.
5376.PP
4380.IP "Limited number of file descriptors" 4 5377\fILimited number of file descriptors\fR
4381.IX Item "Limited number of file descriptors" 5378.IX Subsection "Limited number of file descriptors"
5379.PP
4382Windows has numerous arbitrary (and low) limits on things. 5380Windows has numerous arbitrary (and low) limits on things.
4383.Sp 5381.PP
4384Early versions of winsocket's select only supported waiting for a maximum 5382Early versions of winsocket's select only supported waiting for a maximum
4385of \f(CW64\fR handles (probably owning to the fact that all windows kernels 5383of \f(CW64\fR handles (probably owning to the fact that all windows kernels
4386can only wait for \f(CW64\fR things at the same time internally; Microsoft 5384can only wait for \f(CW64\fR things at the same time internally; Microsoft
4387recommends spawning a chain of threads and wait for 63 handles and the 5385recommends spawning a chain of threads and wait for 63 handles and the
4388previous thread in each. Sounds great!). 5386previous thread in each. Sounds great!).
4389.Sp 5387.PP
4390Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR 5388Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
4391to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select 5389to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
4392call (which might be in libev or elsewhere, for example, perl and many 5390call (which might be in libev or elsewhere, for example, perl and many
4393other interpreters do their own select emulation on windows). 5391other interpreters do their own select emulation on windows).
4394.Sp 5392.PP
4395Another limit is the number of file descriptors in the Microsoft runtime 5393Another limit is the number of file descriptors in the Microsoft runtime
4396libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR 5394libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR
4397fetish or something like this inside Microsoft). You can increase this 5395fetish or something like this inside Microsoft). You can increase this
4398by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR 5396by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
4399(another arbitrary limit), but is broken in many versions of the Microsoft 5397(another arbitrary limit), but is broken in many versions of the Microsoft
4400runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets 5398runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
4401(depending on windows version and/or the phase of the moon). To get more, 5399(depending on windows version and/or the phase of the moon). To get more,
4402you need to wrap all I/O functions and provide your own fd management, but 5400you need to wrap all I/O functions and provide your own fd management, but
4403the cost of calling select (O(nA\*^X)) will likely make this unworkable. 5401the cost of calling select (O(nX)) will likely make this unworkable.
4404.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5402.SS "\s-1PORTABILITY REQUIREMENTS\s0"
4405.IX Subsection "PORTABILITY REQUIREMENTS" 5403.IX Subsection "PORTABILITY REQUIREMENTS"
4406In addition to a working ISO-C implementation and of course the 5404In addition to a working ISO-C implementation and of course the
4407backend-specific APIs, libev relies on a few additional extensions: 5405backend-specific APIs, libev relies on a few additional extensions:
4408.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 5406.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
4409.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5407.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
4410.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5408.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
4411Libev assumes not only that all watcher pointers have the same internal 5409Libev assumes not only that all watcher pointers have the same internal
4412structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5410structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
4413assumes that the same (machine) code can be used to call any watcher 5411assumes that the same (machine) code can be used to call any watcher
4414callback: The watcher callbacks have different type signatures, but libev 5412callback: The watcher callbacks have different type signatures, but libev
4415calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5413calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5414.IP "pointer accesses must be thread-atomic" 4
5415.IX Item "pointer accesses must be thread-atomic"
5416Accessing a pointer value must be atomic, it must both be readable and
5417writable in one piece \- this is the case on all current architectures.
4416.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5418.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
4417.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4 5419.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
4418.IX Item "sig_atomic_t volatile must be thread-atomic as well" 5420.IX Item "sig_atomic_t volatile must be thread-atomic as well"
4419The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as 5421The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
4420\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different 5422\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different
4429thread\*(R" or will block signals process-wide, both behaviours would 5431thread\*(R" or will block signals process-wide, both behaviours would
4430be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5432be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
4431\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5433\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
4432.Sp 5434.Sp
4433The most portable way to handle signals is to block signals in all threads 5435The most portable way to handle signals is to block signals in all threads
4434except the initial one, and run the default loop in the initial thread as 5436except the initial one, and run the signal handling loop in the initial
4435well. 5437thread as well.
4436.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5438.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
4437.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 5439.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
4438.IX Item "long must be large enough for common memory allocation sizes" 5440.IX Item "long must be large enough for common memory allocation sizes"
4439To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally 5441To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
4440instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX 5442instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
4441systems (Microsoft...) this might be unexpectedly low, but is still at 5443systems (Microsoft...) this might be unexpectedly low, but is still at
4442least 31 bits everywhere, which is enough for hundreds of millions of 5444least 31 bits everywhere, which is enough for hundreds of millions of
4443watchers. 5445watchers.
4444.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5446.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
4445.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4 5447.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
4446.IX Item "double must hold a time value in seconds with enough accuracy" 5448.IX Item "double must hold a time value in seconds with enough accuracy"
4447The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5449The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
4448have at least 51 bits of mantissa (and 9 bits of exponent), which is good 5450have at least 51 bits of mantissa (and 9 bits of exponent), which is
4449enough for at least into the year 4000. This requirement is fulfilled by 5451good enough for at least into the year 4000 with millisecond accuracy
5452(the design goal for libev). This requirement is overfulfilled by
4450implementations implementing \s-1IEEE\s0 754, which is basically all existing 5453implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5454.Sp
4451ones. With \s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least 5455With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
44522200. 5456year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5457is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5458something like that, just kidding).
4453.PP 5459.PP
4454If you know of other additional requirements drop me a note. 5460If you know of other additional requirements drop me a note.
4455.SH "ALGORITHMIC COMPLEXITIES" 5461.SH "ALGORITHMIC COMPLEXITIES"
4456.IX Header "ALGORITHMIC COMPLEXITIES" 5462.IX Header "ALGORITHMIC COMPLEXITIES"
4457In this section the complexities of (many of) the algorithms used inside 5463In this section the complexities of (many of) the algorithms used inside
4511.IX Item "Processing ev_async_send: O(number_of_async_watchers)" 5517.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
4512.IP "Processing signals: O(max_signal_number)" 4 5518.IP "Processing signals: O(max_signal_number)" 4
4513.IX Item "Processing signals: O(max_signal_number)" 5519.IX Item "Processing signals: O(max_signal_number)"
4514.PD 5520.PD
4515Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 5521Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
4516calls in the current loop iteration. Checking for async and signal events 5522calls in the current loop iteration and the loop is currently
5523blocked. Checking for async and signal events involves iterating over all
4517involves iterating over all running async watchers or all signal numbers. 5524running async watchers or all signal numbers.
5525.SH "PORTING FROM LIBEV 3.X TO 4.X"
5526.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5527The major version 4 introduced some incompatible changes to the \s-1API.\s0
5528.PP
5529At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5530for all changes, so most programs should still compile. The compatibility
5531layer might be removed in later versions of libev, so better update to the
5532new \s-1API\s0 early than late.
5533.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5534.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5535.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5536The backward compatibility mechanism can be controlled by
5537\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5538section.
5539.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5540.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5541.IX Item "ev_default_destroy and ev_default_fork have been removed"
5542These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5543.Sp
5544.Vb 2
5545\& ev_loop_destroy (EV_DEFAULT_UC);
5546\& ev_loop_fork (EV_DEFAULT);
5547.Ve
5548.IP "function/symbol renames" 4
5549.IX Item "function/symbol renames"
5550A number of functions and symbols have been renamed:
5551.Sp
5552.Vb 3
5553\& ev_loop => ev_run
5554\& EVLOOP_NONBLOCK => EVRUN_NOWAIT
5555\& EVLOOP_ONESHOT => EVRUN_ONCE
5556\&
5557\& ev_unloop => ev_break
5558\& EVUNLOOP_CANCEL => EVBREAK_CANCEL
5559\& EVUNLOOP_ONE => EVBREAK_ONE
5560\& EVUNLOOP_ALL => EVBREAK_ALL
5561\&
5562\& EV_TIMEOUT => EV_TIMER
5563\&
5564\& ev_loop_count => ev_iteration
5565\& ev_loop_depth => ev_depth
5566\& ev_loop_verify => ev_verify
5567.Ve
5568.Sp
5569Most functions working on \f(CW\*(C`struct ev_loop\*(C'\fR objects don't have an
5570\&\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
5571associated constants have been renamed to not collide with the \f(CW\*(C`struct
5572ev_loop\*(C'\fR anymore and \f(CW\*(C`EV_TIMER\*(C'\fR now follows the same naming scheme
5573as all other watcher types. Note that \f(CW\*(C`ev_loop_fork\*(C'\fR is still called
5574\&\f(CW\*(C`ev_loop_fork\*(C'\fR because it would otherwise clash with the \f(CW\*(C`ev_fork\*(C'\fR
5575typedef.
5576.ie n .IP """EV_MINIMAL"" mechanism replaced by ""EV_FEATURES""" 4
5577.el .IP "\f(CWEV_MINIMAL\fR mechanism replaced by \f(CWEV_FEATURES\fR" 4
5578.IX Item "EV_MINIMAL mechanism replaced by EV_FEATURES"
5579The preprocessor symbol \f(CW\*(C`EV_MINIMAL\*(C'\fR has been replaced by a different
5580mechanism, \f(CW\*(C`EV_FEATURES\*(C'\fR. Programs using \f(CW\*(C`EV_MINIMAL\*(C'\fR usually compile
5581and work, but the library code will of course be larger.
4518.SH "GLOSSARY" 5582.SH "GLOSSARY"
4519.IX Header "GLOSSARY" 5583.IX Header "GLOSSARY"
4520.IP "active" 4 5584.IP "active" 4
4521.IX Item "active" 5585.IX Item "active"
4522A watcher is active as long as it has been started (has been attached to 5586A watcher is active as long as it has been started and not yet stopped.
4523an event loop) but not yet stopped (disassociated from the event loop). 5587See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
4524.IP "application" 4 5588.IP "application" 4
4525.IX Item "application" 5589.IX Item "application"
4526In this document, an application is whatever is using libev. 5590In this document, an application is whatever is using libev.
5591.IP "backend" 4
5592.IX Item "backend"
5593The part of the code dealing with the operating system interfaces.
4527.IP "callback" 4 5594.IP "callback" 4
4528.IX Item "callback" 5595.IX Item "callback"
4529The address of a function that is called when some event has been 5596The address of a function that is called when some event has been
4530detected. Callbacks are being passed the event loop, the watcher that 5597detected. Callbacks are being passed the event loop, the watcher that
4531received the event, and the actual event bitset. 5598received the event, and the actual event bitset.
4532.IP "callback invocation" 4 5599.IP "callback/watcher invocation" 4
4533.IX Item "callback invocation" 5600.IX Item "callback/watcher invocation"
4534The act of calling the callback associated with a watcher. 5601The act of calling the callback associated with a watcher.
4535.IP "event" 4 5602.IP "event" 4
4536.IX Item "event" 5603.IX Item "event"
4537A change of state of some external event, such as data now being available 5604A change of state of some external event, such as data now being available
4538for reading on a file descriptor, time having passed or simply not having 5605for reading on a file descriptor, time having passed or simply not having
4539any other events happening anymore. 5606any other events happening anymore.
4540.Sp 5607.Sp
4541In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or 5608In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or
4542\&\f(CW\*(C`EV_TIMEOUT\*(C'\fR). 5609\&\f(CW\*(C`EV_TIMER\*(C'\fR).
4543.IP "event library" 4 5610.IP "event library" 4
4544.IX Item "event library" 5611.IX Item "event library"
4545A software package implementing an event model and loop. 5612A software package implementing an event model and loop.
4546.IP "event loop" 4 5613.IP "event loop" 4
4547.IX Item "event loop" 5614.IX Item "event loop"
4551.IX Item "event model" 5618.IX Item "event model"
4552The model used to describe how an event loop handles and processes 5619The model used to describe how an event loop handles and processes
4553watchers and events. 5620watchers and events.
4554.IP "pending" 4 5621.IP "pending" 4
4555.IX Item "pending" 5622.IX Item "pending"
4556A watcher is pending as soon as the corresponding event has been detected, 5623A watcher is pending as soon as the corresponding event has been
4557and stops being pending as soon as the watcher will be invoked or its 5624detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
4558pending status is explicitly cleared by the application.
4559.Sp
4560A watcher can be pending, but not active. Stopping a watcher also clears
4561its pending status.
4562.IP "real time" 4 5625.IP "real time" 4
4563.IX Item "real time" 5626.IX Item "real time"
4564The physical time that is observed. It is apparently strictly monotonic :) 5627The physical time that is observed. It is apparently strictly monotonic :)
4565.IP "wall-clock time" 4 5628.IP "wall-clock time" 4
4566.IX Item "wall-clock time" 5629.IX Item "wall-clock time"
4567The time and date as shown on clocks. Unlike real time, it can actually 5630The time and date as shown on clocks. Unlike real time, it can actually
4568be wrong and jump forwards and backwards, e.g. when the you adjust your 5631be wrong and jump forwards and backwards, e.g. when you adjust your
4569clock. 5632clock.
4570.IP "watcher" 4 5633.IP "watcher" 4
4571.IX Item "watcher" 5634.IX Item "watcher"
4572A data structure that describes interest in certain events. Watchers need 5635A data structure that describes interest in certain events. Watchers need
4573to be started (attached to an event loop) before they can receive events. 5636to be started (attached to an event loop) before they can receive events.
4574.IP "watcher invocation" 4
4575.IX Item "watcher invocation"
4576The act of calling the callback associated with a watcher.
4577.SH "AUTHOR" 5637.SH "AUTHOR"
4578.IX Header "AUTHOR" 5638.IX Header "AUTHOR"
4579Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. 5639Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5640Magnusson and Emanuele Giaquinta, and minor corrections by many others.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines