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

Comparing libev/ev.3 (file contents):
Revision 1.67 by root, Fri May 23 16:43:45 2008 UTC vs.
Revision 1.72 by root, Tue Oct 21 20:06:52 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines