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

Comparing libev/ev.3 (file contents):
Revision 1.10 by root, Sat Nov 24 06:23:27 2007 UTC vs.
Revision 1.64 by root, Wed Apr 16 17:08:29 2008 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
23.ft R 23.ft R
24.fi 24.fi
25.. 25..
26.\" Set up some character translations and predefined strings. \*(-- will 26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a 28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 31.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 32.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 34.ie n \{\
35. ds -- \(*W- 35. ds -- \(*W-
36. ds PI pi 36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
… …
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
48. ds R" '' 48. ds R" ''
49'br\} 49'br\}
50.\" 50.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 55.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 57.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 58.\" output yourself in some meaningful fashion.
55.if \nF \{\ 59.ie \nF \{\
56. de IX 60. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 61. tm Index:\\$1\t\\n%\t"\\$2"
58.. 62..
59. nr % 0 63. nr % 0
60. rr F 64. rr F
61.\} 65.\}
62.\" 66.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 67. de IX
64.\" way too many mistakes in technical documents. 68..
65.hy 0 69.\}
66.if n .na
67.\" 70.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 72.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 73. \" fudge factors for nroff and troff
71.if n \{\ 74.if n \{\
… …
126. ds Ae AE 129. ds Ae AE
127.\} 130.\}
128.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
129.\" ======================================================================== 132.\" ========================================================================
130.\" 133.\"
131.IX Title ""<STANDARD INPUT>" 1" 134.IX Title "EV 1"
132.TH "<STANDARD INPUT>" 1 "2007-11-24" "perl v5.8.8" "User Contributed Perl Documentation" 135.TH EV 1 "2008-04-11" "perl v5.10.0" "User Contributed Perl Documentation"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
133.SH "NAME" 140.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 141libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 142.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
137.Vb 1 144.Vb 1
138\& #include <ev.h> 145\& #include <ev.h>
139.Ve 146.Ve
147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
148.IX Subsection "EXAMPLE PROGRAM"
149.Vb 2
150\& // a single header file is required
151\& #include <ev.h>
152\&
153\& // every watcher type has its own typedef\*(Aqd struct
154\& // with the name ev_<type>
155\& ev_io stdin_watcher;
156\& ev_timer timeout_watcher;
157\&
158\& // all watcher callbacks have a similar signature
159\& // this callback is called when data is readable on stdin
160\& static void
161\& stdin_cb (EV_P_ struct ev_io *w, int revents)
162\& {
163\& puts ("stdin ready");
164\& // for one\-shot events, one must manually stop the watcher
165\& // with its corresponding stop function.
166\& ev_io_stop (EV_A_ w);
167\&
168\& // this causes all nested ev_loop\*(Aqs to stop iterating
169\& ev_unloop (EV_A_ EVUNLOOP_ALL);
170\& }
171\&
172\& // another callback, this time for a time\-out
173\& static void
174\& timeout_cb (EV_P_ struct ev_timer *w, int revents)
175\& {
176\& puts ("timeout");
177\& // this causes the innermost ev_loop to stop iterating
178\& ev_unloop (EV_A_ EVUNLOOP_ONE);
179\& }
180\&
181\& int
182\& main (void)
183\& {
184\& // use the default event loop unless you have special needs
185\& struct ev_loop *loop = ev_default_loop (0);
186\&
187\& // initialise an io watcher, then start it
188\& // this one will watch for stdin to become readable
189\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
190\& ev_io_start (loop, &stdin_watcher);
191\&
192\& // initialise a timer watcher, then start it
193\& // simple non\-repeating 5.5 second timeout
194\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
195\& ev_timer_start (loop, &timeout_watcher);
196\&
197\& // now wait for events to arrive
198\& ev_loop (loop, 0);
199\&
200\& // unloop was called, so exit
201\& return 0;
202\& }
203.Ve
140.SH "DESCRIPTION" 204.SH "DESCRIPTION"
141.IX Header "DESCRIPTION" 205.IX Header "DESCRIPTION"
206The newest version of this document is also available as an html-formatted
207web page you might find easier to navigate when reading it for the first
208time: <http://cvs.schmorp.de/libev/ev.html>.
209.PP
142Libev is an event loop: you register interest in certain events (such as a 210Libev is an event loop: you register interest in certain events (such as a
143file descriptor being readable or a timeout occuring), and it will manage 211file descriptor being readable or a timeout occurring), and it will manage
144these event sources and provide your program with events. 212these event sources and provide your program with events.
145.PP 213.PP
146To do this, it must take more or less complete control over your process 214To do this, it must take more or less complete control over your process
147(or thread) by executing the \fIevent loop\fR handler, and will then 215(or thread) by executing the \fIevent loop\fR handler, and will then
148communicate events via a callback mechanism. 216communicate events via a callback mechanism.
149.PP 217.PP
150You register interest in certain events by registering so-called \fIevent 218You register interest in certain events by registering so-called \fIevent
151watchers\fR, which are relatively small C structures you initialise with the 219watchers\fR, which are relatively small C structures you initialise with the
152details of the event, and then hand it over to libev by \fIstarting\fR the 220details of the event, and then hand it over to libev by \fIstarting\fR the
153watcher. 221watcher.
154.SH "FEATURES" 222.Sh "\s-1FEATURES\s0"
155.IX Header "FEATURES" 223.IX Subsection "FEATURES"
156Libev supports select, poll, the linux-specific epoll and the bsd-specific 224Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
157kqueue mechanisms for file descriptor events, relative timers, absolute 225BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
158timers with customised rescheduling, signal events, process status change 226for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
159events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event 227(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
160loop mechanism itself (idle, prepare and check watchers). It also is quite 228with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
161fast (see this benchmark comparing 229(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event
162it to libevent for example). 230watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR,
231\&\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
232file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events
233(\f(CW\*(C`ev_fork\*(C'\fR).
234.PP
235It also is quite fast (see this
236benchmark comparing it to libevent
237for example).
163.SH "CONVENTIONS" 238.Sh "\s-1CONVENTIONS\s0"
164.IX Header "CONVENTIONS" 239.IX Subsection "CONVENTIONS"
165Libev is very configurable. In this manual the default configuration 240Libev is very configurable. In this manual the default (and most common)
166will be described, which supports multiple event loops. For more info 241configuration will be described, which supports multiple event loops. For
167about various configuration options please have a look at the file 242more info about various configuration options please have a look at
168\&\fI\s-1README\s0.embed\fR in the libev distribution. If libev was configured without 243\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
169support for multiple event loops, then all functions taking an initial 244for multiple event loops, then all functions taking an initial argument of
170argument of name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) 245name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
171will not have this argument. 246this argument.
172.SH "TIME REPRESENTATION" 247.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0"
173.IX Header "TIME REPRESENTATION" 248.IX Subsection "TIME REPRESENTATION"
174Libev represents time as a single floating point number, representing the 249Libev represents time as a single floating point number, representing the
175(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 250(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
176the beginning of 1970, details are complicated, don't ask). This type is 251the beginning of 1970, details are complicated, don't ask). This type is
177called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases 252called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases
178to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on 253to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on
179it, you should treat it as such. 254it, you should treat it as some floatingpoint value. Unlike the name
255component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences
256throughout libev.
180.SH "GLOBAL FUNCTIONS" 257.SH "GLOBAL FUNCTIONS"
181.IX Header "GLOBAL FUNCTIONS" 258.IX Header "GLOBAL FUNCTIONS"
182These functions can be called anytime, even before initialising the 259These functions can be called anytime, even before initialising the
183library in any way. 260library in any way.
184.IP "ev_tstamp ev_time ()" 4 261.IP "ev_tstamp ev_time ()" 4
185.IX Item "ev_tstamp ev_time ()" 262.IX Item "ev_tstamp ev_time ()"
186Returns the current time as libev would use it. Please note that the 263Returns the current time as libev would use it. Please note that the
187\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp 264\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp
188you actually want to know. 265you actually want to know.
266.IP "ev_sleep (ev_tstamp interval)" 4
267.IX Item "ev_sleep (ev_tstamp interval)"
268Sleep for the given interval: The current thread will be blocked until
269either it is interrupted or the given time interval has passed. Basically
270this is a subsecond-resolution \f(CW\*(C`sleep ()\*(C'\fR.
189.IP "int ev_version_major ()" 4 271.IP "int ev_version_major ()" 4
190.IX Item "int ev_version_major ()" 272.IX Item "int ev_version_major ()"
191.PD 0 273.PD 0
192.IP "int ev_version_minor ()" 4 274.IP "int ev_version_minor ()" 4
193.IX Item "int ev_version_minor ()" 275.IX Item "int ev_version_minor ()"
194.PD 276.PD
195You can find out the major and minor version numbers of the library 277You can find out the major and minor \s-1ABI\s0 version numbers of the library
196you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and 278you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and
197\&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global 279\&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global
198symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the 280symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the
199version of the library your program was compiled against. 281version of the library your program was compiled against.
200.Sp 282.Sp
283These version numbers refer to the \s-1ABI\s0 version of the library, not the
284release version.
285.Sp
201Usually, it's a good idea to terminate if the major versions mismatch, 286Usually, it's a good idea to terminate if the major versions mismatch,
202as this indicates an incompatible change. Minor versions are usually 287as this indicates an incompatible change. Minor versions are usually
203compatible to older versions, so a larger minor version alone is usually 288compatible to older versions, so a larger minor version alone is usually
204not a problem. 289not a problem.
205.Sp 290.Sp
206Example: make sure we haven't accidentally been linked against the wrong 291Example: Make sure we haven't accidentally been linked against the wrong
207version: 292version.
208.Sp 293.Sp
209.Vb 3 294.Vb 3
210\& assert (("libev version mismatch", 295\& assert (("libev version mismatch",
211\& ev_version_major () == EV_VERSION_MAJOR 296\& ev_version_major () == EV_VERSION_MAJOR
212\& && ev_version_minor () >= EV_VERSION_MINOR)); 297\& && ev_version_minor () >= EV_VERSION_MINOR));
… …
234(assuming you know what you are doing). This is the set of backends that 319(assuming you know what you are doing). This is the set of backends that
235libev will probe for if you specify no backends explicitly. 320libev will probe for if you specify no backends explicitly.
236.IP "unsigned int ev_embeddable_backends ()" 4 321.IP "unsigned int ev_embeddable_backends ()" 4
237.IX Item "unsigned int ev_embeddable_backends ()" 322.IX Item "unsigned int ev_embeddable_backends ()"
238Returns the set of backends that are embeddable in other event loops. This 323Returns the set of backends that are embeddable in other event loops. This
239is the theoretical, all\-platform, value. To find which backends 324is the theoretical, all-platform, value. To find which backends
240might be supported on the current system, you would need to look at 325might be supported on the current system, you would need to look at
241\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 326\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
242recommended ones. 327recommended ones.
243.Sp 328.Sp
244See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 329See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
245.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 330.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
246.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 331.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
247Sets the allocation function to use (the prototype is similar to the 332Sets the allocation function to use (the prototype is similar \- the
248realloc C function, the semantics are identical). It is used to allocate 333semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
249and free memory (no surprises here). If it returns zero when memory 334used to allocate and free memory (no surprises here). If it returns zero
250needs to be allocated, the library might abort or take some potentially 335when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
251destructive action. The default is your system realloc function. 336or take some potentially destructive action.
337.Sp
338Since some systems (at least OpenBSD and Darwin) fail to implement
339correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system
340\&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default.
252.Sp 341.Sp
253You could override this function in high-availability programs to, say, 342You could override this function in high-availability programs to, say,
254free some memory if it cannot allocate memory, to use a special allocator, 343free some memory if it cannot allocate memory, to use a special allocator,
255or even to sleep a while and retry until some memory is available. 344or even to sleep a while and retry until some memory is available.
256.Sp 345.Sp
257Example: replace the libev allocator with one that waits a bit and then 346Example: Replace the libev allocator with one that waits a bit and then
258retries: better than mine). 347retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR).
259.Sp 348.Sp
260.Vb 6 349.Vb 6
261\& static void * 350\& static void *
262\& persistent_realloc (void *ptr, long size) 351\& persistent_realloc (void *ptr, size_t size)
263\& { 352\& {
264\& for (;;) 353\& for (;;)
265\& { 354\& {
266\& void *newptr = realloc (ptr, size); 355\& void *newptr = realloc (ptr, size);
267.Ve 356\&
268.Sp
269.Vb 2
270\& if (newptr) 357\& if (newptr)
271\& return newptr; 358\& return newptr;
272.Ve 359\&
273.Sp
274.Vb 3
275\& sleep (60); 360\& sleep (60);
276\& } 361\& }
277\& } 362\& }
278.Ve 363\&
279.Sp
280.Vb 2
281\& ... 364\& ...
282\& ev_set_allocator (persistent_realloc); 365\& ev_set_allocator (persistent_realloc);
283.Ve 366.Ve
284.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 367.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4
285.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" 368.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));"
… …
289callback is set, then libev will expect it to remedy the sitution, no 372callback is set, then libev will expect it to remedy the sitution, no
290matter what, when it returns. That is, libev will generally retry the 373matter what, when it returns. That is, libev will generally retry the
291requested operation, or, if the condition doesn't go away, do bad stuff 374requested operation, or, if the condition doesn't go away, do bad stuff
292(such as abort). 375(such as abort).
293.Sp 376.Sp
294Example: do the same thing as libev does internally: 377Example: This is basically the same thing that libev does internally, too.
295.Sp 378.Sp
296.Vb 6 379.Vb 6
297\& static void 380\& static void
298\& fatal_error (const char *msg) 381\& fatal_error (const char *msg)
299\& { 382\& {
300\& perror (msg); 383\& perror (msg);
301\& abort (); 384\& abort ();
302\& } 385\& }
303.Ve 386\&
304.Sp
305.Vb 2
306\& ... 387\& ...
307\& ev_set_syserr_cb (fatal_error); 388\& ev_set_syserr_cb (fatal_error);
308.Ve 389.Ve
309.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 390.SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
310.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 391.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
311An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two 392An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two
312types of such loops, the \fIdefault\fR loop, which supports signals and child 393types of such loops, the \fIdefault\fR loop, which supports signals and child
313events, and dynamically created loops which do not. 394events, and dynamically created loops which do not.
314.PP
315If you use threads, a common model is to run the default event loop
316in your main thread (or in a separate thread) and for each thread you
317create, you also create another event loop. Libev itself does no locking
318whatsoever, so if you mix calls to the same event loop in different
319threads, make sure you lock (this is usually a bad idea, though, even if
320done correctly, because it's hideous and inefficient).
321.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 395.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
322.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 396.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
323This will initialise the default event loop if it hasn't been initialised 397This will initialise the default event loop if it hasn't been initialised
324yet and return it. If the default loop could not be initialised, returns 398yet and return it. If the default loop could not be initialised, returns
325false. If it already was initialised it simply returns it (and ignores the 399false. If it already was initialised it simply returns it (and ignores the
326flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). 400flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards).
327.Sp 401.Sp
328If you don't know what event loop to use, use the one returned from this 402If you don't know what event loop to use, use the one returned from this
329function. 403function.
404.Sp
405Note that this function is \fInot\fR thread-safe, so if you want to use it
406from multiple threads, you have to lock (note also that this is unlikely,
407as loops cannot bes hared easily between threads anyway).
408.Sp
409The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and
410\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler
411for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your app you can either
412create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you
413can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling
414\&\f(CW\*(C`ev_default_init\*(C'\fR.
330.Sp 415.Sp
331The flags argument can be used to specify special behaviour or specific 416The flags argument can be used to specify special behaviour or specific
332backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). 417backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
333.Sp 418.Sp
334The following flags are supported: 419The following flags are supported:
… …
345or setgid) then libev will \fInot\fR look at the environment variable 430or setgid) then libev will \fInot\fR look at the environment variable
346\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 431\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
347override the flags completely if it is found in the environment. This is 432override the flags completely if it is found in the environment. This is
348useful to try out specific backends to test their performance, or to work 433useful to try out specific backends to test their performance, or to work
349around bugs. 434around bugs.
435.ie n .IP """EVFLAG_FORKCHECK""" 4
436.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
437.IX Item "EVFLAG_FORKCHECK"
438Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after
439a fork, you can also make libev check for a fork in each iteration by
440enabling this flag.
441.Sp
442This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
443and thus this might slow down your event loop if you do a lot of loop
444iterations and little real work, but is usually not noticeable (on my
445GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
446without a syscall and thus \fIvery\fR fast, but my GNU/Linux system also has
447\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
448.Sp
449The big advantage of this flag is that you can forget about fork (and
450forget about forgetting to tell libev about forking) when you use this
451flag.
452.Sp
453This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
454environment variable.
350.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 455.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
351.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 456.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
352.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 457.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
353This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 458This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
354libev tries to roll its own fd_set with no limits on the number of fds, 459libev tries to roll its own fd_set with no limits on the number of fds,
355but if that fails, expect a fairly low limit on the number of fds when 460but if that fails, expect a fairly low limit on the number of fds when
356using this backend. It doesn't scale too well (O(highest_fd)), but its usually 461using this backend. It doesn't scale too well (O(highest_fd)), but its
357the fastest backend for a low number of fds. 462usually the fastest backend for a low number of (low-numbered :) fds.
463.Sp
464To get good performance out of this backend you need a high amount of
465parallelity (most of the file descriptors should be busy). If you are
466writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many
467connections as possible during one iteration. You might also want to have
468a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of
469readyness notifications you get per iteration.
358.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 470.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
359.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 471.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
360.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 472.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
361And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than 473And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
362select, but handles sparse fds better and has no artificial limit on the 474than select, but handles sparse fds better and has no artificial
363number of fds you can use (except it will slow down considerably with a 475limit on the number of fds you can use (except it will slow down
364lot of inactive fds). It scales similarly to select, i.e. O(total_fds). 476considerably with a lot of inactive fds). It scales similarly to select,
477i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
478performance tips.
365.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 479.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
366.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 480.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
367.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 481.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
368For few fds, this backend is a bit little slower than poll and select, 482For few fds, this backend is a bit little slower than poll and select,
369but it scales phenomenally better. While poll and select usually scale like 483but it scales phenomenally better. While poll and select usually scale
370O(total_fds) where n is the total number of fds (or the highest fd), epoll scales 484like O(total_fds) where n is the total number of fds (or the highest fd),
371either O(1) or O(active_fds). 485epoll scales either O(1) or O(active_fds). The epoll design has a number
486of shortcomings, such as silently dropping events in some hard-to-detect
487cases and requiring a syscall per fd change, no fork support and bad
488support for dup.
372.Sp 489.Sp
373While stopping and starting an I/O watcher in the same iteration will 490While stopping, setting and starting an I/O watcher in the same iteration
374result in some caching, there is still a syscall per such incident 491will result in some caching, there is still a syscall per such incident
375(because the fd could point to a different file description now), so its 492(because the fd could point to a different file description now), so its
376best to avoid that. Also, \fIdup()\fRed file descriptors might not work very 493best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work
377well if you register events for both fds. 494very well if you register events for both fds.
378.Sp 495.Sp
379Please note that epoll sometimes generates spurious notifications, so you 496Please note that epoll sometimes generates spurious notifications, so you
380need to use non-blocking I/O or other means to avoid blocking when no data 497need to use non-blocking I/O or other means to avoid blocking when no data
381(or space) is available. 498(or space) is available.
499.Sp
500Best performance from this backend is achieved by not unregistering all
501watchers for a file descriptor until it has been closed, if possible, i.e.
502keep at least one watcher active per fd at all times.
503.Sp
504While nominally embeddeble in other event loops, this feature is broken in
505all kernel versions tested so far.
382.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 506.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
383.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 507.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
384.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 508.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
385Kqueue deserves special mention, as at the time of this writing, it 509Kqueue deserves special mention, as at the time of this writing, it
386was broken on all BSDs except NetBSD (usually it doesn't work with 510was broken on all BSDs except NetBSD (usually it doesn't work reliably
387anything but sockets and pipes, except on Darwin, where of course its 511with anything but sockets and pipes, except on Darwin, where of course
388completely useless). For this reason its not being \*(L"autodetected\*(R" 512it's completely useless). For this reason it's not being \*(L"autodetected\*(R"
389unless you explicitly specify it explicitly in the flags (i.e. using 513unless you explicitly specify it explicitly in the flags (i.e. using
390\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). 514\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough)
515system like NetBSD.
516.Sp
517You still can embed kqueue into a normal poll or select backend and use it
518only for sockets (after having made sure that sockets work with kqueue on
519the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
391.Sp 520.Sp
392It scales in the same way as the epoll backend, but the interface to the 521It scales in the same way as the epoll backend, but the interface to the
393kernel is more efficient (which says nothing about its actual speed, of 522kernel is more efficient (which says nothing about its actual speed, of
394course). While starting and stopping an I/O watcher does not cause an 523course). While stopping, setting and starting an I/O watcher does never
395extra syscall as with epoll, it still adds up to four event changes per 524cause an extra syscall as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
396incident, so its best to avoid that. 525two event changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it
526drops fds silently in similarly hard-to-detect cases.
527.Sp
528This backend usually performs well under most conditions.
529.Sp
530While nominally embeddable in other event loops, this doesn't work
531everywhere, so you might need to test for this. And since it is broken
532almost everywhere, you should only use it when you have a lot of sockets
533(for which it usually works), by embedding it into another event loop
534(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR) and using it only for
535sockets.
397.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 536.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
398.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 537.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4
399.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" 538.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)"
400This is not implemented yet (and might never be). 539This is not implemented yet (and might never be, unless you send me an
540implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
541and is not embeddable, which would limit the usefulness of this backend
542immensely.
401.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 543.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
402.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 544.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
403.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 545.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
404This uses the Solaris 10 port mechanism. As with everything on Solaris, 546This uses the Solaris 10 event port mechanism. As with everything on Solaris,
405it's really slow, but it still scales very well (O(active_fds)). 547it's really slow, but it still scales very well (O(active_fds)).
406.Sp 548.Sp
407Please note that solaris ports can result in a lot of spurious 549Please note that solaris event ports can deliver a lot of spurious
408notifications, so you need to use non-blocking I/O or other means to avoid 550notifications, so you need to use non-blocking I/O or other means to avoid
409blocking when no data (or space) is available. 551blocking when no data (or space) is available.
552.Sp
553While this backend scales well, it requires one system call per active
554file descriptor per loop iteration. For small and medium numbers of file
555descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
556might perform better.
557.Sp
558On the positive side, ignoring the spurious readyness notifications, this
559backend actually performed to specification in all tests and is fully
560embeddable, which is a rare feat among the OS-specific backends.
410.ie n .IP """EVBACKEND_ALL""" 4 561.ie n .IP """EVBACKEND_ALL""" 4
411.el .IP "\f(CWEVBACKEND_ALL\fR" 4 562.el .IP "\f(CWEVBACKEND_ALL\fR" 4
412.IX Item "EVBACKEND_ALL" 563.IX Item "EVBACKEND_ALL"
413Try all backends (even potentially broken ones that wouldn't be tried 564Try all backends (even potentially broken ones that wouldn't be tried
414with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 565with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
415\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. 566\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.
567.Sp
568It is definitely not recommended to use this flag.
416.RE 569.RE
417.RS 4 570.RS 4
418.Sp 571.Sp
419If one or more of these are ored into the flags value, then only these 572If one or more of these are ored into the flags value, then only these
420backends will be tried (in the reverse order as given here). If none are 573backends will be tried (in the reverse order as listed here). If none are
421specified, most compiled-in backend will be tried, usually in reverse 574specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried.
422order of their flag values :)
423.Sp 575.Sp
424The most typical usage is like this: 576The most typical usage is like this:
425.Sp 577.Sp
426.Vb 2 578.Vb 2
427\& if (!ev_default_loop (0)) 579\& if (!ev_default_loop (0))
… …
448Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is 600Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
449always distinct from the default loop. Unlike the default loop, it cannot 601always distinct from the default loop. Unlike the default loop, it cannot
450handle signal and child watchers, and attempts to do so will be greeted by 602handle signal and child watchers, and attempts to do so will be greeted by
451undefined behaviour (or a failed assertion if assertions are enabled). 603undefined behaviour (or a failed assertion if assertions are enabled).
452.Sp 604.Sp
605Note that this function \fIis\fR thread-safe, and the recommended way to use
606libev with threads is indeed to create one loop per thread, and using the
607default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
608.Sp
453Example: try to create a event loop that uses epoll and nothing else. 609Example: Try to create a event loop that uses epoll and nothing else.
454.Sp 610.Sp
455.Vb 3 611.Vb 3
456\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 612\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
457\& if (!epoller) 613\& if (!epoller)
458\& fatal ("no epoll found here, maybe it hides under your chair"); 614\& fatal ("no epoll found here, maybe it hides under your chair");
459.Ve 615.Ve
460.IP "ev_default_destroy ()" 4 616.IP "ev_default_destroy ()" 4
461.IX Item "ev_default_destroy ()" 617.IX Item "ev_default_destroy ()"
462Destroys the default loop again (frees all memory and kernel state 618Destroys the default loop again (frees all memory and kernel state
463etc.). This stops all registered event watchers (by not touching them in 619etc.). None of the active event watchers will be stopped in the normal
464any way whatsoever, although you cannot rely on this :). 620sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your
621responsibility to either stop all watchers cleanly yoursef \fIbefore\fR
622calling this function, or cope with the fact afterwards (which is usually
623the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
624for example).
625.Sp
626Note that certain global state, such as signal state, will not be freed by
627this function, and related watchers (such as signal and child watchers)
628would need to be stopped manually.
629.Sp
630In general it is not advisable to call this function except in the
631rare occasion where you really need to free e.g. the signal handling
632pipe fds. If you need dynamically allocated loops it is better to use
633\&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR).
465.IP "ev_loop_destroy (loop)" 4 634.IP "ev_loop_destroy (loop)" 4
466.IX Item "ev_loop_destroy (loop)" 635.IX Item "ev_loop_destroy (loop)"
467Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an 636Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an
468earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. 637earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR.
469.IP "ev_default_fork ()" 4 638.IP "ev_default_fork ()" 4
470.IX Item "ev_default_fork ()" 639.IX Item "ev_default_fork ()"
640This function sets a flag that causes subsequent \f(CW\*(C`ev_loop\*(C'\fR iterations
471This function reinitialises the kernel state for backends that have 641to reinitialise the kernel state for backends that have one. Despite the
472one. Despite the name, you can call it anytime, but it makes most sense 642name, you can call it anytime, but it makes most sense after forking, in
473after forking, in either the parent or child process (or both, but that 643the child process (or both child and parent, but that again makes little
474again makes little sense). 644sense). You \fImust\fR call it in the child before using any of the libev
645functions, and it will only take effect at the next \f(CW\*(C`ev_loop\*(C'\fR iteration.
475.Sp 646.Sp
476You \fImust\fR call this function in the child process after forking if and 647On the other hand, you only need to call this function in the child
477only if you want to use the event library in both processes. If you just 648process if and only if you want to use the event library in the child. If
478fork+exec, you don't have to call it. 649you just fork+exec, you don't have to call it at all.
479.Sp 650.Sp
480The function itself is quite fast and it's usually not a problem to call 651The function itself is quite fast and it's usually not a problem to call
481it just in case after a fork. To make this easy, the function will fit in 652it just in case after a fork. To make this easy, the function will fit in
482quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR: 653quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR:
483.Sp 654.Sp
484.Vb 1 655.Vb 1
485\& pthread_atfork (0, 0, ev_default_fork); 656\& pthread_atfork (0, 0, ev_default_fork);
486.Ve 657.Ve
487.Sp
488At the moment, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR are safe to use
489without calling this function, so if you force one of those backends you
490do not need to care.
491.IP "ev_loop_fork (loop)" 4 658.IP "ev_loop_fork (loop)" 4
492.IX Item "ev_loop_fork (loop)" 659.IX Item "ev_loop_fork (loop)"
493Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 660Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
494\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 661\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
495after fork, and how you do this is entirely your own problem. 662after fork, and how you do this is entirely your own problem.
663.IP "int ev_is_default_loop (loop)" 4
664.IX Item "int ev_is_default_loop (loop)"
665Returns true when the given loop actually is the default loop, false otherwise.
666.IP "unsigned int ev_loop_count (loop)" 4
667.IX Item "unsigned int ev_loop_count (loop)"
668Returns the count of loop iterations for the loop, which is identical to
669the number of times libev did poll for new events. It starts at \f(CW0\fR and
670happily wraps around with enough iterations.
671.Sp
672This value can sometimes be useful as a generation counter of sorts (it
673\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
674\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls.
496.IP "unsigned int ev_backend (loop)" 4 675.IP "unsigned int ev_backend (loop)" 4
497.IX Item "unsigned int ev_backend (loop)" 676.IX Item "unsigned int ev_backend (loop)"
498Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 677Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
499use. 678use.
500.IP "ev_tstamp ev_now (loop)" 4 679.IP "ev_tstamp ev_now (loop)" 4
501.IX Item "ev_tstamp ev_now (loop)" 680.IX Item "ev_tstamp ev_now (loop)"
502Returns the current \*(L"event loop time\*(R", which is the time the event loop 681Returns the current \*(L"event loop time\*(R", which is the time the event loop
503received events and started processing them. This timestamp does not 682received events and started processing them. This timestamp does not
504change as long as callbacks are being processed, and this is also the base 683change as long as callbacks are being processed, and this is also the base
505time used for relative timers. You can treat it as the timestamp of the 684time used for relative timers. You can treat it as the timestamp of the
506event occuring (or more correctly, libev finding out about it). 685event occurring (or more correctly, libev finding out about it).
507.IP "ev_loop (loop, int flags)" 4 686.IP "ev_loop (loop, int flags)" 4
508.IX Item "ev_loop (loop, int flags)" 687.IX Item "ev_loop (loop, int flags)"
509Finally, this is it, the event handler. This function usually is called 688Finally, this is it, the event handler. This function usually is called
510after you initialised all your watchers and you want to start handling 689after you initialised all your watchers and you want to start handling
511events. 690events.
… …
531libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 710libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
532usually a better approach for this kind of thing. 711usually a better approach for this kind of thing.
533.Sp 712.Sp
534Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 713Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
535.Sp 714.Sp
536.Vb 18 715.Vb 10
537\& * If there are no active watchers (reference count is zero), return. 716\& \- Before the first iteration, call any pending watchers.
538\& - Queue prepare watchers and then call all outstanding watchers. 717\& * If EVFLAG_FORKCHECK was used, check for a fork.
718\& \- If a fork was detected, queue and call all fork watchers.
719\& \- Queue and call all prepare watchers.
539\& - If we have been forked, recreate the kernel state. 720\& \- If we have been forked, recreate the kernel state.
540\& - Update the kernel state with all outstanding changes. 721\& \- Update the kernel state with all outstanding changes.
541\& - Update the "event loop time". 722\& \- Update the "event loop time".
542\& - Calculate for how long to block. 723\& \- Calculate for how long to sleep or block, if at all
724\& (active idle watchers, EVLOOP_NONBLOCK or not having
725\& any active watchers at all will result in not sleeping).
726\& \- Sleep if the I/O and timer collect interval say so.
543\& - Block the process, waiting for any events. 727\& \- Block the process, waiting for any events.
544\& - Queue all outstanding I/O (fd) events. 728\& \- Queue all outstanding I/O (fd) events.
545\& - Update the "event loop time" and do time jump handling. 729\& \- Update the "event loop time" and do time jump handling.
546\& - Queue all outstanding timers. 730\& \- Queue all outstanding timers.
547\& - Queue all outstanding periodics. 731\& \- Queue all outstanding periodics.
548\& - If no events are pending now, queue all idle watchers. 732\& \- If no events are pending now, queue all idle watchers.
549\& - Queue all check watchers. 733\& \- Queue all check watchers.
550\& - Call all queued watchers in reverse order (i.e. check watchers first). 734\& \- Call all queued watchers in reverse order (i.e. check watchers first).
551\& Signals and child watchers are implemented as I/O watchers, and will 735\& Signals and child watchers are implemented as I/O watchers, and will
552\& be handled here by queueing them when their watcher gets executed. 736\& be handled here by queueing them when their watcher gets executed.
553\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 737\& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
554\& were used, return, otherwise continue with step *. 738\& were used, or there are no active watchers, return, otherwise
739\& continue with step *.
555.Ve 740.Ve
556.Sp 741.Sp
557Example: queue some jobs and then loop until no events are outsanding 742Example: Queue some jobs and then loop until no events are outstanding
558anymore. 743anymore.
559.Sp 744.Sp
560.Vb 4 745.Vb 4
561\& ... queue jobs here, make sure they register event watchers as long 746\& ... queue jobs here, make sure they register event watchers as long
562\& ... as they still have work to do (even an idle watcher will do..) 747\& ... as they still have work to do (even an idle watcher will do..)
… …
567.IX Item "ev_unloop (loop, how)" 752.IX Item "ev_unloop (loop, how)"
568Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it 753Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it
569has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 754has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
570\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or 755\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or
571\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. 756\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return.
757.Sp
758This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again.
572.IP "ev_ref (loop)" 4 759.IP "ev_ref (loop)" 4
573.IX Item "ev_ref (loop)" 760.IX Item "ev_ref (loop)"
574.PD 0 761.PD 0
575.IP "ev_unref (loop)" 4 762.IP "ev_unref (loop)" 4
576.IX Item "ev_unref (loop)" 763.IX Item "ev_unref (loop)"
… …
582returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For 769returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For
583example, libev itself uses this for its internal signal pipe: It is not 770example, libev itself uses this for its internal signal pipe: It is not
584visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if 771visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if
585no event watchers registered by it are active. It is also an excellent 772no event watchers registered by it are active. It is also an excellent
586way to do this for generic recurring timers or from within third-party 773way to do this for generic recurring timers or from within third-party
587libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. 774libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR
775(but only if the watcher wasn't active before, or was active before,
776respectively).
588.Sp 777.Sp
589Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 778Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
590running when nothing else is active. 779running when nothing else is active.
591.Sp 780.Sp
592.Vb 4 781.Vb 4
593\& struct dv_signal exitsig; 782\& struct ev_signal exitsig;
594\& ev_signal_init (&exitsig, sig_cb, SIGINT); 783\& ev_signal_init (&exitsig, sig_cb, SIGINT);
595\& ev_signal_start (myloop, &exitsig); 784\& ev_signal_start (loop, &exitsig);
596\& evf_unref (myloop); 785\& evf_unref (loop);
597.Ve 786.Ve
598.Sp 787.Sp
599Example: for some weird reason, unregister the above signal handler again. 788Example: For some weird reason, unregister the above signal handler again.
600.Sp 789.Sp
601.Vb 2 790.Vb 2
602\& ev_ref (myloop); 791\& ev_ref (loop);
603\& ev_signal_stop (myloop, &exitsig); 792\& ev_signal_stop (loop, &exitsig);
604.Ve 793.Ve
794.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4
795.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)"
796.PD 0
797.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4
798.IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)"
799.PD
800These advanced functions influence the time that libev will spend waiting
801for events. Both are by default \f(CW0\fR, meaning that libev will try to
802invoke timer/periodic callbacks and I/O callbacks with minimum latency.
803.Sp
804Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR)
805allows libev to delay invocation of I/O and timer/periodic callbacks to
806increase efficiency of loop iterations.
807.Sp
808The background is that sometimes your program runs just fast enough to
809handle one (or very few) event(s) per loop iteration. While this makes
810the program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new
811events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high
812overhead for the actual polling but can deliver many events at once.
813.Sp
814By setting a higher \fIio collect interval\fR you allow libev to spend more
815time collecting I/O events, so you can handle more events per iteration,
816at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
817\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will
818introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations.
819.Sp
820Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
821to spend more time collecting timeouts, at the expense of increased
822latency (the watcher callback will be called later). \f(CW\*(C`ev_io\*(C'\fR watchers
823will not be affected. Setting this to a non-null value will not introduce
824any overhead in libev.
825.Sp
826Many (busy) programs can usually benefit by setting the io collect
827interval to a value near \f(CW0.1\fR or so, which is often enough for
828interactive servers (of course not for games), likewise for timeouts. It
829usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR,
830as this approsaches the timing granularity of most systems.
605.SH "ANATOMY OF A WATCHER" 831.SH "ANATOMY OF A WATCHER"
606.IX Header "ANATOMY OF A WATCHER" 832.IX Header "ANATOMY OF A WATCHER"
607A watcher is a structure that you create and register to record your 833A watcher is a structure that you create and register to record your
608interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 834interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to
609become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: 835become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that:
… …
612\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 838\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
613\& { 839\& {
614\& ev_io_stop (w); 840\& ev_io_stop (w);
615\& ev_unloop (loop, EVUNLOOP_ALL); 841\& ev_unloop (loop, EVUNLOOP_ALL);
616\& } 842\& }
617.Ve 843\&
618.PP
619.Vb 6
620\& struct ev_loop *loop = ev_default_loop (0); 844\& struct ev_loop *loop = ev_default_loop (0);
621\& struct ev_io stdin_watcher; 845\& struct ev_io stdin_watcher;
622\& ev_init (&stdin_watcher, my_cb); 846\& ev_init (&stdin_watcher, my_cb);
623\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 847\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
624\& ev_io_start (loop, &stdin_watcher); 848\& ev_io_start (loop, &stdin_watcher);
… …
645*)\*(C'\fR), and you can stop watching for events at any time by calling the 869*)\*(C'\fR), and you can stop watching for events at any time by calling the
646corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. 870corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR.
647.PP 871.PP
648As long as your watcher is active (has been started but not stopped) you 872As long as your watcher is active (has been started but not stopped) you
649must not touch the values stored in it. Most specifically you must never 873must not touch the values stored in it. Most specifically you must never
650reinitialise it or call its set macro. 874reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro.
651.PP
652You can check whether an event is active by calling the \f(CW\*(C`ev_is_active
653(watcher *)\*(C'\fR macro. To see whether an event is outstanding (but the
654callback for it has not been called yet) you can use the \f(CW\*(C`ev_is_pending
655(watcher *)\*(C'\fR macro.
656.PP 875.PP
657Each and every callback receives the event loop pointer as first, the 876Each and every callback receives the event loop pointer as first, the
658registered watcher structure as second, and a bitset of received events as 877registered watcher structure as second, and a bitset of received events as
659third argument. 878third argument.
660.PP 879.PP
… …
685The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. 904The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread.
686.ie n .IP """EV_CHILD""" 4 905.ie n .IP """EV_CHILD""" 4
687.el .IP "\f(CWEV_CHILD\fR" 4 906.el .IP "\f(CWEV_CHILD\fR" 4
688.IX Item "EV_CHILD" 907.IX Item "EV_CHILD"
689The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. 908The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change.
909.ie n .IP """EV_STAT""" 4
910.el .IP "\f(CWEV_STAT\fR" 4
911.IX Item "EV_STAT"
912The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow.
690.ie n .IP """EV_IDLE""" 4 913.ie n .IP """EV_IDLE""" 4
691.el .IP "\f(CWEV_IDLE\fR" 4 914.el .IP "\f(CWEV_IDLE\fR" 4
692.IX Item "EV_IDLE" 915.IX Item "EV_IDLE"
693The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. 916The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do.
694.ie n .IP """EV_PREPARE""" 4 917.ie n .IP """EV_PREPARE""" 4
… …
704\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 927\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any
705received events. Callbacks of both watcher types can start and stop as 928received events. Callbacks of both watcher types can start and stop as
706many watchers as they want, and all of them will be taken into account 929many watchers as they want, and all of them will be taken into account
707(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 930(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep
708\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 931\&\f(CW\*(C`ev_loop\*(C'\fR from blocking).
932.ie n .IP """EV_EMBED""" 4
933.el .IP "\f(CWEV_EMBED\fR" 4
934.IX Item "EV_EMBED"
935The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
936.ie n .IP """EV_FORK""" 4
937.el .IP "\f(CWEV_FORK\fR" 4
938.IX Item "EV_FORK"
939The event loop has been resumed in the child process after fork (see
940\&\f(CW\*(C`ev_fork\*(C'\fR).
941.ie n .IP """EV_ASYNC""" 4
942.el .IP "\f(CWEV_ASYNC\fR" 4
943.IX Item "EV_ASYNC"
944The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
709.ie n .IP """EV_ERROR""" 4 945.ie n .IP """EV_ERROR""" 4
710.el .IP "\f(CWEV_ERROR\fR" 4 946.el .IP "\f(CWEV_ERROR\fR" 4
711.IX Item "EV_ERROR" 947.IX Item "EV_ERROR"
712An unspecified error has occured, the watcher has been stopped. This might 948An unspecified error has occured, the watcher has been stopped. This might
713happen because the watcher could not be properly started because libev 949happen because the watcher could not be properly started because libev
… …
718Libev will usually signal a few \*(L"dummy\*(R" events together with an error, 954Libev will usually signal a few \*(L"dummy\*(R" events together with an error,
719for example it might indicate that a fd is readable or writable, and if 955for example it might indicate that a fd is readable or writable, and if
720your callbacks is well-written it can just attempt the operation and cope 956your callbacks is well-written it can just attempt the operation and cope
721with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded 957with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded
722programs, though, so beware. 958programs, though, so beware.
959.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
960.IX Subsection "GENERIC WATCHER FUNCTIONS"
961In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type,
962e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers.
963.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
964.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
965.IX Item "ev_init (ev_TYPE *watcher, callback)"
966This macro initialises the generic portion of a watcher. The contents
967of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only
968the generic parts of the watcher are initialised, you \fIneed\fR to call
969the type-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR macro afterwards to initialise the
970type-specific parts. For each type there is also a \f(CW\*(C`ev_TYPE_init\*(C'\fR macro
971which rolls both calls into one.
972.Sp
973You can reinitialise a watcher at any time as long as it has been stopped
974(or never started) and there are no pending events outstanding.
975.Sp
976The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher,
977int revents)\*(C'\fR.
978.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4
979.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4
980.IX Item "ev_TYPE_set (ev_TYPE *, [args])"
981This macro initialises the type-specific parts of a watcher. You need to
982call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
983call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this
984macro on a watcher that is active (it can be pending, however, which is a
985difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
986.Sp
987Although some watcher types do not have type-specific arguments
988(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro.
989.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4
990.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4
991.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])"
992This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro
993calls into a single call. This is the most convinient method to initialise
994a watcher. The same limitations apply, of course.
995.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4
996.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4
997.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)"
998Starts (activates) the given watcher. Only active watchers will receive
999events. If the watcher is already active nothing will happen.
1000.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4
1001.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4
1002.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)"
1003Stops the given watcher again (if active) and clears the pending
1004status. It is possible that stopped watchers are pending (for example,
1005non-repeating timers are being stopped when they become pending), but
1006\&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If
1007you want to free or reuse the memory used by the watcher it is therefore a
1008good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
1009.IP "bool ev_is_active (ev_TYPE *watcher)" 4
1010.IX Item "bool ev_is_active (ev_TYPE *watcher)"
1011Returns a true value iff the watcher is active (i.e. it has been started
1012and not yet been stopped). As long as a watcher is active you must not modify
1013it.
1014.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
1015.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
1016Returns a true value iff the watcher is pending, (i.e. it has outstanding
1017events but its callback has not yet been invoked). As long as a watcher
1018is pending (but not active) you must not call an init function on it (but
1019\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
1020make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1021it).
1022.IP "callback ev_cb (ev_TYPE *watcher)" 4
1023.IX Item "callback ev_cb (ev_TYPE *watcher)"
1024Returns the callback currently set on the watcher.
1025.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
1026.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
1027Change the callback. You can change the callback at virtually any time
1028(modulo threads).
1029.IP "ev_set_priority (ev_TYPE *watcher, priority)" 4
1030.IX Item "ev_set_priority (ev_TYPE *watcher, priority)"
1031.PD 0
1032.IP "int ev_priority (ev_TYPE *watcher)" 4
1033.IX Item "int ev_priority (ev_TYPE *watcher)"
1034.PD
1035Set and query the priority of the watcher. The priority is a small
1036integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
1037(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
1038before watchers with lower priority, but priority will not keep watchers
1039from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
1040.Sp
1041This means that priorities are \fIonly\fR used for ordering callback
1042invocation after new events have been received. This is useful, for
1043example, to reduce latency after idling, or more often, to bind two
1044watchers on the same event and make sure one is called first.
1045.Sp
1046If you need to suppress invocation when higher priority events are pending
1047you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
1048.Sp
1049You \fImust not\fR change the priority of a watcher as long as it is active or
1050pending.
1051.Sp
1052The default priority used by watchers when no priority has been set is
1053always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1054.Sp
1055Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
1056fine, as long as you do not mind that the priority value you query might
1057or might not have been adjusted to be within valid range.
1058.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1059.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1060Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1061\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1062can deal with that fact.
1063.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
1064.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
1065If the watcher is pending, this function returns clears its pending status
1066and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
1067watcher isn't pending it does nothing and returns \f(CW0\fR.
723.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 1068.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
724.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 1069.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
725Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 1070Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
726and read at any time, libev will completely ignore it. This can be used 1071and read at any time, libev will completely ignore it. This can be used
727to associate arbitrary data with your watcher. If you need more data and 1072to associate arbitrary data with your watcher. If you need more data and
… …
748\& struct my_io *w = (struct my_io *)w_; 1093\& struct my_io *w = (struct my_io *)w_;
749\& ... 1094\& ...
750\& } 1095\& }
751.Ve 1096.Ve
752.PP 1097.PP
753More interesting and less C\-conformant ways of catsing your callback type 1098More interesting and less C\-conformant ways of casting your callback type
754have been omitted.... 1099instead have been omitted.
1100.PP
1101Another common scenario is having some data structure with multiple
1102watchers:
1103.PP
1104.Vb 6
1105\& struct my_biggy
1106\& {
1107\& int some_data;
1108\& ev_timer t1;
1109\& ev_timer t2;
1110\& }
1111.Ve
1112.PP
1113In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated,
1114you need to use \f(CW\*(C`offsetof\*(C'\fR:
1115.PP
1116.Vb 1
1117\& #include <stddef.h>
1118\&
1119\& static void
1120\& t1_cb (EV_P_ struct ev_timer *w, int revents)
1121\& {
1122\& struct my_biggy big = (struct my_biggy *
1123\& (((char *)w) \- offsetof (struct my_biggy, t1));
1124\& }
1125\&
1126\& static void
1127\& t2_cb (EV_P_ struct ev_timer *w, int revents)
1128\& {
1129\& struct my_biggy big = (struct my_biggy *
1130\& (((char *)w) \- offsetof (struct my_biggy, t2));
1131\& }
1132.Ve
755.SH "WATCHER TYPES" 1133.SH "WATCHER TYPES"
756.IX Header "WATCHER TYPES" 1134.IX Header "WATCHER TYPES"
757This section describes each watcher in detail, but will not repeat 1135This section describes each watcher in detail, but will not repeat
758information given in the last section. 1136information given in the last section. Any initialisation/set macros,
1137functions and members specific to the watcher type are explained.
1138.PP
1139Members are additionally marked with either \fI[read\-only]\fR, meaning that,
1140while the watcher is active, you can look at the member and expect some
1141sensible content, but you must not modify it (you can modify it while the
1142watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1143means you can expect it to have some sensible content while the watcher
1144is active, but you can also modify it. Modifying it may not do something
1145sensible or take immediate effect (or do anything at all), but libev will
1146not crash or malfunction in any way.
759.ie n .Sh """ev_io"" \- is this file descriptor readable or writable" 1147.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?"
760.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable" 1148.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?"
761.IX Subsection "ev_io - is this file descriptor readable or writable" 1149.IX Subsection "ev_io - is this file descriptor readable or writable?"
762I/O watchers check whether a file descriptor is readable or writable 1150I/O watchers check whether a file descriptor is readable or writable
763in each iteration of the event loop (This behaviour is called 1151in each iteration of the event loop, or, more precisely, when reading
764level-triggering because you keep receiving events as long as the 1152would not block the process and writing would at least be able to write
765condition persists. Remember you can stop the watcher if you don't want to 1153some data. This behaviour is called level-triggering because you keep
766act on the event and neither want to receive future events). 1154receiving events as long as the condition persists. Remember you can stop
1155the watcher if you don't want to act on the event and neither want to
1156receive future events.
767.PP 1157.PP
768In general you can register as many read and/or write event watchers per 1158In general you can register as many read and/or write event watchers per
769fd as you want (as long as you don't confuse yourself). Setting all file 1159fd as you want (as long as you don't confuse yourself). Setting all file
770descriptors to non-blocking mode is also usually a good idea (but not 1160descriptors to non-blocking mode is also usually a good idea (but not
771required if you know what you are doing). 1161required if you know what you are doing).
772.PP 1162.PP
773You have to be careful with dup'ed file descriptors, though. Some backends
774(the linux epoll backend is a notable example) cannot handle dup'ed file
775descriptors correctly if you register interest in two or more fds pointing
776to the same underlying file/socket etc. description (that is, they share
777the same underlying \*(L"file open\*(R").
778.PP
779If you must do this, then force the use of a known-to-be-good backend 1163If you must do this, then force the use of a known-to-be-good backend
780(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and 1164(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and
781\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1165\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
1166.PP
1167Another thing you have to watch out for is that it is quite easy to
1168receive \*(L"spurious\*(R" readyness notifications, that is your callback might
1169be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
1170because there is no data. Not only are some backends known to create a
1171lot of those (for example solaris ports), it is very easy to get into
1172this situation even with a relatively standard program structure. Thus
1173it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
1174\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives.
1175.PP
1176If you cannot run the fd in non-blocking mode (for example you should not
1177play around with an Xlib connection), then you have to seperately re-test
1178whether a file descriptor is really ready with a known-to-be good interface
1179such as poll (fortunately in our Xlib example, Xlib already does this on
1180its own, so its quite safe to use).
1181.PP
1182\fIThe special problem of disappearing file descriptors\fR
1183.IX Subsection "The special problem of disappearing file descriptors"
1184.PP
1185Some backends (e.g. kqueue, epoll) need to be told about closing a file
1186descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means,
1187such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file
1188descriptor, but when it goes away, the operating system will silently drop
1189this interest. If another file descriptor with the same number then is
1190registered with libev, there is no efficient way to see that this is, in
1191fact, a different file descriptor.
1192.PP
1193To avoid having to explicitly tell libev about such cases, libev follows
1194the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1195will assume that this is potentially a new file descriptor, otherwise
1196it is assumed that the file descriptor stays the same. That means that
1197you \fIhave\fR to call \f(CW\*(C`ev_io_set\*(C'\fR (or \f(CW\*(C`ev_io_init\*(C'\fR) when you change the
1198descriptor even if the file descriptor number itself did not change.
1199.PP
1200This is how one would do it normally anyway, the important point is that
1201the libev application should not optimise around libev but should leave
1202optimisations to libev.
1203.PP
1204\fIThe special problem of dup'ed file descriptors\fR
1205.IX Subsection "The special problem of dup'ed file descriptors"
1206.PP
1207Some backends (e.g. epoll), cannot register events for file descriptors,
1208but only events for the underlying file descriptions. That means when you
1209have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register
1210events for them, only one file descriptor might actually receive events.
1211.PP
1212There is no workaround possible except not registering events
1213for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1214\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1215.PP
1216\fIThe special problem of fork\fR
1217.IX Subsection "The special problem of fork"
1218.PP
1219Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit
1220useless behaviour. Libev fully supports fork, but needs to be told about
1221it in the child.
1222.PP
1223To support fork in your programs, you either have to call
1224\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child,
1225enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or
1226\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1227.PP
1228\fIThe special problem of \s-1SIGPIPE\s0\fR
1229.IX Subsection "The special problem of SIGPIPE"
1230.PP
1231While not really specific to libev, it is easy to forget about \s-1SIGPIPE:\s0
1232when reading from a pipe whose other end has been closed, your program
1233gets send a \s-1SIGPIPE\s0, which, by default, aborts your program. For most
1234programs this is sensible behaviour, for daemons, this is usually
1235undesirable.
1236.PP
1237So when you encounter spurious, unexplained daemon exits, make sure you
1238ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1239somewhere, as that would have given you a big clue).
1240.PP
1241\fIWatcher-Specific Functions\fR
1242.IX Subsection "Watcher-Specific Functions"
782.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1243.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
783.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1244.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
784.PD 0 1245.PD 0
785.IP "ev_io_set (ev_io *, int fd, int events)" 4 1246.IP "ev_io_set (ev_io *, int fd, int events)" 4
786.IX Item "ev_io_set (ev_io *, int fd, int events)" 1247.IX Item "ev_io_set (ev_io *, int fd, int events)"
787.PD 1248.PD
788Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The fd is the file descriptor to rceeive 1249Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
789events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_READ | 1250rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
790EV_WRITE\*(C'\fR to receive the given events. 1251\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events.
791.Sp 1252.IP "int fd [read\-only]" 4
792Please note that most of the more scalable backend mechanisms (for example 1253.IX Item "int fd [read-only]"
793epoll and solaris ports) can result in spurious readyness notifications 1254The file descriptor being watched.
794for file descriptors, so you practically need to use non-blocking I/O (and 1255.IP "int events [read\-only]" 4
795treat callback invocation as hint only), or retest separately with a safe 1256.IX Item "int events [read-only]"
796interface before doing I/O (XLib can do this), or force the use of either 1257The events being watched.
797\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR, which don't suffer from this
798problem. Also note that it is quite easy to have your callback invoked
799when the readyness condition is no longer valid even when employing
800typical ways of handling events, so its a good idea to use non-blocking
801I/O unconditionally.
802.PP 1258.PP
1259\fIExamples\fR
1260.IX Subsection "Examples"
1261.PP
803Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1262Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
804readable, but only once. Since it is likely line\-buffered, you could 1263readable, but only once. Since it is likely line-buffered, you could
805attempt to read a whole line in the callback: 1264attempt to read a whole line in the callback.
806.PP 1265.PP
807.Vb 6 1266.Vb 6
808\& static void 1267\& static void
809\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1268\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
810\& { 1269\& {
811\& ev_io_stop (loop, w); 1270\& ev_io_stop (loop, w);
812\& .. read from stdin here (or from w->fd) and haqndle any I/O errors 1271\& .. read from stdin here (or from w\->fd) and haqndle any I/O errors
813\& } 1272\& }
814.Ve 1273\&
815.PP
816.Vb 6
817\& ... 1274\& ...
818\& struct ev_loop *loop = ev_default_init (0); 1275\& struct ev_loop *loop = ev_default_init (0);
819\& struct ev_io stdin_readable; 1276\& struct ev_io stdin_readable;
820\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1277\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
821\& ev_io_start (loop, &stdin_readable); 1278\& ev_io_start (loop, &stdin_readable);
822\& ev_loop (loop, 0); 1279\& ev_loop (loop, 0);
823.Ve 1280.Ve
824.ie n .Sh """ev_timer"" \- relative and optionally recurring timeouts" 1281.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts"
825.el .Sh "\f(CWev_timer\fP \- relative and optionally recurring timeouts" 1282.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
826.IX Subsection "ev_timer - relative and optionally recurring timeouts" 1283.IX Subsection "ev_timer - relative and optionally repeating timeouts"
827Timer watchers are simple relative timers that generate an event after a 1284Timer watchers are simple relative timers that generate an event after a
828given time, and optionally repeating in regular intervals after that. 1285given time, and optionally repeating in regular intervals after that.
829.PP 1286.PP
830The timers are based on real time, that is, if you register an event that 1287The timers are based on real time, that is, if you register an event that
831times out after an hour and you reset your system clock to last years 1288times out after an hour and you reset your system clock to last years
… …
838of the event triggering whatever timeout you are modifying/starting. If 1295of the event triggering whatever timeout you are modifying/starting. If
839you suspect event processing to be delayed and you \fIneed\fR to base the timeout 1296you suspect event processing to be delayed and you \fIneed\fR to base the timeout
840on the current time, use something like this to adjust for this: 1297on the current time, use something like this to adjust for this:
841.PP 1298.PP
842.Vb 1 1299.Vb 1
843\& ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1300\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.);
844.Ve 1301.Ve
845.PP 1302.PP
846The callback is guarenteed to be invoked only when its timeout has passed, 1303The callback is guarenteed to be invoked only when its timeout has passed,
847but if multiple timers become ready during the same loop iteration then 1304but if multiple timers become ready during the same loop iteration then
848order of execution is undefined. 1305order of execution is undefined.
1306.PP
1307\fIWatcher-Specific Functions and Data Members\fR
1308.IX Subsection "Watcher-Specific Functions and Data Members"
849.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 1309.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
850.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 1310.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
851.PD 0 1311.PD 0
852.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 1312.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
853.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 1313.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
… …
860The timer itself will do a best-effort at avoiding drift, that is, if you 1320The timer itself will do a best-effort at avoiding drift, that is, if you
861configure a timer to trigger every 10 seconds, then it will trigger at 1321configure a timer to trigger every 10 seconds, then it will trigger at
862exactly 10 second intervals. If, however, your program cannot keep up with 1322exactly 10 second intervals. If, however, your program cannot keep up with
863the timer (because it takes longer than those 10 seconds to do stuff) the 1323the timer (because it takes longer than those 10 seconds to do stuff) the
864timer will not fire more than once per event loop iteration. 1324timer will not fire more than once per event loop iteration.
865.IP "ev_timer_again (loop)" 4 1325.IP "ev_timer_again (loop, ev_timer *)" 4
866.IX Item "ev_timer_again (loop)" 1326.IX Item "ev_timer_again (loop, ev_timer *)"
867This will act as if the timer timed out and restart it again if it is 1327This will act as if the timer timed out and restart it again if it is
868repeating. The exact semantics are: 1328repeating. The exact semantics are:
869.Sp 1329.Sp
1330If the timer is pending, its pending status is cleared.
1331.Sp
870If the timer is started but nonrepeating, stop it. 1332If the timer is started but nonrepeating, stop it (as if it timed out).
871.Sp 1333.Sp
872If the timer is repeating, either start it if necessary (with the repeat 1334If the timer is repeating, either start it if necessary (with the
873value), or reset the running timer to the repeat value. 1335\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
874.Sp 1336.Sp
875This sounds a bit complicated, but here is a useful and typical 1337This sounds a bit complicated, but here is a useful and typical
876example: Imagine you have a tcp connection and you want a so-called idle 1338example: Imagine you have a tcp connection and you want a so-called idle
877timeout, that is, you want to be called when there have been, say, 60 1339timeout, that is, you want to be called when there have been, say, 60
878seconds of inactivity on the socket. The easiest way to do this is to 1340seconds of inactivity on the socket. The easiest way to do this is to
879configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_timer_again each 1341configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
880time you successfully read or write some data. If you go into an idle 1342\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
881state where you do not expect data to travel on the socket, you can stop 1343you go into an idle state where you do not expect data to travel on the
882the timer, and again will automatically restart it if need be. 1344socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
1345automatically restart it if need be.
1346.Sp
1347That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR
1348altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR:
1349.Sp
1350.Vb 8
1351\& ev_timer_init (timer, callback, 0., 5.);
1352\& ev_timer_again (loop, timer);
1353\& ...
1354\& timer\->again = 17.;
1355\& ev_timer_again (loop, timer);
1356\& ...
1357\& timer\->again = 10.;
1358\& ev_timer_again (loop, timer);
1359.Ve
1360.Sp
1361This is more slightly efficient then stopping/starting the timer each time
1362you want to modify its timeout value.
1363.IP "ev_tstamp repeat [read\-write]" 4
1364.IX Item "ev_tstamp repeat [read-write]"
1365The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1366or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1367which is also when any modifications are taken into account.
883.PP 1368.PP
1369\fIExamples\fR
1370.IX Subsection "Examples"
1371.PP
884Example: create a timer that fires after 60 seconds. 1372Example: Create a timer that fires after 60 seconds.
885.PP 1373.PP
886.Vb 5 1374.Vb 5
887\& static void 1375\& static void
888\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1376\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
889\& { 1377\& {
890\& .. one minute over, w is actually stopped right here 1378\& .. one minute over, w is actually stopped right here
891\& } 1379\& }
892.Ve 1380\&
893.PP
894.Vb 3
895\& struct ev_timer mytimer; 1381\& struct ev_timer mytimer;
896\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1382\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
897\& ev_timer_start (loop, &mytimer); 1383\& ev_timer_start (loop, &mytimer);
898.Ve 1384.Ve
899.PP 1385.PP
900Example: create a timeout timer that times out after 10 seconds of 1386Example: Create a timeout timer that times out after 10 seconds of
901inactivity. 1387inactivity.
902.PP 1388.PP
903.Vb 5 1389.Vb 5
904\& static void 1390\& static void
905\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1391\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
906\& { 1392\& {
907\& .. ten seconds without any activity 1393\& .. ten seconds without any activity
908\& } 1394\& }
909.Ve 1395\&
910.PP
911.Vb 4
912\& struct ev_timer mytimer; 1396\& struct ev_timer mytimer;
913\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 1397\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
914\& ev_timer_again (&mytimer); /* start timer */ 1398\& ev_timer_again (&mytimer); /* start timer */
915\& ev_loop (loop, 0); 1399\& ev_loop (loop, 0);
916.Ve 1400\&
917.PP
918.Vb 3
919\& // and in some piece of code that gets executed on any "activity": 1401\& // and in some piece of code that gets executed on any "activity":
920\& // reset the timeout to start ticking again at 10 seconds 1402\& // reset the timeout to start ticking again at 10 seconds
921\& ev_timer_again (&mytimer); 1403\& ev_timer_again (&mytimer);
922.Ve 1404.Ve
923.ie n .Sh """ev_periodic"" \- to cron or not to cron" 1405.ie n .Sh """ev_periodic"" \- to cron or not to cron?"
924.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron" 1406.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?"
925.IX Subsection "ev_periodic - to cron or not to cron" 1407.IX Subsection "ev_periodic - to cron or not to cron?"
926Periodic watchers are also timers of a kind, but they are very versatile 1408Periodic watchers are also timers of a kind, but they are very versatile
927(and unfortunately a bit complex). 1409(and unfortunately a bit complex).
928.PP 1410.PP
929Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 1411Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time)
930but on wallclock time (absolute time). You can tell a periodic watcher 1412but on wallclock time (absolute time). You can tell a periodic watcher
931to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a 1413to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a
932periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () 1414periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now ()
933+ 10.>) and then reset your system clock to the last year, then it will 1415+ 10.\*(C'\fR) and then reset your system clock to the last year, then it will
934take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger 1416take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger
935roughly 10 seconds later and of course not if you reset your system time 1417roughly 10 seconds later).
936again).
937.PP 1418.PP
938They can also be used to implement vastly more complex timers, such as 1419They can also be used to implement vastly more complex timers, such as
939triggering an event on eahc midnight, local time. 1420triggering an event on each midnight, local time or other, complicated,
1421rules.
940.PP 1422.PP
941As with timers, the callback is guarenteed to be invoked only when the 1423As with timers, the callback is guarenteed to be invoked only when the
942time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready 1424time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready
943during the same loop iteration then order of execution is undefined. 1425during the same loop iteration then order of execution is undefined.
1426.PP
1427\fIWatcher-Specific Functions and Data Members\fR
1428.IX Subsection "Watcher-Specific Functions and Data Members"
944.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 1429.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4
945.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 1430.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)"
946.PD 0 1431.PD 0
947.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 1432.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4
948.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 1433.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)"
949.PD 1434.PD
950Lots of arguments, lets sort it out... There are basically three modes of 1435Lots of arguments, lets sort it out... There are basically three modes of
951operation, and we will explain them from simplest to complex: 1436operation, and we will explain them from simplest to complex:
952.RS 4 1437.RS 4
1438.IP "\(bu" 4
953.IP "* absolute timer (interval = reschedule_cb = 0)" 4 1439absolute timer (at = time, interval = reschedule_cb = 0)
954.IX Item "absolute timer (interval = reschedule_cb = 0)" 1440.Sp
955In this configuration the watcher triggers an event at the wallclock time 1441In this configuration the watcher triggers an event at the wallclock time
956\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, 1442\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs,
957that is, if it is to be run at January 1st 2011 then it will run when the 1443that is, if it is to be run at January 1st 2011 then it will run when the
958system time reaches or surpasses this time. 1444system time reaches or surpasses this time.
1445.IP "\(bu" 4
959.IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 1446repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
960.IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" 1447.Sp
961In this mode the watcher will always be scheduled to time out at the next 1448In this mode the watcher will always be scheduled to time out at the next
962\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless 1449\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative)
963of any time jumps. 1450and then repeat, regardless of any time jumps.
964.Sp 1451.Sp
965This can be used to create timers that do not drift with respect to system 1452This can be used to create timers that do not drift with respect to system
966time: 1453time:
967.Sp 1454.Sp
968.Vb 1 1455.Vb 1
… …
975by 3600. 1462by 3600.
976.Sp 1463.Sp
977Another way to think about it (for the mathematically inclined) is that 1464Another way to think about it (for the mathematically inclined) is that
978\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 1465\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
979time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 1466time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps.
980.IP "* manual reschedule mode (reschedule_cb = callback)" 4 1467.Sp
981.IX Item "manual reschedule mode (reschedule_cb = callback)" 1468For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near
1469\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
1470this value.
1471.IP "\(bu" 4
1472manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1473.Sp
982In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 1474In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being
983ignored. Instead, each time the periodic watcher gets scheduled, the 1475ignored. Instead, each time the periodic watcher gets scheduled, the
984reschedule callback will be called with the watcher as first, and the 1476reschedule callback will be called with the watcher as first, and the
985current time as second argument. 1477current time as second argument.
986.Sp 1478.Sp
987\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, 1479\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher,
988ever, or make any event loop modifications\fR. If you need to stop it, 1480ever, or make any event loop modifications\fR. If you need to stop it,
989return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by 1481return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by
990starting a prepare watcher). 1482starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal).
991.Sp 1483.Sp
992Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1484Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
993ev_tstamp now)\*(C'\fR, e.g.: 1485ev_tstamp now)\*(C'\fR, e.g.:
994.Sp 1486.Sp
995.Vb 4 1487.Vb 4
… …
1019.IX Item "ev_periodic_again (loop, ev_periodic *)" 1511.IX Item "ev_periodic_again (loop, ev_periodic *)"
1020Simply stops and restarts the periodic watcher again. This is only useful 1512Simply stops and restarts the periodic watcher again. This is only useful
1021when you changed some parameters or the reschedule callback would return 1513when you changed some parameters or the reschedule callback would return
1022a different time than the last time it was called (e.g. in a crond like 1514a different time than the last time it was called (e.g. in a crond like
1023program when the crontabs have changed). 1515program when the crontabs have changed).
1516.IP "ev_tstamp offset [read\-write]" 4
1517.IX Item "ev_tstamp offset [read-write]"
1518When repeating, this contains the offset value, otherwise this is the
1519absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR).
1520.Sp
1521Can be modified any time, but changes only take effect when the periodic
1522timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1523.IP "ev_tstamp interval [read\-write]" 4
1524.IX Item "ev_tstamp interval [read-write]"
1525The current interval value. Can be modified any time, but changes only
1526take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
1527called.
1528.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4
1529.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]"
1530The current reschedule callback, or \f(CW0\fR, if this functionality is
1531switched off. Can be changed any time, but changes only take effect when
1532the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1533.IP "ev_tstamp at [read\-only]" 4
1534.IX Item "ev_tstamp at [read-only]"
1535When active, contains the absolute time that the watcher is supposed to
1536trigger next.
1024.PP 1537.PP
1538\fIExamples\fR
1539.IX Subsection "Examples"
1540.PP
1025Example: call a callback every hour, or, more precisely, whenever the 1541Example: Call a callback every hour, or, more precisely, whenever the
1026system clock is divisible by 3600. The callback invocation times have 1542system clock is divisible by 3600. The callback invocation times have
1027potentially a lot of jittering, but good long-term stability. 1543potentially a lot of jittering, but good long-term stability.
1028.PP 1544.PP
1029.Vb 5 1545.Vb 5
1030\& static void 1546\& static void
1031\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1547\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1032\& { 1548\& {
1033\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 1549\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1034\& } 1550\& }
1035.Ve 1551\&
1036.PP
1037.Vb 3
1038\& struct ev_periodic hourly_tick; 1552\& struct ev_periodic hourly_tick;
1039\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1553\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1040\& ev_periodic_start (loop, &hourly_tick); 1554\& ev_periodic_start (loop, &hourly_tick);
1041.Ve 1555.Ve
1042.PP 1556.PP
1043Example: the same as above, but use a reschedule callback to do it: 1557Example: The same as above, but use a reschedule callback to do it:
1044.PP 1558.PP
1045.Vb 1 1559.Vb 1
1046\& #include <math.h> 1560\& #include <math.h>
1047.Ve 1561\&
1048.PP
1049.Vb 5
1050\& static ev_tstamp 1562\& static ev_tstamp
1051\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1563\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1052\& { 1564\& {
1053\& return fmod (now, 3600.) + 3600.; 1565\& return fmod (now, 3600.) + 3600.;
1054\& } 1566\& }
1055.Ve 1567\&
1056.PP
1057.Vb 1
1058\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1568\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1059.Ve 1569.Ve
1060.PP 1570.PP
1061Example: call a callback every hour, starting now: 1571Example: Call a callback every hour, starting now:
1062.PP 1572.PP
1063.Vb 4 1573.Vb 4
1064\& struct ev_periodic hourly_tick; 1574\& struct ev_periodic hourly_tick;
1065\& ev_periodic_init (&hourly_tick, clock_cb, 1575\& ev_periodic_init (&hourly_tick, clock_cb,
1066\& fmod (ev_now (loop), 3600.), 3600., 0); 1576\& fmod (ev_now (loop), 3600.), 3600., 0);
1067\& ev_periodic_start (loop, &hourly_tick); 1577\& ev_periodic_start (loop, &hourly_tick);
1068.Ve 1578.Ve
1069.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled" 1579.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!"
1070.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled" 1580.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1071.IX Subsection "ev_signal - signal me when a signal gets signalled" 1581.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1072Signal watchers will trigger an event when the process receives a specific 1582Signal watchers will trigger an event when the process receives a specific
1073signal one or more times. Even though signals are very asynchronous, libev 1583signal one or more times. Even though signals are very asynchronous, libev
1074will try it's best to deliver signals synchronously, i.e. as part of the 1584will try it's best to deliver signals synchronously, i.e. as part of the
1075normal event processing, like any other event. 1585normal event processing, like any other event.
1076.PP 1586.PP
… …
1078first watcher gets started will libev actually register a signal watcher 1588first watcher gets started will libev actually register a signal watcher
1079with the kernel (thus it coexists with your own signal handlers as long 1589with the kernel (thus it coexists with your own signal handlers as long
1080as you don't register any with libev). Similarly, when the last signal 1590as you don't register any with libev). Similarly, when the last signal
1081watcher for a signal is stopped libev will reset the signal handler to 1591watcher for a signal is stopped libev will reset the signal handler to
1082\&\s-1SIG_DFL\s0 (regardless of what it was set to before). 1592\&\s-1SIG_DFL\s0 (regardless of what it was set to before).
1593.PP
1594If possible and supported, libev will install its handlers with
1595\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so syscalls should not be unduly
1596interrupted. If you have a problem with syscalls getting interrupted by
1597signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock
1598them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
1599.PP
1600\fIWatcher-Specific Functions and Data Members\fR
1601.IX Subsection "Watcher-Specific Functions and Data Members"
1083.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 1602.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
1084.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 1603.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
1085.PD 0 1604.PD 0
1086.IP "ev_signal_set (ev_signal *, int signum)" 4 1605.IP "ev_signal_set (ev_signal *, int signum)" 4
1087.IX Item "ev_signal_set (ev_signal *, int signum)" 1606.IX Item "ev_signal_set (ev_signal *, int signum)"
1088.PD 1607.PD
1089Configures the watcher to trigger on the given signal number (usually one 1608Configures the watcher to trigger on the given signal number (usually one
1090of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 1609of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
1610.IP "int signum [read\-only]" 4
1611.IX Item "int signum [read-only]"
1612The signal the watcher watches out for.
1613.PP
1614\fIExamples\fR
1615.IX Subsection "Examples"
1616.PP
1617Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1618.PP
1619.Vb 5
1620\& static void
1621\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1622\& {
1623\& ev_unloop (loop, EVUNLOOP_ALL);
1624\& }
1625\&
1626\& struct ev_signal signal_watcher;
1627\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1628\& ev_signal_start (loop, &sigint_cb);
1629.Ve
1091.ie n .Sh """ev_child"" \- wait for pid status changes" 1630.ie n .Sh """ev_child"" \- watch out for process status changes"
1092.el .Sh "\f(CWev_child\fP \- wait for pid status changes" 1631.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1093.IX Subsection "ev_child - wait for pid status changes" 1632.IX Subsection "ev_child - watch out for process status changes"
1094Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1633Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1095some child status changes (most typically when a child of yours dies). 1634some child status changes (most typically when a child of yours dies). It
1635is permissible to install a child watcher \fIafter\fR the child has been
1636forked (which implies it might have already exited), as long as the event
1637loop isn't entered (or is continued from a watcher).
1638.PP
1639Only the default event loop is capable of handling signals, and therefore
1640you can only rgeister child watchers in the default event loop.
1641.PP
1642\fIProcess Interaction\fR
1643.IX Subsection "Process Interaction"
1644.PP
1645Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
1646initialised. This is necessary to guarantee proper behaviour even if
1647the first child watcher is started after the child exits. The occurance
1648of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
1649synchronously as part of the event loop processing. Libev always reaps all
1650children, even ones not watched.
1651.PP
1652\fIOverriding the Built-In Processing\fR
1653.IX Subsection "Overriding the Built-In Processing"
1654.PP
1655Libev offers no special support for overriding the built-in child
1656processing, but if your application collides with libev's default child
1657handler, you can override it easily by installing your own handler for
1658\&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the
1659default loop never gets destroyed. You are encouraged, however, to use an
1660event-based approach to child reaping and thus use libev's support for
1661that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely.
1662.PP
1663\fIWatcher-Specific Functions and Data Members\fR
1664.IX Subsection "Watcher-Specific Functions and Data Members"
1096.IP "ev_child_init (ev_child *, callback, int pid)" 4 1665.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
1097.IX Item "ev_child_init (ev_child *, callback, int pid)" 1666.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
1098.PD 0 1667.PD 0
1099.IP "ev_child_set (ev_child *, int pid)" 4 1668.IP "ev_child_set (ev_child *, int pid, int trace)" 4
1100.IX Item "ev_child_set (ev_child *, int pid)" 1669.IX Item "ev_child_set (ev_child *, int pid, int trace)"
1101.PD 1670.PD
1102Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or 1671Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or
1103\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 1672\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1104at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 1673at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1105the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 1674the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1106\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 1675\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1107process causing the status change. 1676process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only
1677activate the watcher when the process terminates) or \f(CW1\fR (additionally
1678activate the watcher when the process is stopped or continued).
1679.IP "int pid [read\-only]" 4
1680.IX Item "int pid [read-only]"
1681The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
1682.IP "int rpid [read\-write]" 4
1683.IX Item "int rpid [read-write]"
1684The process id that detected a status change.
1685.IP "int rstatus [read\-write]" 4
1686.IX Item "int rstatus [read-write]"
1687The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1688\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1108.PP 1689.PP
1109Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1690\fIExamples\fR
1691.IX Subsection "Examples"
1110.PP 1692.PP
1693Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for
1694its completion.
1695.PP
1111.Vb 5 1696.Vb 1
1697\& ev_child cw;
1698\&
1112\& static void 1699\& static void
1113\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1700\& child_cb (EV_P_ struct ev_child *w, int revents)
1114\& { 1701\& {
1115\& ev_unloop (loop, EVUNLOOP_ALL); 1702\& ev_child_stop (EV_A_ w);
1703\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1116\& } 1704\& }
1705\&
1706\& pid_t pid = fork ();
1707\&
1708\& if (pid < 0)
1709\& // error
1710\& else if (pid == 0)
1711\& {
1712\& // the forked child executes here
1713\& exit (1);
1714\& }
1715\& else
1716\& {
1717\& ev_child_init (&cw, child_cb, pid, 0);
1718\& ev_child_start (EV_DEFAULT_ &cw);
1719\& }
1117.Ve 1720.Ve
1721.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1722.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1723.IX Subsection "ev_stat - did the file attributes just change?"
1724This watches a filesystem path for attribute changes. That is, it calls
1725\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed
1726compared to the last time, invoking the callback if it did.
1118.PP 1727.PP
1728The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
1729not exist\*(R" is a status change like any other. The condition \*(L"path does
1730not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
1731otherwise always forced to be at least one) and all the other fields of
1732the stat buffer having unspecified contents.
1733.PP
1734The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is
1735relative and your working directory changes, the behaviour is undefined.
1736.PP
1737Since there is no standard to do this, the portable implementation simply
1738calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You
1739can specify a recommended polling interval for this case. If you specify
1740a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
1741unspecified default\fR value will be used (which you can expect to be around
1742five seconds, although this might change dynamically). Libev will also
1743impose a minimum interval which is currently around \f(CW0.1\fR, but thats
1744usually overkill.
1745.PP
1746This watcher type is not meant for massive numbers of stat watchers,
1747as even with OS-supported change notifications, this can be
1748resource-intensive.
1749.PP
1750At the time of this writing, only the Linux inotify interface is
1751implemented (implementing kqueue support is left as an exercise for the
1752reader). Inotify will be used to give hints only and should not change the
1753semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1754to fall back to regular polling again even with inotify, but changes are
1755usually detected immediately, and if the file exists there will be no
1756polling.
1757.PP
1758\fI\s-1ABI\s0 Issues (Largefile Support)\fR
1759.IX Subsection "ABI Issues (Largefile Support)"
1760.PP
1761Libev by default (unless the user overrides this) uses the default
1762compilation environment, which means that on systems with optionally
1763disabled large file support, you get the 32 bit version of the stat
1764structure. When using the library from programs that change the \s-1ABI\s0 to
1765use 64 bit file offsets the programs will fail. In that case you have to
1766compile libev with the same flags to get binary compatibility. This is
1767obviously the case with any flags that change the \s-1ABI\s0, but the problem is
1768most noticably with ev_stat and largefile support.
1769.PP
1770\fIInotify\fR
1771.IX Subsection "Inotify"
1772.PP
1773When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only
1774available on Linux) and present at runtime, it will be used to speed up
1775change detection where possible. The inotify descriptor will be created lazily
1776when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started.
1777.PP
1778Inotify presense does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
1779except that changes might be detected earlier, and in some cases, to avoid
1780making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presense of inotify support
1781there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling.
1782.PP
1783(There is no support for kqueue, as apparently it cannot be used to
1784implement this functionality, due to the requirement of having a file
1785descriptor open on the object at all times).
1786.PP
1787\fIThe special problem of stat time resolution\fR
1788.IX Subsection "The special problem of stat time resolution"
1789.PP
1790The \f(CW\*(C`stat ()\*(C'\fR syscall only supports full-second resolution portably, and
1791even on systems where the resolution is higher, many filesystems still
1792only support whole seconds.
1793.PP
1794That means that, if the time is the only thing that changes, you might
1795miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and calls
1796your callback, which does something. When there is another update within
1797the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it.
1798.PP
1799The solution to this is to delay acting on a change for a second (or till
1800the next second boundary), using a roughly one-second delay \f(CW\*(C`ev_timer\*(C'\fR
1801(\f(CW\*(C`ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)\*(C'\fR). The \f(CW.01\fR
1802is added to work around small timing inconsistencies of some operating
1803systems.
1804.PP
1805\fIWatcher-Specific Functions and Data Members\fR
1806.IX Subsection "Watcher-Specific Functions and Data Members"
1807.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1808.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1809.PD 0
1810.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1811.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
1812.PD
1813Configures the watcher to wait for status changes of the given
1814\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
1815be detected and should normally be specified as \f(CW0\fR to let libev choose
1816a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
1817path for as long as the watcher is active.
1818.Sp
1819The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected,
1820relative to the attributes at the time the watcher was started (or the
1821last change was detected).
1822.IP "ev_stat_stat (loop, ev_stat *)" 4
1823.IX Item "ev_stat_stat (loop, ev_stat *)"
1824Updates the stat buffer immediately with new values. If you change the
1825watched path in your callback, you could call this fucntion to avoid
1826detecting this change (while introducing a race condition). Can also be
1827useful simply to find out the new values.
1828.IP "ev_statdata attr [read\-only]" 4
1829.IX Item "ev_statdata attr [read-only]"
1830The most-recently detected attributes of the file. Although the type is of
1831\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types
1832suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there
1833was some error while \f(CW\*(C`stat\*(C'\fRing the file.
1834.IP "ev_statdata prev [read\-only]" 4
1835.IX Item "ev_statdata prev [read-only]"
1836The previous attributes of the file. The callback gets invoked whenever
1837\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR.
1838.IP "ev_tstamp interval [read\-only]" 4
1839.IX Item "ev_tstamp interval [read-only]"
1840The specified interval.
1841.IP "const char *path [read\-only]" 4
1842.IX Item "const char *path [read-only]"
1843The filesystem path that is being watched.
1844.PP
1845\fIExamples\fR
1846.IX Subsection "Examples"
1847.PP
1848Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1849.PP
1850.Vb 10
1851\& static void
1852\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1853\& {
1854\& /* /etc/passwd changed in some way */
1855\& if (w\->attr.st_nlink)
1856\& {
1857\& printf ("passwd current size %ld\en", (long)w\->attr.st_size);
1858\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime);
1859\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime);
1860\& }
1861\& else
1862\& /* you shalt not abuse printf for puts */
1863\& puts ("wow, /etc/passwd is not there, expect problems. "
1864\& "if this is windows, they already arrived\en");
1865\& }
1866\&
1867\& ...
1868\& ev_stat passwd;
1869\&
1870\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1871\& ev_stat_start (loop, &passwd);
1872.Ve
1873.PP
1874Example: Like above, but additionally use a one-second delay so we do not
1875miss updates (however, frequent updates will delay processing, too, so
1876one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on
1877\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
1878.PP
1119.Vb 3 1879.Vb 2
1120\& struct ev_signal signal_watcher; 1880\& static ev_stat passwd;
1121\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1881\& static ev_timer timer;
1122\& ev_signal_start (loop, &sigint_cb); 1882\&
1883\& static void
1884\& timer_cb (EV_P_ ev_timer *w, int revents)
1885\& {
1886\& ev_timer_stop (EV_A_ w);
1887\&
1888\& /* now it\*(Aqs one second after the most recent passwd change */
1889\& }
1890\&
1891\& static void
1892\& stat_cb (EV_P_ ev_stat *w, int revents)
1893\& {
1894\& /* reset the one\-second timer */
1895\& ev_timer_again (EV_A_ &timer);
1896\& }
1897\&
1898\& ...
1899\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1900\& ev_stat_start (loop, &passwd);
1901\& ev_timer_init (&timer, timer_cb, 0., 1.01);
1123.Ve 1902.Ve
1124.ie n .Sh """ev_idle"" \- when you've got nothing better to do" 1903.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1125.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do" 1904.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1126.IX Subsection "ev_idle - when you've got nothing better to do" 1905.IX Subsection "ev_idle - when you've got nothing better to do..."
1127Idle watchers trigger events when there are no other events are pending 1906Idle watchers trigger events when no other events of the same or higher
1128(prepare, check and other idle watchers do not count). That is, as long 1907priority are pending (prepare, check and other idle watchers do not
1129as your process is busy handling sockets or timeouts (or even signals, 1908count).
1130imagine) it will not be triggered. But when your process is idle all idle 1909.PP
1131watchers are being called again and again, once per event loop iteration \- 1910That is, as long as your process is busy handling sockets or timeouts
1911(or even signals, imagine) of the same or higher priority it will not be
1912triggered. But when your process is idle (or only lower-priority watchers
1913are pending), the idle watchers are being called once per event loop
1132until stopped, that is, or your process receives more events and becomes 1914iteration \- until stopped, that is, or your process receives more events
1133busy. 1915and becomes busy again with higher priority stuff.
1134.PP 1916.PP
1135The most noteworthy effect is that as long as any idle watchers are 1917The most noteworthy effect is that as long as any idle watchers are
1136active, the process will not block when waiting for new events. 1918active, the process will not block when waiting for new events.
1137.PP 1919.PP
1138Apart from keeping your process non-blocking (which is a useful 1920Apart from keeping your process non-blocking (which is a useful
1139effect on its own sometimes), idle watchers are a good place to do 1921effect on its own sometimes), idle watchers are a good place to do
1140\&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the 1922\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
1141event loop has handled all outstanding events. 1923event loop has handled all outstanding events.
1924.PP
1925\fIWatcher-Specific Functions and Data Members\fR
1926.IX Subsection "Watcher-Specific Functions and Data Members"
1142.IP "ev_idle_init (ev_signal *, callback)" 4 1927.IP "ev_idle_init (ev_signal *, callback)" 4
1143.IX Item "ev_idle_init (ev_signal *, callback)" 1928.IX Item "ev_idle_init (ev_signal *, callback)"
1144Initialises and configures the idle watcher \- it has no parameters of any 1929Initialises and configures the idle watcher \- it has no parameters of any
1145kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 1930kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1146believe me. 1931believe me.
1147.PP 1932.PP
1933\fIExamples\fR
1934.IX Subsection "Examples"
1935.PP
1148Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the 1936Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1149callback, free it. Alos, use no error checking, as usual. 1937callback, free it. Also, use no error checking, as usual.
1150.PP 1938.PP
1151.Vb 7 1939.Vb 7
1152\& static void 1940\& static void
1153\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1941\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1154\& { 1942\& {
1155\& free (w); 1943\& free (w);
1156\& // now do something you wanted to do when the program has 1944\& // now do something you wanted to do when the program has
1157\& // no longer asnything immediate to do. 1945\& // no longer anything immediate to do.
1158\& } 1946\& }
1159.Ve 1947\&
1160.PP
1161.Vb 3
1162\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1948\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1163\& ev_idle_init (idle_watcher, idle_cb); 1949\& ev_idle_init (idle_watcher, idle_cb);
1164\& ev_idle_start (loop, idle_cb); 1950\& ev_idle_start (loop, idle_cb);
1165.Ve 1951.Ve
1166.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop" 1952.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!"
1167.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop" 1953.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
1168.IX Subsection "ev_prepare and ev_check - customise your event loop" 1954.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1169Prepare and check watchers are usually (but not always) used in tandem: 1955Prepare and check watchers are usually (but not always) used in tandem:
1170prepare watchers get invoked before the process blocks and check watchers 1956prepare watchers get invoked before the process blocks and check watchers
1171afterwards. 1957afterwards.
1172.PP 1958.PP
1959You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter
1960the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
1961watchers. Other loops than the current one are fine, however. The
1962rationale behind this is that you do not need to check for recursion in
1963those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking,
1964\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be
1965called in pairs bracketing the blocking call.
1966.PP
1173Their main purpose is to integrate other event mechanisms into libev and 1967Their main purpose is to integrate other event mechanisms into libev and
1174their use is somewhat advanced. This could be used, for example, to track 1968their use is somewhat advanced. This could be used, for example, to track
1175variable changes, implement your own watchers, integrate net-snmp or a 1969variable changes, implement your own watchers, integrate net-snmp or a
1176coroutine library and lots more. 1970coroutine library and lots more. They are also occasionally useful if
1971you cache some data and want to flush it before blocking (for example,
1972in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR
1973watcher).
1177.PP 1974.PP
1178This is done by examining in each prepare call which file descriptors need 1975This is done by examining in each prepare call which file descriptors need
1179to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 1976to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for
1180them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 1977them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries
1181provide just this functionality). Then, in the check watcher you check for 1978provide just this functionality). Then, in the check watcher you check for
… …
1190are ready to run (it's actually more complicated: it only runs coroutines 1987are ready to run (it's actually more complicated: it only runs coroutines
1191with priority higher than or equal to the event loop and one coroutine 1988with priority higher than or equal to the event loop and one coroutine
1192of lower priority, but only once, using idle watchers to keep the event 1989of lower priority, but only once, using idle watchers to keep the event
1193loop from blocking if lower-priority coroutines are active, thus mapping 1990loop from blocking if lower-priority coroutines are active, thus mapping
1194low-priority coroutines to idle/background tasks). 1991low-priority coroutines to idle/background tasks).
1992.PP
1993It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR)
1994priority, to ensure that they are being run before any other watchers
1995after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers,
1996too) should not activate (\*(L"feed\*(R") events into libev. While libev fully
1997supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers
1998did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other
1999(non-libev) event loops those other event loops might be in an unusable
2000state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to
2001coexist peacefully with others).
2002.PP
2003\fIWatcher-Specific Functions and Data Members\fR
2004.IX Subsection "Watcher-Specific Functions and Data Members"
1195.IP "ev_prepare_init (ev_prepare *, callback)" 4 2005.IP "ev_prepare_init (ev_prepare *, callback)" 4
1196.IX Item "ev_prepare_init (ev_prepare *, callback)" 2006.IX Item "ev_prepare_init (ev_prepare *, callback)"
1197.PD 0 2007.PD 0
1198.IP "ev_check_init (ev_check *, callback)" 4 2008.IP "ev_check_init (ev_check *, callback)" 4
1199.IX Item "ev_check_init (ev_check *, callback)" 2009.IX Item "ev_check_init (ev_check *, callback)"
1200.PD 2010.PD
1201Initialises and configures the prepare or check watcher \- they have no 2011Initialises and configures the prepare or check watcher \- they have no
1202parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 2012parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1203macros, but using them is utterly, utterly and completely pointless. 2013macros, but using them is utterly, utterly and completely pointless.
1204.PP 2014.PP
1205Example: *TODO*. 2015\fIExamples\fR
2016.IX Subsection "Examples"
2017.PP
2018There are a number of principal ways to embed other event loops or modules
2019into libev. Here are some ideas on how to include libadns into libev
2020(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
2021use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR
2022embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0
2023into the Glib event loop).
2024.PP
2025Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler,
2026and in a check watcher, destroy them and call into libadns. What follows
2027is pseudo-code only of course. This requires you to either use a low
2028priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as
2029the callbacks for the IO/timeout watchers might not have been called yet.
2030.PP
2031.Vb 2
2032\& static ev_io iow [nfd];
2033\& static ev_timer tw;
2034\&
2035\& static void
2036\& io_cb (ev_loop *loop, ev_io *w, int revents)
2037\& {
2038\& }
2039\&
2040\& // create io watchers for each fd and a timer before blocking
2041\& static void
2042\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
2043\& {
2044\& int timeout = 3600000;
2045\& struct pollfd fds [nfd];
2046\& // actual code will need to loop here and realloc etc.
2047\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2048\&
2049\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
2050\& ev_timer_init (&tw, 0, timeout * 1e\-3);
2051\& ev_timer_start (loop, &tw);
2052\&
2053\& // create one ev_io per pollfd
2054\& for (int i = 0; i < nfd; ++i)
2055\& {
2056\& ev_io_init (iow + i, io_cb, fds [i].fd,
2057\& ((fds [i].events & POLLIN ? EV_READ : 0)
2058\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
2059\&
2060\& fds [i].revents = 0;
2061\& ev_io_start (loop, iow + i);
2062\& }
2063\& }
2064\&
2065\& // stop all watchers after blocking
2066\& static void
2067\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
2068\& {
2069\& ev_timer_stop (loop, &tw);
2070\&
2071\& for (int i = 0; i < nfd; ++i)
2072\& {
2073\& // set the relevant poll flags
2074\& // could also call adns_processreadable etc. here
2075\& struct pollfd *fd = fds + i;
2076\& int revents = ev_clear_pending (iow + i);
2077\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN;
2078\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT;
2079\&
2080\& // now stop the watcher
2081\& ev_io_stop (loop, iow + i);
2082\& }
2083\&
2084\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
2085\& }
2086.Ve
2087.PP
2088Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
2089in the prepare watcher and would dispose of the check watcher.
2090.PP
2091Method 3: If the module to be embedded supports explicit event
2092notification (adns does), you can also make use of the actual watcher
2093callbacks, and only destroy/create the watchers in the prepare watcher.
2094.PP
2095.Vb 5
2096\& static void
2097\& timer_cb (EV_P_ ev_timer *w, int revents)
2098\& {
2099\& adns_state ads = (adns_state)w\->data;
2100\& update_now (EV_A);
2101\&
2102\& adns_processtimeouts (ads, &tv_now);
2103\& }
2104\&
2105\& static void
2106\& io_cb (EV_P_ ev_io *w, int revents)
2107\& {
2108\& adns_state ads = (adns_state)w\->data;
2109\& update_now (EV_A);
2110\&
2111\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now);
2112\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now);
2113\& }
2114\&
2115\& // do not ever call adns_afterpoll
2116.Ve
2117.PP
2118Method 4: Do not use a prepare or check watcher because the module you
2119want to embed is too inflexible to support it. Instead, youc na override
2120their poll function. The drawback with this solution is that the main
2121loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does
2122this.
2123.PP
2124.Vb 4
2125\& static gint
2126\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2127\& {
2128\& int got_events = 0;
2129\&
2130\& for (n = 0; n < nfds; ++n)
2131\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
2132\&
2133\& if (timeout >= 0)
2134\& // create/start timer
2135\&
2136\& // poll
2137\& ev_loop (EV_A_ 0);
2138\&
2139\& // stop timer again
2140\& if (timeout >= 0)
2141\& ev_timer_stop (EV_A_ &to);
2142\&
2143\& // stop io watchers again \- their callbacks should have set
2144\& for (n = 0; n < nfds; ++n)
2145\& ev_io_stop (EV_A_ iow [n]);
2146\&
2147\& return got_events;
2148\& }
2149.Ve
1206.ie n .Sh """ev_embed"" \- when one backend isn't enough" 2150.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
1207.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough" 2151.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
1208.IX Subsection "ev_embed - when one backend isn't enough" 2152.IX Subsection "ev_embed - when one backend isn't enough..."
1209This is a rather advanced watcher type that lets you embed one event loop 2153This is a rather advanced watcher type that lets you embed one event loop
1210into another. 2154into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
2155loop, other types of watchers might be handled in a delayed or incorrect
2156fashion and must not be used).
1211.PP 2157.PP
1212There are primarily two reasons you would want that: work around bugs and 2158There are primarily two reasons you would want that: work around bugs and
1213prioritise I/O. 2159prioritise I/O.
1214.PP 2160.PP
1215As an example for a bug workaround, the kqueue backend might only support 2161As an example for a bug workaround, the kqueue backend might only support
… …
1224to be watched and handled very quickly (with low latency), and even 2170to be watched and handled very quickly (with low latency), and even
1225priorities and idle watchers might have too much overhead. In this case 2171priorities and idle watchers might have too much overhead. In this case
1226you would put all the high priority stuff in one loop and all the rest in 2172you would put all the high priority stuff in one loop and all the rest in
1227a second one, and embed the second one in the first. 2173a second one, and embed the second one in the first.
1228.PP 2174.PP
2175As long as the watcher is active, the callback will be invoked every time
2176there might be events pending in the embedded loop. The callback must then
2177call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke
2178their callbacks (you could also start an idle watcher to give the embedded
2179loop strictly lower priority for example). You can also set the callback
2180to \f(CW0\fR, in which case the embed watcher will automatically execute the
2181embedded loop sweep.
2182.PP
1229As long as the watcher is started it will automatically handle events. The 2183As long as the watcher is started it will automatically handle events. The
1230callback will be invoked whenever some events have been handled. You can 2184callback will be invoked whenever some events have been handled. You can
1231set the callback to \f(CW0\fR to avoid having to specify one if you are not 2185set the callback to \f(CW0\fR to avoid having to specify one if you are not
1232interested in that. 2186interested in that.
1233.PP 2187.PP
… …
1241portable one. 2195portable one.
1242.PP 2196.PP
1243So when you want to use this feature you will always have to be prepared 2197So when you want to use this feature you will always have to be prepared
1244that you cannot get an embeddable loop. The recommended way to get around 2198that you cannot get an embeddable loop. The recommended way to get around
1245this is to have a separate variables for your embeddable loop, try to 2199this is to have a separate variables for your embeddable loop, try to
1246create it, and if that fails, use the normal loop for everything: 2200create it, and if that fails, use the normal loop for everything.
2201.PP
2202\fIWatcher-Specific Functions and Data Members\fR
2203.IX Subsection "Watcher-Specific Functions and Data Members"
2204.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
2205.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
2206.PD 0
2207.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
2208.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)"
2209.PD
2210Configures the watcher to embed the given loop, which must be
2211embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
2212invoked automatically, otherwise it is the responsibility of the callback
2213to invoke it (it will continue to be called until the sweep has been done,
2214if you do not want thta, you need to temporarily stop the embed watcher).
2215.IP "ev_embed_sweep (loop, ev_embed *)" 4
2216.IX Item "ev_embed_sweep (loop, ev_embed *)"
2217Make a single, non-blocking sweep over the embedded loop. This works
2218similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
2219apropriate way for embedded loops.
2220.IP "struct ev_loop *other [read\-only]" 4
2221.IX Item "struct ev_loop *other [read-only]"
2222The embedded event loop.
2223.PP
2224\fIExamples\fR
2225.IX Subsection "Examples"
2226.PP
2227Example: Try to get an embeddable event loop and embed it into the default
2228event loop. If that is not possible, use the default loop. The default
2229loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the mebeddable loop is stored in
2230\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the acse no embeddable loop can be
2231used).
1247.PP 2232.PP
1248.Vb 3 2233.Vb 3
1249\& struct ev_loop *loop_hi = ev_default_init (0); 2234\& struct ev_loop *loop_hi = ev_default_init (0);
1250\& struct ev_loop *loop_lo = 0; 2235\& struct ev_loop *loop_lo = 0;
1251\& struct ev_embed embed; 2236\& struct ev_embed embed;
1252.Ve 2237\&
1253.PP
1254.Vb 5
1255\& // see if there is a chance of getting one that works 2238\& // see if there is a chance of getting one that works
1256\& // (remember that a flags value of 0 means autodetection) 2239\& // (remember that a flags value of 0 means autodetection)
1257\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 2240\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
1258\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 2241\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
1259\& : 0; 2242\& : 0;
1260.Ve 2243\&
1261.PP
1262.Vb 8
1263\& // if we got one, then embed it, otherwise default to loop_hi 2244\& // if we got one, then embed it, otherwise default to loop_hi
1264\& if (loop_lo) 2245\& if (loop_lo)
1265\& { 2246\& {
1266\& ev_embed_init (&embed, 0, loop_lo); 2247\& ev_embed_init (&embed, 0, loop_lo);
1267\& ev_embed_start (loop_hi, &embed); 2248\& ev_embed_start (loop_hi, &embed);
1268\& } 2249\& }
1269\& else 2250\& else
1270\& loop_lo = loop_hi; 2251\& loop_lo = loop_hi;
1271.Ve 2252.Ve
1272.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *loop)" 4 2253.PP
1273.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *loop)" 2254Example: Check if kqueue is available but not recommended and create
1274.PD 0 2255a kqueue backend for use with sockets (which usually work with any
1275.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *loop)" 4 2256kqueue implementation). Store the kqueue/socket\-only event loop in
1276.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *loop)" 2257\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
1277.PD 2258.PP
1278Configures the watcher to embed the given loop, which must be embeddable. 2259.Vb 3
2260\& struct ev_loop *loop = ev_default_init (0);
2261\& struct ev_loop *loop_socket = 0;
2262\& struct ev_embed embed;
2263\&
2264\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2265\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2266\& {
2267\& ev_embed_init (&embed, 0, loop_socket);
2268\& ev_embed_start (loop, &embed);
2269\& }
2270\&
2271\& if (!loop_socket)
2272\& loop_socket = loop;
2273\&
2274\& // now use loop_socket for all sockets, and loop for everything else
2275.Ve
2276.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
2277.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2278.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2279Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2280whoever is a good citizen cared to tell libev about it by calling
2281\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the
2282event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called,
2283and only in the child after the fork. If whoever good citizen calling
2284\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
2285handlers will be invoked, too, of course.
2286.PP
2287\fIWatcher-Specific Functions and Data Members\fR
2288.IX Subsection "Watcher-Specific Functions and Data Members"
2289.IP "ev_fork_init (ev_signal *, callback)" 4
2290.IX Item "ev_fork_init (ev_signal *, callback)"
2291Initialises and configures the fork watcher \- it has no parameters of any
2292kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
2293believe me.
2294.ie n .Sh """ev_async"" \- how to wake up another event loop"
2295.el .Sh "\f(CWev_async\fP \- how to wake up another event loop"
2296.IX Subsection "ev_async - how to wake up another event loop"
2297In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
2298asynchronous sources such as signal handlers (as opposed to multiple event
2299loops \- those are of course safe to use in different threads).
2300.PP
2301Sometimes, however, you need to wake up another event loop you do not
2302control, for example because it belongs to another thread. This is what
2303\&\f(CW\*(C`ev_async\*(C'\fR watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you
2304can signal it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal
2305safe.
2306.PP
2307This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
2308too, are asynchronous in nature, and signals, too, will be compressed
2309(i.e. the number of callback invocations may be less than the number of
2310\&\f(CW\*(C`ev_async_sent\*(C'\fR calls).
2311.PP
2312Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not
2313just the default loop.
2314.PP
2315\fIQueueing\fR
2316.IX Subsection "Queueing"
2317.PP
2318\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
2319is that the author does not know of a simple (or any) algorithm for a
2320multiple-writer-single-reader queue that works in all cases and doesn't
2321need elaborate support such as pthreads.
2322.PP
2323That means that if you want to queue data, you have to provide your own
2324queue. But at least I can tell you would implement locking around your
2325queue:
2326.IP "queueing from a signal handler context" 4
2327.IX Item "queueing from a signal handler context"
2328To implement race-free queueing, you simply add to the queue in the signal
2329handler but you block the signal handler in the watcher callback. Here is an example that does that for
2330some fictitiuous \s-1SIGUSR1\s0 handler:
2331.Sp
2332.Vb 1
2333\& static ev_async mysig;
2334\&
2335\& static void
2336\& sigusr1_handler (void)
2337\& {
2338\& sometype data;
2339\&
2340\& // no locking etc.
2341\& queue_put (data);
2342\& ev_async_send (EV_DEFAULT_ &mysig);
2343\& }
2344\&
2345\& static void
2346\& mysig_cb (EV_P_ ev_async *w, int revents)
2347\& {
2348\& sometype data;
2349\& sigset_t block, prev;
2350\&
2351\& sigemptyset (&block);
2352\& sigaddset (&block, SIGUSR1);
2353\& sigprocmask (SIG_BLOCK, &block, &prev);
2354\&
2355\& while (queue_get (&data))
2356\& process (data);
2357\&
2358\& if (sigismember (&prev, SIGUSR1)
2359\& sigprocmask (SIG_UNBLOCK, &block, 0);
2360\& }
2361.Ve
2362.Sp
2363(Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR
2364instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it
2365either...).
2366.IP "queueing from a thread context" 4
2367.IX Item "queueing from a thread context"
2368The strategy for threads is different, as you cannot (easily) block
2369threads but you can easily preempt them, so to queue safely you need to
2370employ a traditional mutex lock, such as in this pthread example:
2371.Sp
2372.Vb 2
2373\& static ev_async mysig;
2374\& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
2375\&
2376\& static void
2377\& otherthread (void)
2378\& {
2379\& // only need to lock the actual queueing operation
2380\& pthread_mutex_lock (&mymutex);
2381\& queue_put (data);
2382\& pthread_mutex_unlock (&mymutex);
2383\&
2384\& ev_async_send (EV_DEFAULT_ &mysig);
2385\& }
2386\&
2387\& static void
2388\& mysig_cb (EV_P_ ev_async *w, int revents)
2389\& {
2390\& pthread_mutex_lock (&mymutex);
2391\&
2392\& while (queue_get (&data))
2393\& process (data);
2394\&
2395\& pthread_mutex_unlock (&mymutex);
2396\& }
2397.Ve
2398.PP
2399\fIWatcher-Specific Functions and Data Members\fR
2400.IX Subsection "Watcher-Specific Functions and Data Members"
2401.IP "ev_async_init (ev_async *, callback)" 4
2402.IX Item "ev_async_init (ev_async *, callback)"
2403Initialises and configures the async watcher \- it has no parameters of any
2404kind. There is a \f(CW\*(C`ev_asynd_set\*(C'\fR macro, but using it is utterly pointless,
2405believe me.
2406.IP "ev_async_send (loop, ev_async *)" 4
2407.IX Item "ev_async_send (loop, ev_async *)"
2408Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
2409an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike
2410\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do in other threads, signal or
2411similar contexts (see the dicusssion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding
2412section below on what exactly this means).
2413.Sp
2414This call incurs the overhead of a syscall only once per loop iteration,
2415so while the overhead might be noticable, it doesn't apply to repeated
2416calls to \f(CW\*(C`ev_async_send\*(C'\fR.
2417.IP "bool = ev_async_pending (ev_async *)" 4
2418.IX Item "bool = ev_async_pending (ev_async *)"
2419Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
2420watcher but the event has not yet been processed (or even noted) by the
2421event loop.
2422.Sp
2423\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
2424the loop iterates next and checks for the watcher to have become active,
2425it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
2426quickly check wether invoking the loop might be a good idea.
2427.Sp
2428Not that this does \fInot\fR check wether the watcher itself is pending, only
2429wether it has been requested to make this watcher pending.
1279.SH "OTHER FUNCTIONS" 2430.SH "OTHER FUNCTIONS"
1280.IX Header "OTHER FUNCTIONS" 2431.IX Header "OTHER FUNCTIONS"
1281There are some other functions of possible interest. Described. Here. Now. 2432There are some other functions of possible interest. Described. Here. Now.
1282.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 2433.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
1283.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 2434.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
… …
1307\& if (revents & EV_TIMEOUT) 2458\& if (revents & EV_TIMEOUT)
1308\& /* doh, nothing entered */; 2459\& /* doh, nothing entered */;
1309\& else if (revents & EV_READ) 2460\& else if (revents & EV_READ)
1310\& /* stdin might have data for us, joy! */; 2461\& /* stdin might have data for us, joy! */;
1311\& } 2462\& }
1312.Ve 2463\&
1313.Sp
1314.Vb 1
1315\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 2464\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
1316.Ve 2465.Ve
1317.IP "ev_feed_event (loop, watcher, int events)" 4 2466.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4
1318.IX Item "ev_feed_event (loop, watcher, int events)" 2467.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)"
1319Feeds the given event set into the event loop, as if the specified event 2468Feeds the given event set into the event loop, as if the specified event
1320had happened for the specified watcher (which must be a pointer to an 2469had happened for the specified watcher (which must be a pointer to an
1321initialised but not necessarily started event watcher). 2470initialised but not necessarily started event watcher).
1322.IP "ev_feed_fd_event (loop, int fd, int revents)" 4 2471.IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4
1323.IX Item "ev_feed_fd_event (loop, int fd, int revents)" 2472.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)"
1324Feed an event on the given fd, as if a file descriptor backend detected 2473Feed an event on the given fd, as if a file descriptor backend detected
1325the given events it. 2474the given events it.
1326.IP "ev_feed_signal_event (loop, int signum)" 4 2475.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4
1327.IX Item "ev_feed_signal_event (loop, int signum)" 2476.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)"
1328Feed an event as if the given signal occured (loop must be the default loop!). 2477Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default
2478loop!).
1329.SH "LIBEVENT EMULATION" 2479.SH "LIBEVENT EMULATION"
1330.IX Header "LIBEVENT EMULATION" 2480.IX Header "LIBEVENT EMULATION"
1331Libev offers a compatibility emulation layer for libevent. It cannot 2481Libev offers a compatibility emulation layer for libevent. It cannot
1332emulate the internals of libevent, so here are some usage hints: 2482emulate the internals of libevent, so here are some usage hints:
2483.IP "\(bu" 4
1333.IP "* Use it by including <event.h>, as usual." 4 2484Use it by including <event.h>, as usual.
1334.IX Item "Use it by including <event.h>, as usual." 2485.IP "\(bu" 4
1335.PD 0 2486The following members are fully supported: ev_base, ev_callback,
1336.IP "* The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4 2487ev_arg, ev_fd, ev_res, ev_events.
1337.IX Item "The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 2488.IP "\(bu" 4
1338.IP "* Avoid using ev_flags and the EVLIST_*\-macros, while it is maintained by libev, it does not work exactly the same way as in libevent (consider it a private \s-1API\s0)." 4 2489Avoid using ev_flags and the EVLIST_*\-macros, while it is
1339.IX Item "Avoid using ev_flags and the EVLIST_*-macros, while it is maintained by libev, it does not work exactly the same way as in libevent (consider it a private API)." 2490maintained by libev, it does not work exactly the same way as in libevent (consider
1340.IP "* Priorities are not currently supported. Initialising priorities will fail and all watchers will have the same priority, even though there is an ev_pri field." 4 2491it a private \s-1API\s0).
1341.IX Item "Priorities are not currently supported. Initialising priorities will fail and all watchers will have the same priority, even though there is an ev_pri field." 2492.IP "\(bu" 4
2493Priorities are not currently supported. Initialising priorities
2494will fail and all watchers will have the same priority, even though there
2495is an ev_pri field.
2496.IP "\(bu" 4
2497In libevent, the last base created gets the signals, in libev, the
2498first base created (== the default loop) gets the signals.
2499.IP "\(bu" 4
1342.IP "* Other members are not supported." 4 2500Other members are not supported.
1343.IX Item "Other members are not supported." 2501.IP "\(bu" 4
1344.IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 2502The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
1345.IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." 2503to use the libev header file and library.
1346.PD
1347.SH "\*(C+ SUPPORT" 2504.SH "\*(C+ SUPPORT"
1348.IX Header " SUPPORT" 2505.IX Header " SUPPORT"
1349\&\s-1TBD\s0. 2506Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
2507you to use some convinience methods to start/stop watchers and also change
2508the callback model to a model using method callbacks on objects.
2509.PP
2510To use it,
2511.PP
2512.Vb 1
2513\& #include <ev++.h>
2514.Ve
2515.PP
2516This automatically includes \fIev.h\fR and puts all of its definitions (many
2517of them macros) into the global namespace. All \*(C+ specific things are
2518put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
2519options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
2520.PP
2521Care has been taken to keep the overhead low. The only data member the \*(C+
2522classes add (compared to plain C\-style watchers) is the event loop pointer
2523that the watcher is associated with (or no additional members at all if
2524you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
2525.PP
2526Currently, functions, and static and non-static member functions can be
2527used as callbacks. Other types should be easy to add as long as they only
2528need one additional pointer for context. If you need support for other
2529types of functors please contact the author (preferably after implementing
2530it).
2531.PP
2532Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
2533.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4
2534.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
2535.IX Item "ev::READ, ev::WRITE etc."
2536These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc.
2537macros from \fIev.h\fR.
2538.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4
2539.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4
2540.IX Item "ev::tstamp, ev::now"
2541Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix.
2542.ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4
2543.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
2544.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
2545For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
2546the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
2547which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
2548defines by many implementations.
2549.Sp
2550All of those classes have these methods:
2551.RS 4
2552.IP "ev::TYPE::TYPE ()" 4
2553.IX Item "ev::TYPE::TYPE ()"
2554.PD 0
2555.IP "ev::TYPE::TYPE (struct ev_loop *)" 4
2556.IX Item "ev::TYPE::TYPE (struct ev_loop *)"
2557.IP "ev::TYPE::~TYPE" 4
2558.IX Item "ev::TYPE::~TYPE"
2559.PD
2560The constructor (optionally) takes an event loop to associate the watcher
2561with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
2562.Sp
2563The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the
2564\&\f(CW\*(C`set\*(C'\fR method before starting it.
2565.Sp
2566It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR
2567method to set a callback before you can start the watcher.
2568.Sp
2569(The reason why you have to use a method is a limitation in \*(C+ which does
2570not allow explicit template arguments for constructors).
2571.Sp
2572The destructor automatically stops the watcher if it is active.
2573.IP "w\->set<class, &class::method> (object *)" 4
2574.IX Item "w->set<class, &class::method> (object *)"
2575This method sets the callback method to call. The method has to have a
2576signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as
2577first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as
2578parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher.
2579.Sp
2580This method synthesizes efficient thunking code to call your method from
2581the C callback that libev requires. If your compiler can inline your
2582callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and
2583your compiler is good :), then the method will be fully inlined into the
2584thunking function, making it as fast as a direct C callback.
2585.Sp
2586Example: simple class declaration and watcher initialisation
2587.Sp
2588.Vb 4
2589\& struct myclass
2590\& {
2591\& void io_cb (ev::io &w, int revents) { }
2592\& }
2593\&
2594\& myclass obj;
2595\& ev::io iow;
2596\& iow.set <myclass, &myclass::io_cb> (&obj);
2597.Ve
2598.IP "w\->set<function> (void *data = 0)" 4
2599.IX Item "w->set<function> (void *data = 0)"
2600Also sets a callback, but uses a static method or plain function as
2601callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
2602\&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
2603.Sp
2604The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
2605.Sp
2606See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
2607.Sp
2608Example:
2609.Sp
2610.Vb 2
2611\& static void io_cb (ev::io &w, int revents) { }
2612\& iow.set <io_cb> ();
2613.Ve
2614.IP "w\->set (struct ev_loop *)" 4
2615.IX Item "w->set (struct ev_loop *)"
2616Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
2617do this when the watcher is inactive (and not pending either).
2618.IP "w\->set ([args])" 4
2619.IX Item "w->set ([args])"
2620Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be
2621called at least once. Unlike the C counterpart, an active watcher gets
2622automatically stopped and restarted when reconfiguring it with this
2623method.
2624.IP "w\->start ()" 4
2625.IX Item "w->start ()"
2626Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
2627constructor already stores the event loop.
2628.IP "w\->stop ()" 4
2629.IX Item "w->stop ()"
2630Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
2631.ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4
2632.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4
2633.IX Item "w->again () (ev::timer, ev::periodic only)"
2634For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding
2635\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
2636.ie n .IP "w\->sweep () (""ev::embed"" only)" 4
2637.el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4
2638.IX Item "w->sweep () (ev::embed only)"
2639Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR.
2640.ie n .IP "w\->update () (""ev::stat"" only)" 4
2641.el .IP "w\->update () (\f(CWev::stat\fR only)" 4
2642.IX Item "w->update () (ev::stat only)"
2643Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
2644.RE
2645.RS 4
2646.RE
2647.PP
2648Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in
2649the constructor.
2650.PP
2651.Vb 4
2652\& class myclass
2653\& {
2654\& ev::io io; void io_cb (ev::io &w, int revents);
2655\& ev:idle idle void idle_cb (ev::idle &w, int revents);
2656\&
2657\& myclass (int fd)
2658\& {
2659\& io .set <myclass, &myclass::io_cb > (this);
2660\& idle.set <myclass, &myclass::idle_cb> (this);
2661\&
2662\& io.start (fd, ev::READ);
2663\& }
2664\& };
2665.Ve
2666.SH "OTHER LANGUAGE BINDINGS"
2667.IX Header "OTHER LANGUAGE BINDINGS"
2668Libev does not offer other language bindings itself, but bindings for a
2669numbe rof languages exist in the form of third-party packages. If you know
2670any interesting language binding in addition to the ones listed here, drop
2671me a note.
2672.IP "Perl" 4
2673.IX Item "Perl"
2674The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test
2675libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module,
2676there are additional modules that implement libev-compatible interfaces
2677to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR), \f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the
2678\&\f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR and \f(CW\*(C`EV::Glib\*(C'\fR).
2679.Sp
2680It can be found and installed via \s-1CPAN\s0, its homepage is found at
2681<http://software.schmorp.de/pkg/EV>.
2682.IP "Ruby" 4
2683.IX Item "Ruby"
2684Tony Arcieri has written a ruby extension that offers access to a subset
2685of the libev \s-1API\s0 and adds filehandle abstractions, asynchronous \s-1DNS\s0 and
2686more on top of it. It can be found via gem servers. Its homepage is at
2687<http://rev.rubyforge.org/>.
2688.IP "D" 4
2689.IX Item "D"
2690Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
2691be found at <http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2692.SH "MACRO MAGIC"
2693.IX Header "MACRO MAGIC"
2694Libev can be compiled with a variety of options, the most fundamantal
2695of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
2696functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
2697.PP
2698To make it easier to write programs that cope with either variant, the
2699following macros are defined:
2700.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4
2701.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
2702.IX Item "EV_A, EV_A_"
2703This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
2704loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
2705\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
2706.Sp
2707.Vb 3
2708\& ev_unref (EV_A);
2709\& ev_timer_add (EV_A_ watcher);
2710\& ev_loop (EV_A_ 0);
2711.Ve
2712.Sp
2713It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
2714which is often provided by the following macro.
2715.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4
2716.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
2717.IX Item "EV_P, EV_P_"
2718This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
2719loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
2720\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
2721.Sp
2722.Vb 2
2723\& // this is how ev_unref is being declared
2724\& static void ev_unref (EV_P);
2725\&
2726\& // this is how you can declare your typical callback
2727\& static void cb (EV_P_ ev_timer *w, int revents)
2728.Ve
2729.Sp
2730It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
2731suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
2732.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4
2733.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
2734.IX Item "EV_DEFAULT, EV_DEFAULT_"
2735Similar to the other two macros, this gives you the value of the default
2736loop, if multiple loops are supported (\*(L"ev loop default\*(R").
2737.ie n .IP """EV_DEFAULT_UC""\fR, \f(CW""EV_DEFAULT_UC_""" 4
2738.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
2739.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
2740Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
2741default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
2742is undefined when the default loop has not been initialised by a previous
2743execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR.
2744.Sp
2745It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first
2746watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards.
2747.PP
2748Example: Declare and initialise a check watcher, utilising the above
2749macros so it will work regardless of whether multiple loops are supported
2750or not.
2751.PP
2752.Vb 5
2753\& static void
2754\& check_cb (EV_P_ ev_timer *w, int revents)
2755\& {
2756\& ev_check_stop (EV_A_ w);
2757\& }
2758\&
2759\& ev_check check;
2760\& ev_check_init (&check, check_cb);
2761\& ev_check_start (EV_DEFAULT_ &check);
2762\& ev_loop (EV_DEFAULT_ 0);
2763.Ve
2764.SH "EMBEDDING"
2765.IX Header "EMBEDDING"
2766Libev can (and often is) directly embedded into host
2767applications. Examples of applications that embed it include the Deliantra
2768Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe)
2769and rxvt-unicode.
2770.PP
2771The goal is to enable you to just copy the necessary files into your
2772source directory without having to change even a single line in them, so
2773you can easily upgrade by simply copying (or having a checked-out copy of
2774libev somewhere in your source tree).
2775.Sh "\s-1FILESETS\s0"
2776.IX Subsection "FILESETS"
2777Depending on what features you need you need to include one or more sets of files
2778in your app.
2779.PP
2780\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
2781.IX Subsection "CORE EVENT LOOP"
2782.PP
2783To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
2784configuration (no autoconf):
2785.PP
2786.Vb 2
2787\& #define EV_STANDALONE 1
2788\& #include "ev.c"
2789.Ve
2790.PP
2791This will automatically include \fIev.h\fR, too, and should be done in a
2792single C source file only to provide the function implementations. To use
2793it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
2794done by writing a wrapper around \fIev.h\fR that you can include instead and
2795where you can put other configuration options):
2796.PP
2797.Vb 2
2798\& #define EV_STANDALONE 1
2799\& #include "ev.h"
2800.Ve
2801.PP
2802Both header files and implementation files can be compiled with a \*(C+
2803compiler (at least, thats a stated goal, and breakage will be treated
2804as a bug).
2805.PP
2806You need the following files in your source tree, or in a directory
2807in your include path (e.g. in libev/ when using \-Ilibev):
2808.PP
2809.Vb 4
2810\& ev.h
2811\& ev.c
2812\& ev_vars.h
2813\& ev_wrap.h
2814\&
2815\& ev_win32.c required on win32 platforms only
2816\&
2817\& ev_select.c only when select backend is enabled (which is enabled by default)
2818\& ev_poll.c only when poll backend is enabled (disabled by default)
2819\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2820\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2821\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2822.Ve
2823.PP
2824\&\fIev.c\fR includes the backend files directly when enabled, so you only need
2825to compile this single file.
2826.PP
2827\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR
2828.IX Subsection "LIBEVENT COMPATIBILITY API"
2829.PP
2830To include the libevent compatibility \s-1API\s0, also include:
2831.PP
2832.Vb 1
2833\& #include "event.c"
2834.Ve
2835.PP
2836in the file including \fIev.c\fR, and:
2837.PP
2838.Vb 1
2839\& #include "event.h"
2840.Ve
2841.PP
2842in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR.
2843.PP
2844You need the following additional files for this:
2845.PP
2846.Vb 2
2847\& event.h
2848\& event.c
2849.Ve
2850.PP
2851\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR
2852.IX Subsection "AUTOCONF SUPPORT"
2853.PP
2854Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in
2855whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
2856\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
2857include \fIconfig.h\fR and configure itself accordingly.
2858.PP
2859For this of course you need the m4 file:
2860.PP
2861.Vb 1
2862\& libev.m4
2863.Ve
2864.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
2865.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
2866Libev can be configured via a variety of preprocessor symbols you have to
2867define before including any of its files. The default in the absense of
2868autoconf is noted for every option.
2869.IP "\s-1EV_STANDALONE\s0" 4
2870.IX Item "EV_STANDALONE"
2871Must always be \f(CW1\fR if you do not use autoconf configuration, which
2872keeps libev from including \fIconfig.h\fR, and it also defines dummy
2873implementations for some libevent functions (such as logging, which is not
2874supported). It will also not define any of the structs usually found in
2875\&\fIevent.h\fR that are not directly supported by the libev core alone.
2876.IP "\s-1EV_USE_MONOTONIC\s0" 4
2877.IX Item "EV_USE_MONOTONIC"
2878If defined to be \f(CW1\fR, libev will try to detect the availability of the
2879monotonic clock option at both compiletime and runtime. Otherwise no use
2880of the monotonic clock option will be attempted. If you enable this, you
2881usually have to link against librt or something similar. Enabling it when
2882the functionality isn't available is safe, though, although you have
2883to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
2884function is hiding in (often \fI\-lrt\fR).
2885.IP "\s-1EV_USE_REALTIME\s0" 4
2886.IX Item "EV_USE_REALTIME"
2887If defined to be \f(CW1\fR, libev will try to detect the availability of the
2888realtime clock option at compiletime (and assume its availability at
2889runtime if successful). Otherwise no use of the realtime clock option will
2890be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get
2891(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the
2892note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though.
2893.IP "\s-1EV_USE_NANOSLEEP\s0" 4
2894.IX Item "EV_USE_NANOSLEEP"
2895If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
2896and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
2897.IP "\s-1EV_USE_EVENTFD\s0" 4
2898.IX Item "EV_USE_EVENTFD"
2899If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
2900available and will probe for kernel support at runtime. This will improve
2901\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
2902If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
29032.7 or newer, otherwise disabled.
2904.IP "\s-1EV_USE_SELECT\s0" 4
2905.IX Item "EV_USE_SELECT"
2906If undefined or defined to be \f(CW1\fR, libev will compile in support for the
2907\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no
2908other method takes over, select will be it. Otherwise the select backend
2909will not be compiled in.
2910.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
2911.IX Item "EV_SELECT_USE_FD_SET"
2912If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
2913structure. This is useful if libev doesn't compile due to a missing
2914\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on
2915exotic systems. This usually limits the range of file descriptors to some
2916low limit such as 1024 or might have other limitations (winsocket only
2917allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might
2918influence the size of the \f(CW\*(C`fd_set\*(C'\fR used.
2919.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
2920.IX Item "EV_SELECT_IS_WINSOCKET"
2921When defined to \f(CW1\fR, the select backend will assume that
2922select/socket/connect etc. don't understand file descriptors but
2923wants osf handles on win32 (this is the case when the select to
2924be used is the winsock select). This means that it will call
2925\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
2926it is assumed that all these functions actually work on fds, even
2927on win32. Should not be defined on non\-win32 platforms.
2928.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0" 4
2929.IX Item "EV_FD_TO_WIN32_HANDLE"
2930If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map
2931file descriptors to socket handles. When not defining this symbol (the
2932default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually
2933correct. In some cases, programs use their own file descriptor management,
2934in which case they can provide this function to map fds to socket handles.
2935.IP "\s-1EV_USE_POLL\s0" 4
2936.IX Item "EV_USE_POLL"
2937If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
2938backend. Otherwise it will be enabled on non\-win32 platforms. It
2939takes precedence over select.
2940.IP "\s-1EV_USE_EPOLL\s0" 4
2941.IX Item "EV_USE_EPOLL"
2942If defined to be \f(CW1\fR, libev will compile in support for the Linux
2943\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
2944otherwise another method will be used as fallback. This is the preferred
2945backend for GNU/Linux systems. If undefined, it will be enabled if the
2946headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2947.IP "\s-1EV_USE_KQUEUE\s0" 4
2948.IX Item "EV_USE_KQUEUE"
2949If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
2950\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
2951otherwise another method will be used as fallback. This is the preferred
2952backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only
2953supports some types of fds correctly (the only platform we found that
2954supports ptys for example was NetBSD), so kqueue might be compiled in, but
2955not be used unless explicitly requested. The best way to use it is to find
2956out whether kqueue supports your type of fd properly and use an embedded
2957kqueue loop.
2958.IP "\s-1EV_USE_PORT\s0" 4
2959.IX Item "EV_USE_PORT"
2960If defined to be \f(CW1\fR, libev will compile in support for the Solaris
296110 port style backend. Its availability will be detected at runtime,
2962otherwise another method will be used as fallback. This is the preferred
2963backend for Solaris 10 systems.
2964.IP "\s-1EV_USE_DEVPOLL\s0" 4
2965.IX Item "EV_USE_DEVPOLL"
2966reserved for future expansion, works like the \s-1USE\s0 symbols above.
2967.IP "\s-1EV_USE_INOTIFY\s0" 4
2968.IX Item "EV_USE_INOTIFY"
2969If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2970interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2971be detected at runtime. If undefined, it will be enabled if the headers
2972indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2973.IP "\s-1EV_ATOMIC_T\s0" 4
2974.IX Item "EV_ATOMIC_T"
2975Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
2976access is atomic with respect to other threads or signal contexts. No such
2977type is easily found in the C language, so you can provide your own type
2978that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R"
2979as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers.
2980.Sp
2981In the absense of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
2982(from \fIsignal.h\fR), which is usually good enough on most platforms.
2983.IP "\s-1EV_H\s0" 4
2984.IX Item "EV_H"
2985The name of the \fIev.h\fR header file used to include it. The default if
2986undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
2987used to virtually rename the \fIev.h\fR header file in case of conflicts.
2988.IP "\s-1EV_CONFIG_H\s0" 4
2989.IX Item "EV_CONFIG_H"
2990If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
2991\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
2992\&\f(CW\*(C`EV_H\*(C'\fR, above.
2993.IP "\s-1EV_EVENT_H\s0" 4
2994.IX Item "EV_EVENT_H"
2995Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
2996of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
2997.IP "\s-1EV_PROTOTYPES\s0" 4
2998.IX Item "EV_PROTOTYPES"
2999If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
3000prototypes, but still define all the structs and other symbols. This is
3001occasionally useful if you want to provide your own wrapper functions
3002around libev functions.
3003.IP "\s-1EV_MULTIPLICITY\s0" 4
3004.IX Item "EV_MULTIPLICITY"
3005If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
3006will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
3007additional independent event loops. Otherwise there will be no support
3008for multiple event loops and there is no first event loop pointer
3009argument. Instead, all functions act on the single default loop.
3010.IP "\s-1EV_MINPRI\s0" 4
3011.IX Item "EV_MINPRI"
3012.PD 0
3013.IP "\s-1EV_MAXPRI\s0" 4
3014.IX Item "EV_MAXPRI"
3015.PD
3016The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to
3017\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can
3018provide for more priorities by overriding those symbols (usually defined
3019to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively).
3020.Sp
3021When doing priority-based operations, libev usually has to linearly search
3022all the priorities, so having many of them (hundreds) uses a lot of space
3023and time, so using the defaults of five priorities (\-2 .. +2) is usually
3024fine.
3025.Sp
3026If your embedding app does not need any priorities, defining these both to
3027\&\f(CW0\fR will save some memory and cpu.
3028.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
3029.IX Item "EV_PERIODIC_ENABLE"
3030If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
3031defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
3032code.
3033.IP "\s-1EV_IDLE_ENABLE\s0" 4
3034.IX Item "EV_IDLE_ENABLE"
3035If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If
3036defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
3037code.
3038.IP "\s-1EV_EMBED_ENABLE\s0" 4
3039.IX Item "EV_EMBED_ENABLE"
3040If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
3041defined to be \f(CW0\fR, then they are not.
3042.IP "\s-1EV_STAT_ENABLE\s0" 4
3043.IX Item "EV_STAT_ENABLE"
3044If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
3045defined to be \f(CW0\fR, then they are not.
3046.IP "\s-1EV_FORK_ENABLE\s0" 4
3047.IX Item "EV_FORK_ENABLE"
3048If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
3049defined to be \f(CW0\fR, then they are not.
3050.IP "\s-1EV_ASYNC_ENABLE\s0" 4
3051.IX Item "EV_ASYNC_ENABLE"
3052If undefined or defined to be \f(CW1\fR, then async watchers are supported. If
3053defined to be \f(CW0\fR, then they are not.
3054.IP "\s-1EV_MINIMAL\s0" 4
3055.IX Item "EV_MINIMAL"
3056If you need to shave off some kilobytes of code at the expense of some
3057speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override
3058some inlining decisions, saves roughly 30% codesize of amd64.
3059.IP "\s-1EV_PID_HASHSIZE\s0" 4
3060.IX Item "EV_PID_HASHSIZE"
3061\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
3062pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
3063than enough. If you need to manage thousands of children you might want to
3064increase this value (\fImust\fR be a power of two).
3065.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
3066.IX Item "EV_INOTIFY_HASHSIZE"
3067\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
3068inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
3069usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
3070watchers you might want to increase this value (\fImust\fR be a power of
3071two).
3072.IP "\s-1EV_COMMON\s0" 4
3073.IX Item "EV_COMMON"
3074By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
3075this macro to a something else you can include more and other types of
3076members. You have to define it each time you include one of the files,
3077though, and it must be identical each time.
3078.Sp
3079For example, the perl \s-1EV\s0 module uses something like this:
3080.Sp
3081.Vb 3
3082\& #define EV_COMMON \e
3083\& SV *self; /* contains this struct */ \e
3084\& SV *cb_sv, *fh /* note no trailing ";" */
3085.Ve
3086.IP "\s-1EV_CB_DECLARE\s0 (type)" 4
3087.IX Item "EV_CB_DECLARE (type)"
3088.PD 0
3089.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4
3090.IX Item "EV_CB_INVOKE (watcher, revents)"
3091.IP "ev_set_cb (ev, cb)" 4
3092.IX Item "ev_set_cb (ev, cb)"
3093.PD
3094Can be used to change the callback member declaration in each watcher,
3095and the way callbacks are invoked and set. Must expand to a struct member
3096definition and a statement, respectively. See the \fIev.h\fR header file for
3097their default definitions. One possible use for overriding these is to
3098avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
3099method calls instead of plain function calls in \*(C+.
3100.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
3101.IX Subsection "EXPORTED API SYMBOLS"
3102If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of
3103exported symbols, you can use the provided \fISymbol.*\fR files which list
3104all public symbols, one per line:
3105.PP
3106.Vb 2
3107\& Symbols.ev for libev proper
3108\& Symbols.event for the libevent emulation
3109.Ve
3110.PP
3111This can also be used to rename all public symbols to avoid clashes with
3112multiple versions of libev linked together (which is obviously bad in
3113itself, but sometimes it is inconvinient to avoid this).
3114.PP
3115A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to
3116include before including \fIev.h\fR:
3117.PP
3118.Vb 1
3119\& <Symbols.ev sed \-e "s/.*/#define & myprefix_&/" >wrap.h
3120.Ve
3121.PP
3122This would create a file \fIwrap.h\fR which essentially looks like this:
3123.PP
3124.Vb 4
3125\& #define ev_backend myprefix_ev_backend
3126\& #define ev_check_start myprefix_ev_check_start
3127\& #define ev_check_stop myprefix_ev_check_stop
3128\& ...
3129.Ve
3130.Sh "\s-1EXAMPLES\s0"
3131.IX Subsection "EXAMPLES"
3132For a real-world example of a program the includes libev
3133verbatim, you can have a look at the \s-1EV\s0 perl module
3134(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
3135the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
3136interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
3137will be compiled. It is pretty complex because it provides its own header
3138file.
3139.PP
3140The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
3141that everybody includes and which overrides some configure choices:
3142.PP
3143.Vb 9
3144\& #define EV_MINIMAL 1
3145\& #define EV_USE_POLL 0
3146\& #define EV_MULTIPLICITY 0
3147\& #define EV_PERIODIC_ENABLE 0
3148\& #define EV_STAT_ENABLE 0
3149\& #define EV_FORK_ENABLE 0
3150\& #define EV_CONFIG_H <config.h>
3151\& #define EV_MINPRI 0
3152\& #define EV_MAXPRI 0
3153\&
3154\& #include "ev++.h"
3155.Ve
3156.PP
3157And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
3158.PP
3159.Vb 2
3160\& #include "ev_cpp.h"
3161\& #include "ev.c"
3162.Ve
3163.SH "THREADS AND COROUTINES"
3164.IX Header "THREADS AND COROUTINES"
3165.Sh "\s-1THREADS\s0"
3166.IX Subsection "THREADS"
3167Libev itself is completely threadsafe, but it uses no locking. This
3168means that you can use as many loops as you want in parallel, as long as
3169only one thread ever calls into one libev function with the same loop
3170parameter.
3171.PP
3172Or put differently: calls with different loop parameters can be done in
3173parallel from multiple threads, calls with the same loop parameter must be
3174done serially (but can be done from different threads, as long as only one
3175thread ever is inside a call at any point in time, e.g. by using a mutex
3176per loop).
3177.PP
3178If you want to know which design is best for your problem, then I cannot
3179help you but by giving some generic advice:
3180.IP "\(bu" 4
3181most applications have a main thread: use the default libev loop
3182in that thread, or create a seperate thread running only the default loop.
3183.Sp
3184This helps integrating other libraries or software modules that use libev
3185themselves and don't care/know about threading.
3186.IP "\(bu" 4
3187one loop per thread is usually a good model.
3188.Sp
3189Doing this is almost never wrong, sometimes a better-performance model
3190exists, but it is always a good start.
3191.IP "\(bu" 4
3192other models exist, such as the leader/follower pattern, where one
3193loop is handed through multiple threads in a kind of round-robbin fashion.
3194.Sp
3195Chosing a model is hard \- look around, learn, know that usually you cna do
3196better than you currently do :\-)
3197.IP "\(bu" 4
3198often you need to talk to some other thread which blocks in the
3199event loop \- \f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other
3200threads safely (or from signal contexts...).
3201.Sh "\s-1COROUTINES\s0"
3202.IX Subsection "COROUTINES"
3203Libev is much more accomodating to coroutines (\*(L"cooperative threads\*(R"):
3204libev fully supports nesting calls to it's functions from different
3205coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two
3206different coroutines and switch freely between both coroutines running the
3207loop, as long as you don't confuse yourself). The only exception is that
3208you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
3209.PP
3210Care has been invested into making sure that libev does not keep local
3211state inside \f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow coroutine
3212switches.
3213.SH "COMPLEXITIES"
3214.IX Header "COMPLEXITIES"
3215In this section the complexities of (many of) the algorithms used inside
3216libev will be explained. For complexity discussions about backends see the
3217documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
3218.PP
3219All of the following are about amortised time: If an array needs to be
3220extended, libev needs to realloc and move the whole array, but this
3221happens asymptotically never with higher number of elements, so O(1) might
3222mean it might do a lengthy realloc operation in rare cases, but on average
3223it is much faster and asymptotically approaches constant time.
3224.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
3225.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
3226This means that, when you have a watcher that triggers in one hour and
3227there are 100 watchers that would trigger before that then inserting will
3228have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
3229.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
3230.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
3231That means that changing a timer costs less than removing/adding them
3232as only the relative motion in the event queue has to be paid for.
3233.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4
3234.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)"
3235These just add the watcher into an array or at the head of a list.
3236.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4
3237.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)"
3238.PD 0
3239.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
3240.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
3241.PD
3242These watchers are stored in lists then need to be walked to find the
3243correct watcher to remove. The lists are usually short (you don't usually
3244have many watchers waiting for the same fd or signal).
3245.IP "Finding the next timer in each loop iteration: O(1)" 4
3246.IX Item "Finding the next timer in each loop iteration: O(1)"
3247By virtue of using a binary heap, the next timer is always found at the
3248beginning of the storage array.
3249.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
3250.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
3251A change means an I/O watcher gets started or stopped, which requires
3252libev to recalculate its status (and possibly tell the kernel, depending
3253on backend and wether \f(CW\*(C`ev_io_set\*(C'\fR was used).
3254.IP "Activating one watcher (putting it into the pending state): O(1)" 4
3255.IX Item "Activating one watcher (putting it into the pending state): O(1)"
3256.PD 0
3257.IP "Priority handling: O(number_of_priorities)" 4
3258.IX Item "Priority handling: O(number_of_priorities)"
3259.PD
3260Priorities are implemented by allocating some space for each
3261priority. When doing priority-based operations, libev usually has to
3262linearly search all the priorities, but starting/stopping and activating
3263watchers becomes O(1) w.r.t. priority handling.
3264.IP "Sending an ev_async: O(1)" 4
3265.IX Item "Sending an ev_async: O(1)"
3266.PD 0
3267.IP "Processing ev_async_send: O(number_of_async_watchers)" 4
3268.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
3269.IP "Processing signals: O(max_signal_number)" 4
3270.IX Item "Processing signals: O(max_signal_number)"
3271.PD
3272Sending involves a syscall \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
3273calls in the current loop iteration. Checking for async and signal events
3274involves iterating over all running async watchers or all signal numbers.
3275.SH "Win32 platform limitations and workarounds"
3276.IX Header "Win32 platform limitations and workarounds"
3277Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
3278requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
3279model. Libev still offers limited functionality on this platform in
3280the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
3281descriptors. This only applies when using Win32 natively, not when using
3282e.g. cygwin.
3283.PP
3284There is no supported compilation method available on windows except
3285embedding it into other applications.
3286.PP
3287Due to the many, low, and arbitrary limits on the win32 platform and the
3288abysmal performance of winsockets, using a large number of sockets is not
3289recommended (and not reasonable). If your program needs to use more than
3290a hundred or so sockets, then likely it needs to use a totally different
3291implementation for windows, as libev offers the \s-1POSIX\s0 model, which cannot
3292be implemented efficiently on windows (microsoft monopoly games).
3293.IP "The winsocket select function" 4
3294.IX Item "The winsocket select function"
3295The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it requires
3296socket \fIhandles\fR and not socket \fIfile descriptors\fR. This makes select
3297very inefficient, and also requires a mapping from file descriptors
3298to socket handles. See the discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR,
3299\&\f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and \f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor
3300symbols for more info.
3301.Sp
3302The configuration for a \*(L"naked\*(R" win32 using the microsoft runtime
3303libraries and raw winsocket select is:
3304.Sp
3305.Vb 2
3306\& #define EV_USE_SELECT 1
3307\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3308.Ve
3309.Sp
3310Note that winsockets handling of fd sets is O(n), so you can easily get a
3311complexity in the O(nA\*^X) range when using win32.
3312.IP "Limited number of file descriptors" 4
3313.IX Item "Limited number of file descriptors"
3314Windows has numerous arbitrary (and low) limits on things. Early versions
3315of winsocket's select only supported waiting for a max. of \f(CW64\fR handles
3316(probably owning to the fact that all windows kernels can only wait for
3317\&\f(CW64\fR things at the same time internally; microsoft recommends spawning a
3318chain of threads and wait for 63 handles and the previous thread in each).
3319.Sp
3320Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
3321to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
3322call (which might be in libev or elsewhere, for example, perl does its own
3323select emulation on windows).
3324.Sp
3325Another limit is the number of file descriptors in the microsoft runtime
3326libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish
3327or something like this inside microsoft). You can increase this by calling
3328\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another
3329arbitrary limit), but is broken in many versions of the microsoft runtime
3330libraries.
3331.Sp
3332This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on
3333windows version and/or the phase of the moon). To get more, you need to
3334wrap all I/O functions and provide your own fd management, but the cost of
3335calling select (O(nA\*^X)) will likely make this unworkable.
1350.SH "AUTHOR" 3336.SH "AUTHOR"
1351.IX Header "AUTHOR" 3337.IX Header "AUTHOR"
1352Marc Lehmann <libev@schmorp.de>. 3338Marc Lehmann <libev@schmorp.de>.
3339.SH "POD ERRORS"
3340.IX Header "POD ERRORS"
3341Hey! \fBThe above document had some coding errors, which are explained below:\fR
3342.IP "Around line 3015:" 4
3343.IX Item "Around line 3015:"
3344You forgot a '=back' before '=head2'

Diff Legend

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