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

Comparing libev/ev.3 (file contents):
Revision 1.8 by root, Fri Nov 23 15:26:08 2007 UTC vs.
Revision 1.70 by root, Sun Jul 6 03:36:51 2008 UTC

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

Diff Legend

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