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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines