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

Comparing libev/ev.pod (file contents):
Revision 1.87 by root, Tue Dec 18 01:37:46 2007 UTC vs.
Revision 1.159 by root, Thu May 22 02:44:57 2008 UTC

4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 #include <ev.h> 7 #include <ev.h>
8 8
9=head1 EXAMPLE PROGRAM 9=head2 EXAMPLE PROGRAM
10 10
11 // a single header file is required
11 #include <ev.h> 12 #include <ev.h>
12 13
14 // every watcher type has its own typedef'd struct
15 // with the name ev_<type>
13 ev_io stdin_watcher; 16 ev_io stdin_watcher;
14 ev_timer timeout_watcher; 17 ev_timer timeout_watcher;
15 18
19 // all watcher callbacks have a similar signature
16 /* called when data readable on stdin */ 20 // this callback is called when data is readable on stdin
17 static void 21 static void
18 stdin_cb (EV_P_ struct ev_io *w, int revents) 22 stdin_cb (EV_P_ struct ev_io *w, int revents)
19 { 23 {
20 /* puts ("stdin ready"); */ 24 puts ("stdin ready");
21 ev_io_stop (EV_A_ w); /* just a syntax example */ 25 // for one-shot events, one must manually stop the watcher
22 ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ 26 // with its corresponding stop function.
27 ev_io_stop (EV_A_ w);
28
29 // this causes all nested ev_loop's to stop iterating
30 ev_unloop (EV_A_ EVUNLOOP_ALL);
23 } 31 }
24 32
33 // another callback, this time for a time-out
25 static void 34 static void
26 timeout_cb (EV_P_ struct ev_timer *w, int revents) 35 timeout_cb (EV_P_ struct ev_timer *w, int revents)
27 { 36 {
28 /* puts ("timeout"); */ 37 puts ("timeout");
29 ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ 38 // this causes the innermost ev_loop to stop iterating
39 ev_unloop (EV_A_ EVUNLOOP_ONE);
30 } 40 }
31 41
32 int 42 int
33 main (void) 43 main (void)
34 { 44 {
45 // use the default event loop unless you have special needs
35 struct ev_loop *loop = ev_default_loop (0); 46 struct ev_loop *loop = ev_default_loop (0);
36 47
37 /* initialise an io watcher, then start it */ 48 // initialise an io watcher, then start it
49 // this one will watch for stdin to become readable
38 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 50 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39 ev_io_start (loop, &stdin_watcher); 51 ev_io_start (loop, &stdin_watcher);
40 52
53 // initialise a timer watcher, then start it
41 /* simple non-repeating 5.5 second timeout */ 54 // simple non-repeating 5.5 second timeout
42 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 55 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43 ev_timer_start (loop, &timeout_watcher); 56 ev_timer_start (loop, &timeout_watcher);
44 57
45 /* loop till timeout or data ready */ 58 // now wait for events to arrive
46 ev_loop (loop, 0); 59 ev_loop (loop, 0);
47 60
61 // unloop was called, so exit
48 return 0; 62 return 0;
49 } 63 }
50 64
51=head1 DESCRIPTION 65=head1 DESCRIPTION
52 66
53The newest version of this document is also available as a html-formatted 67The newest version of this document is also available as an html-formatted
54web page you might find easier to navigate when reading it for the first 68web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>. 69time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
56 70
57Libev is an event loop: you register interest in certain events (such as a 71Libev is an event loop: you register interest in certain events (such as a
58file descriptor being readable or a timeout occuring), and it will manage 72file descriptor being readable or a timeout occurring), and it will manage
59these event sources and provide your program with events. 73these event sources and provide your program with events.
60 74
61To do this, it must take more or less complete control over your process 75To do this, it must take more or less complete control over your process
62(or thread) by executing the I<event loop> handler, and will then 76(or thread) by executing the I<event loop> handler, and will then
63communicate events via a callback mechanism. 77communicate events via a callback mechanism.
65You register interest in certain events by registering so-called I<event 79You register interest in certain events by registering so-called I<event
66watchers>, which are relatively small C structures you initialise with the 80watchers>, which are relatively small C structures you initialise with the
67details of the event, and then hand it over to libev by I<starting> the 81details of the event, and then hand it over to libev by I<starting> the
68watcher. 82watcher.
69 83
70=head1 FEATURES 84=head2 FEATURES
71 85
72Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 86Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
73BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 87BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
74for file descriptor events (C<ev_io>), the Linux C<inotify> interface 88for file descriptor events (C<ev_io>), the Linux C<inotify> interface
75(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 89(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
82 96
83It also is quite fast (see this 97It also is quite fast (see this
84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 98L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85for example). 99for example).
86 100
87=head1 CONVENTIONS 101=head2 CONVENTIONS
88 102
89Libev is very configurable. In this manual the default configuration will 103Libev is very configurable. In this manual the default (and most common)
90be described, which supports multiple event loops. For more info about 104configuration will be described, which supports multiple event loops. For
91various configuration options please have a look at B<EMBED> section in 105more info about various configuration options please have a look at
92this manual. If libev was configured without support for multiple event 106B<EMBED> section in this manual. If libev was configured without support
93loops, then all functions taking an initial argument of name C<loop> 107for multiple event loops, then all functions taking an initial argument of
94(which is always of type C<struct ev_loop *>) will not have this argument. 108name C<loop> (which is always of type C<struct ev_loop *>) will not have
109this argument.
95 110
96=head1 TIME REPRESENTATION 111=head2 TIME REPRESENTATION
97 112
98Libev represents time as a single floating point number, representing the 113Libev represents time as a single floating point number, representing the
99(fractional) number of seconds since the (POSIX) epoch (somewhere near 114(fractional) number of seconds since the (POSIX) epoch (somewhere near
100the beginning of 1970, details are complicated, don't ask). This type is 115the beginning of 1970, details are complicated, don't ask). This type is
101called C<ev_tstamp>, which is what you should use too. It usually aliases 116called C<ev_tstamp>, which is what you should use too. It usually aliases
115 130
116Returns the current time as libev would use it. Please note that the 131Returns the current time as libev would use it. Please note that the
117C<ev_now> function is usually faster and also often returns the timestamp 132C<ev_now> function is usually faster and also often returns the timestamp
118you actually want to know. 133you actually want to know.
119 134
135=item ev_sleep (ev_tstamp interval)
136
137Sleep for the given interval: The current thread will be blocked until
138either it is interrupted or the given time interval has passed. Basically
139this is a subsecond-resolution C<sleep ()>.
140
120=item int ev_version_major () 141=item int ev_version_major ()
121 142
122=item int ev_version_minor () 143=item int ev_version_minor ()
123 144
124You can find out the major and minor ABI version numbers of the library 145You can find out the major and minor ABI version numbers of the library
175See the description of C<ev_embed> watchers for more info. 196See the description of C<ev_embed> watchers for more info.
176 197
177=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 198=item ev_set_allocator (void *(*cb)(void *ptr, long size))
178 199
179Sets the allocation function to use (the prototype is similar - the 200Sets the allocation function to use (the prototype is similar - the
180semantics is identical - to the realloc C function). It is used to 201semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
181allocate and free memory (no surprises here). If it returns zero when 202used to allocate and free memory (no surprises here). If it returns zero
182memory needs to be allocated, the library might abort or take some 203when memory needs to be allocated (C<size != 0>), the library might abort
183potentially destructive action. The default is your system realloc 204or take some potentially destructive action.
184function. 205
206Since some systems (at least OpenBSD and Darwin) fail to implement
207correct C<realloc> semantics, libev will use a wrapper around the system
208C<realloc> and C<free> functions by default.
185 209
186You could override this function in high-availability programs to, say, 210You could override this function in high-availability programs to, say,
187free some memory if it cannot allocate memory, to use a special allocator, 211free some memory if it cannot allocate memory, to use a special allocator,
188or even to sleep a while and retry until some memory is available. 212or even to sleep a while and retry until some memory is available.
189 213
190Example: Replace the libev allocator with one that waits a bit and then 214Example: Replace the libev allocator with one that waits a bit and then
191retries). 215retries (example requires a standards-compliant C<realloc>).
192 216
193 static void * 217 static void *
194 persistent_realloc (void *ptr, size_t size) 218 persistent_realloc (void *ptr, size_t size)
195 { 219 {
196 for (;;) 220 for (;;)
235 259
236An event loop is described by a C<struct ev_loop *>. The library knows two 260An event loop is described by a C<struct ev_loop *>. The library knows two
237types of such loops, the I<default> loop, which supports signals and child 261types of such loops, the I<default> loop, which supports signals and child
238events, and dynamically created loops which do not. 262events, and dynamically created loops which do not.
239 263
240If you use threads, a common model is to run the default event loop
241in your main thread (or in a separate thread) and for each thread you
242create, you also create another event loop. Libev itself does no locking
243whatsoever, so if you mix calls to the same event loop in different
244threads, make sure you lock (this is usually a bad idea, though, even if
245done correctly, because it's hideous and inefficient).
246
247=over 4 264=over 4
248 265
249=item struct ev_loop *ev_default_loop (unsigned int flags) 266=item struct ev_loop *ev_default_loop (unsigned int flags)
250 267
251This will initialise the default event loop if it hasn't been initialised 268This will initialise the default event loop if it hasn't been initialised
253false. If it already was initialised it simply returns it (and ignores the 270false. If it already was initialised it simply returns it (and ignores the
254flags. If that is troubling you, check C<ev_backend ()> afterwards). 271flags. If that is troubling you, check C<ev_backend ()> afterwards).
255 272
256If you don't know what event loop to use, use the one returned from this 273If you don't know what event loop to use, use the one returned from this
257function. 274function.
275
276Note that this function is I<not> thread-safe, so if you want to use it
277from multiple threads, you have to lock (note also that this is unlikely,
278as loops cannot bes hared easily between threads anyway).
279
280The default loop is the only loop that can handle C<ev_signal> and
281C<ev_child> watchers, and to do this, it always registers a handler
282for C<SIGCHLD>. If this is a problem for your app you can either
283create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
284can simply overwrite the C<SIGCHLD> signal handler I<after> calling
285C<ev_default_init>.
258 286
259The flags argument can be used to specify special behaviour or specific 287The flags argument can be used to specify special behaviour or specific
260backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). 288backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
261 289
262The following flags are supported: 290The following flags are supported:
284enabling this flag. 312enabling this flag.
285 313
286This works by calling C<getpid ()> on every iteration of the loop, 314This works by calling C<getpid ()> on every iteration of the loop,
287and thus this might slow down your event loop if you do a lot of loop 315and thus this might slow down your event loop if you do a lot of loop
288iterations and little real work, but is usually not noticeable (on my 316iterations and little real work, but is usually not noticeable (on my
289Linux system for example, C<getpid> is actually a simple 5-insn sequence 317GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
290without a syscall and thus I<very> fast, but my Linux system also has 318without a syscall and thus I<very> fast, but my GNU/Linux system also has
291C<pthread_atfork> which is even faster). 319C<pthread_atfork> which is even faster).
292 320
293The big advantage of this flag is that you can forget about fork (and 321The big advantage of this flag is that you can forget about fork (and
294forget about forgetting to tell libev about forking) when you use this 322forget about forgetting to tell libev about forking) when you use this
295flag. 323flag.
300=item C<EVBACKEND_SELECT> (value 1, portable select backend) 328=item C<EVBACKEND_SELECT> (value 1, portable select backend)
301 329
302This is your standard select(2) backend. Not I<completely> standard, as 330This is your standard select(2) backend. Not I<completely> standard, as
303libev tries to roll its own fd_set with no limits on the number of fds, 331libev tries to roll its own fd_set with no limits on the number of fds,
304but if that fails, expect a fairly low limit on the number of fds when 332but if that fails, expect a fairly low limit on the number of fds when
305using this backend. It doesn't scale too well (O(highest_fd)), but its usually 333using this backend. It doesn't scale too well (O(highest_fd)), but its
306the fastest backend for a low number of fds. 334usually the fastest backend for a low number of (low-numbered :) fds.
335
336To get good performance out of this backend you need a high amount of
337parallelity (most of the file descriptors should be busy). If you are
338writing a server, you should C<accept ()> in a loop to accept as many
339connections as possible during one iteration. You might also want to have
340a look at C<ev_set_io_collect_interval ()> to increase the amount of
341readiness notifications you get per iteration.
307 342
308=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) 343=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
309 344
310And this is your standard poll(2) backend. It's more complicated than 345And this is your standard poll(2) backend. It's more complicated
311select, but handles sparse fds better and has no artificial limit on the 346than select, but handles sparse fds better and has no artificial
312number of fds you can use (except it will slow down considerably with a 347limit on the number of fds you can use (except it will slow down
313lot of inactive fds). It scales similarly to select, i.e. O(total_fds). 348considerably with a lot of inactive fds). It scales similarly to select,
349i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
350performance tips.
314 351
315=item C<EVBACKEND_EPOLL> (value 4, Linux) 352=item C<EVBACKEND_EPOLL> (value 4, Linux)
316 353
317For few fds, this backend is a bit little slower than poll and select, 354For few fds, this backend is a bit little slower than poll and select,
318but it scales phenomenally better. While poll and select usually scale like 355but it scales phenomenally better. While poll and select usually scale
319O(total_fds) where n is the total number of fds (or the highest fd), epoll scales 356like O(total_fds) where n is the total number of fds (or the highest fd),
320either O(1) or O(active_fds). 357epoll scales either O(1) or O(active_fds). The epoll design has a number
358of shortcomings, such as silently dropping events in some hard-to-detect
359cases and requiring a syscall per fd change, no fork support and bad
360support for dup.
321 361
322While stopping and starting an I/O watcher in the same iteration will 362While stopping, setting and starting an I/O watcher in the same iteration
323result in some caching, there is still a syscall per such incident 363will result in some caching, there is still a syscall per such incident
324(because the fd could point to a different file description now), so its 364(because the fd could point to a different file description now), so its
325best to avoid that. Also, dup()ed file descriptors might not work very 365best to avoid that. Also, C<dup ()>'ed file descriptors might not work
326well if you register events for both fds. 366very well if you register events for both fds.
327 367
328Please note that epoll sometimes generates spurious notifications, so you 368Please note that epoll sometimes generates spurious notifications, so you
329need to use non-blocking I/O or other means to avoid blocking when no data 369need to use non-blocking I/O or other means to avoid blocking when no data
330(or space) is available. 370(or space) is available.
331 371
372Best performance from this backend is achieved by not unregistering all
373watchers for a file descriptor until it has been closed, if possible, i.e.
374keep at least one watcher active per fd at all times.
375
376While nominally embeddeble in other event loops, this feature is broken in
377all kernel versions tested so far.
378
332=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 379=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
333 380
334Kqueue deserves special mention, as at the time of this writing, it 381Kqueue deserves special mention, as at the time of this writing, it
335was broken on all BSDs except NetBSD (usually it doesn't work with 382was broken on all BSDs except NetBSD (usually it doesn't work reliably
336anything but sockets and pipes, except on Darwin, where of course its 383with anything but sockets and pipes, except on Darwin, where of course
337completely useless). For this reason its not being "autodetected" 384it's completely useless). For this reason it's not being "autodetected"
338unless you explicitly specify it explicitly in the flags (i.e. using 385unless you explicitly specify it explicitly in the flags (i.e. using
339C<EVBACKEND_KQUEUE>). 386C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
387system like NetBSD.
388
389You still can embed kqueue into a normal poll or select backend and use it
390only for sockets (after having made sure that sockets work with kqueue on
391the target platform). See C<ev_embed> watchers for more info.
340 392
341It scales in the same way as the epoll backend, but the interface to the 393It scales in the same way as the epoll backend, but the interface to the
342kernel is more efficient (which says nothing about its actual speed, of 394kernel is more efficient (which says nothing about its actual speed, of
343course). While starting and stopping an I/O watcher does not cause an 395course). While stopping, setting and starting an I/O watcher does never
344extra syscall as with epoll, it still adds up to four event changes per 396cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
345incident, so its best to avoid that. 397two event changes per incident, support for C<fork ()> is very bad and it
398drops fds silently in similarly hard-to-detect cases.
399
400This backend usually performs well under most conditions.
401
402While nominally embeddable in other event loops, this doesn't work
403everywhere, so you might need to test for this. And since it is broken
404almost everywhere, you should only use it when you have a lot of sockets
405(for which it usually works), by embedding it into another event loop
406(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
407sockets.
346 408
347=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) 409=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
348 410
349This is not implemented yet (and might never be). 411This is not implemented yet (and might never be, unless you send me an
412implementation). According to reports, C</dev/poll> only supports sockets
413and is not embeddable, which would limit the usefulness of this backend
414immensely.
350 415
351=item C<EVBACKEND_PORT> (value 32, Solaris 10) 416=item C<EVBACKEND_PORT> (value 32, Solaris 10)
352 417
353This uses the Solaris 10 port mechanism. As with everything on Solaris, 418This uses the Solaris 10 event port mechanism. As with everything on Solaris,
354it's really slow, but it still scales very well (O(active_fds)). 419it's really slow, but it still scales very well (O(active_fds)).
355 420
356Please note that solaris ports can result in a lot of spurious 421Please note that solaris event ports can deliver a lot of spurious
357notifications, so you need to use non-blocking I/O or other means to avoid 422notifications, so you need to use non-blocking I/O or other means to avoid
358blocking when no data (or space) is available. 423blocking when no data (or space) is available.
424
425While this backend scales well, it requires one system call per active
426file descriptor per loop iteration. For small and medium numbers of file
427descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
428might perform better.
429
430On the positive side, ignoring the spurious readiness notifications, this
431backend actually performed to specification in all tests and is fully
432embeddable, which is a rare feat among the OS-specific backends.
359 433
360=item C<EVBACKEND_ALL> 434=item C<EVBACKEND_ALL>
361 435
362Try all backends (even potentially broken ones that wouldn't be tried 436Try all backends (even potentially broken ones that wouldn't be tried
363with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as 437with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
364C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 438C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
365 439
440It is definitely not recommended to use this flag.
441
366=back 442=back
367 443
368If one or more of these are ored into the flags value, then only these 444If one or more of these are ored into the flags value, then only these
369backends will be tried (in the reverse order as given here). If none are 445backends will be tried (in the reverse order as listed here). If none are
370specified, most compiled-in backend will be tried, usually in reverse 446specified, all backends in C<ev_recommended_backends ()> will be tried.
371order of their flag values :)
372 447
373The most typical usage is like this: 448The most typical usage is like this:
374 449
375 if (!ev_default_loop (0)) 450 if (!ev_default_loop (0))
376 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 451 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
390 465
391Similar to C<ev_default_loop>, but always creates a new event loop that is 466Similar to C<ev_default_loop>, but always creates a new event loop that is
392always distinct from the default loop. Unlike the default loop, it cannot 467always distinct from the default loop. Unlike the default loop, it cannot
393handle signal and child watchers, and attempts to do so will be greeted by 468handle signal and child watchers, and attempts to do so will be greeted by
394undefined behaviour (or a failed assertion if assertions are enabled). 469undefined behaviour (or a failed assertion if assertions are enabled).
470
471Note that this function I<is> thread-safe, and the recommended way to use
472libev with threads is indeed to create one loop per thread, and using the
473default loop in the "main" or "initial" thread.
395 474
396Example: Try to create a event loop that uses epoll and nothing else. 475Example: Try to create a event loop that uses epoll and nothing else.
397 476
398 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 477 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
399 if (!epoller) 478 if (!epoller)
407responsibility to either stop all watchers cleanly yoursef I<before> 486responsibility to either stop all watchers cleanly yoursef I<before>
408calling this function, or cope with the fact afterwards (which is usually 487calling this function, or cope with the fact afterwards (which is usually
409the easiest thing, you can just ignore the watchers and/or C<free ()> them 488the easiest thing, you can just ignore the watchers and/or C<free ()> them
410for example). 489for example).
411 490
412Not that certain global state, such as signal state, will not be freed by 491Note that certain global state, such as signal state, will not be freed by
413this function, and related watchers (such as signal and child watchers) 492this function, and related watchers (such as signal and child watchers)
414would need to be stopped manually. 493would need to be stopped manually.
415 494
416In general it is not advisable to call this function except in the 495In general it is not advisable to call this function except in the
417rare occasion where you really need to free e.g. the signal handling 496rare occasion where you really need to free e.g. the signal handling
423Like C<ev_default_destroy>, but destroys an event loop created by an 502Like C<ev_default_destroy>, but destroys an event loop created by an
424earlier call to C<ev_loop_new>. 503earlier call to C<ev_loop_new>.
425 504
426=item ev_default_fork () 505=item ev_default_fork ()
427 506
507This function sets a flag that causes subsequent C<ev_loop> iterations
428This function reinitialises the kernel state for backends that have 508to reinitialise the kernel state for backends that have one. Despite the
429one. Despite the name, you can call it anytime, but it makes most sense 509name, you can call it anytime, but it makes most sense after forking, in
430after forking, in either the parent or child process (or both, but that 510the child process (or both child and parent, but that again makes little
431again makes little sense). 511sense). You I<must> call it in the child before using any of the libev
512functions, and it will only take effect at the next C<ev_loop> iteration.
432 513
433You I<must> call this function in the child process after forking if and 514On the other hand, you only need to call this function in the child
434only if you want to use the event library in both processes. If you just 515process if and only if you want to use the event library in the child. If
435fork+exec, you don't have to call it. 516you just fork+exec, you don't have to call it at all.
436 517
437The function itself is quite fast and it's usually not a problem to call 518The function itself is quite fast and it's usually not a problem to call
438it just in case after a fork. To make this easy, the function will fit in 519it just in case after a fork. To make this easy, the function will fit in
439quite nicely into a call to C<pthread_atfork>: 520quite nicely into a call to C<pthread_atfork>:
440 521
441 pthread_atfork (0, 0, ev_default_fork); 522 pthread_atfork (0, 0, ev_default_fork);
442 523
443At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
444without calling this function, so if you force one of those backends you
445do not need to care.
446
447=item ev_loop_fork (loop) 524=item ev_loop_fork (loop)
448 525
449Like C<ev_default_fork>, but acts on an event loop created by 526Like C<ev_default_fork>, but acts on an event loop created by
450C<ev_loop_new>. Yes, you have to call this on every allocated event loop 527C<ev_loop_new>. Yes, you have to call this on every allocated event loop
451after fork, and how you do this is entirely your own problem. 528after fork, and how you do this is entirely your own problem.
529
530=item int ev_is_default_loop (loop)
531
532Returns true when the given loop actually is the default loop, false otherwise.
452 533
453=item unsigned int ev_loop_count (loop) 534=item unsigned int ev_loop_count (loop)
454 535
455Returns the count of loop iterations for the loop, which is identical to 536Returns the count of loop iterations for the loop, which is identical to
456the number of times libev did poll for new events. It starts at C<0> and 537the number of times libev did poll for new events. It starts at C<0> and
469 550
470Returns the current "event loop time", which is the time the event loop 551Returns the current "event loop time", which is the time the event loop
471received events and started processing them. This timestamp does not 552received events and started processing them. This timestamp does not
472change as long as callbacks are being processed, and this is also the base 553change as long as callbacks are being processed, and this is also the base
473time used for relative timers. You can treat it as the timestamp of the 554time used for relative timers. You can treat it as the timestamp of the
474event occuring (or more correctly, libev finding out about it). 555event occurring (or more correctly, libev finding out about it).
475 556
476=item ev_loop (loop, int flags) 557=item ev_loop (loop, int flags)
477 558
478Finally, this is it, the event handler. This function usually is called 559Finally, this is it, the event handler. This function usually is called
479after you initialised all your watchers and you want to start handling 560after you initialised all your watchers and you want to start handling
501usually a better approach for this kind of thing. 582usually a better approach for this kind of thing.
502 583
503Here are the gory details of what C<ev_loop> does: 584Here are the gory details of what C<ev_loop> does:
504 585
505 - Before the first iteration, call any pending watchers. 586 - Before the first iteration, call any pending watchers.
506 * If there are no active watchers (reference count is zero), return. 587 * If EVFLAG_FORKCHECK was used, check for a fork.
507 - Queue all prepare watchers and then call all outstanding watchers. 588 - If a fork was detected, queue and call all fork watchers.
589 - Queue and call all prepare watchers.
508 - If we have been forked, recreate the kernel state. 590 - If we have been forked, recreate the kernel state.
509 - Update the kernel state with all outstanding changes. 591 - Update the kernel state with all outstanding changes.
510 - Update the "event loop time". 592 - Update the "event loop time".
511 - Calculate for how long to block. 593 - Calculate for how long to sleep or block, if at all
594 (active idle watchers, EVLOOP_NONBLOCK or not having
595 any active watchers at all will result in not sleeping).
596 - Sleep if the I/O and timer collect interval say so.
512 - Block the process, waiting for any events. 597 - Block the process, waiting for any events.
513 - Queue all outstanding I/O (fd) events. 598 - Queue all outstanding I/O (fd) events.
514 - Update the "event loop time" and do time jump handling. 599 - Update the "event loop time" and do time jump handling.
515 - Queue all outstanding timers. 600 - Queue all outstanding timers.
516 - Queue all outstanding periodics. 601 - Queue all outstanding periodics.
517 - If no events are pending now, queue all idle watchers. 602 - If no events are pending now, queue all idle watchers.
518 - Queue all check watchers. 603 - Queue all check watchers.
519 - Call all queued watchers in reverse order (i.e. check watchers first). 604 - Call all queued watchers in reverse order (i.e. check watchers first).
520 Signals and child watchers are implemented as I/O watchers, and will 605 Signals and child watchers are implemented as I/O watchers, and will
521 be handled here by queueing them when their watcher gets executed. 606 be handled here by queueing them when their watcher gets executed.
522 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 607 - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
523 were used, return, otherwise continue with step *. 608 were used, or there are no active watchers, return, otherwise
609 continue with step *.
524 610
525Example: Queue some jobs and then loop until no events are outsanding 611Example: Queue some jobs and then loop until no events are outstanding
526anymore. 612anymore.
527 613
528 ... queue jobs here, make sure they register event watchers as long 614 ... queue jobs here, make sure they register event watchers as long
529 ... as they still have work to do (even an idle watcher will do..) 615 ... as they still have work to do (even an idle watcher will do..)
530 ev_loop (my_loop, 0); 616 ev_loop (my_loop, 0);
534 620
535Can be used to make a call to C<ev_loop> return early (but only after it 621Can be used to make a call to C<ev_loop> return early (but only after it
536has processed all outstanding events). The C<how> argument must be either 622has processed all outstanding events). The C<how> argument must be either
537C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or 623C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
538C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. 624C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
625
626This "unloop state" will be cleared when entering C<ev_loop> again.
539 627
540=item ev_ref (loop) 628=item ev_ref (loop)
541 629
542=item ev_unref (loop) 630=item ev_unref (loop)
543 631
548returning, ev_unref() after starting, and ev_ref() before stopping it. For 636returning, ev_unref() after starting, and ev_ref() before stopping it. For
549example, libev itself uses this for its internal signal pipe: It is not 637example, libev itself uses this for its internal signal pipe: It is not
550visible to the libev user and should not keep C<ev_loop> from exiting if 638visible to the libev user and should not keep C<ev_loop> from exiting if
551no event watchers registered by it are active. It is also an excellent 639no event watchers registered by it are active. It is also an excellent
552way to do this for generic recurring timers or from within third-party 640way to do this for generic recurring timers or from within third-party
553libraries. Just remember to I<unref after start> and I<ref before stop>. 641libraries. Just remember to I<unref after start> and I<ref before stop>
642(but only if the watcher wasn't active before, or was active before,
643respectively).
554 644
555Example: Create a signal watcher, but keep it from keeping C<ev_loop> 645Example: Create a signal watcher, but keep it from keeping C<ev_loop>
556running when nothing else is active. 646running when nothing else is active.
557 647
558 struct ev_signal exitsig; 648 struct ev_signal exitsig;
562 652
563Example: For some weird reason, unregister the above signal handler again. 653Example: For some weird reason, unregister the above signal handler again.
564 654
565 ev_ref (loop); 655 ev_ref (loop);
566 ev_signal_stop (loop, &exitsig); 656 ev_signal_stop (loop, &exitsig);
657
658=item ev_set_io_collect_interval (loop, ev_tstamp interval)
659
660=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
661
662These advanced functions influence the time that libev will spend waiting
663for events. Both are by default C<0>, meaning that libev will try to
664invoke timer/periodic callbacks and I/O callbacks with minimum latency.
665
666Setting these to a higher value (the C<interval> I<must> be >= C<0>)
667allows libev to delay invocation of I/O and timer/periodic callbacks to
668increase efficiency of loop iterations.
669
670The background is that sometimes your program runs just fast enough to
671handle one (or very few) event(s) per loop iteration. While this makes
672the program responsive, it also wastes a lot of CPU time to poll for new
673events, especially with backends like C<select ()> which have a high
674overhead for the actual polling but can deliver many events at once.
675
676By setting a higher I<io collect interval> you allow libev to spend more
677time collecting I/O events, so you can handle more events per iteration,
678at the cost of increasing latency. Timeouts (both C<ev_periodic> and
679C<ev_timer>) will be not affected. Setting this to a non-null value will
680introduce an additional C<ev_sleep ()> call into most loop iterations.
681
682Likewise, by setting a higher I<timeout collect interval> you allow libev
683to spend more time collecting timeouts, at the expense of increased
684latency (the watcher callback will be called later). C<ev_io> watchers
685will not be affected. Setting this to a non-null value will not introduce
686any overhead in libev.
687
688Many (busy) programs can usually benefit by setting the io collect
689interval to a value near C<0.1> or so, which is often enough for
690interactive servers (of course not for games), likewise for timeouts. It
691usually doesn't make much sense to set it to a lower value than C<0.01>,
692as this approsaches the timing granularity of most systems.
693
694=item ev_loop_verify (loop)
695
696This function only does something when C<EV_VERIFY> support has been
697compiled in. It tries to go through all internal structures and checks
698them for validity. If anything is found to be inconsistent, it will print
699an error message to standard error and call C<abort ()>.
700
701This can be used to catch bugs inside libev itself: under normal
702circumstances, this function will never abort as of course libev keeps its
703data structures consistent.
567 704
568=back 705=back
569 706
570 707
571=head1 ANATOMY OF A WATCHER 708=head1 ANATOMY OF A WATCHER
670 807
671=item C<EV_FORK> 808=item C<EV_FORK>
672 809
673The event loop has been resumed in the child process after fork (see 810The event loop has been resumed in the child process after fork (see
674C<ev_fork>). 811C<ev_fork>).
812
813=item C<EV_ASYNC>
814
815The given async watcher has been asynchronously notified (see C<ev_async>).
675 816
676=item C<EV_ERROR> 817=item C<EV_ERROR>
677 818
678An unspecified error has occured, the watcher has been stopped. This might 819An unspecified error has occured, the watcher has been stopped. This might
679happen because the watcher could not be properly started because libev 820happen because the watcher could not be properly started because libev
897In general you can register as many read and/or write event watchers per 1038In general you can register as many read and/or write event watchers per
898fd as you want (as long as you don't confuse yourself). Setting all file 1039fd as you want (as long as you don't confuse yourself). Setting all file
899descriptors to non-blocking mode is also usually a good idea (but not 1040descriptors to non-blocking mode is also usually a good idea (but not
900required if you know what you are doing). 1041required if you know what you are doing).
901 1042
902You have to be careful with dup'ed file descriptors, though. Some backends
903(the linux epoll backend is a notable example) cannot handle dup'ed file
904descriptors correctly if you register interest in two or more fds pointing
905to the same underlying file/socket/etc. description (that is, they share
906the same underlying "file open").
907
908If you must do this, then force the use of a known-to-be-good backend 1043If you must do this, then force the use of a known-to-be-good backend
909(at the time of this writing, this includes only C<EVBACKEND_SELECT> and 1044(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
910C<EVBACKEND_POLL>). 1045C<EVBACKEND_POLL>).
911 1046
912Another thing you have to watch out for is that it is quite easy to 1047Another thing you have to watch out for is that it is quite easy to
913receive "spurious" readyness notifications, that is your callback might 1048receive "spurious" readiness notifications, that is your callback might
914be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1049be called with C<EV_READ> but a subsequent C<read>(2) will actually block
915because there is no data. Not only are some backends known to create a 1050because there is no data. Not only are some backends known to create a
916lot of those (for example solaris ports), it is very easy to get into 1051lot of those (for example solaris ports), it is very easy to get into
917this situation even with a relatively standard program structure. Thus 1052this situation even with a relatively standard program structure. Thus
918it is best to always use non-blocking I/O: An extra C<read>(2) returning 1053it is best to always use non-blocking I/O: An extra C<read>(2) returning
924such as poll (fortunately in our Xlib example, Xlib already does this on 1059such as poll (fortunately in our Xlib example, Xlib already does this on
925its own, so its quite safe to use). 1060its own, so its quite safe to use).
926 1061
927=head3 The special problem of disappearing file descriptors 1062=head3 The special problem of disappearing file descriptors
928 1063
929Some backends (e.g kqueue, epoll) need to be told about closing a file 1064Some backends (e.g. kqueue, epoll) need to be told about closing a file
930descriptor (either by calling C<close> explicitly or by any other means, 1065descriptor (either by calling C<close> explicitly or by any other means,
931such as C<dup>). The reason is that you register interest in some file 1066such as C<dup>). The reason is that you register interest in some file
932descriptor, but when it goes away, the operating system will silently drop 1067descriptor, but when it goes away, the operating system will silently drop
933this interest. If another file descriptor with the same number then is 1068this interest. If another file descriptor with the same number then is
934registered with libev, there is no efficient way to see that this is, in 1069registered with libev, there is no efficient way to see that this is, in
943 1078
944This is how one would do it normally anyway, the important point is that 1079This is how one would do it normally anyway, the important point is that
945the libev application should not optimise around libev but should leave 1080the libev application should not optimise around libev but should leave
946optimisations to libev. 1081optimisations to libev.
947 1082
1083=head3 The special problem of dup'ed file descriptors
1084
1085Some backends (e.g. epoll), cannot register events for file descriptors,
1086but only events for the underlying file descriptions. That means when you
1087have C<dup ()>'ed file descriptors or weirder constellations, and register
1088events for them, only one file descriptor might actually receive events.
1089
1090There is no workaround possible except not registering events
1091for potentially C<dup ()>'ed file descriptors, or to resort to
1092C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1093
1094=head3 The special problem of fork
1095
1096Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1097useless behaviour. Libev fully supports fork, but needs to be told about
1098it in the child.
1099
1100To support fork in your programs, you either have to call
1101C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1102enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1103C<EVBACKEND_POLL>.
1104
1105=head3 The special problem of SIGPIPE
1106
1107While not really specific to libev, it is easy to forget about SIGPIPE:
1108when reading from a pipe whose other end has been closed, your program
1109gets send a SIGPIPE, which, by default, aborts your program. For most
1110programs this is sensible behaviour, for daemons, this is usually
1111undesirable.
1112
1113So when you encounter spurious, unexplained daemon exits, make sure you
1114ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1115somewhere, as that would have given you a big clue).
1116
948 1117
949=head3 Watcher-Specific Functions 1118=head3 Watcher-Specific Functions
950 1119
951=over 4 1120=over 4
952 1121
965=item int events [read-only] 1134=item int events [read-only]
966 1135
967The events being watched. 1136The events being watched.
968 1137
969=back 1138=back
1139
1140=head3 Examples
970 1141
971Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well 1142Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
972readable, but only once. Since it is likely line-buffered, you could 1143readable, but only once. Since it is likely line-buffered, you could
973attempt to read a whole line in the callback. 1144attempt to read a whole line in the callback.
974 1145
991 1162
992Timer watchers are simple relative timers that generate an event after a 1163Timer watchers are simple relative timers that generate an event after a
993given time, and optionally repeating in regular intervals after that. 1164given time, and optionally repeating in regular intervals after that.
994 1165
995The timers are based on real time, that is, if you register an event that 1166The timers are based on real time, that is, if you register an event that
996times out after an hour and you reset your system clock to last years 1167times out after an hour and you reset your system clock to january last
997time, it will still time out after (roughly) and hour. "Roughly" because 1168year, it will still time out after (roughly) and hour. "Roughly" because
998detecting time jumps is hard, and some inaccuracies are unavoidable (the 1169detecting time jumps is hard, and some inaccuracies are unavoidable (the
999monotonic clock option helps a lot here). 1170monotonic clock option helps a lot here).
1000 1171
1001The relative timeouts are calculated relative to the C<ev_now ()> 1172The relative timeouts are calculated relative to the C<ev_now ()>
1002time. This is usually the right thing as this timestamp refers to the time 1173time. This is usually the right thing as this timestamp refers to the time
1004you suspect event processing to be delayed and you I<need> to base the timeout 1175you suspect event processing to be delayed and you I<need> to base the timeout
1005on the current time, use something like this to adjust for this: 1176on the current time, use something like this to adjust for this:
1006 1177
1007 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1178 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1008 1179
1009The callback is guarenteed to be invoked only when its timeout has passed, 1180The callback is guarenteed to be invoked only after its timeout has passed,
1010but if multiple timers become ready during the same loop iteration then 1181but if multiple timers become ready during the same loop iteration then
1011order of execution is undefined. 1182order of execution is undefined.
1012 1183
1013=head3 Watcher-Specific Functions and Data Members 1184=head3 Watcher-Specific Functions and Data Members
1014 1185
1016 1187
1017=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1188=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1018 1189
1019=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 1190=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1020 1191
1021Configure the timer to trigger after C<after> seconds. If C<repeat> is 1192Configure the timer to trigger after C<after> seconds. If C<repeat>
1022C<0.>, then it will automatically be stopped. If it is positive, then the 1193is C<0.>, then it will automatically be stopped once the timeout is
1023timer will automatically be configured to trigger again C<repeat> seconds 1194reached. If it is positive, then the timer will automatically be
1024later, again, and again, until stopped manually. 1195configured to trigger again C<repeat> seconds later, again, and again,
1196until stopped manually.
1025 1197
1026The timer itself will do a best-effort at avoiding drift, that is, if you 1198The timer itself will do a best-effort at avoiding drift, that is, if
1027configure a timer to trigger every 10 seconds, then it will trigger at 1199you configure a timer to trigger every 10 seconds, then it will normally
1028exactly 10 second intervals. If, however, your program cannot keep up with 1200trigger at exactly 10 second intervals. If, however, your program cannot
1029the timer (because it takes longer than those 10 seconds to do stuff) the 1201keep up with the timer (because it takes longer than those 10 seconds to
1030timer will not fire more than once per event loop iteration. 1202do stuff) the timer will not fire more than once per event loop iteration.
1031 1203
1032=item ev_timer_again (loop) 1204=item ev_timer_again (loop, ev_timer *)
1033 1205
1034This will act as if the timer timed out and restart it again if it is 1206This will act as if the timer timed out and restart it again if it is
1035repeating. The exact semantics are: 1207repeating. The exact semantics are:
1036 1208
1037If the timer is pending, its pending status is cleared. 1209If the timer is pending, its pending status is cleared.
1072or C<ev_timer_again> is called and determines the next timeout (if any), 1244or C<ev_timer_again> is called and determines the next timeout (if any),
1073which is also when any modifications are taken into account. 1245which is also when any modifications are taken into account.
1074 1246
1075=back 1247=back
1076 1248
1249=head3 Examples
1250
1077Example: Create a timer that fires after 60 seconds. 1251Example: Create a timer that fires after 60 seconds.
1078 1252
1079 static void 1253 static void
1080 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1254 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1081 { 1255 {
1110Periodic watchers are also timers of a kind, but they are very versatile 1284Periodic watchers are also timers of a kind, but they are very versatile
1111(and unfortunately a bit complex). 1285(and unfortunately a bit complex).
1112 1286
1113Unlike C<ev_timer>'s, they are not based on real time (or relative time) 1287Unlike C<ev_timer>'s, they are not based on real time (or relative time)
1114but on wallclock time (absolute time). You can tell a periodic watcher 1288but on wallclock time (absolute time). You can tell a periodic watcher
1115to trigger "at" some specific point in time. For example, if you tell a 1289to trigger after some specific point in time. For example, if you tell a
1116periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () 1290periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
1117+ 10.>) and then reset your system clock to the last year, then it will 1291+ 10.>, that is, an absolute time not a delay) and then reset your system
1292clock to january of the previous year, then it will take more than year
1118take a year to trigger the event (unlike an C<ev_timer>, which would trigger 1293to trigger the event (unlike an C<ev_timer>, which would still trigger
1119roughly 10 seconds later). 1294roughly 10 seconds later as it uses a relative timeout).
1120 1295
1121They can also be used to implement vastly more complex timers, such as 1296C<ev_periodic>s can also be used to implement vastly more complex timers,
1122triggering an event on each midnight, local time or other, complicated, 1297such as triggering an event on each "midnight, local time", or other
1123rules. 1298complicated, rules.
1124 1299
1125As with timers, the callback is guarenteed to be invoked only when the 1300As with timers, the callback is guarenteed to be invoked only when the
1126time (C<at>) has been passed, but if multiple periodic timers become ready 1301time (C<at>) has passed, but if multiple periodic timers become ready
1127during the same loop iteration then order of execution is undefined. 1302during the same loop iteration then order of execution is undefined.
1128 1303
1129=head3 Watcher-Specific Functions and Data Members 1304=head3 Watcher-Specific Functions and Data Members
1130 1305
1131=over 4 1306=over 4
1139 1314
1140=over 4 1315=over 4
1141 1316
1142=item * absolute timer (at = time, interval = reschedule_cb = 0) 1317=item * absolute timer (at = time, interval = reschedule_cb = 0)
1143 1318
1144In this configuration the watcher triggers an event at the wallclock time 1319In this configuration the watcher triggers an event after the wallclock
1145C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1320time C<at> has passed and doesn't repeat. It will not adjust when a time
1146that is, if it is to be run at January 1st 2011 then it will run when the 1321jump occurs, that is, if it is to be run at January 1st 2011 then it will
1147system time reaches or surpasses this time. 1322run when the system time reaches or surpasses this time.
1148 1323
1149=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1324=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1150 1325
1151In this mode the watcher will always be scheduled to time out at the next 1326In this mode the watcher will always be scheduled to time out at the next
1152C<at + N * interval> time (for some integer N, which can also be negative) 1327C<at + N * interval> time (for some integer N, which can also be negative)
1153and then repeat, regardless of any time jumps. 1328and then repeat, regardless of any time jumps.
1154 1329
1155This can be used to create timers that do not drift with respect to system 1330This can be used to create timers that do not drift with respect to system
1156time: 1331time, for example, here is a C<ev_periodic> that triggers each hour, on
1332the hour:
1157 1333
1158 ev_periodic_set (&periodic, 0., 3600., 0); 1334 ev_periodic_set (&periodic, 0., 3600., 0);
1159 1335
1160This doesn't mean there will always be 3600 seconds in between triggers, 1336This doesn't mean there will always be 3600 seconds in between triggers,
1161but only that the the callback will be called when the system time shows a 1337but only that the the callback will be called when the system time shows a
1166C<ev_periodic> will try to run the callback in this mode at the next possible 1342C<ev_periodic> will try to run the callback in this mode at the next possible
1167time where C<time = at (mod interval)>, regardless of any time jumps. 1343time where C<time = at (mod interval)>, regardless of any time jumps.
1168 1344
1169For numerical stability it is preferable that the C<at> value is near 1345For numerical stability it is preferable that the C<at> value is near
1170C<ev_now ()> (the current time), but there is no range requirement for 1346C<ev_now ()> (the current time), but there is no range requirement for
1171this value. 1347this value, and in fact is often specified as zero.
1348
1349Note also that there is an upper limit to how often a timer can fire (cpu
1350speed for example), so if C<interval> is very small then timing stability
1351will of course detoriate. Libev itself tries to be exact to be about one
1352millisecond (if the OS supports it and the machine is fast enough).
1172 1353
1173=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1354=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1174 1355
1175In this mode the values for C<interval> and C<at> are both being 1356In this mode the values for C<interval> and C<at> are both being
1176ignored. Instead, each time the periodic watcher gets scheduled, the 1357ignored. Instead, each time the periodic watcher gets scheduled, the
1177reschedule callback will be called with the watcher as first, and the 1358reschedule callback will be called with the watcher as first, and the
1178current time as second argument. 1359current time as second argument.
1179 1360
1180NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1361NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1181ever, or make any event loop modifications>. If you need to stop it, 1362ever, or make ANY event loop modifications whatsoever>.
1182return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1183starting an C<ev_prepare> watcher, which is legal).
1184 1363
1364If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1365it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1366only event loop modification you are allowed to do).
1367
1185Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1368The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic
1186ev_tstamp now)>, e.g.: 1369*w, ev_tstamp now)>, e.g.:
1187 1370
1188 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1371 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1189 { 1372 {
1190 return now + 60.; 1373 return now + 60.;
1191 } 1374 }
1193It must return the next time to trigger, based on the passed time value 1376It must return the next time to trigger, based on the passed time value
1194(that is, the lowest time value larger than to the second argument). It 1377(that is, the lowest time value larger than to the second argument). It
1195will usually be called just before the callback will be triggered, but 1378will usually be called just before the callback will be triggered, but
1196might be called at other times, too. 1379might be called at other times, too.
1197 1380
1198NOTE: I<< This callback must always return a time that is later than the 1381NOTE: I<< This callback must always return a time that is higher than or
1199passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger. 1382equal to the passed C<now> value >>.
1200 1383
1201This can be used to create very complex timers, such as a timer that 1384This can be used to create very complex timers, such as a timer that
1202triggers on each midnight, local time. To do this, you would calculate the 1385triggers on "next midnight, local time". To do this, you would calculate the
1203next midnight after C<now> and return the timestamp value for this. How 1386next midnight after C<now> and return the timestamp value for this. How
1204you do this is, again, up to you (but it is not trivial, which is the main 1387you do this is, again, up to you (but it is not trivial, which is the main
1205reason I omitted it as an example). 1388reason I omitted it as an example).
1206 1389
1207=back 1390=back
1211Simply stops and restarts the periodic watcher again. This is only useful 1394Simply stops and restarts the periodic watcher again. This is only useful
1212when you changed some parameters or the reschedule callback would return 1395when you changed some parameters or the reschedule callback would return
1213a different time than the last time it was called (e.g. in a crond like 1396a different time than the last time it was called (e.g. in a crond like
1214program when the crontabs have changed). 1397program when the crontabs have changed).
1215 1398
1399=item ev_tstamp ev_periodic_at (ev_periodic *)
1400
1401When active, returns the absolute time that the watcher is supposed to
1402trigger next.
1403
1216=item ev_tstamp offset [read-write] 1404=item ev_tstamp offset [read-write]
1217 1405
1218When repeating, this contains the offset value, otherwise this is the 1406When repeating, this contains the offset value, otherwise this is the
1219absolute point in time (the C<at> value passed to C<ev_periodic_set>). 1407absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1220 1408
1231 1419
1232The current reschedule callback, or C<0>, if this functionality is 1420The current reschedule callback, or C<0>, if this functionality is
1233switched off. Can be changed any time, but changes only take effect when 1421switched off. Can be changed any time, but changes only take effect when
1234the periodic timer fires or C<ev_periodic_again> is being called. 1422the periodic timer fires or C<ev_periodic_again> is being called.
1235 1423
1236=item ev_tstamp at [read-only]
1237
1238When active, contains the absolute time that the watcher is supposed to
1239trigger next.
1240
1241=back 1424=back
1425
1426=head3 Examples
1242 1427
1243Example: Call a callback every hour, or, more precisely, whenever the 1428Example: Call a callback every hour, or, more precisely, whenever the
1244system clock is divisible by 3600. The callback invocation times have 1429system clock is divisible by 3600. The callback invocation times have
1245potentially a lot of jittering, but good long-term stability. 1430potentially a lot of jittering, but good long-term stability.
1246 1431
1286with the kernel (thus it coexists with your own signal handlers as long 1471with the kernel (thus it coexists with your own signal handlers as long
1287as you don't register any with libev). Similarly, when the last signal 1472as you don't register any with libev). Similarly, when the last signal
1288watcher for a signal is stopped libev will reset the signal handler to 1473watcher for a signal is stopped libev will reset the signal handler to
1289SIG_DFL (regardless of what it was set to before). 1474SIG_DFL (regardless of what it was set to before).
1290 1475
1476If possible and supported, libev will install its handlers with
1477C<SA_RESTART> behaviour enabled, so syscalls should not be unduly
1478interrupted. If you have a problem with syscalls getting interrupted by
1479signals you can block all signals in an C<ev_check> watcher and unblock
1480them in an C<ev_prepare> watcher.
1481
1291=head3 Watcher-Specific Functions and Data Members 1482=head3 Watcher-Specific Functions and Data Members
1292 1483
1293=over 4 1484=over 4
1294 1485
1295=item ev_signal_init (ev_signal *, callback, int signum) 1486=item ev_signal_init (ev_signal *, callback, int signum)
1303 1494
1304The signal the watcher watches out for. 1495The signal the watcher watches out for.
1305 1496
1306=back 1497=back
1307 1498
1499=head3 Examples
1500
1501Example: Try to exit cleanly on SIGINT and SIGTERM.
1502
1503 static void
1504 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1505 {
1506 ev_unloop (loop, EVUNLOOP_ALL);
1507 }
1508
1509 struct ev_signal signal_watcher;
1510 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1511 ev_signal_start (loop, &sigint_cb);
1512
1308 1513
1309=head2 C<ev_child> - watch out for process status changes 1514=head2 C<ev_child> - watch out for process status changes
1310 1515
1311Child watchers trigger when your process receives a SIGCHLD in response to 1516Child watchers trigger when your process receives a SIGCHLD in response to
1312some child status changes (most typically when a child of yours dies). 1517some child status changes (most typically when a child of yours dies). It
1518is permissible to install a child watcher I<after> the child has been
1519forked (which implies it might have already exited), as long as the event
1520loop isn't entered (or is continued from a watcher).
1521
1522Only the default event loop is capable of handling signals, and therefore
1523you can only rgeister child watchers in the default event loop.
1524
1525=head3 Process Interaction
1526
1527Libev grabs C<SIGCHLD> as soon as the default event loop is
1528initialised. This is necessary to guarantee proper behaviour even if
1529the first child watcher is started after the child exits. The occurance
1530of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1531synchronously as part of the event loop processing. Libev always reaps all
1532children, even ones not watched.
1533
1534=head3 Overriding the Built-In Processing
1535
1536Libev offers no special support for overriding the built-in child
1537processing, but if your application collides with libev's default child
1538handler, you can override it easily by installing your own handler for
1539C<SIGCHLD> after initialising the default loop, and making sure the
1540default loop never gets destroyed. You are encouraged, however, to use an
1541event-based approach to child reaping and thus use libev's support for
1542that, so other libev users can use C<ev_child> watchers freely.
1313 1543
1314=head3 Watcher-Specific Functions and Data Members 1544=head3 Watcher-Specific Functions and Data Members
1315 1545
1316=over 4 1546=over 4
1317 1547
1318=item ev_child_init (ev_child *, callback, int pid) 1548=item ev_child_init (ev_child *, callback, int pid, int trace)
1319 1549
1320=item ev_child_set (ev_child *, int pid) 1550=item ev_child_set (ev_child *, int pid, int trace)
1321 1551
1322Configures the watcher to wait for status changes of process C<pid> (or 1552Configures the watcher to wait for status changes of process C<pid> (or
1323I<any> process if C<pid> is specified as C<0>). The callback can look 1553I<any> process if C<pid> is specified as C<0>). The callback can look
1324at the C<rstatus> member of the C<ev_child> watcher structure to see 1554at the C<rstatus> member of the C<ev_child> watcher structure to see
1325the status word (use the macros from C<sys/wait.h> and see your systems 1555the status word (use the macros from C<sys/wait.h> and see your systems
1326C<waitpid> documentation). The C<rpid> member contains the pid of the 1556C<waitpid> documentation). The C<rpid> member contains the pid of the
1327process causing the status change. 1557process causing the status change. C<trace> must be either C<0> (only
1558activate the watcher when the process terminates) or C<1> (additionally
1559activate the watcher when the process is stopped or continued).
1328 1560
1329=item int pid [read-only] 1561=item int pid [read-only]
1330 1562
1331The process id this watcher watches out for, or C<0>, meaning any process id. 1563The process id this watcher watches out for, or C<0>, meaning any process id.
1332 1564
1339The process exit/trace status caused by C<rpid> (see your systems 1571The process exit/trace status caused by C<rpid> (see your systems
1340C<waitpid> and C<sys/wait.h> documentation for details). 1572C<waitpid> and C<sys/wait.h> documentation for details).
1341 1573
1342=back 1574=back
1343 1575
1344Example: Try to exit cleanly on SIGINT and SIGTERM. 1576=head3 Examples
1577
1578Example: C<fork()> a new process and install a child handler to wait for
1579its completion.
1580
1581 ev_child cw;
1345 1582
1346 static void 1583 static void
1347 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1584 child_cb (EV_P_ struct ev_child *w, int revents)
1348 { 1585 {
1349 ev_unloop (loop, EVUNLOOP_ALL); 1586 ev_child_stop (EV_A_ w);
1587 printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1350 } 1588 }
1351 1589
1352 struct ev_signal signal_watcher; 1590 pid_t pid = fork ();
1353 ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1591
1354 ev_signal_start (loop, &sigint_cb); 1592 if (pid < 0)
1593 // error
1594 else if (pid == 0)
1595 {
1596 // the forked child executes here
1597 exit (1);
1598 }
1599 else
1600 {
1601 ev_child_init (&cw, child_cb, pid, 0);
1602 ev_child_start (EV_DEFAULT_ &cw);
1603 }
1355 1604
1356 1605
1357=head2 C<ev_stat> - did the file attributes just change? 1606=head2 C<ev_stat> - did the file attributes just change?
1358 1607
1359This watches a filesystem path for attribute changes. That is, it calls 1608This watches a filesystem path for attribute changes. That is, it calls
1382as even with OS-supported change notifications, this can be 1631as even with OS-supported change notifications, this can be
1383resource-intensive. 1632resource-intensive.
1384 1633
1385At the time of this writing, only the Linux inotify interface is 1634At the time of this writing, only the Linux inotify interface is
1386implemented (implementing kqueue support is left as an exercise for the 1635implemented (implementing kqueue support is left as an exercise for the
1636reader, note, however, that the author sees no way of implementing ev_stat
1387reader). Inotify will be used to give hints only and should not change the 1637semantics with kqueue). Inotify will be used to give hints only and should
1388semantics of C<ev_stat> watchers, which means that libev sometimes needs 1638not change the semantics of C<ev_stat> watchers, which means that libev
1389to fall back to regular polling again even with inotify, but changes are 1639sometimes needs to fall back to regular polling again even with inotify,
1390usually detected immediately, and if the file exists there will be no 1640but changes are usually detected immediately, and if the file exists there
1391polling. 1641will be no polling.
1642
1643=head3 ABI Issues (Largefile Support)
1644
1645Libev by default (unless the user overrides this) uses the default
1646compilation environment, which means that on systems with optionally
1647disabled large file support, you get the 32 bit version of the stat
1648structure. When using the library from programs that change the ABI to
1649use 64 bit file offsets the programs will fail. In that case you have to
1650compile libev with the same flags to get binary compatibility. This is
1651obviously the case with any flags that change the ABI, but the problem is
1652most noticably with ev_stat and largefile support.
1653
1654=head3 Inotify
1655
1656When C<inotify (7)> support has been compiled into libev (generally only
1657available on Linux) and present at runtime, it will be used to speed up
1658change detection where possible. The inotify descriptor will be created lazily
1659when the first C<ev_stat> watcher is being started.
1660
1661Inotify presence does not change the semantics of C<ev_stat> watchers
1662except that changes might be detected earlier, and in some cases, to avoid
1663making regular C<stat> calls. Even in the presence of inotify support
1664there are many cases where libev has to resort to regular C<stat> polling.
1665
1666(There is no support for kqueue, as apparently it cannot be used to
1667implement this functionality, due to the requirement of having a file
1668descriptor open on the object at all times).
1669
1670=head3 The special problem of stat time resolution
1671
1672The C<stat ()> syscall only supports full-second resolution portably, and
1673even on systems where the resolution is higher, many filesystems still
1674only support whole seconds.
1675
1676That means that, if the time is the only thing that changes, you can
1677easily miss updates: on the first update, C<ev_stat> detects a change and
1678calls your callback, which does something. When there is another update
1679within the same second, C<ev_stat> will be unable to detect it as the stat
1680data does not change.
1681
1682The solution to this is to delay acting on a change for slightly more
1683than a second (or till slightly after the next full second boundary), using
1684a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1685ev_timer_again (loop, w)>).
1686
1687The C<.02> offset is added to work around small timing inconsistencies
1688of some operating systems (where the second counter of the current time
1689might be be delayed. One such system is the Linux kernel, where a call to
1690C<gettimeofday> might return a timestamp with a full second later than
1691a subsequent C<time> call - if the equivalent of C<time ()> is used to
1692update file times then there will be a small window where the kernel uses
1693the previous second to update file times but libev might already execute
1694the timer callback).
1392 1695
1393=head3 Watcher-Specific Functions and Data Members 1696=head3 Watcher-Specific Functions and Data Members
1394 1697
1395=over 4 1698=over 4
1396 1699
1402C<path>. The C<interval> is a hint on how quickly a change is expected to 1705C<path>. The C<interval> is a hint on how quickly a change is expected to
1403be detected and should normally be specified as C<0> to let libev choose 1706be detected and should normally be specified as C<0> to let libev choose
1404a suitable value. The memory pointed to by C<path> must point to the same 1707a suitable value. The memory pointed to by C<path> must point to the same
1405path for as long as the watcher is active. 1708path for as long as the watcher is active.
1406 1709
1407The callback will be receive C<EV_STAT> when a change was detected, 1710The callback will receive C<EV_STAT> when a change was detected, relative
1408relative to the attributes at the time the watcher was started (or the 1711to the attributes at the time the watcher was started (or the last change
1409last change was detected). 1712was detected).
1410 1713
1411=item ev_stat_stat (ev_stat *) 1714=item ev_stat_stat (loop, ev_stat *)
1412 1715
1413Updates the stat buffer immediately with new values. If you change the 1716Updates the stat buffer immediately with new values. If you change the
1414watched path in your callback, you could call this fucntion to avoid 1717watched path in your callback, you could call this function to avoid
1415detecting this change (while introducing a race condition). Can also be 1718detecting this change (while introducing a race condition if you are not
1416useful simply to find out the new values. 1719the only one changing the path). Can also be useful simply to find out the
1720new values.
1417 1721
1418=item ev_statdata attr [read-only] 1722=item ev_statdata attr [read-only]
1419 1723
1420The most-recently detected attributes of the file. Although the type is of 1724The most-recently detected attributes of the file. Although the type is
1421C<ev_statdata>, this is usually the (or one of the) C<struct stat> types 1725C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1422suitable for your system. If the C<st_nlink> member is C<0>, then there 1726suitable for your system, but you can only rely on the POSIX-standardised
1727members to be present. If the C<st_nlink> member is C<0>, then there was
1423was some error while C<stat>ing the file. 1728some error while C<stat>ing the file.
1424 1729
1425=item ev_statdata prev [read-only] 1730=item ev_statdata prev [read-only]
1426 1731
1427The previous attributes of the file. The callback gets invoked whenever 1732The previous attributes of the file. The callback gets invoked whenever
1428C<prev> != C<attr>. 1733C<prev> != C<attr>, or, more precisely, one or more of these members
1734differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
1735C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1429 1736
1430=item ev_tstamp interval [read-only] 1737=item ev_tstamp interval [read-only]
1431 1738
1432The specified interval. 1739The specified interval.
1433 1740
1434=item const char *path [read-only] 1741=item const char *path [read-only]
1435 1742
1436The filesystem path that is being watched. 1743The filesystem path that is being watched.
1437 1744
1438=back 1745=back
1746
1747=head3 Examples
1439 1748
1440Example: Watch C</etc/passwd> for attribute changes. 1749Example: Watch C</etc/passwd> for attribute changes.
1441 1750
1442 static void 1751 static void
1443 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1752 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1456 } 1765 }
1457 1766
1458 ... 1767 ...
1459 ev_stat passwd; 1768 ev_stat passwd;
1460 1769
1461 ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1770 ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1462 ev_stat_start (loop, &passwd); 1771 ev_stat_start (loop, &passwd);
1772
1773Example: Like above, but additionally use a one-second delay so we do not
1774miss updates (however, frequent updates will delay processing, too, so
1775one might do the work both on C<ev_stat> callback invocation I<and> on
1776C<ev_timer> callback invocation).
1777
1778 static ev_stat passwd;
1779 static ev_timer timer;
1780
1781 static void
1782 timer_cb (EV_P_ ev_timer *w, int revents)
1783 {
1784 ev_timer_stop (EV_A_ w);
1785
1786 /* now it's one second after the most recent passwd change */
1787 }
1788
1789 static void
1790 stat_cb (EV_P_ ev_stat *w, int revents)
1791 {
1792 /* reset the one-second timer */
1793 ev_timer_again (EV_A_ &timer);
1794 }
1795
1796 ...
1797 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1798 ev_stat_start (loop, &passwd);
1799 ev_timer_init (&timer, timer_cb, 0., 1.02);
1463 1800
1464 1801
1465=head2 C<ev_idle> - when you've got nothing better to do... 1802=head2 C<ev_idle> - when you've got nothing better to do...
1466 1803
1467Idle watchers trigger events when no other events of the same or higher 1804Idle watchers trigger events when no other events of the same or higher
1493kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1830kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1494believe me. 1831believe me.
1495 1832
1496=back 1833=back
1497 1834
1835=head3 Examples
1836
1498Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the 1837Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1499callback, free it. Also, use no error checking, as usual. 1838callback, free it. Also, use no error checking, as usual.
1500 1839
1501 static void 1840 static void
1502 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1841 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1503 { 1842 {
1504 free (w); 1843 free (w);
1505 // now do something you wanted to do when the program has 1844 // now do something you wanted to do when the program has
1506 // no longer asnything immediate to do. 1845 // no longer anything immediate to do.
1507 } 1846 }
1508 1847
1509 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1848 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1510 ev_idle_init (idle_watcher, idle_cb); 1849 ev_idle_init (idle_watcher, idle_cb);
1511 ev_idle_start (loop, idle_cb); 1850 ev_idle_start (loop, idle_cb);
1553 1892
1554It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 1893It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1555priority, to ensure that they are being run before any other watchers 1894priority, to ensure that they are being run before any other watchers
1556after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, 1895after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1557too) should not activate ("feed") events into libev. While libev fully 1896too) should not activate ("feed") events into libev. While libev fully
1558supports this, they will be called before other C<ev_check> watchers did 1897supports this, they might get executed before other C<ev_check> watchers
1559their job. As C<ev_check> watchers are often used to embed other event 1898did their job. As C<ev_check> watchers are often used to embed other
1560loops those other event loops might be in an unusable state until their 1899(non-libev) event loops those other event loops might be in an unusable
1561C<ev_check> watcher ran (always remind yourself to coexist peacefully with 1900state until their C<ev_check> watcher ran (always remind yourself to
1562others). 1901coexist peacefully with others).
1563 1902
1564=head3 Watcher-Specific Functions and Data Members 1903=head3 Watcher-Specific Functions and Data Members
1565 1904
1566=over 4 1905=over 4
1567 1906
1573parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1912parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1574macros, but using them is utterly, utterly and completely pointless. 1913macros, but using them is utterly, utterly and completely pointless.
1575 1914
1576=back 1915=back
1577 1916
1917=head3 Examples
1918
1578There are a number of principal ways to embed other event loops or modules 1919There are a number of principal ways to embed other event loops or modules
1579into libev. Here are some ideas on how to include libadns into libev 1920into libev. Here are some ideas on how to include libadns into libev
1580(there is a Perl module named C<EV::ADNS> that does this, which you could 1921(there is a Perl module named C<EV::ADNS> that does this, which you could
1581use for an actually working example. Another Perl module named C<EV::Glib> 1922use as a working example. Another Perl module named C<EV::Glib> embeds a
1582embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV 1923Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1583into the Glib event loop). 1924Glib event loop).
1584 1925
1585Method 1: Add IO watchers and a timeout watcher in a prepare handler, 1926Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1586and in a check watcher, destroy them and call into libadns. What follows 1927and in a check watcher, destroy them and call into libadns. What follows
1587is pseudo-code only of course. This requires you to either use a low 1928is pseudo-code only of course. This requires you to either use a low
1588priority for the check watcher or use C<ev_clear_pending> explicitly, as 1929priority for the check watcher or use C<ev_clear_pending> explicitly, as
1750portable one. 2091portable one.
1751 2092
1752So when you want to use this feature you will always have to be prepared 2093So when you want to use this feature you will always have to be prepared
1753that you cannot get an embeddable loop. The recommended way to get around 2094that you cannot get an embeddable loop. The recommended way to get around
1754this is to have a separate variables for your embeddable loop, try to 2095this is to have a separate variables for your embeddable loop, try to
1755create it, and if that fails, use the normal loop for everything: 2096create it, and if that fails, use the normal loop for everything.
2097
2098=head3 Watcher-Specific Functions and Data Members
2099
2100=over 4
2101
2102=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
2103
2104=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
2105
2106Configures the watcher to embed the given loop, which must be
2107embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2108invoked automatically, otherwise it is the responsibility of the callback
2109to invoke it (it will continue to be called until the sweep has been done,
2110if you do not want thta, you need to temporarily stop the embed watcher).
2111
2112=item ev_embed_sweep (loop, ev_embed *)
2113
2114Make a single, non-blocking sweep over the embedded loop. This works
2115similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
2116apropriate way for embedded loops.
2117
2118=item struct ev_loop *other [read-only]
2119
2120The embedded event loop.
2121
2122=back
2123
2124=head3 Examples
2125
2126Example: Try to get an embeddable event loop and embed it into the default
2127event loop. If that is not possible, use the default loop. The default
2128loop is stored in C<loop_hi>, while the mebeddable loop is stored in
2129C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
2130used).
1756 2131
1757 struct ev_loop *loop_hi = ev_default_init (0); 2132 struct ev_loop *loop_hi = ev_default_init (0);
1758 struct ev_loop *loop_lo = 0; 2133 struct ev_loop *loop_lo = 0;
1759 struct ev_embed embed; 2134 struct ev_embed embed;
1760 2135
1771 ev_embed_start (loop_hi, &embed); 2146 ev_embed_start (loop_hi, &embed);
1772 } 2147 }
1773 else 2148 else
1774 loop_lo = loop_hi; 2149 loop_lo = loop_hi;
1775 2150
1776=head3 Watcher-Specific Functions and Data Members 2151Example: Check if kqueue is available but not recommended and create
2152a kqueue backend for use with sockets (which usually work with any
2153kqueue implementation). Store the kqueue/socket-only event loop in
2154C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1777 2155
1778=over 4 2156 struct ev_loop *loop = ev_default_init (0);
2157 struct ev_loop *loop_socket = 0;
2158 struct ev_embed embed;
2159
2160 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2161 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2162 {
2163 ev_embed_init (&embed, 0, loop_socket);
2164 ev_embed_start (loop, &embed);
2165 }
1779 2166
1780=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 2167 if (!loop_socket)
2168 loop_socket = loop;
1781 2169
1782=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 2170 // now use loop_socket for all sockets, and loop for everything else
1783
1784Configures the watcher to embed the given loop, which must be
1785embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1786invoked automatically, otherwise it is the responsibility of the callback
1787to invoke it (it will continue to be called until the sweep has been done,
1788if you do not want thta, you need to temporarily stop the embed watcher).
1789
1790=item ev_embed_sweep (loop, ev_embed *)
1791
1792Make a single, non-blocking sweep over the embedded loop. This works
1793similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1794apropriate way for embedded loops.
1795
1796=item struct ev_loop *loop [read-only]
1797
1798The embedded event loop.
1799
1800=back
1801 2171
1802 2172
1803=head2 C<ev_fork> - the audacity to resume the event loop after a fork 2173=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1804 2174
1805Fork watchers are called when a C<fork ()> was detected (usually because 2175Fork watchers are called when a C<fork ()> was detected (usually because
1821believe me. 2191believe me.
1822 2192
1823=back 2193=back
1824 2194
1825 2195
2196=head2 C<ev_async> - how to wake up another event loop
2197
2198In general, you cannot use an C<ev_loop> from multiple threads or other
2199asynchronous sources such as signal handlers (as opposed to multiple event
2200loops - those are of course safe to use in different threads).
2201
2202Sometimes, however, you need to wake up another event loop you do not
2203control, for example because it belongs to another thread. This is what
2204C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
2205can signal it by calling C<ev_async_send>, which is thread- and signal
2206safe.
2207
2208This functionality is very similar to C<ev_signal> watchers, as signals,
2209too, are asynchronous in nature, and signals, too, will be compressed
2210(i.e. the number of callback invocations may be less than the number of
2211C<ev_async_sent> calls).
2212
2213Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
2214just the default loop.
2215
2216=head3 Queueing
2217
2218C<ev_async> does not support queueing of data in any way. The reason
2219is that the author does not know of a simple (or any) algorithm for a
2220multiple-writer-single-reader queue that works in all cases and doesn't
2221need elaborate support such as pthreads.
2222
2223That means that if you want to queue data, you have to provide your own
2224queue. But at least I can tell you would implement locking around your
2225queue:
2226
2227=over 4
2228
2229=item queueing from a signal handler context
2230
2231To implement race-free queueing, you simply add to the queue in the signal
2232handler but you block the signal handler in the watcher callback. Here is an example that does that for
2233some fictitiuous SIGUSR1 handler:
2234
2235 static ev_async mysig;
2236
2237 static void
2238 sigusr1_handler (void)
2239 {
2240 sometype data;
2241
2242 // no locking etc.
2243 queue_put (data);
2244 ev_async_send (EV_DEFAULT_ &mysig);
2245 }
2246
2247 static void
2248 mysig_cb (EV_P_ ev_async *w, int revents)
2249 {
2250 sometype data;
2251 sigset_t block, prev;
2252
2253 sigemptyset (&block);
2254 sigaddset (&block, SIGUSR1);
2255 sigprocmask (SIG_BLOCK, &block, &prev);
2256
2257 while (queue_get (&data))
2258 process (data);
2259
2260 if (sigismember (&prev, SIGUSR1)
2261 sigprocmask (SIG_UNBLOCK, &block, 0);
2262 }
2263
2264(Note: pthreads in theory requires you to use C<pthread_setmask>
2265instead of C<sigprocmask> when you use threads, but libev doesn't do it
2266either...).
2267
2268=item queueing from a thread context
2269
2270The strategy for threads is different, as you cannot (easily) block
2271threads but you can easily preempt them, so to queue safely you need to
2272employ a traditional mutex lock, such as in this pthread example:
2273
2274 static ev_async mysig;
2275 static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
2276
2277 static void
2278 otherthread (void)
2279 {
2280 // only need to lock the actual queueing operation
2281 pthread_mutex_lock (&mymutex);
2282 queue_put (data);
2283 pthread_mutex_unlock (&mymutex);
2284
2285 ev_async_send (EV_DEFAULT_ &mysig);
2286 }
2287
2288 static void
2289 mysig_cb (EV_P_ ev_async *w, int revents)
2290 {
2291 pthread_mutex_lock (&mymutex);
2292
2293 while (queue_get (&data))
2294 process (data);
2295
2296 pthread_mutex_unlock (&mymutex);
2297 }
2298
2299=back
2300
2301
2302=head3 Watcher-Specific Functions and Data Members
2303
2304=over 4
2305
2306=item ev_async_init (ev_async *, callback)
2307
2308Initialises and configures the async watcher - it has no parameters of any
2309kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
2310believe me.
2311
2312=item ev_async_send (loop, ev_async *)
2313
2314Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2315an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2316C<ev_feed_event>, this call is safe to do in other threads, signal or
2317similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding
2318section below on what exactly this means).
2319
2320This call incurs the overhead of a syscall only once per loop iteration,
2321so while the overhead might be noticable, it doesn't apply to repeated
2322calls to C<ev_async_send>.
2323
2324=item bool = ev_async_pending (ev_async *)
2325
2326Returns a non-zero value when C<ev_async_send> has been called on the
2327watcher but the event has not yet been processed (or even noted) by the
2328event loop.
2329
2330C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2331the loop iterates next and checks for the watcher to have become active,
2332it will reset the flag again. C<ev_async_pending> can be used to very
2333quickly check wether invoking the loop might be a good idea.
2334
2335Not that this does I<not> check wether the watcher itself is pending, only
2336wether it has been requested to make this watcher pending.
2337
2338=back
2339
2340
1826=head1 OTHER FUNCTIONS 2341=head1 OTHER FUNCTIONS
1827 2342
1828There are some other functions of possible interest. Described. Here. Now. 2343There are some other functions of possible interest. Described. Here. Now.
1829 2344
1830=over 4 2345=over 4
1898 2413
1899=item * Priorities are not currently supported. Initialising priorities 2414=item * Priorities are not currently supported. Initialising priorities
1900will fail and all watchers will have the same priority, even though there 2415will fail and all watchers will have the same priority, even though there
1901is an ev_pri field. 2416is an ev_pri field.
1902 2417
2418=item * In libevent, the last base created gets the signals, in libev, the
2419first base created (== the default loop) gets the signals.
2420
1903=item * Other members are not supported. 2421=item * Other members are not supported.
1904 2422
1905=item * The libev emulation is I<not> ABI compatible to libevent, you need 2423=item * The libev emulation is I<not> ABI compatible to libevent, you need
1906to use the libev header file and library. 2424to use the libev header file and library.
1907 2425
2057Example: Define a class with an IO and idle watcher, start one of them in 2575Example: Define a class with an IO and idle watcher, start one of them in
2058the constructor. 2576the constructor.
2059 2577
2060 class myclass 2578 class myclass
2061 { 2579 {
2062 ev_io io; void io_cb (ev::io &w, int revents); 2580 ev::io io; void io_cb (ev::io &w, int revents);
2063 ev_idle idle void idle_cb (ev::idle &w, int revents); 2581 ev:idle idle void idle_cb (ev::idle &w, int revents);
2064 2582
2065 myclass (); 2583 myclass (int fd)
2066 }
2067
2068 myclass::myclass (int fd)
2069 { 2584 {
2070 io .set <myclass, &myclass::io_cb > (this); 2585 io .set <myclass, &myclass::io_cb > (this);
2071 idle.set <myclass, &myclass::idle_cb> (this); 2586 idle.set <myclass, &myclass::idle_cb> (this);
2072 2587
2073 io.start (fd, ev::READ); 2588 io.start (fd, ev::READ);
2589 }
2074 } 2590 };
2591
2592
2593=head1 OTHER LANGUAGE BINDINGS
2594
2595Libev does not offer other language bindings itself, but bindings for a
2596numbe rof languages exist in the form of third-party packages. If you know
2597any interesting language binding in addition to the ones listed here, drop
2598me a note.
2599
2600=over 4
2601
2602=item Perl
2603
2604The EV module implements the full libev API and is actually used to test
2605libev. EV is developed together with libev. Apart from the EV core module,
2606there are additional modules that implement libev-compatible interfaces
2607to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2608C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2609
2610It can be found and installed via CPAN, its homepage is found at
2611L<http://software.schmorp.de/pkg/EV>.
2612
2613=item Ruby
2614
2615Tony Arcieri has written a ruby extension that offers access to a subset
2616of the libev API and adds filehandle abstractions, asynchronous DNS and
2617more on top of it. It can be found via gem servers. Its homepage is at
2618L<http://rev.rubyforge.org/>.
2619
2620=item D
2621
2622Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2623be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2624
2625=back
2075 2626
2076 2627
2077=head1 MACRO MAGIC 2628=head1 MACRO MAGIC
2078 2629
2079Libev can be compiled with a variety of options, the most fundamantal 2630Libev can be compiled with a variety of options, the most fundamantal
2115 2666
2116=item C<EV_DEFAULT>, C<EV_DEFAULT_> 2667=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2117 2668
2118Similar to the other two macros, this gives you the value of the default 2669Similar to the other two macros, this gives you the value of the default
2119loop, if multiple loops are supported ("ev loop default"). 2670loop, if multiple loops are supported ("ev loop default").
2671
2672=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
2673
2674Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
2675default loop has been initialised (C<UC> == unchecked). Their behaviour
2676is undefined when the default loop has not been initialised by a previous
2677execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
2678
2679It is often prudent to use C<EV_DEFAULT> when initialising the first
2680watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2120 2681
2121=back 2682=back
2122 2683
2123Example: Declare and initialise a check watcher, utilising the above 2684Example: Declare and initialise a check watcher, utilising the above
2124macros so it will work regardless of whether multiple loops are supported 2685macros so it will work regardless of whether multiple loops are supported
2140Libev can (and often is) directly embedded into host 2701Libev can (and often is) directly embedded into host
2141applications. Examples of applications that embed it include the Deliantra 2702applications. Examples of applications that embed it include the Deliantra
2142Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) 2703Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
2143and rxvt-unicode. 2704and rxvt-unicode.
2144 2705
2145The goal is to enable you to just copy the neecssary files into your 2706The goal is to enable you to just copy the necessary files into your
2146source directory without having to change even a single line in them, so 2707source directory without having to change even a single line in them, so
2147you can easily upgrade by simply copying (or having a checked-out copy of 2708you can easily upgrade by simply copying (or having a checked-out copy of
2148libev somewhere in your source tree). 2709libev somewhere in your source tree).
2149 2710
2150=head2 FILESETS 2711=head2 FILESETS
2220 2781
2221 libev.m4 2782 libev.m4
2222 2783
2223=head2 PREPROCESSOR SYMBOLS/MACROS 2784=head2 PREPROCESSOR SYMBOLS/MACROS
2224 2785
2225Libev can be configured via a variety of preprocessor symbols you have to define 2786Libev can be configured via a variety of preprocessor symbols you have to
2226before including any of its files. The default is not to build for multiplicity 2787define before including any of its files. The default in the absense of
2227and only include the select backend. 2788autoconf is noted for every option.
2228 2789
2229=over 4 2790=over 4
2230 2791
2231=item EV_STANDALONE 2792=item EV_STANDALONE
2232 2793
2240 2801
2241If defined to be C<1>, libev will try to detect the availability of the 2802If defined to be C<1>, libev will try to detect the availability of the
2242monotonic clock option at both compiletime and runtime. Otherwise no use 2803monotonic clock option at both compiletime and runtime. Otherwise no use
2243of the monotonic clock option will be attempted. If you enable this, you 2804of the monotonic clock option will be attempted. If you enable this, you
2244usually have to link against librt or something similar. Enabling it when 2805usually have to link against librt or something similar. Enabling it when
2245the functionality isn't available is safe, though, althoguh you have 2806the functionality isn't available is safe, though, although you have
2246to make sure you link against any libraries where the C<clock_gettime> 2807to make sure you link against any libraries where the C<clock_gettime>
2247function is hiding in (often F<-lrt>). 2808function is hiding in (often F<-lrt>).
2248 2809
2249=item EV_USE_REALTIME 2810=item EV_USE_REALTIME
2250 2811
2251If defined to be C<1>, libev will try to detect the availability of the 2812If defined to be C<1>, libev will try to detect the availability of the
2252realtime clock option at compiletime (and assume its availability at 2813realtime clock option at compiletime (and assume its availability at
2253runtime if successful). Otherwise no use of the realtime clock option will 2814runtime if successful). Otherwise no use of the realtime clock option will
2254be attempted. This effectively replaces C<gettimeofday> by C<clock_get 2815be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2255(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries 2816(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2256in the description of C<EV_USE_MONOTONIC>, though. 2817note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2818
2819=item EV_USE_NANOSLEEP
2820
2821If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2822and will use it for delays. Otherwise it will use C<select ()>.
2823
2824=item EV_USE_EVENTFD
2825
2826If defined to be C<1>, then libev will assume that C<eventfd ()> is
2827available and will probe for kernel support at runtime. This will improve
2828C<ev_signal> and C<ev_async> performance and reduce resource consumption.
2829If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
28302.7 or newer, otherwise disabled.
2257 2831
2258=item EV_USE_SELECT 2832=item EV_USE_SELECT
2259 2833
2260If undefined or defined to be C<1>, libev will compile in support for the 2834If undefined or defined to be C<1>, libev will compile in support for the
2261C<select>(2) backend. No attempt at autodetection will be done: if no 2835C<select>(2) backend. No attempt at autodetection will be done: if no
2280be used is the winsock select). This means that it will call 2854be used is the winsock select). This means that it will call
2281C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 2855C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2282it is assumed that all these functions actually work on fds, even 2856it is assumed that all these functions actually work on fds, even
2283on win32. Should not be defined on non-win32 platforms. 2857on win32. Should not be defined on non-win32 platforms.
2284 2858
2859=item EV_FD_TO_WIN32_HANDLE
2860
2861If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2862file descriptors to socket handles. When not defining this symbol (the
2863default), then libev will call C<_get_osfhandle>, which is usually
2864correct. In some cases, programs use their own file descriptor management,
2865in which case they can provide this function to map fds to socket handles.
2866
2285=item EV_USE_POLL 2867=item EV_USE_POLL
2286 2868
2287If defined to be C<1>, libev will compile in support for the C<poll>(2) 2869If defined to be C<1>, libev will compile in support for the C<poll>(2)
2288backend. Otherwise it will be enabled on non-win32 platforms. It 2870backend. Otherwise it will be enabled on non-win32 platforms. It
2289takes precedence over select. 2871takes precedence over select.
2290 2872
2291=item EV_USE_EPOLL 2873=item EV_USE_EPOLL
2292 2874
2293If defined to be C<1>, libev will compile in support for the Linux 2875If defined to be C<1>, libev will compile in support for the Linux
2294C<epoll>(7) backend. Its availability will be detected at runtime, 2876C<epoll>(7) backend. Its availability will be detected at runtime,
2295otherwise another method will be used as fallback. This is the 2877otherwise another method will be used as fallback. This is the preferred
2296preferred backend for GNU/Linux systems. 2878backend for GNU/Linux systems. If undefined, it will be enabled if the
2879headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2297 2880
2298=item EV_USE_KQUEUE 2881=item EV_USE_KQUEUE
2299 2882
2300If defined to be C<1>, libev will compile in support for the BSD style 2883If defined to be C<1>, libev will compile in support for the BSD style
2301C<kqueue>(2) backend. Its actual availability will be detected at runtime, 2884C<kqueue>(2) backend. Its actual availability will be detected at runtime,
2320 2903
2321=item EV_USE_INOTIFY 2904=item EV_USE_INOTIFY
2322 2905
2323If defined to be C<1>, libev will compile in support for the Linux inotify 2906If defined to be C<1>, libev will compile in support for the Linux inotify
2324interface to speed up C<ev_stat> watchers. Its actual availability will 2907interface to speed up C<ev_stat> watchers. Its actual availability will
2325be detected at runtime. 2908be detected at runtime. If undefined, it will be enabled if the headers
2909indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2910
2911=item EV_ATOMIC_T
2912
2913Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2914access is atomic with respect to other threads or signal contexts. No such
2915type is easily found in the C language, so you can provide your own type
2916that you know is safe for your purposes. It is used both for signal handler "locking"
2917as well as for signal and thread safety in C<ev_async> watchers.
2918
2919In the absense of this define, libev will use C<sig_atomic_t volatile>
2920(from F<signal.h>), which is usually good enough on most platforms.
2326 2921
2327=item EV_H 2922=item EV_H
2328 2923
2329The name of the F<ev.h> header file used to include it. The default if 2924The name of the F<ev.h> header file used to include it. The default if
2330undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2925undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2331can be used to virtually rename the F<ev.h> header file in case of conflicts. 2926used to virtually rename the F<ev.h> header file in case of conflicts.
2332 2927
2333=item EV_CONFIG_H 2928=item EV_CONFIG_H
2334 2929
2335If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2930If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2336F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2931F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2337C<EV_H>, above. 2932C<EV_H>, above.
2338 2933
2339=item EV_EVENT_H 2934=item EV_EVENT_H
2340 2935
2341Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2936Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2342of how the F<event.h> header can be found. 2937of how the F<event.h> header can be found, the default is C<"event.h">.
2343 2938
2344=item EV_PROTOTYPES 2939=item EV_PROTOTYPES
2345 2940
2346If defined to be C<0>, then F<ev.h> will not define any function 2941If defined to be C<0>, then F<ev.h> will not define any function
2347prototypes, but still define all the structs and other symbols. This is 2942prototypes, but still define all the structs and other symbols. This is
2398=item EV_FORK_ENABLE 2993=item EV_FORK_ENABLE
2399 2994
2400If undefined or defined to be C<1>, then fork watchers are supported. If 2995If undefined or defined to be C<1>, then fork watchers are supported. If
2401defined to be C<0>, then they are not. 2996defined to be C<0>, then they are not.
2402 2997
2998=item EV_ASYNC_ENABLE
2999
3000If undefined or defined to be C<1>, then async watchers are supported. If
3001defined to be C<0>, then they are not.
3002
2403=item EV_MINIMAL 3003=item EV_MINIMAL
2404 3004
2405If you need to shave off some kilobytes of code at the expense of some 3005If you need to shave off some kilobytes of code at the expense of some
2406speed, define this symbol to C<1>. Currently only used for gcc to override 3006speed, define this symbol to C<1>. Currently this is used to override some
2407some inlining decisions, saves roughly 30% codesize of amd64. 3007inlining decisions, saves roughly 30% codesize of amd64. It also selects a
3008much smaller 2-heap for timer management over the default 4-heap.
2408 3009
2409=item EV_PID_HASHSIZE 3010=item EV_PID_HASHSIZE
2410 3011
2411C<ev_child> watchers use a small hash table to distribute workload by 3012C<ev_child> watchers use a small hash table to distribute workload by
2412pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3013pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
2413than enough. If you need to manage thousands of children you might want to 3014than enough. If you need to manage thousands of children you might want to
2414increase this value (I<must> be a power of two). 3015increase this value (I<must> be a power of two).
2415 3016
2416=item EV_INOTIFY_HASHSIZE 3017=item EV_INOTIFY_HASHSIZE
2417 3018
2418C<ev_staz> watchers use a small hash table to distribute workload by 3019C<ev_stat> watchers use a small hash table to distribute workload by
2419inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 3020inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2420usually more than enough. If you need to manage thousands of C<ev_stat> 3021usually more than enough. If you need to manage thousands of C<ev_stat>
2421watchers you might want to increase this value (I<must> be a power of 3022watchers you might want to increase this value (I<must> be a power of
2422two). 3023two).
2423 3024
3025=item EV_USE_4HEAP
3026
3027Heaps are not very cache-efficient. To improve the cache-efficiency of the
3028timer and periodics heap, libev uses a 4-heap when this symbol is defined
3029to C<1>. The 4-heap uses more complicated (longer) code but has
3030noticably faster performance with many (thousands) of watchers.
3031
3032The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3033(disabled).
3034
3035=item EV_HEAP_CACHE_AT
3036
3037Heaps are not very cache-efficient. To improve the cache-efficiency of the
3038timer and periodics heap, libev can cache the timestamp (I<at>) within
3039the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3040which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3041but avoids random read accesses on heap changes. This improves performance
3042noticably with with many (hundreds) of watchers.
3043
3044The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3045(disabled).
3046
3047=item EV_VERIFY
3048
3049Controls how much internal verification (see C<ev_loop_verify ()>) will
3050be done: If set to C<0>, no internal verification code will be compiled
3051in. If set to C<1>, then verification code will be compiled in, but not
3052called. If set to C<2>, then the internal verification code will be
3053called once per loop, which can slow down libev. If set to C<3>, then the
3054verification code will be called very frequently, which will slow down
3055libev considerably.
3056
3057The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
3058C<0.>
3059
2424=item EV_COMMON 3060=item EV_COMMON
2425 3061
2426By default, all watchers have a C<void *data> member. By redefining 3062By default, all watchers have a C<void *data> member. By redefining
2427this macro to a something else you can include more and other types of 3063this macro to a something else you can include more and other types of
2428members. You have to define it each time you include one of the files, 3064members. You have to define it each time you include one of the files,
2440 3076
2441=item ev_set_cb (ev, cb) 3077=item ev_set_cb (ev, cb)
2442 3078
2443Can be used to change the callback member declaration in each watcher, 3079Can be used to change the callback member declaration in each watcher,
2444and the way callbacks are invoked and set. Must expand to a struct member 3080and the way callbacks are invoked and set. Must expand to a struct member
2445definition and a statement, respectively. See the F<ev.v> header file for 3081definition and a statement, respectively. See the F<ev.h> header file for
2446their default definitions. One possible use for overriding these is to 3082their default definitions. One possible use for overriding these is to
2447avoid the C<struct ev_loop *> as first argument in all cases, or to use 3083avoid the C<struct ev_loop *> as first argument in all cases, or to use
2448method calls instead of plain function calls in C++. 3084method calls instead of plain function calls in C++.
3085
3086=head2 EXPORTED API SYMBOLS
3087
3088If you need to re-export the API (e.g. via a dll) and you need a list of
3089exported symbols, you can use the provided F<Symbol.*> files which list
3090all public symbols, one per line:
3091
3092 Symbols.ev for libev proper
3093 Symbols.event for the libevent emulation
3094
3095This can also be used to rename all public symbols to avoid clashes with
3096multiple versions of libev linked together (which is obviously bad in
3097itself, but sometimes it is inconvinient to avoid this).
3098
3099A sed command like this will create wrapper C<#define>'s that you need to
3100include before including F<ev.h>:
3101
3102 <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
3103
3104This would create a file F<wrap.h> which essentially looks like this:
3105
3106 #define ev_backend myprefix_ev_backend
3107 #define ev_check_start myprefix_ev_check_start
3108 #define ev_check_stop myprefix_ev_check_stop
3109 ...
2449 3110
2450=head2 EXAMPLES 3111=head2 EXAMPLES
2451 3112
2452For a real-world example of a program the includes libev 3113For a real-world example of a program the includes libev
2453verbatim, you can have a look at the EV perl module 3114verbatim, you can have a look at the EV perl module
2476 3137
2477 #include "ev_cpp.h" 3138 #include "ev_cpp.h"
2478 #include "ev.c" 3139 #include "ev.c"
2479 3140
2480 3141
3142=head1 THREADS AND COROUTINES
3143
3144=head2 THREADS
3145
3146Libev itself is completely threadsafe, but it uses no locking. This
3147means that you can use as many loops as you want in parallel, as long as
3148only one thread ever calls into one libev function with the same loop
3149parameter.
3150
3151Or put differently: calls with different loop parameters can be done in
3152parallel from multiple threads, calls with the same loop parameter must be
3153done serially (but can be done from different threads, as long as only one
3154thread ever is inside a call at any point in time, e.g. by using a mutex
3155per loop).
3156
3157If you want to know which design is best for your problem, then I cannot
3158help you but by giving some generic advice:
3159
3160=over 4
3161
3162=item * most applications have a main thread: use the default libev loop
3163in that thread, or create a seperate thread running only the default loop.
3164
3165This helps integrating other libraries or software modules that use libev
3166themselves and don't care/know about threading.
3167
3168=item * one loop per thread is usually a good model.
3169
3170Doing this is almost never wrong, sometimes a better-performance model
3171exists, but it is always a good start.
3172
3173=item * other models exist, such as the leader/follower pattern, where one
3174loop is handed through multiple threads in a kind of round-robbin fashion.
3175
3176Chosing a model is hard - look around, learn, know that usually you cna do
3177better than you currently do :-)
3178
3179=item * often you need to talk to some other thread which blocks in the
3180event loop - C<ev_async> watchers can be used to wake them up from other
3181threads safely (or from signal contexts...).
3182
3183=back
3184
3185=head2 COROUTINES
3186
3187Libev is much more accomodating to coroutines ("cooperative threads"):
3188libev fully supports nesting calls to it's functions from different
3189coroutines (e.g. you can call C<ev_loop> on the same loop from two
3190different coroutines and switch freely between both coroutines running the
3191loop, as long as you don't confuse yourself). The only exception is that
3192you must not do this from C<ev_periodic> reschedule callbacks.
3193
3194Care has been invested into making sure that libev does not keep local
3195state inside C<ev_loop>, and other calls do not usually allow coroutine
3196switches.
3197
3198
2481=head1 COMPLEXITIES 3199=head1 COMPLEXITIES
2482 3200
2483In this section the complexities of (many of) the algorithms used inside 3201In this section the complexities of (many of) the algorithms used inside
2484libev will be explained. For complexity discussions about backends see the 3202libev will be explained. For complexity discussions about backends see the
2485documentation for C<ev_default_init>. 3203documentation for C<ev_default_init>.
2494 3212
2495=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 3213=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2496 3214
2497This means that, when you have a watcher that triggers in one hour and 3215This means that, when you have a watcher that triggers in one hour and
2498there are 100 watchers that would trigger before that then inserting will 3216there are 100 watchers that would trigger before that then inserting will
2499have to skip those 100 watchers. 3217have to skip roughly seven (C<ld 100>) of these watchers.
2500 3218
2501=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 3219=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2502 3220
2503That means that for changing a timer costs less than removing/adding them 3221That means that changing a timer costs less than removing/adding them
2504as only the relative motion in the event queue has to be paid for. 3222as only the relative motion in the event queue has to be paid for.
2505 3223
2506=item Starting io/check/prepare/idle/signal/child watchers: O(1) 3224=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2507 3225
2508These just add the watcher into an array or at the head of a list. 3226These just add the watcher into an array or at the head of a list.
3227
2509=item Stopping check/prepare/idle watchers: O(1) 3228=item Stopping check/prepare/idle/fork/async watchers: O(1)
2510 3229
2511=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 3230=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2512 3231
2513These watchers are stored in lists then need to be walked to find the 3232These watchers are stored in lists then need to be walked to find the
2514correct watcher to remove. The lists are usually short (you don't usually 3233correct watcher to remove. The lists are usually short (you don't usually
2515have many watchers waiting for the same fd or signal). 3234have many watchers waiting for the same fd or signal).
2516 3235
2517=item Finding the next timer per loop iteration: O(1) 3236=item Finding the next timer in each loop iteration: O(1)
3237
3238By virtue of using a binary or 4-heap, the next timer is always found at a
3239fixed position in the storage array.
2518 3240
2519=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 3241=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2520 3242
2521A change means an I/O watcher gets started or stopped, which requires 3243A change means an I/O watcher gets started or stopped, which requires
2522libev to recalculate its status (and possibly tell the kernel). 3244libev to recalculate its status (and possibly tell the kernel, depending
3245on backend and wether C<ev_io_set> was used).
2523 3246
2524=item Activating one watcher: O(1) 3247=item Activating one watcher (putting it into the pending state): O(1)
2525 3248
2526=item Priority handling: O(number_of_priorities) 3249=item Priority handling: O(number_of_priorities)
2527 3250
2528Priorities are implemented by allocating some space for each 3251Priorities are implemented by allocating some space for each
2529priority. When doing priority-based operations, libev usually has to 3252priority. When doing priority-based operations, libev usually has to
2530linearly search all the priorities. 3253linearly search all the priorities, but starting/stopping and activating
3254watchers becomes O(1) w.r.t. priority handling.
3255
3256=item Sending an ev_async: O(1)
3257
3258=item Processing ev_async_send: O(number_of_async_watchers)
3259
3260=item Processing signals: O(max_signal_number)
3261
3262Sending involves a syscall I<iff> there were no other C<ev_async_send>
3263calls in the current loop iteration. Checking for async and signal events
3264involves iterating over all running async watchers or all signal numbers.
2531 3265
2532=back 3266=back
2533 3267
2534 3268
3269=head1 Win32 platform limitations and workarounds
3270
3271Win32 doesn't support any of the standards (e.g. POSIX) that libev
3272requires, and its I/O model is fundamentally incompatible with the POSIX
3273model. Libev still offers limited functionality on this platform in
3274the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3275descriptors. This only applies when using Win32 natively, not when using
3276e.g. cygwin.
3277
3278Lifting these limitations would basically require the full
3279re-implementation of the I/O system. If you are into these kinds of
3280things, then note that glib does exactly that for you in a very portable
3281way (note also that glib is the slowest event library known to man).
3282
3283There is no supported compilation method available on windows except
3284embedding it into other applications.
3285
3286Due to the many, low, and arbitrary limits on the win32 platform and
3287the abysmal performance of winsockets, using a large number of sockets
3288is not recommended (and not reasonable). If your program needs to use
3289more than a hundred or so sockets, then likely it needs to use a totally
3290different implementation for windows, as libev offers the POSIX readiness
3291notification model, which cannot be implemented efficiently on windows
3292(microsoft monopoly games).
3293
3294=over 4
3295
3296=item The winsocket select function
3297
3298The winsocket C<select> function doesn't follow POSIX in that it requires
3299socket I<handles> and not socket I<file descriptors>. This makes select
3300very inefficient, and also requires a mapping from file descriptors
3301to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
3302C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
3303symbols for more info.
3304
3305The configuration for a "naked" win32 using the microsoft runtime
3306libraries and raw winsocket select is:
3307
3308 #define EV_USE_SELECT 1
3309 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3310
3311Note that winsockets handling of fd sets is O(n), so you can easily get a
3312complexity in the O(n²) range when using win32.
3313
3314=item Limited number of file descriptors
3315
3316Windows has numerous arbitrary (and low) limits on things.
3317
3318Early versions of winsocket's select only supported waiting for a maximum
3319of C<64> handles (probably owning to the fact that all windows kernels
3320can only wait for C<64> things at the same time internally; microsoft
3321recommends spawning a chain of threads and wait for 63 handles and the
3322previous thread in each. Great).
3323
3324Newer versions support more handles, but you need to define C<FD_SETSIZE>
3325to some high number (e.g. C<2048>) before compiling the winsocket select
3326call (which might be in libev or elsewhere, for example, perl does its own
3327select emulation on windows).
3328
3329Another limit is the number of file descriptors in the microsoft runtime
3330libraries, which by default is C<64> (there must be a hidden I<64> fetish
3331or something like this inside microsoft). You can increase this by calling
3332C<_setmaxstdio>, which can increase this limit to C<2048> (another
3333arbitrary limit), but is broken in many versions of the microsoft runtime
3334libraries.
3335
3336This might get you to about C<512> or C<2048> sockets (depending on
3337windows version and/or the phase of the moon). To get more, you need to
3338wrap all I/O functions and provide your own fd management, but the cost of
3339calling select (O(n²)) will likely make this unworkable.
3340
3341=back
3342
3343
3344=head1 PORTABILITY REQUIREMENTS
3345
3346In addition to a working ISO-C implementation, libev relies on a few
3347additional extensions:
3348
3349=over 4
3350
3351=item C<sig_atomic_t volatile> must be thread-atomic as well
3352
3353The type C<sig_atomic_t volatile> (or whatever is defined as
3354C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
3355threads. This is not part of the specification for C<sig_atomic_t>, but is
3356believed to be sufficiently portable.
3357
3358=item C<sigprocmask> must work in a threaded environment
3359
3360Libev uses C<sigprocmask> to temporarily block signals. This is not
3361allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
3362pthread implementations will either allow C<sigprocmask> in the "main
3363thread" or will block signals process-wide, both behaviours would
3364be compatible with libev. Interaction between C<sigprocmask> and
3365C<pthread_sigmask> could complicate things, however.
3366
3367The most portable way to handle signals is to block signals in all threads
3368except the initial one, and run the default loop in the initial thread as
3369well.
3370
3371=item C<long> must be large enough for common memory allocation sizes
3372
3373To improve portability and simplify using libev, libev uses C<long>
3374internally instead of C<size_t> when allocating its data structures. On
3375non-POSIX systems (Microsoft...) this might be unexpectedly low, but
3376is still at least 31 bits everywhere, which is enough for hundreds of
3377millions of watchers.
3378
3379=item C<double> must hold a time value in seconds with enough accuracy
3380
3381The type C<double> is used to represent timestamps. It is required to
3382have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3383enough for at least into the year 4000. This requirement is fulfilled by
3384implementations implementing IEEE 754 (basically all existing ones).
3385
3386=back
3387
3388If you know of other additional requirements drop me a note.
3389
3390
3391=head1 VALGRIND
3392
3393Valgrind has a special section here because it is a popular tool that is
3394highly useful, but valgrind reports are very hard to interpret.
3395
3396If you think you found a bug (memory leak, uninitialised data access etc.)
3397in libev, then check twice: If valgrind reports something like:
3398
3399 ==2274== definitely lost: 0 bytes in 0 blocks.
3400 ==2274== possibly lost: 0 bytes in 0 blocks.
3401 ==2274== still reachable: 256 bytes in 1 blocks.
3402
3403then there is no memory leak. Similarly, under some circumstances,
3404valgrind might report kernel bugs as if it were a bug in libev, or it
3405might be confused (it is a very good tool, but only a tool).
3406
3407If you are unsure about something, feel free to contact the mailing list
3408with the full valgrind report and an explanation on why you think this is
3409a bug in libev. However, don't be annoyed when you get a brisk "this is
3410no bug" answer and take the chance of learning how to interpret valgrind
3411properly.
3412
3413If you need, for some reason, empty reports from valgrind for your project
3414I suggest using suppression lists.
3415
3416
2535=head1 AUTHOR 3417=head1 AUTHOR
2536 3418
2537Marc Lehmann <libev@schmorp.de>. 3419Marc Lehmann <libev@schmorp.de>.
2538 3420

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines