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

Comparing libev/ev.3 (file contents):
Revision 1.65 by root, Sun May 11 11:47:27 2008 UTC vs.
Revision 1.73 by root, Thu Oct 30 08:09:30 2008 UTC

130.\} 130.\}
131.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
132.\" ======================================================================== 132.\" ========================================================================
133.\" 133.\"
134.IX Title "LIBEV 3" 134.IX Title "LIBEV 3"
135.TH LIBEV 3 "2008-05-09" "libev-1.1" "libev - high perfromance full featured event loop" 135.TH LIBEV 3 "2008-10-30" "libev-3.48" "libev - high performance full featured event loop"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 137.\" way too many mistakes in technical documents.
138.if n .ad l 138.if n .ad l
139.nh 139.nh
140.SH "NAME" 140.SH "NAME"
141libev \- a high performance full\-featured event loop written in C 141libev \- a high performance full\-featured event loop written in C
142.SH "SYNOPSIS" 142.SH "SYNOPSIS"
143.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
144.Vb 1 144.Vb 1
145\& #include <ev.h> 145\& #include <ev.h>
146.Ve 146.Ve
147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
148.IX Subsection "EXAMPLE PROGRAM" 148.IX Subsection "EXAMPLE PROGRAM"
149.Vb 2 149.Vb 2
150\& // a single header file is required 150\& // a single header file is required
151\& #include <ev.h> 151\& #include <ev.h>
152\& 152\&
153\& // every watcher type has its own typedef\*(Aqd struct 153\& // every watcher type has its own typedef\*(Aqd struct
154\& // with the name ev_<type> 154\& // with the name ev_TYPE
155\& ev_io stdin_watcher; 155\& ev_io stdin_watcher;
156\& ev_timer timeout_watcher; 156\& ev_timer timeout_watcher;
157\& 157\&
158\& // all watcher callbacks have a similar signature 158\& // all watcher callbacks have a similar signature
159\& // this callback is called when data is readable on stdin 159\& // this callback is called when data is readable on stdin
160\& static void 160\& static void
161\& stdin_cb (EV_P_ struct ev_io *w, int revents) 161\& stdin_cb (EV_P_ ev_io *w, int revents)
162\& { 162\& {
163\& puts ("stdin ready"); 163\& puts ("stdin ready");
164\& // for one\-shot events, one must manually stop the watcher 164\& // for one\-shot events, one must manually stop the watcher
165\& // with its corresponding stop function. 165\& // with its corresponding stop function.
166\& ev_io_stop (EV_A_ w); 166\& ev_io_stop (EV_A_ w);
167\& 167\&
168\& // this causes all nested ev_loop\*(Aqs to stop iterating 168\& // this causes all nested ev_loop\*(Aqs to stop iterating
169\& ev_unloop (EV_A_ EVUNLOOP_ALL); 169\& ev_unloop (EV_A_ EVUNLOOP_ALL);
170\& } 170\& }
171\& 171\&
172\& // another callback, this time for a time\-out 172\& // another callback, this time for a time\-out
173\& static void 173\& static void
174\& timeout_cb (EV_P_ struct ev_timer *w, int revents) 174\& timeout_cb (EV_P_ ev_timer *w, int revents)
175\& { 175\& {
176\& puts ("timeout"); 176\& puts ("timeout");
177\& // this causes the innermost ev_loop to stop iterating 177\& // this causes the innermost ev_loop to stop iterating
178\& ev_unloop (EV_A_ EVUNLOOP_ONE); 178\& ev_unloop (EV_A_ EVUNLOOP_ONE);
179\& } 179\& }
180\& 180\&
181\& int 181\& int
182\& main (void) 182\& main (void)
183\& { 183\& {
184\& // use the default event loop unless you have special needs 184\& // use the default event loop unless you have special needs
185\& struct ev_loop *loop = ev_default_loop (0); 185\& ev_loop *loop = ev_default_loop (0);
186\& 186\&
187\& // initialise an io watcher, then start it 187\& // initialise an io watcher, then start it
188\& // this one will watch for stdin to become readable 188\& // this one will watch for stdin to become readable
189\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 189\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
190\& ev_io_start (loop, &stdin_watcher); 190\& ev_io_start (loop, &stdin_watcher);
191\& 191\&
192\& // initialise a timer watcher, then start it 192\& // initialise a timer watcher, then start it
193\& // simple non\-repeating 5.5 second timeout 193\& // simple non\-repeating 5.5 second timeout
194\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 194\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
195\& ev_timer_start (loop, &timeout_watcher); 195\& ev_timer_start (loop, &timeout_watcher);
196\& 196\&
197\& // now wait for events to arrive 197\& // now wait for events to arrive
198\& ev_loop (loop, 0); 198\& ev_loop (loop, 0);
199\& 199\&
200\& // unloop was called, so exit 200\& // unloop was called, so exit
201\& return 0; 201\& return 0;
202\& } 202\& }
203.Ve 203.Ve
204.SH "DESCRIPTION" 204.SH "DESCRIPTION"
205.IX Header "DESCRIPTION" 205.IX Header "DESCRIPTION"
206The newest version of this document is also available as an html-formatted 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 207web page you might find easier to navigate when reading it for the first
208time: <http://cvs.schmorp.de/libev/ev.html>. 208time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
209.PP 209.PP
210Libev 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
211file descriptor being readable or a timeout occurring), and it will manage 211file descriptor being readable or a timeout occurring), and it will manage
212these event sources and provide your program with events. 212these event sources and provide your program with events.
213.PP 213.PP
240Libev is very configurable. In this manual the default (and most common) 240Libev is very configurable. In this manual the default (and most common)
241configuration will be described, which supports multiple event loops. For 241configuration will be described, which supports multiple event loops. For
242more info about various configuration options please have a look at 242more info about various configuration options please have a look at
243\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support 243\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
244for multiple event loops, then all functions taking an initial argument of 244for multiple event loops, then all functions taking an initial argument of
245name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have 245name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`ev_loop *\*(C'\fR) will not have
246this argument. 246this argument.
247.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0" 247.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0"
248.IX Subsection "TIME REPRESENTATION" 248.IX Subsection "TIME REPRESENTATION"
249Libev represents time as a single floating point number, representing the 249Libev represents time as a single floating point number, representing the
250(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
251the 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
252called \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
253to 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
254it, you should treat it as some floatingpoint value. Unlike the name 254it, you should treat it as some floating point value. Unlike the name
255component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences 255component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences
256throughout libev. 256throughout libev.
257.SH "ERROR HANDLING"
258.IX Header "ERROR HANDLING"
259Libev knows three classes of errors: operating system errors, usage errors
260and internal errors (bugs).
261.PP
262When libev catches an operating system error it cannot handle (for example
263a system call indicating a condition libev cannot fix), it calls the callback
264set via \f(CW\*(C`ev_set_syserr_cb\*(C'\fR, which is supposed to fix the problem or
265abort. The default is to print a diagnostic message and to call \f(CW\*(C`abort
266()\*(C'\fR.
267.PP
268When libev detects a usage error such as a negative timer interval, then
269it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism,
270so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in
271the libev caller and need to be fixed there.
272.PP
273Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has
274extensive consistency checking code. These do not trigger under normal
275circumstances, as they indicate either a bug in libev or worse.
257.SH "GLOBAL FUNCTIONS" 276.SH "GLOBAL FUNCTIONS"
258.IX Header "GLOBAL FUNCTIONS" 277.IX Header "GLOBAL FUNCTIONS"
259These functions can be called anytime, even before initialising the 278These functions can be called anytime, even before initialising the
260library in any way. 279library in any way.
261.IP "ev_tstamp ev_time ()" 4 280.IP "ev_tstamp ev_time ()" 4
265you actually want to know. 284you actually want to know.
266.IP "ev_sleep (ev_tstamp interval)" 4 285.IP "ev_sleep (ev_tstamp interval)" 4
267.IX Item "ev_sleep (ev_tstamp interval)" 286.IX Item "ev_sleep (ev_tstamp interval)"
268Sleep for the given interval: The current thread will be blocked until 287Sleep for the given interval: The current thread will be blocked until
269either it is interrupted or the given time interval has passed. Basically 288either it is interrupted or the given time interval has passed. Basically
270this is a subsecond-resolution \f(CW\*(C`sleep ()\*(C'\fR. 289this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR.
271.IP "int ev_version_major ()" 4 290.IP "int ev_version_major ()" 4
272.IX Item "int ev_version_major ()" 291.IX Item "int ev_version_major ()"
273.PD 0 292.PD 0
274.IP "int ev_version_minor ()" 4 293.IP "int ev_version_minor ()" 4
275.IX Item "int ev_version_minor ()" 294.IX Item "int ev_version_minor ()"
290.Sp 309.Sp
291Example: Make sure we haven't accidentally been linked against the wrong 310Example: Make sure we haven't accidentally been linked against the wrong
292version. 311version.
293.Sp 312.Sp
294.Vb 3 313.Vb 3
295\& assert (("libev version mismatch", 314\& assert (("libev version mismatch",
296\& ev_version_major () == EV_VERSION_MAJOR 315\& ev_version_major () == EV_VERSION_MAJOR
297\& && ev_version_minor () >= EV_VERSION_MINOR)); 316\& && ev_version_minor () >= EV_VERSION_MINOR));
298.Ve 317.Ve
299.IP "unsigned int ev_supported_backends ()" 4 318.IP "unsigned int ev_supported_backends ()" 4
300.IX Item "unsigned int ev_supported_backends ()" 319.IX Item "unsigned int ev_supported_backends ()"
301Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR 320Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR
302value) compiled into this binary of libev (independent of their 321value) compiled into this binary of libev (independent of their
305.Sp 324.Sp
306Example: make sure we have the epoll method, because yeah this is cool and 325Example: make sure we have the epoll method, because yeah this is cool and
307a must have and can we have a torrent of it please!!!11 326a must have and can we have a torrent of it please!!!11
308.Sp 327.Sp
309.Vb 2 328.Vb 2
310\& assert (("sorry, no epoll, no sex", 329\& assert (("sorry, no epoll, no sex",
311\& ev_supported_backends () & EVBACKEND_EPOLL)); 330\& ev_supported_backends () & EVBACKEND_EPOLL));
312.Ve 331.Ve
313.IP "unsigned int ev_recommended_backends ()" 4 332.IP "unsigned int ev_recommended_backends ()" 4
314.IX Item "unsigned int ev_recommended_backends ()" 333.IX Item "unsigned int ev_recommended_backends ()"
315Return the set of all backends compiled into this binary of libev and also 334Return the set of all backends compiled into this binary of libev and also
316recommended for this platform. This set is often smaller than the one 335recommended for this platform. This set is often smaller than the one
317returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on 336returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on
318most BSDs and will not be autodetected unless you explicitly request it 337most BSDs and will not be auto-detected unless you explicitly request it
319(assuming you know what you are doing). This is the set of backends that 338(assuming you know what you are doing). This is the set of backends that
320libev will probe for if you specify no backends explicitly. 339libev will probe for if you specify no backends explicitly.
321.IP "unsigned int ev_embeddable_backends ()" 4 340.IP "unsigned int ev_embeddable_backends ()" 4
322.IX Item "unsigned int ev_embeddable_backends ()" 341.IX Item "unsigned int ev_embeddable_backends ()"
323Returns the set of backends that are embeddable in other event loops. This 342Returns the set of backends that are embeddable in other event loops. This
325might be supported on the current system, you would need to look at 344might be supported on the current system, you would need to look at
326\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 345\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
327recommended ones. 346recommended ones.
328.Sp 347.Sp
329See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 348See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
330.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 349.IP "ev_set_allocator (void *(*cb)(void *ptr, long size)) [\s-1NOT\s0 \s-1REENTRANT\s0]" 4
331.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 350.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]"
332Sets the allocation function to use (the prototype is similar \- the 351Sets the allocation function to use (the prototype is similar \- the
333semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is 352semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
334used to allocate and free memory (no surprises here). If it returns zero 353used to allocate and free memory (no surprises here). If it returns zero
335when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort 354when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
336or take some potentially destructive action. 355or take some potentially destructive action.
362\& } 381\& }
363\& 382\&
364\& ... 383\& ...
365\& ev_set_allocator (persistent_realloc); 384\& ev_set_allocator (persistent_realloc);
366.Ve 385.Ve
367.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 386.IP "ev_set_syserr_cb (void (*cb)(const char *msg)); [\s-1NOT\s0 \s-1REENTRANT\s0]" 4
368.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" 387.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]"
369Set the callback function to call on a retryable syscall error (such 388Set the callback function to call on a retryable system call error (such
370as failed select, poll, epoll_wait). The message is a printable string 389as failed select, poll, epoll_wait). The message is a printable string
371indicating the system call or subsystem causing the problem. If this 390indicating the system call or subsystem causing the problem. If this
372callback is set, then libev will expect it to remedy the sitution, no 391callback is set, then libev will expect it to remedy the situation, no
373matter what, when it returns. That is, libev will generally retry the 392matter what, when it returns. That is, libev will generally retry the
374requested operation, or, if the condition doesn't go away, do bad stuff 393requested operation, or, if the condition doesn't go away, do bad stuff
375(such as abort). 394(such as abort).
376.Sp 395.Sp
377Example: This is basically the same thing that libev does internally, too. 396Example: This is basically the same thing that libev does internally, too.
387\& ... 406\& ...
388\& ev_set_syserr_cb (fatal_error); 407\& ev_set_syserr_cb (fatal_error);
389.Ve 408.Ve
390.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 409.SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
391.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 410.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
392An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two 411An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR
393types of such loops, the \fIdefault\fR loop, which supports signals and child 412is \fInot\fR optional in this case, as there is also an \f(CW\*(C`ev_loop\*(C'\fR
394events, and dynamically created loops which do not. 413\&\fIfunction\fR).
414.PP
415The library knows two types of such loops, the \fIdefault\fR loop, which
416supports signals and child events, and dynamically created loops which do
417not.
395.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 418.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
396.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 419.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
397This will initialise the default event loop if it hasn't been initialised 420This will initialise the default event loop if it hasn't been initialised
398yet and return it. If the default loop could not be initialised, returns 421yet and return it. If the default loop could not be initialised, returns
399false. If it already was initialised it simply returns it (and ignores the 422false. If it already was initialised it simply returns it (and ignores the
402If you don't know what event loop to use, use the one returned from this 425If you don't know what event loop to use, use the one returned from this
403function. 426function.
404.Sp 427.Sp
405Note that this function is \fInot\fR thread-safe, so if you want to use it 428Note 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, 429from multiple threads, you have to lock (note also that this is unlikely,
407as loops cannot bes hared easily between threads anyway). 430as loops cannot be shared easily between threads anyway).
408.Sp 431.Sp
409The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and 432The 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 433\&\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 434for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your application you can either
412create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you 435create 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 436can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling
414\&\f(CW\*(C`ev_default_init\*(C'\fR. 437\&\f(CW\*(C`ev_default_init\*(C'\fR.
415.Sp 438.Sp
416The flags argument can be used to specify special behaviour or specific 439The flags argument can be used to specify special behaviour or specific
424The default flags value. Use this if you have no clue (it's the right 447The default flags value. Use this if you have no clue (it's the right
425thing, believe me). 448thing, believe me).
426.ie n .IP """EVFLAG_NOENV""" 4 449.ie n .IP """EVFLAG_NOENV""" 4
427.el .IP "\f(CWEVFLAG_NOENV\fR" 4 450.el .IP "\f(CWEVFLAG_NOENV\fR" 4
428.IX Item "EVFLAG_NOENV" 451.IX Item "EVFLAG_NOENV"
429If this flag bit is ored into the flag value (or the program runs setuid 452If this flag bit is or'ed into the flag value (or the program runs setuid
430or setgid) then libev will \fInot\fR look at the environment variable 453or setgid) then libev will \fInot\fR look at the environment variable
431\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 454\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
432override the flags completely if it is found in the environment. This is 455override the flags completely if it is found in the environment. This is
433useful to try out specific backends to test their performance, or to work 456useful to try out specific backends to test their performance, or to work
434around bugs. 457around bugs.
441.Sp 464.Sp
442This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 465This 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 466and 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 467iterations 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 468GNU/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 469without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has
447\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 470\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
448.Sp 471.Sp
449The big advantage of this flag is that you can forget about fork (and 472The 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 473forget about forgetting to tell libev about forking) when you use this
451flag. 474flag.
452.Sp 475.Sp
453This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 476This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
454environment variable. 477environment variable.
455.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 478.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
456.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 479.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
457.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 480.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
458This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 481This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
460but if that fails, expect a fairly low limit on the number of fds when 483but if that fails, expect a fairly low limit on the number of fds when
461using this backend. It doesn't scale too well (O(highest_fd)), but its 484using this backend. It doesn't scale too well (O(highest_fd)), but its
462usually the fastest backend for a low number of (low-numbered :) fds. 485usually the fastest backend for a low number of (low-numbered :) fds.
463.Sp 486.Sp
464To get good performance out of this backend you need a high amount of 487To 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 488parallelism (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 489writing 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 490connections 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 491a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of
469readyness notifications you get per iteration. 492readiness notifications you get per iteration.
493.Sp
494This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the
495\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
496\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
470.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 497.ie n .IP """EVBACKEND_POLL"" (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 498.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
472.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 499.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
473And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 500And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
474than select, but handles sparse fds better and has no artificial 501than select, but handles sparse fds better and has no artificial
475limit on the number of fds you can use (except it will slow down 502limit on the number of fds you can use (except it will slow down
476considerably with a lot of inactive fds). It scales similarly to select, 503considerably 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 504i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
478performance tips. 505performance tips.
506.Sp
507This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
508\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
479.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 509.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
480.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 510.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
481.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 511.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
482For few fds, this backend is a bit little slower than poll and select, 512For few fds, this backend is a bit little slower than poll and select,
483but it scales phenomenally better. While poll and select usually scale 513but it scales phenomenally better. While poll and select usually scale
484like O(total_fds) where n is the total number of fds (or the highest fd), 514like O(total_fds) where n is the total number of fds (or the highest fd),
485epoll scales either O(1) or O(active_fds). The epoll design has a number 515epoll scales either O(1) or O(active_fds).
486of shortcomings, such as silently dropping events in some hard-to-detect 516.Sp
487cases and requiring a syscall per fd change, no fork support and bad 517The epoll mechanism deserves honorable mention as the most misdesigned
488support for dup. 518of the more advanced event mechanisms: mere annoyances include silently
519dropping file descriptors, requiring a system call per change per file
520descriptor (and unnecessary guessing of parameters), problems with dup and
521so on. The biggest issue is fork races, however \- if a program forks then
522\&\fIboth\fR parent and child process have to recreate the epoll set, which can
523take considerable time (one syscall per file descriptor) and is of course
524hard to detect.
525.Sp
526Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but
527of course \fIdoesn't\fR, and epoll just loves to report events for totally
528\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot
529even remove them from the set) than registered in the set (especially
530on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by
531employing an additional generation counter and comparing that against the
532events to filter out spurious ones, recreating the set when required.
489.Sp 533.Sp
490While stopping, setting and starting an I/O watcher in the same iteration 534While stopping, setting and starting an I/O watcher in the same iteration
491will result in some caching, there is still a syscall per such incident 535will result in some caching, there is still a system call per such
492(because the fd could point to a different file description now), so its 536incident (because the same \fIfile descriptor\fR could point to a different
493best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work 537\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
494very well if you register events for both fds. 538file descriptors might not work very well if you register events for both
495.Sp 539file descriptors.
496Please note that epoll sometimes generates spurious notifications, so you
497need to use non-blocking I/O or other means to avoid blocking when no data
498(or space) is available.
499.Sp 540.Sp
500Best performance from this backend is achieved by not unregistering all 541Best performance from this backend is achieved by not unregistering all
501watchers for a file descriptor until it has been closed, if possible, i.e. 542watchers for a file descriptor until it has been closed, if possible,
502keep at least one watcher active per fd at all times. 543i.e. keep at least one watcher active per fd at all times. Stopping and
544starting a watcher (without re-setting it) also usually doesn't cause
545extra overhead. A fork can both result in spurious notifications as well
546as in libev having to destroy and recreate the epoll object, which can
547take considerable time and thus should be avoided.
503.Sp 548.Sp
504While nominally embeddeble in other event loops, this feature is broken in 549While nominally embeddable in other event loops, this feature is broken in
505all kernel versions tested so far. 550all kernel versions tested so far.
551.Sp
552This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
553\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
506.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 554.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
507.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 555.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
508.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 556.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
509Kqueue deserves special mention, as at the time of this writing, it 557Kqueue deserves special mention, as at the time of this writing, it
510was broken on all BSDs except NetBSD (usually it doesn't work reliably 558was broken on all BSDs except NetBSD (usually it doesn't work reliably
511with anything but sockets and pipes, except on Darwin, where of course 559with anything but sockets and pipes, except on Darwin, where of course
512it's completely useless). For this reason it's not being \*(L"autodetected\*(R" 560it's completely useless). Unlike epoll, however, whose brokenness
561is by design, these kqueue bugs can (and eventually will) be fixed
562without \s-1API\s0 changes to existing programs. For this reason it's not being
513unless you explicitly specify it explicitly in the flags (i.e. using 563\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using
514\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) 564\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough)
515system like NetBSD. 565system like NetBSD.
516.Sp 566.Sp
517You still can embed kqueue into a normal poll or select backend and use it 567You 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 568only 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. 569the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
520.Sp 570.Sp
521It scales in the same way as the epoll backend, but the interface to the 571It scales in the same way as the epoll backend, but the interface to the
522kernel is more efficient (which says nothing about its actual speed, of 572kernel is more efficient (which says nothing about its actual speed, of
523course). While stopping, setting and starting an I/O watcher does never 573course). While stopping, setting and starting an I/O watcher does never
524cause an extra syscall as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 574cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
525two event changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it 575two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but
526drops fds silently in similarly hard-to-detect cases. 576sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
577cases
527.Sp 578.Sp
528This backend usually performs well under most conditions. 579This backend usually performs well under most conditions.
529.Sp 580.Sp
530While nominally embeddable in other event loops, this doesn't work 581While nominally embeddable in other event loops, this doesn't work
531everywhere, so you might need to test for this. And since it is broken 582everywhere, 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 583almost 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 584(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 585(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR) and, did I mention it,
535sockets. 586using it only for sockets.
587.Sp
588This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
589\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with
590\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
536.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 591.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
537.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 592.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4
538.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" 593.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)"
539This is not implemented yet (and might never be, unless you send me an 594This 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 595implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
544.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 599.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
545.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 600.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
546This uses the Solaris 10 event port mechanism. As with everything on Solaris, 601This uses the Solaris 10 event port mechanism. As with everything on Solaris,
547it's really slow, but it still scales very well (O(active_fds)). 602it's really slow, but it still scales very well (O(active_fds)).
548.Sp 603.Sp
549Please note that solaris event ports can deliver a lot of spurious 604Please note that Solaris event ports can deliver a lot of spurious
550notifications, so you need to use non-blocking I/O or other means to avoid 605notifications, so you need to use non-blocking I/O or other means to avoid
551blocking when no data (or space) is available. 606blocking when no data (or space) is available.
552.Sp 607.Sp
553While this backend scales well, it requires one system call per active 608While this backend scales well, it requires one system call per active
554file descriptor per loop iteration. For small and medium numbers of file 609file 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 610descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
556might perform better. 611might perform better.
557.Sp 612.Sp
558On the positive side, ignoring the spurious readyness notifications, this 613On the positive side, with the exception of the spurious readiness
559backend actually performed to specification in all tests and is fully 614notifications, this backend actually performed fully to specification
560embeddable, which is a rare feat among the OS-specific backends. 615in all tests and is fully embeddable, which is a rare feat among the
616OS-specific backends (I vastly prefer correctness over speed hacks).
617.Sp
618This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
619\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
561.ie n .IP """EVBACKEND_ALL""" 4 620.ie n .IP """EVBACKEND_ALL""" 4
562.el .IP "\f(CWEVBACKEND_ALL\fR" 4 621.el .IP "\f(CWEVBACKEND_ALL\fR" 4
563.IX Item "EVBACKEND_ALL" 622.IX Item "EVBACKEND_ALL"
564Try all backends (even potentially broken ones that wouldn't be tried 623Try all backends (even potentially broken ones that wouldn't be tried
565with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 624with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
567.Sp 626.Sp
568It is definitely not recommended to use this flag. 627It is definitely not recommended to use this flag.
569.RE 628.RE
570.RS 4 629.RS 4
571.Sp 630.Sp
572If one or more of these are ored into the flags value, then only these 631If one or more of these are or'ed into the flags value, then only these
573backends will be tried (in the reverse order as listed here). If none are 632backends will be tried (in the reverse order as listed here). If none are
574specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried. 633specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried.
575.Sp 634.Sp
576The most typical usage is like this: 635Example: This is the most typical usage.
577.Sp 636.Sp
578.Vb 2 637.Vb 2
579\& if (!ev_default_loop (0)) 638\& if (!ev_default_loop (0))
580\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 639\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
581.Ve 640.Ve
582.Sp 641.Sp
583Restrict libev to the select and poll backends, and do not allow 642Example: Restrict libev to the select and poll backends, and do not allow
584environment settings to be taken into account: 643environment settings to be taken into account:
585.Sp 644.Sp
586.Vb 1 645.Vb 1
587\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); 646\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
588.Ve 647.Ve
589.Sp 648.Sp
590Use whatever libev has to offer, but make sure that kqueue is used if 649Example: Use whatever libev has to offer, but make sure that kqueue is
591available (warning, breaks stuff, best use only with your own private 650used if available (warning, breaks stuff, best use only with your own
592event loop and only if you know the \s-1OS\s0 supports your types of fds): 651private event loop and only if you know the \s-1OS\s0 supports your types of
652fds):
593.Sp 653.Sp
594.Vb 1 654.Vb 1
595\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); 655\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
596.Ve 656.Ve
597.RE 657.RE
598.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 658.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
599.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" 659.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
600Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is 660Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
607default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread. 667default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
608.Sp 668.Sp
609Example: Try to create a event loop that uses epoll and nothing else. 669Example: Try to create a event loop that uses epoll and nothing else.
610.Sp 670.Sp
611.Vb 3 671.Vb 3
612\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 672\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
613\& if (!epoller) 673\& if (!epoller)
614\& fatal ("no epoll found here, maybe it hides under your chair"); 674\& fatal ("no epoll found here, maybe it hides under your chair");
615.Ve 675.Ve
616.IP "ev_default_destroy ()" 4 676.IP "ev_default_destroy ()" 4
617.IX Item "ev_default_destroy ()" 677.IX Item "ev_default_destroy ()"
618Destroys the default loop again (frees all memory and kernel state 678Destroys the default loop again (frees all memory and kernel state
619etc.). None of the active event watchers will be stopped in the normal 679etc.). None of the active event watchers will be stopped in the normal
620sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your 680sense, 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 681responsibility to either stop all watchers cleanly yourself \fIbefore\fR
622calling this function, or cope with the fact afterwards (which is usually 682calling 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 683the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
624for example). 684for example).
625.Sp 685.Sp
626Note that certain global state, such as signal state, will not be freed by 686Note that certain global state, such as signal state (and installed signal
627this function, and related watchers (such as signal and child watchers) 687handlers), will not be freed by this function, and related watchers (such
628would need to be stopped manually. 688as signal and child watchers) would need to be stopped manually.
629.Sp 689.Sp
630In general it is not advisable to call this function except in the 690In 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 691rare 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 692pipe 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). 693\&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR).
657.Ve 717.Ve
658.IP "ev_loop_fork (loop)" 4 718.IP "ev_loop_fork (loop)" 4
659.IX Item "ev_loop_fork (loop)" 719.IX Item "ev_loop_fork (loop)"
660Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 720Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
661\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 721\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
662after fork, and how you do this is entirely your own problem. 722after fork that you want to re-use in the child, and how you do this is
723entirely your own problem.
663.IP "int ev_is_default_loop (loop)" 4 724.IP "int ev_is_default_loop (loop)" 4
664.IX Item "int ev_is_default_loop (loop)" 725.IX Item "int ev_is_default_loop (loop)"
665Returns true when the given loop actually is the default loop, false otherwise. 726Returns true when the given loop is, in fact, the default loop, and false
727otherwise.
666.IP "unsigned int ev_loop_count (loop)" 4 728.IP "unsigned int ev_loop_count (loop)" 4
667.IX Item "unsigned int ev_loop_count (loop)" 729.IX Item "unsigned int ev_loop_count (loop)"
668Returns the count of loop iterations for the loop, which is identical to 730Returns 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 731the number of times libev did poll for new events. It starts at \f(CW0\fR and
670happily wraps around with enough iterations. 732happily wraps around with enough iterations.
681Returns the current \*(L"event loop time\*(R", which is the time the event loop 743Returns the current \*(L"event loop time\*(R", which is the time the event loop
682received events and started processing them. This timestamp does not 744received events and started processing them. This timestamp does not
683change as long as callbacks are being processed, and this is also the base 745change as long as callbacks are being processed, and this is also the base
684time used for relative timers. You can treat it as the timestamp of the 746time used for relative timers. You can treat it as the timestamp of the
685event occurring (or more correctly, libev finding out about it). 747event occurring (or more correctly, libev finding out about it).
748.IP "ev_now_update (loop)" 4
749.IX Item "ev_now_update (loop)"
750Establishes the current time by querying the kernel, updating the time
751returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and
752is usually done automatically within \f(CW\*(C`ev_loop ()\*(C'\fR.
753.Sp
754This function is rarely useful, but when some event callback runs for a
755very long time without entering the event loop, updating libev's idea of
756the current time is a good idea.
757.Sp
758See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section.
686.IP "ev_loop (loop, int flags)" 4 759.IP "ev_loop (loop, int flags)" 4
687.IX Item "ev_loop (loop, int flags)" 760.IX Item "ev_loop (loop, int flags)"
688Finally, this is it, the event handler. This function usually is called 761Finally, this is it, the event handler. This function usually is called
689after you initialised all your watchers and you want to start handling 762after you initialised all your watchers and you want to start handling
690events. 763events.
692If the flags argument is specified as \f(CW0\fR, it will not return until 765If the flags argument is specified as \f(CW0\fR, it will not return until
693either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. 766either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called.
694.Sp 767.Sp
695Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than 768Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than
696relying on all watchers to be stopped when deciding when a program has 769relying on all watchers to be stopped when deciding when a program has
697finished (especially in interactive programs), but having a program that 770finished (especially in interactive programs), but having a program
698automatically loops as long as it has to and no longer by virtue of 771that automatically loops as long as it has to and no longer by virtue
699relying on its watchers stopping correctly is a thing of beauty. 772of relying on its watchers stopping correctly, that is truly a thing of
773beauty.
700.Sp 774.Sp
701A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle 775A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle
702those events and any outstanding ones, but will not block your process in 776those events and any already outstanding ones, but will not block your
703case there are no events and will return after one iteration of the loop. 777process in case there are no events and will return after one iteration of
778the loop.
704.Sp 779.Sp
705A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if 780A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if
706neccessary) and will handle those and any outstanding ones. It will block 781necessary) and will handle those and any already outstanding ones. It
707your process until at least one new event arrives, and will return after 782will block your process until at least one new event arrives (which could
708one iteration of the loop. This is useful if you are waiting for some 783be an event internal to libev itself, so there is no guarantee that a
709external event in conjunction with something not expressible using other 784user-registered callback will be called), and will return after one
785iteration of the loop.
786.Sp
787This is useful if you are waiting for some external event in conjunction
788with something not expressible using other libev watchers (i.e. "roll your
710libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 789own \f(CW\*(C`ev_loop\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
711usually a better approach for this kind of thing. 790usually a better approach for this kind of thing.
712.Sp 791.Sp
713Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 792Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
714.Sp 793.Sp
715.Vb 10 794.Vb 10
716\& \- Before the first iteration, call any pending watchers. 795\& \- Before the first iteration, call any pending watchers.
717\& * If EVFLAG_FORKCHECK was used, check for a fork. 796\& * If EVFLAG_FORKCHECK was used, check for a fork.
718\& \- If a fork was detected, queue and call all fork watchers. 797\& \- If a fork was detected (by any means), queue and call all fork watchers.
719\& \- Queue and call all prepare watchers. 798\& \- Queue and call all prepare watchers.
720\& \- If we have been forked, recreate the kernel state. 799\& \- If we have been forked, detach and recreate the kernel state
800\& as to not disturb the other process.
721\& \- Update the kernel state with all outstanding changes. 801\& \- Update the kernel state with all outstanding changes.
722\& \- Update the "event loop time". 802\& \- Update the "event loop time" (ev_now ()).
723\& \- Calculate for how long to sleep or block, if at all 803\& \- Calculate for how long to sleep or block, if at all
724\& (active idle watchers, EVLOOP_NONBLOCK or not having 804\& (active idle watchers, EVLOOP_NONBLOCK or not having
725\& any active watchers at all will result in not sleeping). 805\& any active watchers at all will result in not sleeping).
726\& \- Sleep if the I/O and timer collect interval say so. 806\& \- Sleep if the I/O and timer collect interval say so.
727\& \- Block the process, waiting for any events. 807\& \- Block the process, waiting for any events.
728\& \- Queue all outstanding I/O (fd) events. 808\& \- Queue all outstanding I/O (fd) events.
729\& \- Update the "event loop time" and do time jump handling. 809\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments.
730\& \- Queue all outstanding timers. 810\& \- Queue all expired timers.
731\& \- Queue all outstanding periodics. 811\& \- Queue all expired periodics.
732\& \- If no events are pending now, queue all idle watchers. 812\& \- Unless any events are pending now, queue all idle watchers.
733\& \- Queue all check watchers. 813\& \- Queue all check watchers.
734\& \- Call all queued watchers in reverse order (i.e. check watchers first). 814\& \- Call all queued watchers in reverse order (i.e. check watchers first).
735\& Signals and child watchers are implemented as I/O watchers, and will 815\& Signals and child watchers are implemented as I/O watchers, and will
736\& be handled here by queueing them when their watcher gets executed. 816\& be handled here by queueing them when their watcher gets executed.
737\& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 817\& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
744.Sp 824.Sp
745.Vb 4 825.Vb 4
746\& ... queue jobs here, make sure they register event watchers as long 826\& ... queue jobs here, make sure they register event watchers as long
747\& ... as they still have work to do (even an idle watcher will do..) 827\& ... as they still have work to do (even an idle watcher will do..)
748\& ev_loop (my_loop, 0); 828\& ev_loop (my_loop, 0);
749\& ... jobs done. yeah! 829\& ... jobs done or somebody called unloop. yeah!
750.Ve 830.Ve
751.IP "ev_unloop (loop, how)" 4 831.IP "ev_unloop (loop, how)" 4
752.IX Item "ev_unloop (loop, how)" 832.IX Item "ev_unloop (loop, how)"
753Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it 833Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it
754has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 834has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
755\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or 835\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or
756\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. 836\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return.
757.Sp 837.Sp
758This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again. 838This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again.
839.Sp
840It is safe to call \f(CW\*(C`ev_unloop\*(C'\fR from otuside any \f(CW\*(C`ev_loop\*(C'\fR calls.
759.IP "ev_ref (loop)" 4 841.IP "ev_ref (loop)" 4
760.IX Item "ev_ref (loop)" 842.IX Item "ev_ref (loop)"
761.PD 0 843.PD 0
762.IP "ev_unref (loop)" 4 844.IP "ev_unref (loop)" 4
763.IX Item "ev_unref (loop)" 845.IX Item "ev_unref (loop)"
764.PD 846.PD
765Ref/unref can be used to add or remove a reference count on the event 847Ref/unref can be used to add or remove a reference count on the event
766loop: Every watcher keeps one reference, and as long as the reference 848loop: Every watcher keeps one reference, and as long as the reference
767count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own. If you have 849count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own.
850.Sp
768a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR from 851If you have a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR
769returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For 852from returning, call \fIev_unref()\fR after starting, and \fIev_ref()\fR before
853stopping it.
854.Sp
770example, libev itself uses this for its internal signal pipe: It is not 855As an example, libev itself uses this for its internal signal pipe: It is
771visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if 856not visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting
772no event watchers registered by it are active. It is also an excellent 857if no event watchers registered by it are active. It is also an excellent
773way to do this for generic recurring timers or from within third-party 858way to do this for generic recurring timers or from within third-party
774libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR 859libraries. 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, 860(but only if the watcher wasn't active before, or was active before,
776respectively). 861respectively).
777.Sp 862.Sp
778Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 863Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
779running when nothing else is active. 864running when nothing else is active.
780.Sp 865.Sp
781.Vb 4 866.Vb 4
782\& struct ev_signal exitsig; 867\& ev_signal exitsig;
783\& ev_signal_init (&exitsig, sig_cb, SIGINT); 868\& ev_signal_init (&exitsig, sig_cb, SIGINT);
784\& ev_signal_start (loop, &exitsig); 869\& ev_signal_start (loop, &exitsig);
785\& evf_unref (loop); 870\& evf_unref (loop);
786.Ve 871.Ve
787.Sp 872.Sp
788Example: For some weird reason, unregister the above signal handler again. 873Example: For some weird reason, unregister the above signal handler again.
789.Sp 874.Sp
790.Vb 2 875.Vb 2
791\& ev_ref (loop); 876\& ev_ref (loop);
792\& ev_signal_stop (loop, &exitsig); 877\& ev_signal_stop (loop, &exitsig);
793.Ve 878.Ve
794.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4 879.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4
795.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)" 880.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)"
796.PD 0 881.PD 0
797.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4 882.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4
798.IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 883.IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)"
799.PD 884.PD
800These advanced functions influence the time that libev will spend waiting 885These 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 886for events. Both time intervals are by default \f(CW0\fR, meaning that libev
802invoke timer/periodic callbacks and I/O callbacks with minimum latency. 887will try to invoke timer/periodic callbacks and I/O callbacks with minimum
888latency.
803.Sp 889.Sp
804Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR) 890Setting 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 891allows libev to delay invocation of I/O and timer/periodic callbacks
806increase efficiency of loop iterations. 892to increase efficiency of loop iterations (or to increase power-saving
893opportunities).
807.Sp 894.Sp
808The background is that sometimes your program runs just fast enough to 895The idea is that sometimes your program runs just fast enough to handle
809handle one (or very few) event(s) per loop iteration. While this makes 896one (or very few) event(s) per loop iteration. While this makes the
810the program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new 897program 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 898events, 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. 899overhead for the actual polling but can deliver many events at once.
813.Sp 900.Sp
814By setting a higher \fIio collect interval\fR you allow libev to spend more 901By 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, 902time collecting I/O events, so you can handle more events per iteration,
817\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will 904\&\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. 905introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations.
819.Sp 906.Sp
820Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 907Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
821to spend more time collecting timeouts, at the expense of increased 908to 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 909latency/jitter/inexactness (the watcher callback will be called
823will not be affected. Setting this to a non-null value will not introduce 910later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
824any overhead in libev. 911value will not introduce any overhead in libev.
825.Sp 912.Sp
826Many (busy) programs can usually benefit by setting the io collect 913Many (busy) programs can usually benefit by setting the I/O collect
827interval to a value near \f(CW0.1\fR or so, which is often enough for 914interval 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 915interactive 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, 916usually 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. 917as this approaches the timing granularity of most systems.
918.Sp
919Setting the \fItimeout collect interval\fR can improve the opportunity for
920saving power, as the program will \*(L"bundle\*(R" timer callback invocations that
921are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of
922times the process sleeps and wakes up again. Another useful technique to
923reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure
924they fire on, say, one-second boundaries only.
925.IP "ev_loop_verify (loop)" 4
926.IX Item "ev_loop_verify (loop)"
927This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been
928compiled in, which is the default for non-minimal builds. It tries to go
929through all internal structures and checks them for validity. If anything
930is found to be inconsistent, it will print an error message to standard
931error and call \f(CW\*(C`abort ()\*(C'\fR.
932.Sp
933This can be used to catch bugs inside libev itself: under normal
934circumstances, this function will never abort as of course libev keeps its
935data structures consistent.
831.SH "ANATOMY OF A WATCHER" 936.SH "ANATOMY OF A WATCHER"
832.IX Header "ANATOMY OF A WATCHER" 937.IX Header "ANATOMY OF A WATCHER"
938In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the
939watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer
940watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers.
941.PP
833A watcher is a structure that you create and register to record your 942A watcher is a structure that you create and register to record your
834interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 943interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to
835become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: 944become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that:
836.PP 945.PP
837.Vb 5 946.Vb 5
838\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 947\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
839\& { 948\& {
840\& ev_io_stop (w); 949\& ev_io_stop (w);
841\& ev_unloop (loop, EVUNLOOP_ALL); 950\& ev_unloop (loop, EVUNLOOP_ALL);
842\& } 951\& }
843\& 952\&
844\& struct ev_loop *loop = ev_default_loop (0); 953\& struct ev_loop *loop = ev_default_loop (0);
954\&
845\& struct ev_io stdin_watcher; 955\& ev_io stdin_watcher;
956\&
846\& ev_init (&stdin_watcher, my_cb); 957\& ev_init (&stdin_watcher, my_cb);
847\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 958\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
848\& ev_io_start (loop, &stdin_watcher); 959\& ev_io_start (loop, &stdin_watcher);
960\&
849\& ev_loop (loop, 0); 961\& ev_loop (loop, 0);
850.Ve 962.Ve
851.PP 963.PP
852As you can see, you are responsible for allocating the memory for your 964As you can see, you are responsible for allocating the memory for your
853watcher structures (and it is usually a bad idea to do this on the stack, 965watcher structures (and it is \fIusually\fR a bad idea to do this on the
854although this can sometimes be quite valid). 966stack).
967.PP
968Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR
969or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs).
855.PP 970.PP
856Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init 971Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init
857(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This 972(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This
858callback gets invoked each time the event occurs (or, in the case of io 973callback gets invoked each time the event occurs (or, in the case of I/O
859watchers, each time the event loop detects that the file descriptor given 974watchers, each time the event loop detects that the file descriptor given
860is readable and/or writable). 975is readable and/or writable).
861.PP 976.PP
862Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro 977Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR
863with arguments specific to this watcher type. There is also a macro 978macro to configure it, with arguments specific to the watcher type. There
864to combine initialisation and setting in one call: \f(CW\*(C`ev_<type>_init 979is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR.
865(watcher *, callback, ...)\*(C'\fR.
866.PP 980.PP
867To make the watcher actually watch out for events, you have to start it 981To make the watcher actually watch out for events, you have to start it
868with a watcher-specific start function (\f(CW\*(C`ev_<type>_start (loop, watcher 982with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher
869*)\*(C'\fR), and you can stop watching for events at any time by calling the 983*)\*(C'\fR), and you can stop watching for events at any time by calling the
870corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. 984corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR.
871.PP 985.PP
872As long as your watcher is active (has been started but not stopped) you 986As long as your watcher is active (has been started but not stopped) you
873must not touch the values stored in it. Most specifically you must never 987must not touch the values stored in it. Most specifically you must never
874reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro. 988reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro.
875.PP 989.PP
876Each and every callback receives the event loop pointer as first, the 990Each and every callback receives the event loop pointer as first, the
877registered watcher structure as second, and a bitset of received events as 991registered watcher structure as second, and a bitset of received events as
878third argument. 992third argument.
879.PP 993.PP
943.IX Item "EV_ASYNC" 1057.IX Item "EV_ASYNC"
944The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). 1058The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
945.ie n .IP """EV_ERROR""" 4 1059.ie n .IP """EV_ERROR""" 4
946.el .IP "\f(CWEV_ERROR\fR" 4 1060.el .IP "\f(CWEV_ERROR\fR" 4
947.IX Item "EV_ERROR" 1061.IX Item "EV_ERROR"
948An unspecified error has occured, the watcher has been stopped. This might 1062An unspecified error has occurred, the watcher has been stopped. This might
949happen because the watcher could not be properly started because libev 1063happen because the watcher could not be properly started because libev
950ran out of memory, a file descriptor was found to be closed or any other 1064ran out of memory, a file descriptor was found to be closed or any other
1065problem. Libev considers these application bugs.
1066.Sp
951problem. You best act on it by reporting the problem and somehow coping 1067You best act on it by reporting the problem and somehow coping with the
952with the watcher being stopped. 1068watcher being stopped. Note that well-written programs should not receive
1069an error ever, so when your watcher receives it, this usually indicates a
1070bug in your program.
953.Sp 1071.Sp
954Libev will usually signal a few \*(L"dummy\*(R" events together with an error, 1072Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
955for example it might indicate that a fd is readable or writable, and if 1073example it might indicate that a fd is readable or writable, and if your
956your callbacks is well-written it can just attempt the operation and cope 1074callbacks is well-written it can just attempt the operation and cope with
957with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded 1075the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
958programs, though, so beware. 1076programs, though, as the fd could already be closed and reused for another
1077thing, so beware.
959.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1078.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
960.IX Subsection "GENERIC WATCHER FUNCTIONS" 1079.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 1080.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
964.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1081.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
965.IX Item "ev_init (ev_TYPE *watcher, callback)" 1082.IX Item "ev_init (ev_TYPE *watcher, callback)"
966This macro initialises the generic portion of a watcher. The contents 1083This 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 1084of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only
971which rolls both calls into one. 1088which rolls both calls into one.
972.Sp 1089.Sp
973You can reinitialise a watcher at any time as long as it has been stopped 1090You 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. 1091(or never started) and there are no pending events outstanding.
975.Sp 1092.Sp
976The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, 1093The callback is always of type \f(CW\*(C`void (*)(struct ev_loop *loop, ev_TYPE *watcher,
977int revents)\*(C'\fR. 1094int revents)\*(C'\fR.
1095.Sp
1096Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps.
1097.Sp
1098.Vb 3
1099\& ev_io w;
1100\& ev_init (&w, my_cb);
1101\& ev_io_set (&w, STDIN_FILENO, EV_READ);
1102.Ve
978.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 1103.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4
979.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 1104.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4
980.IX Item "ev_TYPE_set (ev_TYPE *, [args])" 1105.IX Item "ev_TYPE_set (ev_TYPE *, [args])"
981This macro initialises the type-specific parts of a watcher. You need to 1106This 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 1107call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
984macro on a watcher that is active (it can be pending, however, which is a 1109macro 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). 1110difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
986.Sp 1111.Sp
987Although some watcher types do not have type-specific arguments 1112Although 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. 1113(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro.
1114.Sp
1115See \f(CW\*(C`ev_init\*(C'\fR, above, for an example.
989.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 1116.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 1117.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4
991.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" 1118.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 1119This convenience 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 1120calls into a single call. This is the most convenient method to initialise
994a watcher. The same limitations apply, of course. 1121a watcher. The same limitations apply, of course.
1122.Sp
1123Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step.
1124.Sp
1125.Vb 1
1126\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1127.Ve
995.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 1128.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4
996.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 1129.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4
997.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" 1130.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)"
998Starts (activates) the given watcher. Only active watchers will receive 1131Starts (activates) the given watcher. Only active watchers will receive
999events. If the watcher is already active nothing will happen. 1132events. If the watcher is already active nothing will happen.
1133.Sp
1134Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this
1135whole section.
1136.Sp
1137.Vb 1
1138\& ev_io_start (EV_DEFAULT_UC, &w);
1139.Ve
1000.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 1140.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4
1001.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 1141.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4
1002.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" 1142.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)"
1003Stops the given watcher again (if active) and clears the pending 1143Stops the given watcher if active, and clears the pending status (whether
1144the watcher was active or not).
1145.Sp
1004status. It is possible that stopped watchers are pending (for example, 1146It is possible that stopped watchers are pending \- for example,
1005non-repeating timers are being stopped when they become pending), but 1147non-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 1148calling \f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor
1007you want to free or reuse the memory used by the watcher it is therefore a 1149pending. If you want to free or reuse the memory used by the watcher it is
1008good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. 1150therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
1009.IP "bool ev_is_active (ev_TYPE *watcher)" 4 1151.IP "bool ev_is_active (ev_TYPE *watcher)" 4
1010.IX Item "bool ev_is_active (ev_TYPE *watcher)" 1152.IX Item "bool ev_is_active (ev_TYPE *watcher)"
1011Returns a true value iff the watcher is active (i.e. it has been started 1153Returns 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 1154and not yet been stopped). As long as a watcher is active you must not modify
1013it. 1155it.
1052The default priority used by watchers when no priority has been set is 1194The 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 :). 1195always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1054.Sp 1196.Sp
1055Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is 1197Setting 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 1198fine, 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. 1199or might not have been clamped to the valid range.
1058.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1200.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1059.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1201.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 1202Invoke 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 1203\&\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. 1204can deal with that fact, as both are simply passed through to the
1205callback.
1063.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 1206.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
1064.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" 1207.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
1065If the watcher is pending, this function returns clears its pending status 1208If the watcher is pending, this function clears its pending status and
1066and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the 1209returns 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. 1210watcher isn't pending it does nothing and returns \f(CW0\fR.
1211.Sp
1212Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its
1213callback to be invoked, which can be accomplished with this function.
1068.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 1214.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
1069.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 1215.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
1070Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 1216Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
1071and read at any time, libev will completely ignore it. This can be used 1217and read at any time: libev will completely ignore it. This can be used
1072to associate arbitrary data with your watcher. If you need more data and 1218to associate arbitrary data with your watcher. If you need more data and
1073don't want to allocate memory and store a pointer to it in that data 1219don't want to allocate memory and store a pointer to it in that data
1074member, you can also \*(L"subclass\*(R" the watcher type and provide your own 1220member, you can also \*(L"subclass\*(R" the watcher type and provide your own
1075data: 1221data:
1076.PP 1222.PP
1077.Vb 7 1223.Vb 7
1078\& struct my_io 1224\& struct my_io
1079\& { 1225\& {
1080\& struct ev_io io; 1226\& ev_io io;
1081\& int otherfd; 1227\& int otherfd;
1082\& void *somedata; 1228\& void *somedata;
1083\& struct whatever *mostinteresting; 1229\& struct whatever *mostinteresting;
1084\& } 1230\& };
1231\&
1232\& ...
1233\& struct my_io w;
1234\& ev_io_init (&w.io, my_cb, fd, EV_READ);
1085.Ve 1235.Ve
1086.PP 1236.PP
1087And since your callback will be called with a pointer to the watcher, you 1237And since your callback will be called with a pointer to the watcher, you
1088can cast it back to your own type: 1238can cast it back to your own type:
1089.PP 1239.PP
1090.Vb 5 1240.Vb 5
1091\& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) 1241\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1092\& { 1242\& {
1093\& struct my_io *w = (struct my_io *)w_; 1243\& struct my_io *w = (struct my_io *)w_;
1094\& ... 1244\& ...
1095\& } 1245\& }
1096.Ve 1246.Ve
1097.PP 1247.PP
1098More interesting and less C\-conformant ways of casting your callback type 1248More interesting and less C\-conformant ways of casting your callback type
1099instead have been omitted. 1249instead have been omitted.
1100.PP 1250.PP
1101Another common scenario is having some data structure with multiple 1251Another common scenario is to use some data structure with multiple
1102watchers: 1252embedded watchers:
1103.PP 1253.PP
1104.Vb 6 1254.Vb 6
1105\& struct my_biggy 1255\& struct my_biggy
1106\& { 1256\& {
1107\& int some_data; 1257\& int some_data;
1108\& ev_timer t1; 1258\& ev_timer t1;
1109\& ev_timer t2; 1259\& ev_timer t2;
1110\& } 1260\& }
1111.Ve 1261.Ve
1112.PP 1262.PP
1113In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, 1263In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more
1114you need to use \f(CW\*(C`offsetof\*(C'\fR: 1264complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct
1265in the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies), or you need to use
1266some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for real
1267programmers):
1115.PP 1268.PP
1116.Vb 1 1269.Vb 1
1117\& #include <stddef.h> 1270\& #include <stddef.h>
1118\& 1271\&
1119\& static void 1272\& static void
1120\& t1_cb (EV_P_ struct ev_timer *w, int revents) 1273\& t1_cb (EV_P_ ev_timer *w, int revents)
1121\& { 1274\& {
1122\& struct my_biggy big = (struct my_biggy * 1275\& struct my_biggy big = (struct my_biggy *
1123\& (((char *)w) \- offsetof (struct my_biggy, t1)); 1276\& (((char *)w) \- offsetof (struct my_biggy, t1));
1124\& } 1277\& }
1125\& 1278\&
1126\& static void 1279\& static void
1127\& t2_cb (EV_P_ struct ev_timer *w, int revents) 1280\& t2_cb (EV_P_ ev_timer *w, int revents)
1128\& { 1281\& {
1129\& struct my_biggy big = (struct my_biggy * 1282\& struct my_biggy big = (struct my_biggy *
1130\& (((char *)w) \- offsetof (struct my_biggy, t2)); 1283\& (((char *)w) \- offsetof (struct my_biggy, t2));
1131\& } 1284\& }
1132.Ve 1285.Ve
1133.SH "WATCHER TYPES" 1286.SH "WATCHER TYPES"
1134.IX Header "WATCHER TYPES" 1287.IX Header "WATCHER TYPES"
1135This section describes each watcher in detail, but will not repeat 1288This section describes each watcher in detail, but will not repeat
1136information given in the last section. Any initialisation/set macros, 1289information given in the last section. Any initialisation/set macros,
1158In general you can register as many read and/or write event watchers per 1311In general you can register as many read and/or write event watchers per
1159fd as you want (as long as you don't confuse yourself). Setting all file 1312fd as you want (as long as you don't confuse yourself). Setting all file
1160descriptors to non-blocking mode is also usually a good idea (but not 1313descriptors to non-blocking mode is also usually a good idea (but not
1161required if you know what you are doing). 1314required if you know what you are doing).
1162.PP 1315.PP
1163If you must do this, then force the use of a known-to-be-good backend 1316If you cannot use non-blocking mode, then force the use of a
1164(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and 1317known-to-be-good backend (at the time of this writing, this includes only
1165\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1318\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
1166.PP 1319.PP
1167Another thing you have to watch out for is that it is quite easy to 1320Another 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 1321receive \*(L"spurious\*(R" readiness 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 1322be 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 1323because 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 1324lot of those (for example Solaris ports), it is very easy to get into
1172this situation even with a relatively standard program structure. Thus 1325this 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 1326it 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. 1327\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives.
1175.PP 1328.PP
1176If you cannot run the fd in non-blocking mode (for example you should not 1329If you cannot run the fd in non-blocking mode (for example you should
1177play around with an Xlib connection), then you have to seperately re-test 1330not play around with an Xlib connection), then you have to separately
1178whether a file descriptor is really ready with a known-to-be good interface 1331re-test whether a file descriptor is really ready with a known-to-be good
1179such as poll (fortunately in our Xlib example, Xlib already does this on 1332interface such as poll (fortunately in our Xlib example, Xlib already
1180its own, so its quite safe to use). 1333does this on its own, so its quite safe to use). Some people additionally
1334use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block
1335indefinitely.
1336.PP
1337But really, best use non-blocking mode.
1181.PP 1338.PP
1182\fIThe special problem of disappearing file descriptors\fR 1339\fIThe special problem of disappearing file descriptors\fR
1183.IX Subsection "The special problem of disappearing file descriptors" 1340.IX Subsection "The special problem of disappearing file descriptors"
1184.PP 1341.PP
1185Some backends (e.g. kqueue, epoll) need to be told about closing a file 1342Some 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, 1343descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means,
1187such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file 1344such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file
1188descriptor, but when it goes away, the operating system will silently drop 1345descriptor, but when it goes away, the operating system will silently drop
1189this interest. If another file descriptor with the same number then is 1346this 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 1347registered with libev, there is no efficient way to see that this is, in
1191fact, a different file descriptor. 1348fact, a different file descriptor.
1192.PP 1349.PP
1226\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1383\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1227.PP 1384.PP
1228\fIThe special problem of \s-1SIGPIPE\s0\fR 1385\fIThe special problem of \s-1SIGPIPE\s0\fR
1229.IX Subsection "The special problem of SIGPIPE" 1386.IX Subsection "The special problem of SIGPIPE"
1230.PP 1387.PP
1231While not really specific to libev, it is easy to forget about \s-1SIGPIPE:\s0 1388While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1232when reading from a pipe whose other end has been closed, your program 1389when writing to a pipe whose other end has been closed, your program gets
1233gets send a \s-1SIGPIPE\s0, which, by default, aborts your program. For most 1390sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs
1234programs this is sensible behaviour, for daemons, this is usually 1391this is sensible behaviour, for daemons, this is usually undesirable.
1235undesirable.
1236.PP 1392.PP
1237So when you encounter spurious, unexplained daemon exits, make sure you 1393So 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 1394ignore \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). 1395somewhere, as that would have given you a big clue).
1240.PP 1396.PP
1245.PD 0 1401.PD 0
1246.IP "ev_io_set (ev_io *, int fd, int events)" 4 1402.IP "ev_io_set (ev_io *, int fd, int events)" 4
1247.IX Item "ev_io_set (ev_io *, int fd, int events)" 1403.IX Item "ev_io_set (ev_io *, int fd, int events)"
1248.PD 1404.PD
1249Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1405Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
1250rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or 1406receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
1251\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. 1407\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events.
1252.IP "int fd [read\-only]" 4 1408.IP "int fd [read\-only]" 4
1253.IX Item "int fd [read-only]" 1409.IX Item "int fd [read-only]"
1254The file descriptor being watched. 1410The file descriptor being watched.
1255.IP "int events [read\-only]" 4 1411.IP "int events [read\-only]" 4
1256.IX Item "int events [read-only]" 1412.IX Item "int events [read-only]"
1262Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1418Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
1263readable, but only once. Since it is likely line-buffered, you could 1419readable, but only once. Since it is likely line-buffered, you could
1264attempt to read a whole line in the callback. 1420attempt to read a whole line in the callback.
1265.PP 1421.PP
1266.Vb 6 1422.Vb 6
1267\& static void 1423\& static void
1268\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1424\& stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1269\& { 1425\& {
1270\& ev_io_stop (loop, w); 1426\& ev_io_stop (loop, w);
1271\& .. read from stdin here (or from w\->fd) and haqndle any I/O errors 1427\& .. read from stdin here (or from w\->fd) and handle any I/O errors
1272\& } 1428\& }
1273\& 1429\&
1274\& ... 1430\& ...
1275\& struct ev_loop *loop = ev_default_init (0); 1431\& struct ev_loop *loop = ev_default_init (0);
1276\& struct ev_io stdin_readable; 1432\& ev_io stdin_readable;
1277\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1433\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1278\& ev_io_start (loop, &stdin_readable); 1434\& ev_io_start (loop, &stdin_readable);
1279\& ev_loop (loop, 0); 1435\& ev_loop (loop, 0);
1280.Ve 1436.Ve
1281.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" 1437.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts"
1282.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" 1438.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
1283.IX Subsection "ev_timer - relative and optionally repeating timeouts" 1439.IX Subsection "ev_timer - relative and optionally repeating timeouts"
1284Timer watchers are simple relative timers that generate an event after a 1440Timer watchers are simple relative timers that generate an event after a
1285given time, and optionally repeating in regular intervals after that. 1441given time, and optionally repeating in regular intervals after that.
1286.PP 1442.PP
1287The timers are based on real time, that is, if you register an event that 1443The timers are based on real time, that is, if you register an event that
1288times out after an hour and you reset your system clock to last years 1444times out after an hour and you reset your system clock to January last
1289time, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because 1445year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because
1290detecting time jumps is hard, and some inaccuracies are unavoidable (the 1446detecting time jumps is hard, and some inaccuracies are unavoidable (the
1291monotonic clock option helps a lot here). 1447monotonic clock option helps a lot here).
1448.PP
1449The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1450passed, but if multiple timers become ready during the same loop iteration
1451then order of execution is undefined.
1452.PP
1453\fIBe smart about timeouts\fR
1454.IX Subsection "Be smart about timeouts"
1455.PP
1456Many real-world problems involve some kind of timeout, usually for error
1457recovery. A typical example is an \s-1HTTP\s0 request \- if the other side hangs,
1458you want to raise some error after a while.
1459.PP
1460What follows are some ways to handle this problem, from obvious and
1461inefficient to smart and efficient.
1462.PP
1463In the following, a 60 second activity timeout is assumed \- a timeout that
1464gets reset to 60 seconds each time there is activity (e.g. each time some
1465data or other life sign was received).
1466.IP "1. Use a timer and stop, reinitialise and start it on activity." 4
1467.IX Item "1. Use a timer and stop, reinitialise and start it on activity."
1468This is the most obvious, but not the most simple way: In the beginning,
1469start the watcher:
1470.Sp
1471.Vb 2
1472\& ev_timer_init (timer, callback, 60., 0.);
1473\& ev_timer_start (loop, timer);
1474.Ve
1475.Sp
1476Then, each time there is some activity, \f(CW\*(C`ev_timer_stop\*(C'\fR it, initialise it
1477and start it again:
1478.Sp
1479.Vb 3
1480\& ev_timer_stop (loop, timer);
1481\& ev_timer_set (timer, 60., 0.);
1482\& ev_timer_start (loop, timer);
1483.Ve
1484.Sp
1485This is relatively simple to implement, but means that each time there is
1486some activity, libev will first have to remove the timer from its internal
1487data structure and then add it again. Libev tries to be fast, but it's
1488still not a constant-time operation.
1489.ie n .IP "2. Use a timer and re-start it with ""ev_timer_again"" inactivity." 4
1490.el .IP "2. Use a timer and re-start it with \f(CWev_timer_again\fR inactivity." 4
1491.IX Item "2. Use a timer and re-start it with ev_timer_again inactivity."
1492This is the easiest way, and involves using \f(CW\*(C`ev_timer_again\*(C'\fR instead of
1493\&\f(CW\*(C`ev_timer_start\*(C'\fR.
1494.Sp
1495To implement this, configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value
1496of \f(CW60\fR and then call \f(CW\*(C`ev_timer_again\*(C'\fR at start and each time you
1497successfully read or write some data. If you go into an idle state where
1498you do not expect data to travel on the socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR
1499the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will automatically restart it if need be.
1500.Sp
1501That means you can ignore both the \f(CW\*(C`ev_timer_start\*(C'\fR function and the
1502\&\f(CW\*(C`after\*(C'\fR argument to \f(CW\*(C`ev_timer_set\*(C'\fR, and only ever use the \f(CW\*(C`repeat\*(C'\fR
1503member and \f(CW\*(C`ev_timer_again\*(C'\fR.
1504.Sp
1505At start:
1506.Sp
1507.Vb 3
1508\& ev_timer_init (timer, callback);
1509\& timer\->repeat = 60.;
1510\& ev_timer_again (loop, timer);
1511.Ve
1512.Sp
1513Each time there is some activity:
1514.Sp
1515.Vb 1
1516\& ev_timer_again (loop, timer);
1517.Ve
1518.Sp
1519It is even possible to change the time-out on the fly, regardless of
1520whether the watcher is active or not:
1521.Sp
1522.Vb 2
1523\& timer\->repeat = 30.;
1524\& ev_timer_again (loop, timer);
1525.Ve
1526.Sp
1527This is slightly more efficient then stopping/starting the timer each time
1528you want to modify its timeout value, as libev does not have to completely
1529remove and re-insert the timer from/into its internal data structure.
1530.Sp
1531It is, however, even simpler than the \*(L"obvious\*(R" way to do it.
1532.IP "3. Let the timer time out, but then re-arm it as required." 4
1533.IX Item "3. Let the timer time out, but then re-arm it as required."
1534This method is more tricky, but usually most efficient: Most timeouts are
1535relatively long compared to the intervals between other activity \- in
1536our example, within 60 seconds, there are usually many I/O events with
1537associated activity resets.
1538.Sp
1539In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
1540but remember the time of last activity, and check for a real timeout only
1541within the callback:
1542.Sp
1543.Vb 1
1544\& ev_tstamp last_activity; // time of last activity
1545\&
1546\& static void
1547\& callback (EV_P_ ev_timer *w, int revents)
1548\& {
1549\& ev_tstamp now = ev_now (EV_A);
1550\& ev_tstamp timeout = last_activity + 60.;
1551\&
1552\& // if last_activity + 60. is older than now, we did time out
1553\& if (timeout < now)
1554\& {
1555\& // timeout occured, take action
1556\& }
1557\& else
1558\& {
1559\& // callback was invoked, but there was some activity, re\-arm
1560\& // the watcher to fire in last_activity + 60, which is
1561\& // guaranteed to be in the future, so "again" is positive:
1562\& w\->again = timeout \- now;
1563\& ev_timer_again (EV_A_ w);
1564\& }
1565\& }
1566.Ve
1567.Sp
1568To summarise the callback: first calculate the real timeout (defined
1569as \*(L"60 seconds after the last activity\*(R"), then check if that time has
1570been reached, which means something \fIdid\fR, in fact, time out. Otherwise
1571the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so
1572re-schedule the timer to fire at that future time, to see if maybe we have
1573a timeout then.
1574.Sp
1575Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the
1576\&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running.
1577.Sp
1578This scheme causes more callback invocations (about one every 60 seconds
1579minus half the average time between activity), but virtually no calls to
1580libev to change the timeout.
1581.Sp
1582To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR
1583to the current time (meaning we just have some activity :), then call the
1584callback, which will \*(L"do the right thing\*(R" and start the timer:
1585.Sp
1586.Vb 3
1587\& ev_timer_init (timer, callback);
1588\& last_activity = ev_now (loop);
1589\& callback (loop, timer, EV_TIMEOUT);
1590.Ve
1591.Sp
1592And when there is some activity, simply store the current time in
1593\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
1594.Sp
1595.Vb 1
1596\& last_actiivty = ev_now (loop);
1597.Ve
1598.Sp
1599This technique is slightly more complex, but in most cases where the
1600time-out is unlikely to be triggered, much more efficient.
1601.Sp
1602Changing the timeout is trivial as well (if it isn't hard-coded in the
1603callback :) \- just change the timeout and invoke the callback, which will
1604fix things for you.
1605.IP "4. Wee, just use a double-linked list for your timeouts." 4
1606.IX Item "4. Wee, just use a double-linked list for your timeouts."
1607If there is not one request, but many thousands (millions...), all
1608employing some kind of timeout with the same timeout value, then one can
1609do even better:
1610.Sp
1611When starting the timeout, calculate the timeout value and put the timeout
1612at the \fIend\fR of the list.
1613.Sp
1614Then use an \f(CW\*(C`ev_timer\*(C'\fR to fire when the timeout at the \fIbeginning\fR of
1615the list is expected to fire (for example, using the technique #3).
1616.Sp
1617When there is some activity, remove the timer from the list, recalculate
1618the timeout, append it to the end of the list again, and make sure to
1619update the \f(CW\*(C`ev_timer\*(C'\fR if it was taken from the beginning of the list.
1620.Sp
1621This way, one can manage an unlimited number of timeouts in O(1) time for
1622starting, stopping and updating the timers, at the expense of a major
1623complication, and having to use a constant timeout. The constant timeout
1624ensures that the list stays sorted.
1625.PP
1626So which method the best?
1627.PP
1628Method #2 is a simple no-brain-required solution that is adequate in most
1629situations. Method #3 requires a bit more thinking, but handles many cases
1630better, and isn't very complicated either. In most case, choosing either
1631one is fine, with #3 being better in typical situations.
1632.PP
1633Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1634rather complicated, but extremely efficient, something that really pays
1635off after the first million or so of active timers, i.e. it's usually
1636overkill :)
1637.PP
1638\fIThe special problem of time updates\fR
1639.IX Subsection "The special problem of time updates"
1640.PP
1641Establishing the current time is a costly operation (it usually takes at
1642least two system calls): \s-1EV\s0 therefore updates its idea of the current
1643time only before and after \f(CW\*(C`ev_loop\*(C'\fR collects new events, which causes a
1644growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling
1645lots of events in one iteration.
1292.PP 1646.PP
1293The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 1647The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
1294time. This is usually the right thing as this timestamp refers to the time 1648time. This is usually the right thing as this timestamp refers to the time
1295of the event triggering whatever timeout you are modifying/starting. If 1649of the event triggering whatever timeout you are modifying/starting. If
1296you suspect event processing to be delayed and you \fIneed\fR to base the timeout 1650you suspect event processing to be delayed and you \fIneed\fR to base the
1297on the current time, use something like this to adjust for this: 1651timeout on the current time, use something like this to adjust for this:
1298.PP 1652.PP
1299.Vb 1 1653.Vb 1
1300\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 1654\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.);
1301.Ve 1655.Ve
1302.PP 1656.PP
1303The callback is guarenteed to be invoked only when its timeout has passed, 1657If the event loop is suspended for a long time, you can also force an
1304but if multiple timers become ready during the same loop iteration then 1658update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
1305order of execution is undefined. 1659()\*(C'\fR.
1306.PP 1660.PP
1307\fIWatcher-Specific Functions and Data Members\fR 1661\fIWatcher-Specific Functions and Data Members\fR
1308.IX Subsection "Watcher-Specific Functions and Data Members" 1662.IX Subsection "Watcher-Specific Functions and Data Members"
1309.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 1663.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
1310.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 1664.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
1311.PD 0 1665.PD 0
1312.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 1666.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
1313.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 1667.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
1314.PD 1668.PD
1315Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR is 1669Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR
1316\&\f(CW0.\fR, then it will automatically be stopped. If it is positive, then the 1670is \f(CW0.\fR, then it will automatically be stopped once the timeout is
1317timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds 1671reached. If it is positive, then the timer will automatically be
1318later, again, and again, until stopped manually. 1672configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again,
1673until stopped manually.
1319.Sp 1674.Sp
1320The timer itself will do a best-effort at avoiding drift, that is, if you 1675The timer itself will do a best-effort at avoiding drift, that is, if
1321configure a timer to trigger every 10 seconds, then it will trigger at 1676you configure a timer to trigger every 10 seconds, then it will normally
1322exactly 10 second intervals. If, however, your program cannot keep up with 1677trigger at exactly 10 second intervals. If, however, your program cannot
1323the timer (because it takes longer than those 10 seconds to do stuff) the 1678keep up with the timer (because it takes longer than those 10 seconds to
1324timer will not fire more than once per event loop iteration. 1679do stuff) the timer will not fire more than once per event loop iteration.
1325.IP "ev_timer_again (loop, ev_timer *)" 4 1680.IP "ev_timer_again (loop, ev_timer *)" 4
1326.IX Item "ev_timer_again (loop, ev_timer *)" 1681.IX Item "ev_timer_again (loop, ev_timer *)"
1327This will act as if the timer timed out and restart it again if it is 1682This will act as if the timer timed out and restart it again if it is
1328repeating. The exact semantics are: 1683repeating. The exact semantics are:
1329.Sp 1684.Sp
1330If the timer is pending, its pending status is cleared. 1685If the timer is pending, its pending status is cleared.
1331.Sp 1686.Sp
1332If the timer is started but nonrepeating, stop it (as if it timed out). 1687If the timer is started but non-repeating, stop it (as if it timed out).
1333.Sp 1688.Sp
1334If the timer is repeating, either start it if necessary (with the 1689If the timer is repeating, either start it if necessary (with the
1335\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 1690\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
1336.Sp 1691.Sp
1337This sounds a bit complicated, but here is a useful and typical 1692This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
1338example: Imagine you have a tcp connection and you want a so-called idle 1693usage example.
1339timeout, that is, you want to be called when there have been, say, 60
1340seconds of inactivity on the socket. The easiest way to do this is to
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
1342\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
1343you go into an idle state where you do not expect data to travel on the
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 1694.IP "ev_tstamp repeat [read\-write]" 4
1364.IX Item "ev_tstamp repeat [read-write]" 1695.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 1696The 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), 1697or \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. 1698which is also when any modifications are taken into account.
1368.PP 1699.PP
1369\fIExamples\fR 1700\fIExamples\fR
1370.IX Subsection "Examples" 1701.IX Subsection "Examples"
1371.PP 1702.PP
1372Example: Create a timer that fires after 60 seconds. 1703Example: Create a timer that fires after 60 seconds.
1373.PP 1704.PP
1374.Vb 5 1705.Vb 5
1375\& static void 1706\& static void
1376\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1707\& one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1377\& { 1708\& {
1378\& .. one minute over, w is actually stopped right here 1709\& .. one minute over, w is actually stopped right here
1379\& } 1710\& }
1380\& 1711\&
1381\& struct ev_timer mytimer; 1712\& ev_timer mytimer;
1382\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1713\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1383\& ev_timer_start (loop, &mytimer); 1714\& ev_timer_start (loop, &mytimer);
1384.Ve 1715.Ve
1385.PP 1716.PP
1386Example: Create a timeout timer that times out after 10 seconds of 1717Example: Create a timeout timer that times out after 10 seconds of
1387inactivity. 1718inactivity.
1388.PP 1719.PP
1389.Vb 5 1720.Vb 5
1390\& static void 1721\& static void
1391\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1722\& timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1392\& { 1723\& {
1393\& .. ten seconds without any activity 1724\& .. ten seconds without any activity
1394\& } 1725\& }
1395\& 1726\&
1396\& struct ev_timer mytimer; 1727\& ev_timer mytimer;
1397\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 1728\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1398\& ev_timer_again (&mytimer); /* start timer */ 1729\& ev_timer_again (&mytimer); /* start timer */
1399\& ev_loop (loop, 0); 1730\& ev_loop (loop, 0);
1400\& 1731\&
1401\& // and in some piece of code that gets executed on any "activity": 1732\& // and in some piece of code that gets executed on any "activity":
1402\& // reset the timeout to start ticking again at 10 seconds 1733\& // reset the timeout to start ticking again at 10 seconds
1403\& ev_timer_again (&mytimer); 1734\& ev_timer_again (&mytimer);
1404.Ve 1735.Ve
1405.ie n .Sh """ev_periodic"" \- to cron or not to cron?" 1736.ie n .Sh """ev_periodic"" \- to cron or not to cron?"
1406.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" 1737.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?"
1407.IX Subsection "ev_periodic - to cron or not to cron?" 1738.IX Subsection "ev_periodic - to cron or not to cron?"
1408Periodic watchers are also timers of a kind, but they are very versatile 1739Periodic watchers are also timers of a kind, but they are very versatile
1409(and unfortunately a bit complex). 1740(and unfortunately a bit complex).
1410.PP 1741.PP
1411Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 1742Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time)
1412but on wallclock time (absolute time). You can tell a periodic watcher 1743but on wall clock time (absolute time). You can tell a periodic watcher
1413to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a 1744to trigger after some specific point in time. For example, if you tell a
1414periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () 1745periodic watcher to trigger in 10 seconds (by specifying e.g. \f(CW\*(C`ev_now ()
1415+ 10.\*(C'\fR) and then reset your system clock to the last year, then it will 1746+ 10.\*(C'\fR, that is, an absolute time not a delay) and then reset your system
1747clock to January of the previous year, then it will take more than year
1416take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger 1748to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would still trigger
1417roughly 10 seconds later). 1749roughly 10 seconds later as it uses a relative timeout).
1418.PP 1750.PP
1419They can also be used to implement vastly more complex timers, such as 1751\&\f(CW\*(C`ev_periodic\*(C'\fRs can also be used to implement vastly more complex timers,
1420triggering an event on each midnight, local time or other, complicated, 1752such as triggering an event on each \*(L"midnight, local time\*(R", or other
1421rules. 1753complicated rules.
1422.PP 1754.PP
1423As with timers, the callback is guarenteed to be invoked only when the 1755As with timers, the callback is guaranteed to be invoked only when the
1424time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready 1756time (\f(CW\*(C`at\*(C'\fR) has passed, but if multiple periodic timers become ready
1425during the same loop iteration then order of execution is undefined. 1757during the same loop iteration, then order of execution is undefined.
1426.PP 1758.PP
1427\fIWatcher-Specific Functions and Data Members\fR 1759\fIWatcher-Specific Functions and Data Members\fR
1428.IX Subsection "Watcher-Specific Functions and Data Members" 1760.IX Subsection "Watcher-Specific Functions and Data Members"
1429.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 1761.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4
1430.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 1762.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)"
1431.PD 0 1763.PD 0
1432.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 1764.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4
1433.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 1765.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)"
1434.PD 1766.PD
1435Lots of arguments, lets sort it out... There are basically three modes of 1767Lots of arguments, lets sort it out... There are basically three modes of
1436operation, and we will explain them from simplest to complex: 1768operation, and we will explain them from simplest to most complex:
1437.RS 4 1769.RS 4
1438.IP "\(bu" 4 1770.IP "\(bu" 4
1439absolute timer (at = time, interval = reschedule_cb = 0) 1771absolute timer (at = time, interval = reschedule_cb = 0)
1440.Sp 1772.Sp
1441In this configuration the watcher triggers an event at the wallclock time 1773In this configuration the watcher triggers an event after the wall clock
1442\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, 1774time \f(CW\*(C`at\*(C'\fR has passed. It will not repeat and will not adjust when a time
1443that is, if it is to be run at January 1st 2011 then it will run when the 1775jump occurs, that is, if it is to be run at January 1st 2011 then it will
1444system time reaches or surpasses this time. 1776only run when the system clock reaches or surpasses this time.
1445.IP "\(bu" 4 1777.IP "\(bu" 4
1446repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1778repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1447.Sp 1779.Sp
1448In this mode the watcher will always be scheduled to time out at the next 1780In this mode the watcher will always be scheduled to time out at the next
1449\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) 1781\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative)
1450and then repeat, regardless of any time jumps. 1782and then repeat, regardless of any time jumps.
1451.Sp 1783.Sp
1452This can be used to create timers that do not drift with respect to system 1784This can be used to create timers that do not drift with respect to the
1453time: 1785system clock, for example, here is a \f(CW\*(C`ev_periodic\*(C'\fR that triggers each
1786hour, on the hour:
1454.Sp 1787.Sp
1455.Vb 1 1788.Vb 1
1456\& ev_periodic_set (&periodic, 0., 3600., 0); 1789\& ev_periodic_set (&periodic, 0., 3600., 0);
1457.Ve 1790.Ve
1458.Sp 1791.Sp
1459This doesn't mean there will always be 3600 seconds in between triggers, 1792This doesn't mean there will always be 3600 seconds in between triggers,
1460but only that the the callback will be called when the system time shows a 1793but only that the callback will be called when the system time shows a
1461full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible 1794full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible
1462by 3600. 1795by 3600.
1463.Sp 1796.Sp
1464Another way to think about it (for the mathematically inclined) is that 1797Another way to think about it (for the mathematically inclined) is that
1465\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 1798\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
1466time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 1799time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps.
1467.Sp 1800.Sp
1468For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near 1801For 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 1802\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
1470this value. 1803this value, and in fact is often specified as zero.
1804.Sp
1805Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
1806speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
1807will of course deteriorate. Libev itself tries to be exact to be about one
1808millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
1471.IP "\(bu" 4 1809.IP "\(bu" 4
1472manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1810manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1473.Sp 1811.Sp
1474In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 1812In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being
1475ignored. Instead, each time the periodic watcher gets scheduled, the 1813ignored. Instead, each time the periodic watcher gets scheduled, the
1476reschedule callback will be called with the watcher as first, and the 1814reschedule callback will be called with the watcher as first, and the
1477current time as second argument. 1815current time as second argument.
1478.Sp 1816.Sp
1479\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, 1817\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher,
1480ever, or make any event loop modifications\fR. If you need to stop it, 1818ever, or make \s-1ANY\s0 event loop modifications whatsoever\fR.
1481return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by 1819.Sp
1820If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
1482starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). 1821it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
1822only event loop modification you are allowed to do).
1483.Sp 1823.Sp
1484Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1824The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(ev_periodic
1485ev_tstamp now)\*(C'\fR, e.g.: 1825*w, ev_tstamp now)\*(C'\fR, e.g.:
1486.Sp 1826.Sp
1487.Vb 4 1827.Vb 5
1828\& static ev_tstamp
1488\& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1829\& my_rescheduler (ev_periodic *w, ev_tstamp now)
1489\& { 1830\& {
1490\& return now + 60.; 1831\& return now + 60.;
1491\& } 1832\& }
1492.Ve 1833.Ve
1493.Sp 1834.Sp
1494It must return the next time to trigger, based on the passed time value 1835It must return the next time to trigger, based on the passed time value
1495(that is, the lowest time value larger than to the second argument). It 1836(that is, the lowest time value larger than to the second argument). It
1496will usually be called just before the callback will be triggered, but 1837will usually be called just before the callback will be triggered, but
1497might be called at other times, too. 1838might be called at other times, too.
1498.Sp 1839.Sp
1499\&\s-1NOTE:\s0 \fIThis callback must always return a time that is later than the 1840\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
1500passed \f(CI\*(C`now\*(C'\fI value\fR. Not even \f(CW\*(C`now\*(C'\fR itself will do, it \fImust\fR be larger. 1841equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
1501.Sp 1842.Sp
1502This can be used to create very complex timers, such as a timer that 1843This can be used to create very complex timers, such as a timer that
1503triggers on each midnight, local time. To do this, you would calculate the 1844triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the
1504next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 1845next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How
1505you do this is, again, up to you (but it is not trivial, which is the main 1846you do this is, again, up to you (but it is not trivial, which is the main
1506reason I omitted it as an example). 1847reason I omitted it as an example).
1507.RE 1848.RE
1508.RS 4 1849.RS 4
1527.IP "ev_tstamp interval [read\-write]" 4 1868.IP "ev_tstamp interval [read\-write]" 4
1528.IX Item "ev_tstamp interval [read-write]" 1869.IX Item "ev_tstamp interval [read-write]"
1529The current interval value. Can be modified any time, but changes only 1870The current interval value. Can be modified any time, but changes only
1530take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being 1871take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
1531called. 1872called.
1532.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 1873.IP "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read\-write]" 4
1533.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" 1874.IX Item "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]"
1534The current reschedule callback, or \f(CW0\fR, if this functionality is 1875The current reschedule callback, or \f(CW0\fR, if this functionality is
1535switched off. Can be changed any time, but changes only take effect when 1876switched off. Can be changed any time, but changes only take effect when
1536the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. 1877the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1537.PP 1878.PP
1538\fIExamples\fR 1879\fIExamples\fR
1539.IX Subsection "Examples" 1880.IX Subsection "Examples"
1540.PP 1881.PP
1541Example: Call a callback every hour, or, more precisely, whenever the 1882Example: Call a callback every hour, or, more precisely, whenever the
1542system clock is divisible by 3600. The callback invocation times have 1883system time is divisible by 3600. The callback invocation times have
1543potentially a lot of jittering, but good long-term stability. 1884potentially a lot of jitter, but good long-term stability.
1544.PP 1885.PP
1545.Vb 5 1886.Vb 5
1546\& static void 1887\& static void
1547\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1888\& clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1548\& { 1889\& {
1549\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 1890\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1550\& } 1891\& }
1551\& 1892\&
1552\& struct ev_periodic hourly_tick; 1893\& ev_periodic hourly_tick;
1553\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1894\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1554\& ev_periodic_start (loop, &hourly_tick); 1895\& ev_periodic_start (loop, &hourly_tick);
1555.Ve 1896.Ve
1556.PP 1897.PP
1557Example: The same as above, but use a reschedule callback to do it: 1898Example: The same as above, but use a reschedule callback to do it:
1558.PP 1899.PP
1559.Vb 1 1900.Vb 1
1560\& #include <math.h> 1901\& #include <math.h>
1561\& 1902\&
1562\& static ev_tstamp 1903\& static ev_tstamp
1563\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1904\& my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1564\& { 1905\& {
1565\& return fmod (now, 3600.) + 3600.; 1906\& return now + (3600. \- fmod (now, 3600.));
1566\& } 1907\& }
1567\& 1908\&
1568\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1909\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1569.Ve 1910.Ve
1570.PP 1911.PP
1571Example: Call a callback every hour, starting now: 1912Example: Call a callback every hour, starting now:
1572.PP 1913.PP
1573.Vb 4 1914.Vb 4
1574\& struct ev_periodic hourly_tick; 1915\& ev_periodic hourly_tick;
1575\& ev_periodic_init (&hourly_tick, clock_cb, 1916\& ev_periodic_init (&hourly_tick, clock_cb,
1576\& fmod (ev_now (loop), 3600.), 3600., 0); 1917\& fmod (ev_now (loop), 3600.), 3600., 0);
1577\& ev_periodic_start (loop, &hourly_tick); 1918\& ev_periodic_start (loop, &hourly_tick);
1578.Ve 1919.Ve
1579.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" 1920.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!"
1580.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" 1921.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1581.IX Subsection "ev_signal - signal me when a signal gets signalled!" 1922.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1582Signal watchers will trigger an event when the process receives a specific 1923Signal watchers will trigger an event when the process receives a specific
1583signal one or more times. Even though signals are very asynchronous, libev 1924signal one or more times. Even though signals are very asynchronous, libev
1584will try it's best to deliver signals synchronously, i.e. as part of the 1925will try it's best to deliver signals synchronously, i.e. as part of the
1585normal event processing, like any other event. 1926normal event processing, like any other event.
1586.PP 1927.PP
1928If you want signals asynchronously, just use \f(CW\*(C`sigaction\*(C'\fR as you would
1929do without libev and forget about sharing the signal. You can even use
1930\&\f(CW\*(C`ev_async\*(C'\fR from a signal handler to synchronously wake up an event loop.
1931.PP
1587You can configure as many watchers as you like per signal. Only when the 1932You can configure as many watchers as you like per signal. Only when the
1588first watcher gets started will libev actually register a signal watcher 1933first watcher gets started will libev actually register a signal handler
1589with the kernel (thus it coexists with your own signal handlers as long 1934with the kernel (thus it coexists with your own signal handlers as long as
1590as you don't register any with libev). Similarly, when the last signal 1935you don't register any with libev for the same signal). Similarly, when
1591watcher for a signal is stopped libev will reset the signal handler to 1936the last signal watcher for a signal is stopped, libev will reset the
1592\&\s-1SIG_DFL\s0 (regardless of what it was set to before). 1937signal handler to \s-1SIG_DFL\s0 (regardless of what it was set to before).
1593.PP 1938.PP
1594If possible and supported, libev will install its handlers with 1939If 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 1940\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so system calls should not be unduly
1596interrupted. If you have a problem with syscalls getting interrupted by 1941interrupted. If you have a problem with system calls getting interrupted by
1597signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock 1942signals 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. 1943them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
1599.PP 1944.PP
1600\fIWatcher-Specific Functions and Data Members\fR 1945\fIWatcher-Specific Functions and Data Members\fR
1601.IX Subsection "Watcher-Specific Functions and Data Members" 1946.IX Subsection "Watcher-Specific Functions and Data Members"
1612The signal the watcher watches out for. 1957The signal the watcher watches out for.
1613.PP 1958.PP
1614\fIExamples\fR 1959\fIExamples\fR
1615.IX Subsection "Examples" 1960.IX Subsection "Examples"
1616.PP 1961.PP
1617Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1962Example: Try to exit cleanly on \s-1SIGINT\s0.
1618.PP 1963.PP
1619.Vb 5 1964.Vb 5
1620\& static void 1965\& static void
1621\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1966\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1622\& { 1967\& {
1623\& ev_unloop (loop, EVUNLOOP_ALL); 1968\& ev_unloop (loop, EVUNLOOP_ALL);
1624\& } 1969\& }
1625\& 1970\&
1626\& struct ev_signal signal_watcher; 1971\& ev_signal signal_watcher;
1627\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1972\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1628\& ev_signal_start (loop, &sigint_cb); 1973\& ev_signal_start (loop, &signal_watcher);
1629.Ve 1974.Ve
1630.ie n .Sh """ev_child"" \- watch out for process status changes" 1975.ie n .Sh """ev_child"" \- watch out for process status changes"
1631.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 1976.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1632.IX Subsection "ev_child - watch out for process status changes" 1977.IX Subsection "ev_child - watch out for process status changes"
1633Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1978Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1634some child status changes (most typically when a child of yours dies). It 1979some child status changes (most typically when a child of yours dies or
1635is permissible to install a child watcher \fIafter\fR the child has been 1980exits). It is permissible to install a child watcher \fIafter\fR the child
1636forked (which implies it might have already exited), as long as the event 1981has been forked (which implies it might have already exited), as long
1637loop isn't entered (or is continued from a watcher). 1982as the event loop isn't entered (or is continued from a watcher), i.e.,
1983forking and then immediately registering a watcher for the child is fine,
1984but forking and registering a watcher a few event loop iterations later is
1985not.
1638.PP 1986.PP
1639Only the default event loop is capable of handling signals, and therefore 1987Only the default event loop is capable of handling signals, and therefore
1640you can only rgeister child watchers in the default event loop. 1988you can only register child watchers in the default event loop.
1641.PP 1989.PP
1642\fIProcess Interaction\fR 1990\fIProcess Interaction\fR
1643.IX Subsection "Process Interaction" 1991.IX Subsection "Process Interaction"
1644.PP 1992.PP
1645Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is 1993Libev 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 1994initialised. This is necessary to guarantee proper behaviour even if
1647the first child watcher is started after the child exits. The occurance 1995the first child watcher is started after the child exits. The occurrence
1648of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done 1996of \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 1997synchronously as part of the event loop processing. Libev always reaps all
1650children, even ones not watched. 1998children, even ones not watched.
1651.PP 1999.PP
1652\fIOverriding the Built-In Processing\fR 2000\fIOverriding the Built-In Processing\fR
1657handler, you can override it easily by installing your own handler for 2005handler, 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 2006\&\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 2007default loop never gets destroyed. You are encouraged, however, to use an
1660event-based approach to child reaping and thus use libev's support for 2008event-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. 2009that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely.
2010.PP
2011\fIStopping the Child Watcher\fR
2012.IX Subsection "Stopping the Child Watcher"
2013.PP
2014Currently, the child watcher never gets stopped, even when the
2015child terminates, so normally one needs to stop the watcher in the
2016callback. Future versions of libev might stop the watcher automatically
2017when a child exit is detected.
1662.PP 2018.PP
1663\fIWatcher-Specific Functions and Data Members\fR 2019\fIWatcher-Specific Functions and Data Members\fR
1664.IX Subsection "Watcher-Specific Functions and Data Members" 2020.IX Subsection "Watcher-Specific Functions and Data Members"
1665.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4 2021.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
1666.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)" 2022.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
1692.PP 2048.PP
1693Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for 2049Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for
1694its completion. 2050its completion.
1695.PP 2051.PP
1696.Vb 1 2052.Vb 1
1697\& ev_child cw; 2053\& ev_child cw;
1698\& 2054\&
1699\& static void 2055\& static void
1700\& child_cb (EV_P_ struct ev_child *w, int revents) 2056\& child_cb (EV_P_ ev_child *w, int revents)
1701\& { 2057\& {
1702\& ev_child_stop (EV_A_ w); 2058\& ev_child_stop (EV_A_ w);
1703\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus); 2059\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1704\& } 2060\& }
1705\& 2061\&
1706\& pid_t pid = fork (); 2062\& pid_t pid = fork ();
1707\& 2063\&
1708\& if (pid < 0) 2064\& if (pid < 0)
1709\& // error 2065\& // error
1710\& else if (pid == 0) 2066\& else if (pid == 0)
1711\& { 2067\& {
1712\& // the forked child executes here 2068\& // the forked child executes here
1713\& exit (1); 2069\& exit (1);
1714\& } 2070\& }
1715\& else 2071\& else
1716\& { 2072\& {
1717\& ev_child_init (&cw, child_cb, pid, 0); 2073\& ev_child_init (&cw, child_cb, pid, 0);
1718\& ev_child_start (EV_DEFAULT_ &cw); 2074\& ev_child_start (EV_DEFAULT_ &cw);
1719\& } 2075\& }
1720.Ve 2076.Ve
1721.ie n .Sh """ev_stat"" \- did the file attributes just change?" 2077.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1722.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" 2078.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1723.IX Subsection "ev_stat - did the file attributes just change?" 2079.IX Subsection "ev_stat - did the file attributes just change?"
1724This watches a filesystem path for attribute changes. That is, it calls 2080This watches a file system 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 2081\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
1726compared to the last time, invoking the callback if it did. 2082and sees if it changed compared to the last time, invoking the callback if
2083it did.
1727.PP 2084.PP
1728The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2085The 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 2086not 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 2087not 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 2088otherwise always forced to be at least one) and all the other fields of
1732the stat buffer having unspecified contents. 2089the stat buffer having unspecified contents.
1733.PP 2090.PP
1734The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is 2091The path \fImust not\fR end in a slash or contain special components such as
2092\&\f(CW\*(C`.\*(C'\fR or \f(CW\*(C`..\*(C'\fR. The path \fIshould\fR be absolute: If it is relative and
1735relative and your working directory changes, the behaviour is undefined. 2093your working directory changes, then the behaviour is undefined.
1736.PP 2094.PP
1737Since there is no standard to do this, the portable implementation simply 2095Since there is no portable change notification interface available, the
1738calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You 2096portable implementation simply calls \f(CWstat(2)\fR regularly on the path
1739can specify a recommended polling interval for this case. If you specify 2097to see if it changed somehow. You can specify a recommended polling
1740a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, 2098interval for this case. If you specify a polling interval of \f(CW0\fR (highly
1741unspecified default\fR value will be used (which you can expect to be around 2099recommended!) then a \fIsuitable, unspecified default\fR value will be used
1742five seconds, although this might change dynamically). Libev will also 2100(which you can expect to be around five seconds, although this might
1743impose a minimum interval which is currently around \f(CW0.1\fR, but thats 2101change dynamically). Libev will also impose a minimum interval which is
1744usually overkill. 2102currently around \f(CW0.1\fR, but that's usually overkill.
1745.PP 2103.PP
1746This watcher type is not meant for massive numbers of stat watchers, 2104This watcher type is not meant for massive numbers of stat watchers,
1747as even with OS-supported change notifications, this can be 2105as even with OS-supported change notifications, this can be
1748resource-intensive. 2106resource-intensive.
1749.PP 2107.PP
1750At the time of this writing, only the Linux inotify interface is 2108At the time of this writing, the only OS-specific interface implemented
1751implemented (implementing kqueue support is left as an exercise for the 2109is the Linux inotify interface (implementing kqueue support is left as
1752reader, note, however, that the author sees no way of implementing ev_stat 2110an exercise for the reader. Note, however, that the author sees no way
1753semantics with kqueue). Inotify will be used to give hints only and should 2111of implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue).
1754not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev
1755sometimes needs to fall back to regular polling again even with inotify,
1756but changes are usually detected immediately, and if the file exists there
1757will be no polling.
1758.PP 2112.PP
1759\fI\s-1ABI\s0 Issues (Largefile Support)\fR 2113\fI\s-1ABI\s0 Issues (Largefile Support)\fR
1760.IX Subsection "ABI Issues (Largefile Support)" 2114.IX Subsection "ABI Issues (Largefile Support)"
1761.PP 2115.PP
1762Libev by default (unless the user overrides this) uses the default 2116Libev by default (unless the user overrides this) uses the default
1763compilation environment, which means that on systems with optionally 2117compilation environment, which means that on systems with large file
1764disabled large file support, you get the 32 bit version of the stat 2118support disabled by default, you get the 32 bit version of the stat
1765structure. When using the library from programs that change the \s-1ABI\s0 to 2119structure. When using the library from programs that change the \s-1ABI\s0 to
1766use 64 bit file offsets the programs will fail. In that case you have to 2120use 64 bit file offsets the programs will fail. In that case you have to
1767compile libev with the same flags to get binary compatibility. This is 2121compile libev with the same flags to get binary compatibility. This is
1768obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2122obviously the case with any flags that change the \s-1ABI\s0, but the problem is
1769most noticably with ev_stat and largefile support. 2123most noticeably displayed with ev_stat and large file support.
1770.PP 2124.PP
1771\fIInotify\fR 2125The solution for this is to lobby your distribution maker to make large
2126file interfaces available by default (as e.g. FreeBSD does) and not
2127optional. Libev cannot simply switch on large file support because it has
2128to exchange stat structures with application programs compiled using the
2129default compilation environment.
2130.PP
2131\fIInotify and Kqueue\fR
1772.IX Subsection "Inotify" 2132.IX Subsection "Inotify and Kqueue"
1773.PP 2133.PP
1774When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only 2134When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally
2135only available with Linux 2.6.25 or above due to bugs in earlier
1775available on Linux) and present at runtime, it will be used to speed up 2136implementations) and present at runtime, it will be used to speed up
1776change detection where possible. The inotify descriptor will be created lazily 2137change detection where possible. The inotify descriptor will be created
1777when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started. 2138lazily when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started.
1778.PP 2139.PP
1779Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers 2140Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
1780except that changes might be detected earlier, and in some cases, to avoid 2141except that changes might be detected earlier, and in some cases, to avoid
1781making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support 2142making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support
1782there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling. 2143there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling,
2144but as long as the path exists, libev usually gets away without polling.
1783.PP 2145.PP
1784(There is no support for kqueue, as apparently it cannot be used to 2146There is no support for kqueue, as apparently it cannot be used to
1785implement this functionality, due to the requirement of having a file 2147implement this functionality, due to the requirement of having a file
1786descriptor open on the object at all times). 2148descriptor open on the object at all times, and detecting renames, unlinks
2149etc. is difficult.
1787.PP 2150.PP
1788\fIThe special problem of stat time resolution\fR 2151\fIThe special problem of stat time resolution\fR
1789.IX Subsection "The special problem of stat time resolution" 2152.IX Subsection "The special problem of stat time resolution"
1790.PP 2153.PP
1791The \f(CW\*(C`stat ()\*(C'\fR syscall only supports full-second resolution portably, and 2154The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably,
1792even on systems where the resolution is higher, many filesystems still 2155and even on systems where the resolution is higher, most file systems
1793only support whole seconds. 2156still only support whole seconds.
1794.PP 2157.PP
1795That means that, if the time is the only thing that changes, you can 2158That means that, if the time is the only thing that changes, you can
1796easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and 2159easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and
1797calls your callback, which does something. When there is another update 2160calls your callback, which does something. When there is another update
1798within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it as the stat 2161within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the
1799data does not change. 2162stat data does change in other ways (e.g. file size).
1800.PP 2163.PP
1801The solution to this is to delay acting on a change for slightly more 2164The solution to this is to delay acting on a change for slightly more
1802than second (or till slightly after the next full second boundary), using 2165than a second (or till slightly after the next full second boundary), using
1803a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02); 2166a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02);
1804ev_timer_again (loop, w)\*(C'\fR). 2167ev_timer_again (loop, w)\*(C'\fR).
1805.PP 2168.PP
1806The \f(CW.02\fR offset is added to work around small timing inconsistencies 2169The \f(CW.02\fR offset is added to work around small timing inconsistencies
1807of some operating systems (where the second counter of the current time 2170of some operating systems (where the second counter of the current time
1824\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to 2187\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
1825be detected and should normally be specified as \f(CW0\fR to let libev choose 2188be detected and should normally be specified as \f(CW0\fR to let libev choose
1826a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same 2189a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
1827path for as long as the watcher is active. 2190path for as long as the watcher is active.
1828.Sp 2191.Sp
1829The callback will receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, relative 2192The callback will receive an \f(CW\*(C`EV_STAT\*(C'\fR event when a change was detected,
1830to the attributes at the time the watcher was started (or the last change 2193relative to the attributes at the time the watcher was started (or the
1831was detected). 2194last change was detected).
1832.IP "ev_stat_stat (loop, ev_stat *)" 4 2195.IP "ev_stat_stat (loop, ev_stat *)" 4
1833.IX Item "ev_stat_stat (loop, ev_stat *)" 2196.IX Item "ev_stat_stat (loop, ev_stat *)"
1834Updates the stat buffer immediately with new values. If you change the 2197Updates the stat buffer immediately with new values. If you change the
1835watched path in your callback, you could call this function to avoid 2198watched path in your callback, you could call this function to avoid
1836detecting this change (while introducing a race condition if you are not 2199detecting this change (while introducing a race condition if you are not
1852.IP "ev_tstamp interval [read\-only]" 4 2215.IP "ev_tstamp interval [read\-only]" 4
1853.IX Item "ev_tstamp interval [read-only]" 2216.IX Item "ev_tstamp interval [read-only]"
1854The specified interval. 2217The specified interval.
1855.IP "const char *path [read\-only]" 4 2218.IP "const char *path [read\-only]" 4
1856.IX Item "const char *path [read-only]" 2219.IX Item "const char *path [read-only]"
1857The filesystem path that is being watched. 2220The file system path that is being watched.
1858.PP 2221.PP
1859\fIExamples\fR 2222\fIExamples\fR
1860.IX Subsection "Examples" 2223.IX Subsection "Examples"
1861.PP 2224.PP
1862Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. 2225Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1863.PP 2226.PP
1864.Vb 10 2227.Vb 10
1865\& static void 2228\& static void
1866\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 2229\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1867\& { 2230\& {
1868\& /* /etc/passwd changed in some way */ 2231\& /* /etc/passwd changed in some way */
1869\& if (w\->attr.st_nlink) 2232\& if (w\->attr.st_nlink)
1870\& { 2233\& {
1871\& printf ("passwd current size %ld\en", (long)w\->attr.st_size); 2234\& printf ("passwd current size %ld\en", (long)w\->attr.st_size);
1872\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime); 2235\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime);
1873\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime); 2236\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime);
1874\& } 2237\& }
1875\& else 2238\& else
1876\& /* you shalt not abuse printf for puts */ 2239\& /* you shalt not abuse printf for puts */
1877\& puts ("wow, /etc/passwd is not there, expect problems. " 2240\& puts ("wow, /etc/passwd is not there, expect problems. "
1878\& "if this is windows, they already arrived\en"); 2241\& "if this is windows, they already arrived\en");
1879\& } 2242\& }
1880\& 2243\&
1881\& ... 2244\& ...
1882\& ev_stat passwd; 2245\& ev_stat passwd;
1883\& 2246\&
1884\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); 2247\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1885\& ev_stat_start (loop, &passwd); 2248\& ev_stat_start (loop, &passwd);
1886.Ve 2249.Ve
1887.PP 2250.PP
1888Example: Like above, but additionally use a one-second delay so we do not 2251Example: Like above, but additionally use a one-second delay so we do not
1889miss updates (however, frequent updates will delay processing, too, so 2252miss updates (however, frequent updates will delay processing, too, so
1890one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on 2253one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on
1891\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation). 2254\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
1892.PP 2255.PP
1893.Vb 2 2256.Vb 2
1894\& static ev_stat passwd; 2257\& static ev_stat passwd;
1895\& static ev_timer timer; 2258\& static ev_timer timer;
1896\& 2259\&
1897\& static void 2260\& static void
1898\& timer_cb (EV_P_ ev_timer *w, int revents) 2261\& timer_cb (EV_P_ ev_timer *w, int revents)
1899\& { 2262\& {
1900\& ev_timer_stop (EV_A_ w); 2263\& ev_timer_stop (EV_A_ w);
1901\& 2264\&
1902\& /* now it\*(Aqs one second after the most recent passwd change */ 2265\& /* now it\*(Aqs one second after the most recent passwd change */
1903\& } 2266\& }
1904\& 2267\&
1905\& static void 2268\& static void
1906\& stat_cb (EV_P_ ev_stat *w, int revents) 2269\& stat_cb (EV_P_ ev_stat *w, int revents)
1907\& { 2270\& {
1908\& /* reset the one\-second timer */ 2271\& /* reset the one\-second timer */
1909\& ev_timer_again (EV_A_ &timer); 2272\& ev_timer_again (EV_A_ &timer);
1910\& } 2273\& }
1911\& 2274\&
1912\& ... 2275\& ...
1913\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); 2276\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1914\& ev_stat_start (loop, &passwd); 2277\& ev_stat_start (loop, &passwd);
1915\& ev_timer_init (&timer, timer_cb, 0., 1.02); 2278\& ev_timer_init (&timer, timer_cb, 0., 1.02);
1916.Ve 2279.Ve
1917.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 2280.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1918.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 2281.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1919.IX Subsection "ev_idle - when you've got nothing better to do..." 2282.IX Subsection "ev_idle - when you've got nothing better to do..."
1920Idle watchers trigger events when no other events of the same or higher 2283Idle watchers trigger events when no other events of the same or higher
1921priority are pending (prepare, check and other idle watchers do not 2284priority are pending (prepare, check and other idle watchers do not count
1922count). 2285as receiving \*(L"events\*(R").
1923.PP 2286.PP
1924That is, as long as your process is busy handling sockets or timeouts 2287That is, as long as your process is busy handling sockets or timeouts
1925(or even signals, imagine) of the same or higher priority it will not be 2288(or even signals, imagine) of the same or higher priority it will not be
1926triggered. But when your process is idle (or only lower-priority watchers 2289triggered. But when your process is idle (or only lower-priority watchers
1927are pending), the idle watchers are being called once per event loop 2290are pending), the idle watchers are being called once per event loop
1949.PP 2312.PP
1950Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 2313Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1951callback, free it. Also, use no error checking, as usual. 2314callback, free it. Also, use no error checking, as usual.
1952.PP 2315.PP
1953.Vb 7 2316.Vb 7
1954\& static void 2317\& static void
1955\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 2318\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1956\& { 2319\& {
1957\& free (w); 2320\& free (w);
1958\& // now do something you wanted to do when the program has 2321\& // now do something you wanted to do when the program has
1959\& // no longer anything immediate to do. 2322\& // no longer anything immediate to do.
1960\& } 2323\& }
1961\& 2324\&
1962\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 2325\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1963\& ev_idle_init (idle_watcher, idle_cb); 2326\& ev_idle_init (idle_watcher, idle_cb);
1964\& ev_idle_start (loop, idle_cb); 2327\& ev_idle_start (loop, idle_cb);
1965.Ve 2328.Ve
1966.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" 2329.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!"
1967.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 2330.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
1968.IX Subsection "ev_prepare and ev_check - customise your event loop!" 2331.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1969Prepare and check watchers are usually (but not always) used in tandem: 2332Prepare and check watchers are usually (but not always) used in pairs:
1970prepare watchers get invoked before the process blocks and check watchers 2333prepare watchers get invoked before the process blocks and check watchers
1971afterwards. 2334afterwards.
1972.PP 2335.PP
1973You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter 2336You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter
1974the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 2337the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
1977those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 2340those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking,
1978\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 2341\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be
1979called in pairs bracketing the blocking call. 2342called in pairs bracketing the blocking call.
1980.PP 2343.PP
1981Their main purpose is to integrate other event mechanisms into libev and 2344Their main purpose is to integrate other event mechanisms into libev and
1982their use is somewhat advanced. This could be used, for example, to track 2345their use is somewhat advanced. They could be used, for example, to track
1983variable changes, implement your own watchers, integrate net-snmp or a 2346variable changes, implement your own watchers, integrate net-snmp or a
1984coroutine library and lots more. They are also occasionally useful if 2347coroutine library and lots more. They are also occasionally useful if
1985you cache some data and want to flush it before blocking (for example, 2348you cache some data and want to flush it before blocking (for example,
1986in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR 2349in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR
1987watcher). 2350watcher).
1988.PP 2351.PP
1989This is done by examining in each prepare call which file descriptors need 2352This is done by examining in each prepare call which file descriptors
1990to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 2353need to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers
1991them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 2354for them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many
1992provide just this functionality). Then, in the check watcher you check for 2355libraries provide exactly this functionality). Then, in the check watcher,
1993any events that occured (by checking the pending status of all watchers 2356you check for any events that occurred (by checking the pending status
1994and stopping them) and call back into the library. The I/O and timer 2357of all watchers and stopping them) and call back into the library. The
1995callbacks will never actually be called (but must be valid nevertheless, 2358I/O and timer callbacks will never actually be called (but must be valid
1996because you never know, you know?). 2359nevertheless, because you never know, you know?).
1997.PP 2360.PP
1998As another example, the Perl Coro module uses these hooks to integrate 2361As another example, the Perl Coro module uses these hooks to integrate
1999coroutines into libev programs, by yielding to other active coroutines 2362coroutines into libev programs, by yielding to other active coroutines
2000during each prepare and only letting the process block if no coroutines 2363during each prepare and only letting the process block if no coroutines
2001are ready to run (it's actually more complicated: it only runs coroutines 2364are ready to run (it's actually more complicated: it only runs coroutines
2004loop from blocking if lower-priority coroutines are active, thus mapping 2367loop from blocking if lower-priority coroutines are active, thus mapping
2005low-priority coroutines to idle/background tasks). 2368low-priority coroutines to idle/background tasks).
2006.PP 2369.PP
2007It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 2370It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR)
2008priority, to ensure that they are being run before any other watchers 2371priority, to ensure that they are being run before any other watchers
2372after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers).
2373.PP
2009after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, 2374Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
2010too) should not activate (\*(L"feed\*(R") events into libev. While libev fully 2375activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
2011supports this, they might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers 2376might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
2012did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other 2377\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
2013(non-libev) event loops those other event loops might be in an unusable 2378loops those other event loops might be in an unusable state until their
2014state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to 2379\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
2015coexist peacefully with others). 2380others).
2016.PP 2381.PP
2017\fIWatcher-Specific Functions and Data Members\fR 2382\fIWatcher-Specific Functions and Data Members\fR
2018.IX Subsection "Watcher-Specific Functions and Data Members" 2383.IX Subsection "Watcher-Specific Functions and Data Members"
2019.IP "ev_prepare_init (ev_prepare *, callback)" 4 2384.IP "ev_prepare_init (ev_prepare *, callback)" 4
2020.IX Item "ev_prepare_init (ev_prepare *, callback)" 2385.IX Item "ev_prepare_init (ev_prepare *, callback)"
2022.IP "ev_check_init (ev_check *, callback)" 4 2387.IP "ev_check_init (ev_check *, callback)" 4
2023.IX Item "ev_check_init (ev_check *, callback)" 2388.IX Item "ev_check_init (ev_check *, callback)"
2024.PD 2389.PD
2025Initialises and configures the prepare or check watcher \- they have no 2390Initialises and configures the prepare or check watcher \- they have no
2026parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 2391parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
2027macros, but using them is utterly, utterly and completely pointless. 2392macros, but using them is utterly, utterly, utterly and completely
2393pointless.
2028.PP 2394.PP
2029\fIExamples\fR 2395\fIExamples\fR
2030.IX Subsection "Examples" 2396.IX Subsection "Examples"
2031.PP 2397.PP
2032There are a number of principal ways to embed other event loops or modules 2398There are a number of principal ways to embed other event loops or modules
2041is pseudo-code only of course. This requires you to either use a low 2407is pseudo-code only of course. This requires you to either use a low
2042priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as 2408priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as
2043the callbacks for the IO/timeout watchers might not have been called yet. 2409the callbacks for the IO/timeout watchers might not have been called yet.
2044.PP 2410.PP
2045.Vb 2 2411.Vb 2
2046\& static ev_io iow [nfd]; 2412\& static ev_io iow [nfd];
2047\& static ev_timer tw; 2413\& static ev_timer tw;
2048\& 2414\&
2049\& static void 2415\& static void
2050\& io_cb (ev_loop *loop, ev_io *w, int revents) 2416\& io_cb (struct ev_loop *loop, ev_io *w, int revents)
2051\& { 2417\& {
2052\& } 2418\& }
2053\& 2419\&
2054\& // create io watchers for each fd and a timer before blocking 2420\& // create io watchers for each fd and a timer before blocking
2055\& static void 2421\& static void
2056\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 2422\& adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
2057\& { 2423\& {
2058\& int timeout = 3600000; 2424\& int timeout = 3600000;
2059\& struct pollfd fds [nfd]; 2425\& struct pollfd fds [nfd];
2060\& // actual code will need to loop here and realloc etc. 2426\& // actual code will need to loop here and realloc etc.
2061\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2427\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2062\& 2428\&
2063\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */ 2429\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
2064\& ev_timer_init (&tw, 0, timeout * 1e\-3); 2430\& ev_timer_init (&tw, 0, timeout * 1e\-3);
2065\& ev_timer_start (loop, &tw); 2431\& ev_timer_start (loop, &tw);
2066\& 2432\&
2067\& // create one ev_io per pollfd 2433\& // create one ev_io per pollfd
2068\& for (int i = 0; i < nfd; ++i) 2434\& for (int i = 0; i < nfd; ++i)
2069\& { 2435\& {
2070\& ev_io_init (iow + i, io_cb, fds [i].fd, 2436\& ev_io_init (iow + i, io_cb, fds [i].fd,
2071\& ((fds [i].events & POLLIN ? EV_READ : 0) 2437\& ((fds [i].events & POLLIN ? EV_READ : 0)
2072\& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 2438\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
2073\& 2439\&
2074\& fds [i].revents = 0; 2440\& fds [i].revents = 0;
2075\& ev_io_start (loop, iow + i); 2441\& ev_io_start (loop, iow + i);
2076\& } 2442\& }
2077\& } 2443\& }
2078\& 2444\&
2079\& // stop all watchers after blocking 2445\& // stop all watchers after blocking
2080\& static void 2446\& static void
2081\& adns_check_cb (ev_loop *loop, ev_check *w, int revents) 2447\& adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
2082\& { 2448\& {
2083\& ev_timer_stop (loop, &tw); 2449\& ev_timer_stop (loop, &tw);
2084\& 2450\&
2085\& for (int i = 0; i < nfd; ++i) 2451\& for (int i = 0; i < nfd; ++i)
2086\& { 2452\& {
2087\& // set the relevant poll flags 2453\& // set the relevant poll flags
2088\& // could also call adns_processreadable etc. here 2454\& // could also call adns_processreadable etc. here
2089\& struct pollfd *fd = fds + i; 2455\& struct pollfd *fd = fds + i;
2090\& int revents = ev_clear_pending (iow + i); 2456\& int revents = ev_clear_pending (iow + i);
2091\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN; 2457\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN;
2092\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT; 2458\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT;
2093\& 2459\&
2094\& // now stop the watcher 2460\& // now stop the watcher
2095\& ev_io_stop (loop, iow + i); 2461\& ev_io_stop (loop, iow + i);
2096\& } 2462\& }
2097\& 2463\&
2098\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 2464\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
2099\& } 2465\& }
2100.Ve 2466.Ve
2101.PP 2467.PP
2102Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR 2468Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
2103in the prepare watcher and would dispose of the check watcher. 2469in the prepare watcher and would dispose of the check watcher.
2104.PP 2470.PP
2105Method 3: If the module to be embedded supports explicit event 2471Method 3: If the module to be embedded supports explicit event
2106notification (adns does), you can also make use of the actual watcher 2472notification (libadns does), you can also make use of the actual watcher
2107callbacks, and only destroy/create the watchers in the prepare watcher. 2473callbacks, and only destroy/create the watchers in the prepare watcher.
2108.PP 2474.PP
2109.Vb 5 2475.Vb 5
2110\& static void 2476\& static void
2111\& timer_cb (EV_P_ ev_timer *w, int revents) 2477\& timer_cb (EV_P_ ev_timer *w, int revents)
2112\& { 2478\& {
2113\& adns_state ads = (adns_state)w\->data; 2479\& adns_state ads = (adns_state)w\->data;
2114\& update_now (EV_A); 2480\& update_now (EV_A);
2115\& 2481\&
2116\& adns_processtimeouts (ads, &tv_now); 2482\& adns_processtimeouts (ads, &tv_now);
2117\& } 2483\& }
2118\& 2484\&
2119\& static void 2485\& static void
2120\& io_cb (EV_P_ ev_io *w, int revents) 2486\& io_cb (EV_P_ ev_io *w, int revents)
2121\& { 2487\& {
2122\& adns_state ads = (adns_state)w\->data; 2488\& adns_state ads = (adns_state)w\->data;
2123\& update_now (EV_A); 2489\& update_now (EV_A);
2124\& 2490\&
2125\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now); 2491\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now);
2126\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now); 2492\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now);
2127\& } 2493\& }
2128\& 2494\&
2129\& // do not ever call adns_afterpoll 2495\& // do not ever call adns_afterpoll
2130.Ve 2496.Ve
2131.PP 2497.PP
2132Method 4: Do not use a prepare or check watcher because the module you 2498Method 4: Do not use a prepare or check watcher because the module you
2133want to embed is too inflexible to support it. Instead, youc na override 2499want to embed is not flexible enough to support it. Instead, you can
2134their poll function. The drawback with this solution is that the main 2500override their poll function. The drawback with this solution is that the
2135loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does 2501main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses
2136this. 2502this approach, effectively embedding \s-1EV\s0 as a client into the horrible
2503libglib event loop.
2137.PP 2504.PP
2138.Vb 4 2505.Vb 4
2139\& static gint 2506\& static gint
2140\& event_poll_func (GPollFD *fds, guint nfds, gint timeout) 2507\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2141\& { 2508\& {
2142\& int got_events = 0; 2509\& int got_events = 0;
2143\& 2510\&
2144\& for (n = 0; n < nfds; ++n) 2511\& for (n = 0; n < nfds; ++n)
2145\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events 2512\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
2146\& 2513\&
2147\& if (timeout >= 0) 2514\& if (timeout >= 0)
2148\& // create/start timer 2515\& // create/start timer
2149\& 2516\&
2150\& // poll 2517\& // poll
2151\& ev_loop (EV_A_ 0); 2518\& ev_loop (EV_A_ 0);
2152\& 2519\&
2153\& // stop timer again 2520\& // stop timer again
2154\& if (timeout >= 0) 2521\& if (timeout >= 0)
2155\& ev_timer_stop (EV_A_ &to); 2522\& ev_timer_stop (EV_A_ &to);
2156\& 2523\&
2157\& // stop io watchers again \- their callbacks should have set 2524\& // stop io watchers again \- their callbacks should have set
2158\& for (n = 0; n < nfds; ++n) 2525\& for (n = 0; n < nfds; ++n)
2159\& ev_io_stop (EV_A_ iow [n]); 2526\& ev_io_stop (EV_A_ iow [n]);
2160\& 2527\&
2161\& return got_events; 2528\& return got_events;
2162\& } 2529\& }
2163.Ve 2530.Ve
2164.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 2531.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
2165.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 2532.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
2166.IX Subsection "ev_embed - when one backend isn't enough..." 2533.IX Subsection "ev_embed - when one backend isn't enough..."
2167This is a rather advanced watcher type that lets you embed one event loop 2534This is a rather advanced watcher type that lets you embed one event loop
2173prioritise I/O. 2540prioritise I/O.
2174.PP 2541.PP
2175As an example for a bug workaround, the kqueue backend might only support 2542As an example for a bug workaround, the kqueue backend might only support
2176sockets on some platform, so it is unusable as generic backend, but you 2543sockets on some platform, so it is unusable as generic backend, but you
2177still want to make use of it because you have many sockets and it scales 2544still want to make use of it because you have many sockets and it scales
2178so nicely. In this case, you would create a kqueue-based loop and embed it 2545so nicely. In this case, you would create a kqueue-based loop and embed
2179into your default loop (which might use e.g. poll). Overall operation will 2546it into your default loop (which might use e.g. poll). Overall operation
2180be a bit slower because first libev has to poll and then call kevent, but 2547will be a bit slower because first libev has to call \f(CW\*(C`poll\*(C'\fR and then
2181at least you can use both at what they are best. 2548\&\f(CW\*(C`kevent\*(C'\fR, but at least you can use both mechanisms for what they are
2549best: \f(CW\*(C`kqueue\*(C'\fR for scalable sockets and \f(CW\*(C`poll\*(C'\fR if you want it to work :)
2182.PP 2550.PP
2183As for prioritising I/O: rarely you have the case where some fds have 2551As for prioritising I/O: under rare circumstances you have the case where
2184to be watched and handled very quickly (with low latency), and even 2552some fds have to be watched and handled very quickly (with low latency),
2185priorities and idle watchers might have too much overhead. In this case 2553and even priorities and idle watchers might have too much overhead. In
2186you would put all the high priority stuff in one loop and all the rest in 2554this case you would put all the high priority stuff in one loop and all
2187a second one, and embed the second one in the first. 2555the rest in a second one, and embed the second one in the first.
2188.PP 2556.PP
2189As long as the watcher is active, the callback will be invoked every time 2557As long as the watcher is active, the callback will be invoked every time
2190there might be events pending in the embedded loop. The callback must then 2558there might be events pending in the embedded loop. The callback must then
2191call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke 2559call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke
2192their callbacks (you could also start an idle watcher to give the embedded 2560their callbacks (you could also start an idle watcher to give the embedded
2200interested in that. 2568interested in that.
2201.PP 2569.PP
2202Also, there have not currently been made special provisions for forking: 2570Also, there have not currently been made special provisions for forking:
2203when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops, 2571when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops,
2204but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers 2572but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers
2205yourself. 2573yourself \- but you can use a fork watcher to handle this automatically,
2574and future versions of libev might do just that.
2206.PP 2575.PP
2207Unfortunately, not all backends are embeddable, only the ones returned by 2576Unfortunately, not all backends are embeddable: only the ones returned by
2208\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any 2577\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any
2209portable one. 2578portable one.
2210.PP 2579.PP
2211So when you want to use this feature you will always have to be prepared 2580So when you want to use this feature you will always have to be prepared
2212that you cannot get an embeddable loop. The recommended way to get around 2581that you cannot get an embeddable loop. The recommended way to get around
2213this is to have a separate variables for your embeddable loop, try to 2582this is to have a separate variables for your embeddable loop, try to
2214create it, and if that fails, use the normal loop for everything. 2583create it, and if that fails, use the normal loop for everything.
2584.PP
2585\fI\f(CI\*(C`ev_embed\*(C'\fI and fork\fR
2586.IX Subsection "ev_embed and fork"
2587.PP
2588While the \f(CW\*(C`ev_embed\*(C'\fR watcher is running, forks in the embedding loop will
2589automatically be applied to the embedded loop as well, so no special
2590fork handling is required in that case. When the watcher is not running,
2591however, it is still the task of the libev user to call \f(CW\*(C`ev_loop_fork ()\*(C'\fR
2592as applicable.
2215.PP 2593.PP
2216\fIWatcher-Specific Functions and Data Members\fR 2594\fIWatcher-Specific Functions and Data Members\fR
2217.IX Subsection "Watcher-Specific Functions and Data Members" 2595.IX Subsection "Watcher-Specific Functions and Data Members"
2218.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 2596.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
2219.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 2597.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
2223.PD 2601.PD
2224Configures the watcher to embed the given loop, which must be 2602Configures the watcher to embed the given loop, which must be
2225embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 2603embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
2226invoked automatically, otherwise it is the responsibility of the callback 2604invoked automatically, otherwise it is the responsibility of the callback
2227to invoke it (it will continue to be called until the sweep has been done, 2605to invoke it (it will continue to be called until the sweep has been done,
2228if you do not want thta, you need to temporarily stop the embed watcher). 2606if you do not want that, you need to temporarily stop the embed watcher).
2229.IP "ev_embed_sweep (loop, ev_embed *)" 4 2607.IP "ev_embed_sweep (loop, ev_embed *)" 4
2230.IX Item "ev_embed_sweep (loop, ev_embed *)" 2608.IX Item "ev_embed_sweep (loop, ev_embed *)"
2231Make a single, non-blocking sweep over the embedded loop. This works 2609Make a single, non-blocking sweep over the embedded loop. This works
2232similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 2610similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
2233apropriate way for embedded loops. 2611appropriate way for embedded loops.
2234.IP "struct ev_loop *other [read\-only]" 4 2612.IP "struct ev_loop *other [read\-only]" 4
2235.IX Item "struct ev_loop *other [read-only]" 2613.IX Item "struct ev_loop *other [read-only]"
2236The embedded event loop. 2614The embedded event loop.
2237.PP 2615.PP
2238\fIExamples\fR 2616\fIExamples\fR
2239.IX Subsection "Examples" 2617.IX Subsection "Examples"
2240.PP 2618.PP
2241Example: Try to get an embeddable event loop and embed it into the default 2619Example: Try to get an embeddable event loop and embed it into the default
2242event loop. If that is not possible, use the default loop. The default 2620event loop. If that is not possible, use the default loop. The default
2243loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the mebeddable loop is stored in 2621loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the embeddable loop is stored in
2244\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the acse no embeddable loop can be 2622\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the case no embeddable loop can be
2245used). 2623used).
2246.PP 2624.PP
2247.Vb 3 2625.Vb 3
2248\& struct ev_loop *loop_hi = ev_default_init (0); 2626\& struct ev_loop *loop_hi = ev_default_init (0);
2249\& struct ev_loop *loop_lo = 0; 2627\& struct ev_loop *loop_lo = 0;
2250\& struct ev_embed embed; 2628\& ev_embed embed;
2251\& 2629\&
2252\& // see if there is a chance of getting one that works 2630\& // see if there is a chance of getting one that works
2253\& // (remember that a flags value of 0 means autodetection) 2631\& // (remember that a flags value of 0 means autodetection)
2254\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 2632\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2255\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 2633\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2256\& : 0; 2634\& : 0;
2257\& 2635\&
2258\& // if we got one, then embed it, otherwise default to loop_hi 2636\& // if we got one, then embed it, otherwise default to loop_hi
2259\& if (loop_lo) 2637\& if (loop_lo)
2260\& { 2638\& {
2261\& ev_embed_init (&embed, 0, loop_lo); 2639\& ev_embed_init (&embed, 0, loop_lo);
2262\& ev_embed_start (loop_hi, &embed); 2640\& ev_embed_start (loop_hi, &embed);
2263\& } 2641\& }
2264\& else 2642\& else
2265\& loop_lo = loop_hi; 2643\& loop_lo = loop_hi;
2266.Ve 2644.Ve
2267.PP 2645.PP
2268Example: Check if kqueue is available but not recommended and create 2646Example: Check if kqueue is available but not recommended and create
2269a kqueue backend for use with sockets (which usually work with any 2647a kqueue backend for use with sockets (which usually work with any
2270kqueue implementation). Store the kqueue/socket\-only event loop in 2648kqueue implementation). Store the kqueue/socket\-only event loop in
2271\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too). 2649\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
2272.PP 2650.PP
2273.Vb 3 2651.Vb 3
2274\& struct ev_loop *loop = ev_default_init (0); 2652\& struct ev_loop *loop = ev_default_init (0);
2275\& struct ev_loop *loop_socket = 0; 2653\& struct ev_loop *loop_socket = 0;
2276\& struct ev_embed embed; 2654\& ev_embed embed;
2277\& 2655\&
2278\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 2656\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2279\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 2657\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2280\& { 2658\& {
2281\& ev_embed_init (&embed, 0, loop_socket); 2659\& ev_embed_init (&embed, 0, loop_socket);
2282\& ev_embed_start (loop, &embed); 2660\& ev_embed_start (loop, &embed);
2283\& } 2661\& }
2284\& 2662\&
2285\& if (!loop_socket) 2663\& if (!loop_socket)
2286\& loop_socket = loop; 2664\& loop_socket = loop;
2287\& 2665\&
2288\& // now use loop_socket for all sockets, and loop for everything else 2666\& // now use loop_socket for all sockets, and loop for everything else
2289.Ve 2667.Ve
2290.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" 2668.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
2291.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 2669.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2292.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 2670.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2293Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 2671Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2333is that the author does not know of a simple (or any) algorithm for a 2711is that the author does not know of a simple (or any) algorithm for a
2334multiple-writer-single-reader queue that works in all cases and doesn't 2712multiple-writer-single-reader queue that works in all cases and doesn't
2335need elaborate support such as pthreads. 2713need elaborate support such as pthreads.
2336.PP 2714.PP
2337That means that if you want to queue data, you have to provide your own 2715That means that if you want to queue data, you have to provide your own
2338queue. But at least I can tell you would implement locking around your 2716queue. But at least I can tell you how to implement locking around your
2339queue: 2717queue:
2340.IP "queueing from a signal handler context" 4 2718.IP "queueing from a signal handler context" 4
2341.IX Item "queueing from a signal handler context" 2719.IX Item "queueing from a signal handler context"
2342To implement race-free queueing, you simply add to the queue in the signal 2720To implement race-free queueing, you simply add to the queue in the signal
2343handler but you block the signal handler in the watcher callback. Here is an example that does that for 2721handler but you block the signal handler in the watcher callback. Here is
2344some fictitiuous \s-1SIGUSR1\s0 handler: 2722an example that does that for some fictitious \s-1SIGUSR1\s0 handler:
2345.Sp 2723.Sp
2346.Vb 1 2724.Vb 1
2347\& static ev_async mysig; 2725\& static ev_async mysig;
2348\& 2726\&
2349\& static void 2727\& static void
2413\fIWatcher-Specific Functions and Data Members\fR 2791\fIWatcher-Specific Functions and Data Members\fR
2414.IX Subsection "Watcher-Specific Functions and Data Members" 2792.IX Subsection "Watcher-Specific Functions and Data Members"
2415.IP "ev_async_init (ev_async *, callback)" 4 2793.IP "ev_async_init (ev_async *, callback)" 4
2416.IX Item "ev_async_init (ev_async *, callback)" 2794.IX Item "ev_async_init (ev_async *, callback)"
2417Initialises and configures the async watcher \- it has no parameters of any 2795Initialises and configures the async watcher \- it has no parameters of any
2418kind. There is a \f(CW\*(C`ev_asynd_set\*(C'\fR macro, but using it is utterly pointless, 2796kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless,
2419believe me. 2797trust me.
2420.IP "ev_async_send (loop, ev_async *)" 4 2798.IP "ev_async_send (loop, ev_async *)" 4
2421.IX Item "ev_async_send (loop, ev_async *)" 2799.IX Item "ev_async_send (loop, ev_async *)"
2422Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds 2800Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
2423an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike 2801an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike
2424\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do in other threads, signal or 2802\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or
2425similar contexts (see the dicusssion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding 2803similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding
2426section below on what exactly this means). 2804section below on what exactly this means).
2427.Sp 2805.Sp
2428This call incurs the overhead of a syscall only once per loop iteration, 2806This call incurs the overhead of a system call only once per loop iteration,
2429so while the overhead might be noticable, it doesn't apply to repeated 2807so while the overhead might be noticeable, it doesn't apply to repeated
2430calls to \f(CW\*(C`ev_async_send\*(C'\fR. 2808calls to \f(CW\*(C`ev_async_send\*(C'\fR.
2431.IP "bool = ev_async_pending (ev_async *)" 4 2809.IP "bool = ev_async_pending (ev_async *)" 4
2432.IX Item "bool = ev_async_pending (ev_async *)" 2810.IX Item "bool = ev_async_pending (ev_async *)"
2433Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 2811Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
2434watcher but the event has not yet been processed (or even noted) by the 2812watcher but the event has not yet been processed (or even noted) by the
2435event loop. 2813event loop.
2436.Sp 2814.Sp
2437\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When 2815\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
2438the loop iterates next and checks for the watcher to have become active, 2816the loop iterates next and checks for the watcher to have become active,
2439it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very 2817it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
2440quickly check wether invoking the loop might be a good idea. 2818quickly check whether invoking the loop might be a good idea.
2441.Sp 2819.Sp
2442Not that this does \fInot\fR check wether the watcher itself is pending, only 2820Not that this does \fInot\fR check whether the watcher itself is pending, only
2443wether it has been requested to make this watcher pending. 2821whether it has been requested to make this watcher pending.
2444.SH "OTHER FUNCTIONS" 2822.SH "OTHER FUNCTIONS"
2445.IX Header "OTHER FUNCTIONS" 2823.IX Header "OTHER FUNCTIONS"
2446There are some other functions of possible interest. Described. Here. Now. 2824There are some other functions of possible interest. Described. Here. Now.
2447.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 2825.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
2448.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 2826.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
2449This function combines a simple timer and an I/O watcher, calls your 2827This function combines a simple timer and an I/O watcher, calls your
2450callback on whichever event happens first and automatically stop both 2828callback on whichever event happens first and automatically stops both
2451watchers. This is useful if you want to wait for a single event on an fd 2829watchers. This is useful if you want to wait for a single event on an fd
2452or timeout without having to allocate/configure/start/stop/free one or 2830or timeout without having to allocate/configure/start/stop/free one or
2453more watchers yourself. 2831more watchers yourself.
2454.Sp 2832.Sp
2455If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events 2833If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and the
2456is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and 2834\&\f(CW\*(C`events\*(C'\fR argument is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for
2457\&\f(CW\*(C`events\*(C'\fR set will be craeted and started. 2835the given \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`events\*(C'\fR set will be created and started.
2458.Sp 2836.Sp
2459If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be 2837If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be
2460started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and 2838started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and
2461repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of 2839repeat = 0) will be started. \f(CW0\fR is a valid timeout.
2462dubious value.
2463.Sp 2840.Sp
2464The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets 2841The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets
2465passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of 2842passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of
2466\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR 2843\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
2467value passed to \f(CW\*(C`ev_once\*(C'\fR: 2844value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
2845a timeout and an io event at the same time \- you probably should give io
2846events precedence.
2847.Sp
2848Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0.
2468.Sp 2849.Sp
2469.Vb 7 2850.Vb 7
2470\& static void stdin_ready (int revents, void *arg) 2851\& static void stdin_ready (int revents, void *arg)
2471\& { 2852\& {
2472\& if (revents & EV_TIMEOUT)
2473\& /* doh, nothing entered */;
2474\& else if (revents & EV_READ) 2853\& if (revents & EV_READ)
2475\& /* stdin might have data for us, joy! */; 2854\& /* stdin might have data for us, joy! */;
2855\& else if (revents & EV_TIMEOUT)
2856\& /* doh, nothing entered */;
2476\& } 2857\& }
2477\& 2858\&
2478\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 2859\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2479.Ve 2860.Ve
2480.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 2861.IP "ev_feed_event (struct ev_loop *, watcher *, int revents)" 4
2481.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" 2862.IX Item "ev_feed_event (struct ev_loop *, watcher *, int revents)"
2482Feeds the given event set into the event loop, as if the specified event 2863Feeds the given event set into the event loop, as if the specified event
2483had happened for the specified watcher (which must be a pointer to an 2864had happened for the specified watcher (which must be a pointer to an
2484initialised but not necessarily started event watcher). 2865initialised but not necessarily started event watcher).
2485.IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4 2866.IP "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" 4
2486.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" 2867.IX Item "ev_feed_fd_event (struct ev_loop *, int fd, int revents)"
2487Feed an event on the given fd, as if a file descriptor backend detected 2868Feed an event on the given fd, as if a file descriptor backend detected
2488the given events it. 2869the given events it.
2489.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 2870.IP "ev_feed_signal_event (struct ev_loop *loop, int signum)" 4
2490.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" 2871.IX Item "ev_feed_signal_event (struct ev_loop *loop, int signum)"
2491Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default 2872Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default
2492loop!). 2873loop!).
2493.SH "LIBEVENT EMULATION" 2874.SH "LIBEVENT EMULATION"
2494.IX Header "LIBEVENT EMULATION" 2875.IX Header "LIBEVENT EMULATION"
2495Libev offers a compatibility emulation layer for libevent. It cannot 2876Libev offers a compatibility emulation layer for libevent. It cannot
2496emulate the internals of libevent, so here are some usage hints: 2877emulate the internals of libevent, so here are some usage hints:
2516The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 2897The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
2517to use the libev header file and library. 2898to use the libev header file and library.
2518.SH "\*(C+ SUPPORT" 2899.SH "\*(C+ SUPPORT"
2519.IX Header " SUPPORT" 2900.IX Header " SUPPORT"
2520Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 2901Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
2521you to use some convinience methods to start/stop watchers and also change 2902you to use some convenience methods to start/stop watchers and also change
2522the callback model to a model using method callbacks on objects. 2903the callback model to a model using method callbacks on objects.
2523.PP 2904.PP
2524To use it, 2905To use it,
2525.PP 2906.PP
2526.Vb 1 2907.Vb 1
2527\& #include <ev++.h> 2908\& #include <ev++.h>
2528.Ve 2909.Ve
2529.PP 2910.PP
2530This automatically includes \fIev.h\fR and puts all of its definitions (many 2911This automatically includes \fIev.h\fR and puts all of its definitions (many
2531of them macros) into the global namespace. All \*(C+ specific things are 2912of them macros) into the global namespace. All \*(C+ specific things are
2532put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding 2913put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
2598thunking function, making it as fast as a direct C callback. 2979thunking function, making it as fast as a direct C callback.
2599.Sp 2980.Sp
2600Example: simple class declaration and watcher initialisation 2981Example: simple class declaration and watcher initialisation
2601.Sp 2982.Sp
2602.Vb 4 2983.Vb 4
2603\& struct myclass 2984\& struct myclass
2604\& { 2985\& {
2605\& void io_cb (ev::io &w, int revents) { } 2986\& void io_cb (ev::io &w, int revents) { }
2606\& } 2987\& }
2607\& 2988\&
2608\& myclass obj; 2989\& myclass obj;
2609\& ev::io iow; 2990\& ev::io iow;
2610\& iow.set <myclass, &myclass::io_cb> (&obj); 2991\& iow.set <myclass, &myclass::io_cb> (&obj);
2611.Ve 2992.Ve
2612.IP "w\->set<function> (void *data = 0)" 4 2993.IP "w\->set<function> (void *data = 0)" 4
2613.IX Item "w->set<function> (void *data = 0)" 2994.IX Item "w->set<function> (void *data = 0)"
2614Also sets a callback, but uses a static method or plain function as 2995Also sets a callback, but uses a static method or plain function as
2615callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's 2996callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
2617.Sp 2998.Sp
2618The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. 2999The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
2619.Sp 3000.Sp
2620See the method\-\f(CW\*(C`set\*(C'\fR above for more details. 3001See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
2621.Sp 3002.Sp
2622Example: 3003Example: Use a plain function as callback.
2623.Sp 3004.Sp
2624.Vb 2 3005.Vb 2
2625\& static void io_cb (ev::io &w, int revents) { } 3006\& static void io_cb (ev::io &w, int revents) { }
2626\& iow.set <io_cb> (); 3007\& iow.set <io_cb> ();
2627.Ve 3008.Ve
2628.IP "w\->set (struct ev_loop *)" 4 3009.IP "w\->set (struct ev_loop *)" 4
2629.IX Item "w->set (struct ev_loop *)" 3010.IX Item "w->set (struct ev_loop *)"
2630Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 3011Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
2631do this when the watcher is inactive (and not pending either). 3012do this when the watcher is inactive (and not pending either).
2632.IP "w\->set ([args])" 4 3013.IP "w\->set ([arguments])" 4
2633.IX Item "w->set ([args])" 3014.IX Item "w->set ([arguments])"
2634Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be 3015Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Must be
2635called at least once. Unlike the C counterpart, an active watcher gets 3016called at least once. Unlike the C counterpart, an active watcher gets
2636automatically stopped and restarted when reconfiguring it with this 3017automatically stopped and restarted when reconfiguring it with this
2637method. 3018method.
2638.IP "w\->start ()" 4 3019.IP "w\->start ()" 4
2639.IX Item "w->start ()" 3020.IX Item "w->start ()"
2661.PP 3042.PP
2662Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 3043Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in
2663the constructor. 3044the constructor.
2664.PP 3045.PP
2665.Vb 4 3046.Vb 4
2666\& class myclass 3047\& class myclass
2667\& { 3048\& {
2668\& ev::io io; void io_cb (ev::io &w, int revents); 3049\& ev::io io ; void io_cb (ev::io &w, int revents);
2669\& ev:idle idle void idle_cb (ev::idle &w, int revents); 3050\& ev::idle idle; void idle_cb (ev::idle &w, int revents);
2670\& 3051\&
2671\& myclass (int fd) 3052\& myclass (int fd)
2672\& { 3053\& {
2673\& io .set <myclass, &myclass::io_cb > (this); 3054\& io .set <myclass, &myclass::io_cb > (this);
2674\& idle.set <myclass, &myclass::idle_cb> (this); 3055\& idle.set <myclass, &myclass::idle_cb> (this);
2675\& 3056\&
2676\& io.start (fd, ev::READ); 3057\& io.start (fd, ev::READ);
2677\& } 3058\& }
2678\& }; 3059\& };
2679.Ve 3060.Ve
2680.SH "OTHER LANGUAGE BINDINGS" 3061.SH "OTHER LANGUAGE BINDINGS"
2681.IX Header "OTHER LANGUAGE BINDINGS" 3062.IX Header "OTHER LANGUAGE BINDINGS"
2682Libev does not offer other language bindings itself, but bindings for a 3063Libev does not offer other language bindings itself, but bindings for a
2683numbe rof languages exist in the form of third-party packages. If you know 3064number of languages exist in the form of third-party packages. If you know
2684any interesting language binding in addition to the ones listed here, drop 3065any interesting language binding in addition to the ones listed here, drop
2685me a note. 3066me a note.
2686.IP "Perl" 4 3067.IP "Perl" 4
2687.IX Item "Perl" 3068.IX Item "Perl"
2688The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test 3069The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test
2689libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module, 3070libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module,
2690there are additional modules that implement libev-compatible interfaces 3071there are additional modules that implement libev-compatible interfaces
2691to \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 3072to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
2692\&\f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR and \f(CW\*(C`EV::Glib\*(C'\fR). 3073\&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR
3074and \f(CW\*(C`EV::Glib\*(C'\fR).
2693.Sp 3075.Sp
2694It can be found and installed via \s-1CPAN\s0, its homepage is found at 3076It can be found and installed via \s-1CPAN\s0, its homepage is at
2695<http://software.schmorp.de/pkg/EV>. 3077<http://software.schmorp.de/pkg/EV>.
3078.IP "Python" 4
3079.IX Item "Python"
3080Python bindings can be found at <http://code.google.com/p/pyev/>. It
3081seems to be quite complete and well-documented. Note, however, that the
3082patch they require for libev is outright dangerous as it breaks the \s-1ABI\s0
3083for everybody else, and therefore, should never be applied in an installed
3084libev (if python requires an incompatible \s-1ABI\s0 then it needs to embed
3085libev).
2696.IP "Ruby" 4 3086.IP "Ruby" 4
2697.IX Item "Ruby" 3087.IX Item "Ruby"
2698Tony Arcieri has written a ruby extension that offers access to a subset 3088Tony Arcieri has written a ruby extension that offers access to a subset
2699of the libev \s-1API\s0 and adds filehandle abstractions, asynchronous \s-1DNS\s0 and 3089of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and
2700more on top of it. It can be found via gem servers. Its homepage is at 3090more on top of it. It can be found via gem servers. Its homepage is at
2701<http://rev.rubyforge.org/>. 3091<http://rev.rubyforge.org/>.
2702.IP "D" 4 3092.IP "D" 4
2703.IX Item "D" 3093.IX Item "D"
2704Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 3094Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
2705be found at <http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>. 3095be found at <http://proj.llucax.com.ar/wiki/evd>.
3096.IP "Ocaml" 4
3097.IX Item "Ocaml"
3098Erkki Seppala has written Ocaml bindings for libev, to be found at
3099<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
2706.SH "MACRO MAGIC" 3100.SH "MACRO MAGIC"
2707.IX Header "MACRO MAGIC" 3101.IX Header "MACRO MAGIC"
2708Libev can be compiled with a variety of options, the most fundamantal 3102Libev can be compiled with a variety of options, the most fundamental
2709of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 3103of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
2710functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 3104functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
2711.PP 3105.PP
2712To make it easier to write programs that cope with either variant, the 3106To make it easier to write programs that cope with either variant, the
2713following macros are defined: 3107following macros are defined:
2717This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev 3111This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
2718loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, 3112loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
2719\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: 3113\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
2720.Sp 3114.Sp
2721.Vb 3 3115.Vb 3
2722\& ev_unref (EV_A); 3116\& ev_unref (EV_A);
2723\& ev_timer_add (EV_A_ watcher); 3117\& ev_timer_add (EV_A_ watcher);
2724\& ev_loop (EV_A_ 0); 3118\& ev_loop (EV_A_ 0);
2725.Ve 3119.Ve
2726.Sp 3120.Sp
2727It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, 3121It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
2728which is often provided by the following macro. 3122which is often provided by the following macro.
2729.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 3123.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4
2732This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev 3126This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
2733loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, 3127loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
2734\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: 3128\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
2735.Sp 3129.Sp
2736.Vb 2 3130.Vb 2
2737\& // this is how ev_unref is being declared 3131\& // this is how ev_unref is being declared
2738\& static void ev_unref (EV_P); 3132\& static void ev_unref (EV_P);
2739\& 3133\&
2740\& // this is how you can declare your typical callback 3134\& // this is how you can declare your typical callback
2741\& static void cb (EV_P_ ev_timer *w, int revents) 3135\& static void cb (EV_P_ ev_timer *w, int revents)
2742.Ve 3136.Ve
2743.Sp 3137.Sp
2744It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite 3138It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
2745suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 3139suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
2746.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 3140.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4
2762Example: Declare and initialise a check watcher, utilising the above 3156Example: Declare and initialise a check watcher, utilising the above
2763macros so it will work regardless of whether multiple loops are supported 3157macros so it will work regardless of whether multiple loops are supported
2764or not. 3158or not.
2765.PP 3159.PP
2766.Vb 5 3160.Vb 5
2767\& static void 3161\& static void
2768\& check_cb (EV_P_ ev_timer *w, int revents) 3162\& check_cb (EV_P_ ev_timer *w, int revents)
2769\& { 3163\& {
2770\& ev_check_stop (EV_A_ w); 3164\& ev_check_stop (EV_A_ w);
2771\& } 3165\& }
2772\& 3166\&
2773\& ev_check check; 3167\& ev_check check;
2774\& ev_check_init (&check, check_cb); 3168\& ev_check_init (&check, check_cb);
2775\& ev_check_start (EV_DEFAULT_ &check); 3169\& ev_check_start (EV_DEFAULT_ &check);
2776\& ev_loop (EV_DEFAULT_ 0); 3170\& ev_loop (EV_DEFAULT_ 0);
2777.Ve 3171.Ve
2778.SH "EMBEDDING" 3172.SH "EMBEDDING"
2779.IX Header "EMBEDDING" 3173.IX Header "EMBEDDING"
2780Libev can (and often is) directly embedded into host 3174Libev can (and often is) directly embedded into host
2781applications. Examples of applications that embed it include the Deliantra 3175applications. Examples of applications that embed it include the Deliantra
2787you can easily upgrade by simply copying (or having a checked-out copy of 3181you can easily upgrade by simply copying (or having a checked-out copy of
2788libev somewhere in your source tree). 3182libev somewhere in your source tree).
2789.Sh "\s-1FILESETS\s0" 3183.Sh "\s-1FILESETS\s0"
2790.IX Subsection "FILESETS" 3184.IX Subsection "FILESETS"
2791Depending on what features you need you need to include one or more sets of files 3185Depending on what features you need you need to include one or more sets of files
2792in your app. 3186in your application.
2793.PP 3187.PP
2794\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 3188\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
2795.IX Subsection "CORE EVENT LOOP" 3189.IX Subsection "CORE EVENT LOOP"
2796.PP 3190.PP
2797To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 3191To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
2798configuration (no autoconf): 3192configuration (no autoconf):
2799.PP 3193.PP
2800.Vb 2 3194.Vb 2
2801\& #define EV_STANDALONE 1 3195\& #define EV_STANDALONE 1
2802\& #include "ev.c" 3196\& #include "ev.c"
2803.Ve 3197.Ve
2804.PP 3198.PP
2805This will automatically include \fIev.h\fR, too, and should be done in a 3199This will automatically include \fIev.h\fR, too, and should be done in a
2806single C source file only to provide the function implementations. To use 3200single C source file only to provide the function implementations. To use
2807it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best 3201it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
2808done by writing a wrapper around \fIev.h\fR that you can include instead and 3202done by writing a wrapper around \fIev.h\fR that you can include instead and
2809where you can put other configuration options): 3203where you can put other configuration options):
2810.PP 3204.PP
2811.Vb 2 3205.Vb 2
2812\& #define EV_STANDALONE 1 3206\& #define EV_STANDALONE 1
2813\& #include "ev.h" 3207\& #include "ev.h"
2814.Ve 3208.Ve
2815.PP 3209.PP
2816Both header files and implementation files can be compiled with a \*(C+ 3210Both header files and implementation files can be compiled with a \*(C+
2817compiler (at least, thats a stated goal, and breakage will be treated 3211compiler (at least, that's a stated goal, and breakage will be treated
2818as a bug). 3212as a bug).
2819.PP 3213.PP
2820You need the following files in your source tree, or in a directory 3214You need the following files in your source tree, or in a directory
2821in your include path (e.g. in libev/ when using \-Ilibev): 3215in your include path (e.g. in libev/ when using \-Ilibev):
2822.PP 3216.PP
2823.Vb 4 3217.Vb 4
2824\& ev.h 3218\& ev.h
2825\& ev.c 3219\& ev.c
2826\& ev_vars.h 3220\& ev_vars.h
2827\& ev_wrap.h 3221\& ev_wrap.h
2828\& 3222\&
2829\& ev_win32.c required on win32 platforms only 3223\& ev_win32.c required on win32 platforms only
2830\& 3224\&
2831\& ev_select.c only when select backend is enabled (which is enabled by default) 3225\& ev_select.c only when select backend is enabled (which is enabled by default)
2832\& ev_poll.c only when poll backend is enabled (disabled by default) 3226\& ev_poll.c only when poll backend is enabled (disabled by default)
2833\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 3227\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2834\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 3228\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2835\& ev_port.c only when the solaris port backend is enabled (disabled by default) 3229\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2836.Ve 3230.Ve
2837.PP 3231.PP
2838\&\fIev.c\fR includes the backend files directly when enabled, so you only need 3232\&\fIev.c\fR includes the backend files directly when enabled, so you only need
2839to compile this single file. 3233to compile this single file.
2840.PP 3234.PP
2842.IX Subsection "LIBEVENT COMPATIBILITY API" 3236.IX Subsection "LIBEVENT COMPATIBILITY API"
2843.PP 3237.PP
2844To include the libevent compatibility \s-1API\s0, also include: 3238To include the libevent compatibility \s-1API\s0, also include:
2845.PP 3239.PP
2846.Vb 1 3240.Vb 1
2847\& #include "event.c" 3241\& #include "event.c"
2848.Ve 3242.Ve
2849.PP 3243.PP
2850in the file including \fIev.c\fR, and: 3244in the file including \fIev.c\fR, and:
2851.PP 3245.PP
2852.Vb 1 3246.Vb 1
2853\& #include "event.h" 3247\& #include "event.h"
2854.Ve 3248.Ve
2855.PP 3249.PP
2856in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 3250in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR.
2857.PP 3251.PP
2858You need the following additional files for this: 3252You need the following additional files for this:
2859.PP 3253.PP
2860.Vb 2 3254.Vb 2
2861\& event.h 3255\& event.h
2862\& event.c 3256\& event.c
2863.Ve 3257.Ve
2864.PP 3258.PP
2865\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 3259\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR
2866.IX Subsection "AUTOCONF SUPPORT" 3260.IX Subsection "AUTOCONF SUPPORT"
2867.PP 3261.PP
2868Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in 3262Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
2869whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 3263whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
2870\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 3264\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
2871include \fIconfig.h\fR and configure itself accordingly. 3265include \fIconfig.h\fR and configure itself accordingly.
2872.PP 3266.PP
2873For this of course you need the m4 file: 3267For this of course you need the m4 file:
2874.PP 3268.PP
2875.Vb 1 3269.Vb 1
2876\& libev.m4 3270\& libev.m4
2877.Ve 3271.Ve
2878.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 3272.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
2879.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 3273.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
2880Libev can be configured via a variety of preprocessor symbols you have to 3274Libev can be configured via a variety of preprocessor symbols you have to
2881define before including any of its files. The default in the absense of 3275define before including any of its files. The default in the absence of
2882autoconf is noted for every option. 3276autoconf is documented for every option.
2883.IP "\s-1EV_STANDALONE\s0" 4 3277.IP "\s-1EV_STANDALONE\s0" 4
2884.IX Item "EV_STANDALONE" 3278.IX Item "EV_STANDALONE"
2885Must always be \f(CW1\fR if you do not use autoconf configuration, which 3279Must always be \f(CW1\fR if you do not use autoconf configuration, which
2886keeps libev from including \fIconfig.h\fR, and it also defines dummy 3280keeps libev from including \fIconfig.h\fR, and it also defines dummy
2887implementations for some libevent functions (such as logging, which is not 3281implementations for some libevent functions (such as logging, which is not
2888supported). It will also not define any of the structs usually found in 3282supported). It will also not define any of the structs usually found in
2889\&\fIevent.h\fR that are not directly supported by the libev core alone. 3283\&\fIevent.h\fR that are not directly supported by the libev core alone.
2890.IP "\s-1EV_USE_MONOTONIC\s0" 4 3284.IP "\s-1EV_USE_MONOTONIC\s0" 4
2891.IX Item "EV_USE_MONOTONIC" 3285.IX Item "EV_USE_MONOTONIC"
2892If defined to be \f(CW1\fR, libev will try to detect the availability of the 3286If defined to be \f(CW1\fR, libev will try to detect the availability of the
2893monotonic clock option at both compiletime and runtime. Otherwise no use 3287monotonic clock option at both compile time and runtime. Otherwise no use
2894of the monotonic clock option will be attempted. If you enable this, you 3288of the monotonic clock option will be attempted. If you enable this, you
2895usually have to link against librt or something similar. Enabling it when 3289usually have to link against librt or something similar. Enabling it when
2896the functionality isn't available is safe, though, although you have 3290the functionality isn't available is safe, though, although you have
2897to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR 3291to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
2898function is hiding in (often \fI\-lrt\fR). 3292function is hiding in (often \fI\-lrt\fR).
2899.IP "\s-1EV_USE_REALTIME\s0" 4 3293.IP "\s-1EV_USE_REALTIME\s0" 4
2900.IX Item "EV_USE_REALTIME" 3294.IX Item "EV_USE_REALTIME"
2901If defined to be \f(CW1\fR, libev will try to detect the availability of the 3295If defined to be \f(CW1\fR, libev will try to detect the availability of the
2902realtime clock option at compiletime (and assume its availability at 3296real-time clock option at compile time (and assume its availability at
2903runtime if successful). Otherwise no use of the realtime clock option will 3297runtime if successful). Otherwise no use of the real-time clock option will
2904be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get 3298be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get
2905(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the 3299(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the
2906note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. 3300note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though.
2907.IP "\s-1EV_USE_NANOSLEEP\s0" 4 3301.IP "\s-1EV_USE_NANOSLEEP\s0" 4
2908.IX Item "EV_USE_NANOSLEEP" 3302.IX Item "EV_USE_NANOSLEEP"
2916If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 3310If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
29172.7 or newer, otherwise disabled. 33112.7 or newer, otherwise disabled.
2918.IP "\s-1EV_USE_SELECT\s0" 4 3312.IP "\s-1EV_USE_SELECT\s0" 4
2919.IX Item "EV_USE_SELECT" 3313.IX Item "EV_USE_SELECT"
2920If undefined or defined to be \f(CW1\fR, libev will compile in support for the 3314If undefined or defined to be \f(CW1\fR, libev will compile in support for the
2921\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no 3315\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no
2922other method takes over, select will be it. Otherwise the select backend 3316other method takes over, select will be it. Otherwise the select backend
2923will not be compiled in. 3317will not be compiled in.
2924.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 3318.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
2925.IX Item "EV_SELECT_USE_FD_SET" 3319.IX Item "EV_SELECT_USE_FD_SET"
2926If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR 3320If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
2927structure. This is useful if libev doesn't compile due to a missing 3321structure. This is useful if libev doesn't compile due to a missing
2928\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on 3322\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout on
2929exotic systems. This usually limits the range of file descriptors to some 3323exotic systems. This usually limits the range of file descriptors to some
2930low limit such as 1024 or might have other limitations (winsocket only 3324low limit such as 1024 or might have other limitations (winsocket only
2931allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might 3325allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might
2932influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. 3326influence the size of the \f(CW\*(C`fd_set\*(C'\fR used.
2933.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 3327.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
297510 port style backend. Its availability will be detected at runtime, 336910 port style backend. Its availability will be detected at runtime,
2976otherwise another method will be used as fallback. This is the preferred 3370otherwise another method will be used as fallback. This is the preferred
2977backend for Solaris 10 systems. 3371backend for Solaris 10 systems.
2978.IP "\s-1EV_USE_DEVPOLL\s0" 4 3372.IP "\s-1EV_USE_DEVPOLL\s0" 4
2979.IX Item "EV_USE_DEVPOLL" 3373.IX Item "EV_USE_DEVPOLL"
2980reserved for future expansion, works like the \s-1USE\s0 symbols above. 3374Reserved for future expansion, works like the \s-1USE\s0 symbols above.
2981.IP "\s-1EV_USE_INOTIFY\s0" 4 3375.IP "\s-1EV_USE_INOTIFY\s0" 4
2982.IX Item "EV_USE_INOTIFY" 3376.IX Item "EV_USE_INOTIFY"
2983If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 3377If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2984interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 3378interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2985be detected at runtime. If undefined, it will be enabled if the headers 3379be detected at runtime. If undefined, it will be enabled if the headers
2990access is atomic with respect to other threads or signal contexts. No such 3384access is atomic with respect to other threads or signal contexts. No such
2991type is easily found in the C language, so you can provide your own type 3385type is easily found in the C language, so you can provide your own type
2992that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" 3386that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R"
2993as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. 3387as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers.
2994.Sp 3388.Sp
2995In the absense of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 3389In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
2996(from \fIsignal.h\fR), which is usually good enough on most platforms. 3390(from \fIsignal.h\fR), which is usually good enough on most platforms.
2997.IP "\s-1EV_H\s0" 4 3391.IP "\s-1EV_H\s0" 4
2998.IX Item "EV_H" 3392.IX Item "EV_H"
2999The name of the \fIev.h\fR header file used to include it. The default if 3393The name of the \fIev.h\fR header file used to include it. The default if
3000undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 3394undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
3035When doing priority-based operations, libev usually has to linearly search 3429When doing priority-based operations, libev usually has to linearly search
3036all the priorities, so having many of them (hundreds) uses a lot of space 3430all the priorities, so having many of them (hundreds) uses a lot of space
3037and time, so using the defaults of five priorities (\-2 .. +2) is usually 3431and time, so using the defaults of five priorities (\-2 .. +2) is usually
3038fine. 3432fine.
3039.Sp 3433.Sp
3040If your embedding app does not need any priorities, defining these both to 3434If your embedding application does not need any priorities, defining these
3041\&\f(CW0\fR will save some memory and cpu. 3435both to \f(CW0\fR will save some memory and \s-1CPU\s0.
3042.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 3436.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
3043.IX Item "EV_PERIODIC_ENABLE" 3437.IX Item "EV_PERIODIC_ENABLE"
3044If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 3438If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
3045defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 3439defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
3046code. 3440code.
3050defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 3444defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
3051code. 3445code.
3052.IP "\s-1EV_EMBED_ENABLE\s0" 4 3446.IP "\s-1EV_EMBED_ENABLE\s0" 4
3053.IX Item "EV_EMBED_ENABLE" 3447.IX Item "EV_EMBED_ENABLE"
3054If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If 3448If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
3055defined to be \f(CW0\fR, then they are not. 3449defined to be \f(CW0\fR, then they are not. Embed watchers rely on most other
3450watcher types, which therefore must not be disabled.
3056.IP "\s-1EV_STAT_ENABLE\s0" 4 3451.IP "\s-1EV_STAT_ENABLE\s0" 4
3057.IX Item "EV_STAT_ENABLE" 3452.IX Item "EV_STAT_ENABLE"
3058If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If 3453If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
3059defined to be \f(CW0\fR, then they are not. 3454defined to be \f(CW0\fR, then they are not.
3060.IP "\s-1EV_FORK_ENABLE\s0" 4 3455.IP "\s-1EV_FORK_ENABLE\s0" 4
3067defined to be \f(CW0\fR, then they are not. 3462defined to be \f(CW0\fR, then they are not.
3068.IP "\s-1EV_MINIMAL\s0" 4 3463.IP "\s-1EV_MINIMAL\s0" 4
3069.IX Item "EV_MINIMAL" 3464.IX Item "EV_MINIMAL"
3070If you need to shave off some kilobytes of code at the expense of some 3465If you need to shave off some kilobytes of code at the expense of some
3071speed, define this symbol to \f(CW1\fR. Currently this is used to override some 3466speed, define this symbol to \f(CW1\fR. Currently this is used to override some
3072inlining decisions, saves roughly 30% codesize of amd64. It also selects a 3467inlining decisions, saves roughly 30% code size on amd64. It also selects a
3073much smaller 2\-heap for timer management over the default 4\-heap. 3468much smaller 2\-heap for timer management over the default 4\-heap.
3074.IP "\s-1EV_PID_HASHSIZE\s0" 4 3469.IP "\s-1EV_PID_HASHSIZE\s0" 4
3075.IX Item "EV_PID_HASHSIZE" 3470.IX Item "EV_PID_HASHSIZE"
3076\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 3471\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
3077pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 3472pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
3085watchers you might want to increase this value (\fImust\fR be a power of 3480watchers you might want to increase this value (\fImust\fR be a power of
3086two). 3481two).
3087.IP "\s-1EV_USE_4HEAP\s0" 4 3482.IP "\s-1EV_USE_4HEAP\s0" 4
3088.IX Item "EV_USE_4HEAP" 3483.IX Item "EV_USE_4HEAP"
3089Heaps are not very cache-efficient. To improve the cache-efficiency of the 3484Heaps are not very cache-efficient. To improve the cache-efficiency of the
3090timer and periodics heap, libev uses a 4\-heap when this symbol is defined 3485timer and periodics heaps, libev uses a 4\-heap when this symbol is defined
3091to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has a 3486to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably
3092noticable after performance with many (thousands) of watchers. 3487faster performance with many (thousands) of watchers.
3093.Sp 3488.Sp
3094The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR 3489The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR
3095(disabled). 3490(disabled).
3096.IP "\s-1EV_HEAP_CACHE_AT\s0" 4 3491.IP "\s-1EV_HEAP_CACHE_AT\s0" 4
3097.IX Item "EV_HEAP_CACHE_AT" 3492.IX Item "EV_HEAP_CACHE_AT"
3098Heaps are not very cache-efficient. To improve the cache-efficiency of the 3493Heaps are not very cache-efficient. To improve the cache-efficiency of the
3099timer and periodics heap, libev can cache the timestamp (\fIat\fR) within 3494timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within
3100the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR), 3495the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR),
3101which uses 8\-12 bytes more per watcher and a few hundred bytes more code, 3496which uses 8\-12 bytes more per watcher and a few hundred bytes more code,
3102but avoids random read accesses on heap changes. This noticably improves 3497but avoids random read accesses on heap changes. This improves performance
3103performance noticably with with many (hundreds) of watchers. 3498noticeably with many (hundreds) of watchers.
3104.Sp 3499.Sp
3105The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR 3500The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR
3106(disabled). 3501(disabled).
3502.IP "\s-1EV_VERIFY\s0" 4
3503.IX Item "EV_VERIFY"
3504Controls how much internal verification (see \f(CW\*(C`ev_loop_verify ()\*(C'\fR) will
3505be done: If set to \f(CW0\fR, no internal verification code will be compiled
3506in. If set to \f(CW1\fR, then verification code will be compiled in, but not
3507called. If set to \f(CW2\fR, then the internal verification code will be
3508called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
3509verification code will be called very frequently, which will slow down
3510libev considerably.
3511.Sp
3512The default is \f(CW1\fR, unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set, in which case it will be
3513\&\f(CW0\fR.
3107.IP "\s-1EV_COMMON\s0" 4 3514.IP "\s-1EV_COMMON\s0" 4
3108.IX Item "EV_COMMON" 3515.IX Item "EV_COMMON"
3109By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 3516By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
3110this macro to a something else you can include more and other types of 3517this macro to a something else you can include more and other types of
3111members. You have to define it each time you include one of the files, 3518members. You have to define it each time you include one of the files,
3112though, and it must be identical each time. 3519though, and it must be identical each time.
3113.Sp 3520.Sp
3114For example, the perl \s-1EV\s0 module uses something like this: 3521For example, the perl \s-1EV\s0 module uses something like this:
3115.Sp 3522.Sp
3116.Vb 3 3523.Vb 3
3117\& #define EV_COMMON \e 3524\& #define EV_COMMON \e
3118\& SV *self; /* contains this struct */ \e 3525\& SV *self; /* contains this struct */ \e
3119\& SV *cb_sv, *fh /* note no trailing ";" */ 3526\& SV *cb_sv, *fh /* note no trailing ";" */
3120.Ve 3527.Ve
3121.IP "\s-1EV_CB_DECLARE\s0 (type)" 4 3528.IP "\s-1EV_CB_DECLARE\s0 (type)" 4
3122.IX Item "EV_CB_DECLARE (type)" 3529.IX Item "EV_CB_DECLARE (type)"
3123.PD 0 3530.PD 0
3124.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 3531.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4
3132their default definitions. One possible use for overriding these is to 3539their default definitions. One possible use for overriding these is to
3133avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 3540avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
3134method calls instead of plain function calls in \*(C+. 3541method calls instead of plain function calls in \*(C+.
3135.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 3542.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
3136.IX Subsection "EXPORTED API SYMBOLS" 3543.IX Subsection "EXPORTED API SYMBOLS"
3137If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of 3544If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
3138exported symbols, you can use the provided \fISymbol.*\fR files which list 3545exported symbols, you can use the provided \fISymbol.*\fR files which list
3139all public symbols, one per line: 3546all public symbols, one per line:
3140.PP 3547.PP
3141.Vb 2 3548.Vb 2
3142\& Symbols.ev for libev proper 3549\& Symbols.ev for libev proper
3143\& Symbols.event for the libevent emulation 3550\& Symbols.event for the libevent emulation
3144.Ve 3551.Ve
3145.PP 3552.PP
3146This can also be used to rename all public symbols to avoid clashes with 3553This can also be used to rename all public symbols to avoid clashes with
3147multiple versions of libev linked together (which is obviously bad in 3554multiple versions of libev linked together (which is obviously bad in
3148itself, but sometimes it is inconvinient to avoid this). 3555itself, but sometimes it is inconvenient to avoid this).
3149.PP 3556.PP
3150A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to 3557A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to
3151include before including \fIev.h\fR: 3558include before including \fIev.h\fR:
3152.PP 3559.PP
3153.Vb 1 3560.Vb 1
3174.PP 3581.PP
3175The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 3582The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
3176that everybody includes and which overrides some configure choices: 3583that everybody includes and which overrides some configure choices:
3177.PP 3584.PP
3178.Vb 9 3585.Vb 9
3179\& #define EV_MINIMAL 1 3586\& #define EV_MINIMAL 1
3180\& #define EV_USE_POLL 0 3587\& #define EV_USE_POLL 0
3181\& #define EV_MULTIPLICITY 0 3588\& #define EV_MULTIPLICITY 0
3182\& #define EV_PERIODIC_ENABLE 0 3589\& #define EV_PERIODIC_ENABLE 0
3183\& #define EV_STAT_ENABLE 0 3590\& #define EV_STAT_ENABLE 0
3184\& #define EV_FORK_ENABLE 0 3591\& #define EV_FORK_ENABLE 0
3185\& #define EV_CONFIG_H <config.h> 3592\& #define EV_CONFIG_H <config.h>
3186\& #define EV_MINPRI 0 3593\& #define EV_MINPRI 0
3187\& #define EV_MAXPRI 0 3594\& #define EV_MAXPRI 0
3188\& 3595\&
3189\& #include "ev++.h" 3596\& #include "ev++.h"
3190.Ve 3597.Ve
3191.PP 3598.PP
3192And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 3599And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
3193.PP 3600.PP
3194.Vb 2 3601.Vb 2
3195\& #include "ev_cpp.h" 3602\& #include "ev_cpp.h"
3196\& #include "ev.c" 3603\& #include "ev.c"
3197.Ve 3604.Ve
3198.SH "THREADS AND COROUTINES" 3605.SH "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES"
3606.IX Header "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES"
3607.Sh "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0"
3199.IX Header "THREADS AND COROUTINES" 3608.IX Subsection "THREADS AND COROUTINES"
3200.Sh "\s-1THREADS\s0" 3609\fI\s-1THREADS\s0\fR
3201.IX Subsection "THREADS" 3610.IX Subsection "THREADS"
3202Libev itself is completely threadsafe, but it uses no locking. This 3611.PP
3612All libev functions are reentrant and thread-safe unless explicitly
3613documented otherwise, but libev implements no locking itself. This means
3203means that you can use as many loops as you want in parallel, as long as 3614that you can use as many loops as you want in parallel, as long as there
3204only one thread ever calls into one libev function with the same loop 3615are no concurrent calls into any libev function with the same loop
3205parameter. 3616parameter (\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter,
3617of course): libev guarantees that different event loops share no data
3618structures that need any locking.
3206.PP 3619.PP
3207Or put differently: calls with different loop parameters can be done in 3620Or to put it differently: calls with different loop parameters can be done
3208parallel from multiple threads, calls with the same loop parameter must be 3621concurrently from multiple threads, calls with the same loop parameter
3209done serially (but can be done from different threads, as long as only one 3622must be done serially (but can be done from different threads, as long as
3210thread ever is inside a call at any point in time, e.g. by using a mutex 3623only one thread ever is inside a call at any point in time, e.g. by using
3211per loop). 3624a mutex per loop).
3212.PP 3625.PP
3213If you want to know which design is best for your problem, then I cannot 3626Specifically to support threads (and signal handlers), libev implements
3627so-called \f(CW\*(C`ev_async\*(C'\fR watchers, which allow some limited form of
3628concurrency on the same event loop, namely waking it up \*(L"from the
3629outside\*(R".
3630.PP
3631If you want to know which design (one loop, locking, or multiple loops
3632without or something else still) is best for your problem, then I cannot
3214help you but by giving some generic advice: 3633help you, but here is some generic advice:
3215.IP "\(bu" 4 3634.IP "\(bu" 4
3216most applications have a main thread: use the default libev loop 3635most applications have a main thread: use the default libev loop
3217in that thread, or create a seperate thread running only the default loop. 3636in that thread, or create a separate thread running only the default loop.
3218.Sp 3637.Sp
3219This helps integrating other libraries or software modules that use libev 3638This helps integrating other libraries or software modules that use libev
3220themselves and don't care/know about threading. 3639themselves and don't care/know about threading.
3221.IP "\(bu" 4 3640.IP "\(bu" 4
3222one loop per thread is usually a good model. 3641one loop per thread is usually a good model.
3223.Sp 3642.Sp
3224Doing this is almost never wrong, sometimes a better-performance model 3643Doing this is almost never wrong, sometimes a better-performance model
3225exists, but it is always a good start. 3644exists, but it is always a good start.
3226.IP "\(bu" 4 3645.IP "\(bu" 4
3227other models exist, such as the leader/follower pattern, where one 3646other models exist, such as the leader/follower pattern, where one
3228loop is handed through multiple threads in a kind of round-robbin fashion. 3647loop is handed through multiple threads in a kind of round-robin fashion.
3229.Sp 3648.Sp
3230Chosing a model is hard \- look around, learn, know that usually you cna do 3649Choosing a model is hard \- look around, learn, know that usually you can do
3231better than you currently do :\-) 3650better than you currently do :\-)
3232.IP "\(bu" 4 3651.IP "\(bu" 4
3233often you need to talk to some other thread which blocks in the 3652often you need to talk to some other thread which blocks in the
3653event loop.
3654.Sp
3234event loop \- \f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other 3655\&\f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other threads safely
3235threads safely (or from signal contexts...). 3656(or from signal contexts...).
3236.Sh "\s-1COROUTINES\s0" 3657.Sp
3658An example use would be to communicate signals or other events that only
3659work in the default loop by registering the signal watcher with the
3660default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
3661watcher callback into the event loop interested in the signal.
3662.PP
3663\fI\s-1COROUTINES\s0\fR
3237.IX Subsection "COROUTINES" 3664.IX Subsection "COROUTINES"
3665.PP
3238Libev is much more accomodating to coroutines (\*(L"cooperative threads\*(R"): 3666Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
3239libev fully supports nesting calls to it's functions from different 3667libev fully supports nesting calls to its functions from different
3240coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two 3668coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two
3241different coroutines and switch freely between both coroutines running the 3669different coroutines, and switch freely between both coroutines running the
3242loop, as long as you don't confuse yourself). The only exception is that 3670loop, as long as you don't confuse yourself). The only exception is that
3243you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 3671you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
3244.PP 3672.PP
3245Care has been invested into making sure that libev does not keep local 3673Care has been taken to ensure that libev does not keep local state inside
3246state inside \f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow coroutine 3674\&\f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow for coroutine switches as
3247switches. 3675they do not call any callbacks.
3248.SH "COMPLEXITIES" 3676.Sh "\s-1COMPILER\s0 \s-1WARNINGS\s0"
3249.IX Header "COMPLEXITIES" 3677.IX Subsection "COMPILER WARNINGS"
3250In this section the complexities of (many of) the algorithms used inside 3678Depending on your compiler and compiler settings, you might get no or a
3251libev will be explained. For complexity discussions about backends see the 3679lot of warnings when compiling libev code. Some people are apparently
3252documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 3680scared by this.
3253.PP 3681.PP
3254All of the following are about amortised time: If an array needs to be 3682However, these are unavoidable for many reasons. For one, each compiler
3255extended, libev needs to realloc and move the whole array, but this 3683has different warnings, and each user has different tastes regarding
3256happens asymptotically never with higher number of elements, so O(1) might 3684warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when
3257mean it might do a lengthy realloc operation in rare cases, but on average 3685targeting a specific compiler and compiler-version.
3258it is much faster and asymptotically approaches constant time. 3686.PP
3259.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 3687Another reason is that some compiler warnings require elaborate
3260.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 3688workarounds, or other changes to the code that make it less clear and less
3261This means that, when you have a watcher that triggers in one hour and 3689maintainable.
3262there are 100 watchers that would trigger before that then inserting will 3690.PP
3263have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers. 3691And of course, some compiler warnings are just plain stupid, or simply
3264.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4 3692wrong (because they don't actually warn about the condition their message
3265.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 3693seems to warn about). For example, certain older gcc versions had some
3266That means that changing a timer costs less than removing/adding them 3694warnings that resulted an extreme number of false positives. These have
3267as only the relative motion in the event queue has to be paid for. 3695been fixed, but some people still insist on making code warn-free with
3268.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4 3696such buggy versions.
3269.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 3697.PP
3270These just add the watcher into an array or at the head of a list. 3698While libev is written to generate as few warnings as possible,
3271.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4 3699\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
3272.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)" 3700with any compiler warnings enabled unless you are prepared to cope with
3273.PD 0 3701them (e.g. by ignoring them). Remember that warnings are just that:
3274.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 3702warnings, not errors, or proof of bugs.
3275.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" 3703.Sh "\s-1VALGRIND\s0"
3276.PD 3704.IX Subsection "VALGRIND"
3277These watchers are stored in lists then need to be walked to find the 3705Valgrind has a special section here because it is a popular tool that is
3278correct watcher to remove. The lists are usually short (you don't usually 3706highly useful. Unfortunately, valgrind reports are very hard to interpret.
3279have many watchers waiting for the same fd or signal). 3707.PP
3280.IP "Finding the next timer in each loop iteration: O(1)" 4 3708If you think you found a bug (memory leak, uninitialised data access etc.)
3281.IX Item "Finding the next timer in each loop iteration: O(1)" 3709in libev, then check twice: If valgrind reports something like:
3282By virtue of using a binary or 4\-heap, the next timer is always found at a 3710.PP
3283fixed position in the storage array. 3711.Vb 3
3284.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 3712\& ==2274== definitely lost: 0 bytes in 0 blocks.
3285.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 3713\& ==2274== possibly lost: 0 bytes in 0 blocks.
3286A change means an I/O watcher gets started or stopped, which requires 3714\& ==2274== still reachable: 256 bytes in 1 blocks.
3287libev to recalculate its status (and possibly tell the kernel, depending 3715.Ve
3288on backend and wether \f(CW\*(C`ev_io_set\*(C'\fR was used). 3716.PP
3289.IP "Activating one watcher (putting it into the pending state): O(1)" 4 3717Then there is no memory leak, just as memory accounted to global variables
3290.IX Item "Activating one watcher (putting it into the pending state): O(1)" 3718is not a memleak \- the memory is still being referenced, and didn't leak.
3291.PD 0 3719.PP
3292.IP "Priority handling: O(number_of_priorities)" 4 3720Similarly, under some circumstances, valgrind might report kernel bugs
3293.IX Item "Priority handling: O(number_of_priorities)" 3721as if it were a bug in libev (e.g. in realloc or in the poll backend,
3294.PD 3722although an acceptable workaround has been found here), or it might be
3295Priorities are implemented by allocating some space for each 3723confused.
3296priority. When doing priority-based operations, libev usually has to 3724.PP
3297linearly search all the priorities, but starting/stopping and activating 3725Keep in mind that valgrind is a very good tool, but only a tool. Don't
3298watchers becomes O(1) w.r.t. priority handling. 3726make it into some kind of religion.
3299.IP "Sending an ev_async: O(1)" 4 3727.PP
3300.IX Item "Sending an ev_async: O(1)" 3728If you are unsure about something, feel free to contact the mailing list
3301.PD 0 3729with the full valgrind report and an explanation on why you think this
3302.IP "Processing ev_async_send: O(number_of_async_watchers)" 4 3730is a bug in libev (best check the archives, too :). However, don't be
3303.IX Item "Processing ev_async_send: O(number_of_async_watchers)" 3731annoyed when you get a brisk \*(L"this is no bug\*(R" answer and take the chance
3304.IP "Processing signals: O(max_signal_number)" 4 3732of learning how to interpret valgrind properly.
3305.IX Item "Processing signals: O(max_signal_number)" 3733.PP
3306.PD 3734If you need, for some reason, empty reports from valgrind for your project
3307Sending involves a syscall \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 3735I suggest using suppression lists.
3308calls in the current loop iteration. Checking for async and signal events 3736.SH "PORTABILITY NOTES"
3309involves iterating over all running async watchers or all signal numbers. 3737.IX Header "PORTABILITY NOTES"
3310.SH "Win32 platform limitations and workarounds" 3738.Sh "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0"
3311.IX Header "Win32 platform limitations and workarounds" 3739.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
3312Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 3740Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
3313requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 3741requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
3314model. Libev still offers limited functionality on this platform in 3742model. Libev still offers limited functionality on this platform in
3315the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 3743the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
3316descriptors. This only applies when using Win32 natively, not when using 3744descriptors. This only applies when using Win32 natively, not when using
3322way (note also that glib is the slowest event library known to man). 3750way (note also that glib is the slowest event library known to man).
3323.PP 3751.PP
3324There is no supported compilation method available on windows except 3752There is no supported compilation method available on windows except
3325embedding it into other applications. 3753embedding it into other applications.
3326.PP 3754.PP
3755Not a libev limitation but worth mentioning: windows apparently doesn't
3756accept large writes: instead of resulting in a partial write, windows will
3757either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large,
3758so make sure you only write small amounts into your sockets (less than a
3759megabyte seems safe, but this apparently depends on the amount of memory
3760available).
3761.PP
3327Due to the many, low, and arbitrary limits on the win32 platform and 3762Due to the many, low, and arbitrary limits on the win32 platform and
3328the abysmal performance of winsockets, using a large number of sockets 3763the abysmal performance of winsockets, using a large number of sockets
3329is not recommended (and not reasonable). If your program needs to use 3764is not recommended (and not reasonable). If your program needs to use
3330more than a hundred or so sockets, then likely it needs to use a totally 3765more than a hundred or so sockets, then likely it needs to use a totally
3331different implementation for windows, as libev offers the \s-1POSIX\s0 readyness 3766different implementation for windows, as libev offers the \s-1POSIX\s0 readiness
3332notification model, which cannot be implemented efficiently on windows 3767notification model, which cannot be implemented efficiently on windows
3333(microsoft monopoly games). 3768(Microsoft monopoly games).
3769.PP
3770A typical way to use libev under windows is to embed it (see the embedding
3771section for details) and use the following \fIevwrap.h\fR header file instead
3772of \fIev.h\fR:
3773.PP
3774.Vb 2
3775\& #define EV_STANDALONE /* keeps ev from requiring config.h */
3776\& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3777\&
3778\& #include "ev.h"
3779.Ve
3780.PP
3781And compile the following \fIevwrap.c\fR file into your project (make sure
3782you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!):
3783.PP
3784.Vb 2
3785\& #include "evwrap.h"
3786\& #include "ev.c"
3787.Ve
3334.IP "The winsocket select function" 4 3788.IP "The winsocket select function" 4
3335.IX Item "The winsocket select function" 3789.IX Item "The winsocket select function"
3336The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it requires 3790The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
3337socket \fIhandles\fR and not socket \fIfile descriptors\fR. This makes select 3791requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
3338very inefficient, and also requires a mapping from file descriptors 3792also extremely buggy). This makes select very inefficient, and also
3339to socket handles. See the discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, 3793requires a mapping from file descriptors to socket handles (the Microsoft
3340\&\f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and \f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor 3794C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
3341symbols for more info. 3795discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
3796\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
3342.Sp 3797.Sp
3343The configuration for a \*(L"naked\*(R" win32 using the microsoft runtime 3798The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime
3344libraries and raw winsocket select is: 3799libraries and raw winsocket select is:
3345.Sp 3800.Sp
3346.Vb 2 3801.Vb 2
3347\& #define EV_USE_SELECT 1 3802\& #define EV_USE_SELECT 1
3348\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 3803\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3349.Ve 3804.Ve
3350.Sp 3805.Sp
3351Note that winsockets handling of fd sets is O(n), so you can easily get a 3806Note that winsockets handling of fd sets is O(n), so you can easily get a
3352complexity in the O(nA\*^X) range when using win32. 3807complexity in the O(nA\*^X) range when using win32.
3353.IP "Limited number of file descriptors" 4 3808.IP "Limited number of file descriptors" 4
3354.IX Item "Limited number of file descriptors" 3809.IX Item "Limited number of file descriptors"
3355Windows has numerous arbitrary (and low) limits on things. 3810Windows has numerous arbitrary (and low) limits on things.
3356.Sp 3811.Sp
3357Early versions of winsocket's select only supported waiting for a maximum 3812Early versions of winsocket's select only supported waiting for a maximum
3358of \f(CW64\fR handles (probably owning to the fact that all windows kernels 3813of \f(CW64\fR handles (probably owning to the fact that all windows kernels
3359can only wait for \f(CW64\fR things at the same time internally; microsoft 3814can only wait for \f(CW64\fR things at the same time internally; Microsoft
3360recommends spawning a chain of threads and wait for 63 handles and the 3815recommends spawning a chain of threads and wait for 63 handles and the
3361previous thread in each. Great). 3816previous thread in each. Great).
3362.Sp 3817.Sp
3363Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR 3818Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
3364to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select 3819to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
3365call (which might be in libev or elsewhere, for example, perl does its own 3820call (which might be in libev or elsewhere, for example, perl does its own
3366select emulation on windows). 3821select emulation on windows).
3367.Sp 3822.Sp
3368Another limit is the number of file descriptors in the microsoft runtime 3823Another limit is the number of file descriptors in the Microsoft runtime
3369libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish 3824libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish
3370or something like this inside microsoft). You can increase this by calling 3825or something like this inside Microsoft). You can increase this by calling
3371\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another 3826\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another
3372arbitrary limit), but is broken in many versions of the microsoft runtime 3827arbitrary limit), but is broken in many versions of the Microsoft runtime
3373libraries. 3828libraries.
3374.Sp 3829.Sp
3375This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on 3830This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on
3376windows version and/or the phase of the moon). To get more, you need to 3831windows version and/or the phase of the moon). To get more, you need to
3377wrap all I/O functions and provide your own fd management, but the cost of 3832wrap all I/O functions and provide your own fd management, but the cost of
3378calling select (O(nA\*^X)) will likely make this unworkable. 3833calling select (O(nA\*^X)) will likely make this unworkable.
3379.SH "PORTABILITY REQUIREMENTS" 3834.Sh "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0"
3380.IX Header "PORTABILITY REQUIREMENTS" 3835.IX Subsection "PORTABILITY REQUIREMENTS"
3381In addition to a working ISO-C implementation, libev relies on a few 3836In addition to a working ISO-C implementation and of course the
3382additional extensions: 3837backend-specific APIs, libev relies on a few additional extensions:
3838.ie n .IP """void (*)(ev_watcher_type *, int revents)""\fR must have compatible calling conventions regardless of \f(CW""ev_watcher_type *""." 4
3839.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
3840.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
3841Libev assumes not only that all watcher pointers have the same internal
3842structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also
3843assumes that the same (machine) code can be used to call any watcher
3844callback: The watcher callbacks have different type signatures, but libev
3845calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
3383.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 3846.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
3384.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4 3847.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
3385.IX Item "sig_atomic_t volatile must be thread-atomic as well" 3848.IX Item "sig_atomic_t volatile must be thread-atomic as well"
3386The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as 3849The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
3387\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic w.r.t. accesses from different 3850\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different
3388threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is 3851threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is
3389believed to be sufficiently portable. 3852believed to be sufficiently portable.
3390.ie n .IP """sigprocmask"" must work in a threaded environment" 4 3853.ie n .IP """sigprocmask"" must work in a threaded environment" 4
3391.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4 3854.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4
3392.IX Item "sigprocmask must work in a threaded environment" 3855.IX Item "sigprocmask must work in a threaded environment"
3401except the initial one, and run the default loop in the initial thread as 3864except the initial one, and run the default loop in the initial thread as
3402well. 3865well.
3403.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 3866.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
3404.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 3867.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
3405.IX Item "long must be large enough for common memory allocation sizes" 3868.IX Item "long must be large enough for common memory allocation sizes"
3406To improve portability and simplify using libev, libev uses \f(CW\*(C`long\*(C'\fR 3869To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally
3407internally instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On 3870instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
3408non-POSIX systems (Microsoft...) this might be unexpectedly low, but 3871systems (Microsoft...) this might be unexpectedly low, but is still at
3409is still at least 31 bits everywhere, which is enough for hundreds of 3872least 31 bits everywhere, which is enough for hundreds of millions of
3410millions of watchers. 3873watchers.
3411.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 3874.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
3412.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4 3875.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
3413.IX Item "double must hold a time value in seconds with enough accuracy" 3876.IX Item "double must hold a time value in seconds with enough accuracy"
3414The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 3877The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
3415have at least 51 bits of mantissa (and 9 bits of exponent), which is good 3878have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3416enough for at least into the year 4000. This requirement is fulfilled by 3879enough for at least into the year 4000. This requirement is fulfilled by
3417implementations implementing \s-1IEEE\s0 754 (basically all existing ones). 3880implementations implementing \s-1IEEE\s0 754 (basically all existing ones).
3418.PP 3881.PP
3419If you know of other additional requirements drop me a note. 3882If you know of other additional requirements drop me a note.
3883.SH "ALGORITHMIC COMPLEXITIES"
3884.IX Header "ALGORITHMIC COMPLEXITIES"
3885In this section the complexities of (many of) the algorithms used inside
3886libev will be documented. For complexity discussions about backends see
3887the documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
3888.PP
3889All of the following are about amortised time: If an array needs to be
3890extended, libev needs to realloc and move the whole array, but this
3891happens asymptotically rarer with higher number of elements, so O(1) might
3892mean that libev does a lengthy realloc operation in rare cases, but on
3893average it is much faster and asymptotically approaches constant time.
3894.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
3895.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
3896This means that, when you have a watcher that triggers in one hour and
3897there are 100 watchers that would trigger before that, then inserting will
3898have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
3899.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
3900.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
3901That means that changing a timer costs less than removing/adding them,
3902as only the relative motion in the event queue has to be paid for.
3903.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4
3904.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)"
3905These just add the watcher into an array or at the head of a list.
3906.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4
3907.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)"
3908.PD 0
3909.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
3910.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
3911.PD
3912These watchers are stored in lists, so they need to be walked to find the
3913correct watcher to remove. The lists are usually short (you don't usually
3914have many watchers waiting for the same fd or signal: one is typical, two
3915is rare).
3916.IP "Finding the next timer in each loop iteration: O(1)" 4
3917.IX Item "Finding the next timer in each loop iteration: O(1)"
3918By virtue of using a binary or 4\-heap, the next timer is always found at a
3919fixed position in the storage array.
3920.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
3921.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
3922A change means an I/O watcher gets started or stopped, which requires
3923libev to recalculate its status (and possibly tell the kernel, depending
3924on backend and whether \f(CW\*(C`ev_io_set\*(C'\fR was used).
3925.IP "Activating one watcher (putting it into the pending state): O(1)" 4
3926.IX Item "Activating one watcher (putting it into the pending state): O(1)"
3927.PD 0
3928.IP "Priority handling: O(number_of_priorities)" 4
3929.IX Item "Priority handling: O(number_of_priorities)"
3930.PD
3931Priorities are implemented by allocating some space for each
3932priority. When doing priority-based operations, libev usually has to
3933linearly search all the priorities, but starting/stopping and activating
3934watchers becomes O(1) with respect to priority handling.
3935.IP "Sending an ev_async: O(1)" 4
3936.IX Item "Sending an ev_async: O(1)"
3937.PD 0
3938.IP "Processing ev_async_send: O(number_of_async_watchers)" 4
3939.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
3940.IP "Processing signals: O(max_signal_number)" 4
3941.IX Item "Processing signals: O(max_signal_number)"
3942.PD
3943Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
3944calls in the current loop iteration. Checking for async and signal events
3945involves iterating over all running async watchers or all signal numbers.
3420.SH "AUTHOR" 3946.SH "AUTHOR"
3421.IX Header "AUTHOR" 3947.IX Header "AUTHOR"
3422Marc Lehmann <libev@schmorp.de>. 3948Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3423.SH "POD ERRORS"
3424.IX Header "POD ERRORS"
3425Hey! \fBThe above document had some coding errors, which are explained below:\fR
3426.IP "Around line 3052:" 4
3427.IX Item "Around line 3052:"
3428You forgot a '=back' before '=head2'

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines