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

Comparing libev/ev.3 (file contents):
Revision 1.25 by root, Tue Nov 27 19:23:31 2007 UTC vs.
Revision 1.62 by root, Sun Mar 16 16:38:23 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines