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

Comparing libev/ev.3 (file contents):
Revision 1.71 by root, Mon Sep 29 03:31:14 2008 UTC vs.
Revision 1.79 by root, Fri Jul 17 14:43:38 2009 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
51.\" Escape single quotes in literal strings from groff's Unicode transform. 43.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq 44.ie \n(.g .ds Aq \(aq
53.el .ds Aq ' 45.el .ds Aq '
54.\" 46.\"
55.\" If the F register is turned on, we'll generate index entries on stderr for 47.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the 49.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 51.ie \nF \{\
60. de IX 52. de IX
61. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
130.\} 122.\}
131.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
132.\" ======================================================================== 124.\" ========================================================================
133.\" 125.\"
134.IX Title "LIBEV 3" 126.IX Title "LIBEV 3"
135.TH LIBEV 3 "2008-09-29" "libev-3.44" "libev - high performance full featured event loop" 127.TH LIBEV 3 "2009-07-15" "libev-3.7" "libev - high performance full featured event loop"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
138.if n .ad l 130.if n .ad l
139.nh 131.nh
140.SH "NAME" 132.SH "NAME"
142.SH "SYNOPSIS" 134.SH "SYNOPSIS"
143.IX Header "SYNOPSIS" 135.IX Header "SYNOPSIS"
144.Vb 1 136.Vb 1
145\& #include <ev.h> 137\& #include <ev.h>
146.Ve 138.Ve
147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 139.SS "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
148.IX Subsection "EXAMPLE PROGRAM" 140.IX Subsection "EXAMPLE PROGRAM"
149.Vb 2 141.Vb 2
150\& // a single header file is required 142\& // a single header file is required
151\& #include <ev.h> 143\& #include <ev.h>
152\& 144\&
145\& #include <stdio.h> // for puts
146\&
153\& // every watcher type has its own typedef\*(Aqd struct 147\& // every watcher type has its own typedef\*(Aqd struct
154\& // with the name ev_<type> 148\& // with the name ev_TYPE
155\& ev_io stdin_watcher; 149\& ev_io stdin_watcher;
156\& ev_timer timeout_watcher; 150\& ev_timer timeout_watcher;
157\& 151\&
158\& // all watcher callbacks have a similar signature 152\& // all watcher callbacks have a similar signature
159\& // this callback is called when data is readable on stdin 153\& // this callback is called when data is readable on stdin
160\& static void 154\& static void
161\& stdin_cb (EV_P_ struct ev_io *w, int revents) 155\& stdin_cb (EV_P_ ev_io *w, int revents)
162\& { 156\& {
163\& puts ("stdin ready"); 157\& puts ("stdin ready");
164\& // for one\-shot events, one must manually stop the watcher 158\& // for one\-shot events, one must manually stop the watcher
165\& // with its corresponding stop function. 159\& // with its corresponding stop function.
166\& ev_io_stop (EV_A_ w); 160\& ev_io_stop (EV_A_ w);
169\& ev_unloop (EV_A_ EVUNLOOP_ALL); 163\& ev_unloop (EV_A_ EVUNLOOP_ALL);
170\& } 164\& }
171\& 165\&
172\& // another callback, this time for a time\-out 166\& // another callback, this time for a time\-out
173\& static void 167\& static void
174\& timeout_cb (EV_P_ struct ev_timer *w, int revents) 168\& timeout_cb (EV_P_ ev_timer *w, int revents)
175\& { 169\& {
176\& puts ("timeout"); 170\& puts ("timeout");
177\& // this causes the innermost ev_loop to stop iterating 171\& // this causes the innermost ev_loop to stop iterating
178\& ev_unloop (EV_A_ EVUNLOOP_ONE); 172\& ev_unloop (EV_A_ EVUNLOOP_ONE);
179\& } 173\& }
199\& 193\&
200\& // unloop was called, so exit 194\& // unloop was called, so exit
201\& return 0; 195\& return 0;
202\& } 196\& }
203.Ve 197.Ve
204.SH "DESCRIPTION" 198.SH "ABOUT THIS DOCUMENT"
205.IX Header "DESCRIPTION" 199.IX Header "ABOUT THIS DOCUMENT"
200This document documents the libev software package.
201.PP
206The newest version of this document is also available as an html-formatted 202The newest version of this document is also available as an html-formatted
207web page you might find easier to navigate when reading it for the first 203web page you might find easier to navigate when reading it for the first
208time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. 204time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
209.PP 205.PP
206While this document tries to be as complete as possible in documenting
207libev, its usage and the rationale behind its design, it is not a tutorial
208on event-based programming, nor will it introduce event-based programming
209with libev.
210.PP
211Familarity with event based programming techniques in general is assumed
212throughout this document.
213.SH "ABOUT LIBEV"
214.IX Header "ABOUT LIBEV"
210Libev is an event loop: you register interest in certain events (such as a 215Libev is an event loop: you register interest in certain events (such as a
211file descriptor being readable or a timeout occurring), and it will manage 216file descriptor being readable or a timeout occurring), and it will manage
212these event sources and provide your program with events. 217these event sources and provide your program with events.
213.PP 218.PP
214To do this, it must take more or less complete control over your process 219To do this, it must take more or less complete control over your process
217.PP 222.PP
218You register interest in certain events by registering so-called \fIevent 223You register interest in certain events by registering so-called \fIevent
219watchers\fR, which are relatively small C structures you initialise with the 224watchers\fR, which are relatively small C structures you initialise with the
220details of the event, and then hand it over to libev by \fIstarting\fR the 225details of the event, and then hand it over to libev by \fIstarting\fR the
221watcher. 226watcher.
222.Sh "\s-1FEATURES\s0" 227.SS "\s-1FEATURES\s0"
223.IX Subsection "FEATURES" 228.IX Subsection "FEATURES"
224Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 229Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
225BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 230BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
226for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 231for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
227(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers 232(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
231\&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as 236\&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as
232file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events 237file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events
233(\f(CW\*(C`ev_fork\*(C'\fR). 238(\f(CW\*(C`ev_fork\*(C'\fR).
234.PP 239.PP
235It also is quite fast (see this 240It also is quite fast (see this
236benchmark comparing it to libevent 241<benchmark> comparing it to libevent
237for example). 242for example).
238.Sh "\s-1CONVENTIONS\s0" 243.SS "\s-1CONVENTIONS\s0"
239.IX Subsection "CONVENTIONS" 244.IX Subsection "CONVENTIONS"
240Libev is very configurable. In this manual the default (and most common) 245Libev is very configurable. In this manual the default (and most common)
241configuration will be described, which supports multiple event loops. For 246configuration will be described, which supports multiple event loops. For
242more info about various configuration options please have a look at 247more info about various configuration options please have a look at
243\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support 248\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
244for multiple event loops, then all functions taking an initial argument of 249for multiple event loops, then all functions taking an initial argument of
245name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have 250name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`ev_loop *\*(C'\fR) will not have
246this argument. 251this argument.
247.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0" 252.SS "\s-1TIME\s0 \s-1REPRESENTATION\s0"
248.IX Subsection "TIME REPRESENTATION" 253.IX Subsection "TIME REPRESENTATION"
249Libev represents time as a single floating point number, representing the 254Libev represents time as a single floating point number, representing
250(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 255the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere
251the beginning of 1970, details are complicated, don't ask). This type is 256near the beginning of 1970, details are complicated, don't ask). This
252called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases 257type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually
253to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on 258aliases to the \f(CW\*(C`double\*(C'\fR type in C. When you need to do any calculations
254it, you should treat it as some floating point value. Unlike the name 259on it, you should treat it as some floating point value. Unlike the name
255component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences 260component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences
256throughout libev. 261throughout libev.
257.SH "ERROR HANDLING" 262.SH "ERROR HANDLING"
258.IX Header "ERROR HANDLING" 263.IX Header "ERROR HANDLING"
259Libev knows three classes of errors: operating system errors, usage errors 264Libev knows three classes of errors: operating system errors, usage errors
406\& ... 411\& ...
407\& ev_set_syserr_cb (fatal_error); 412\& ev_set_syserr_cb (fatal_error);
408.Ve 413.Ve
409.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 414.SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
410.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 415.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
411An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two 416An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR
412types of such loops, the \fIdefault\fR loop, which supports signals and child 417is \fInot\fR optional in this case, as there is also an \f(CW\*(C`ev_loop\*(C'\fR
413events, and dynamically created loops which do not. 418\&\fIfunction\fR).
419.PP
420The library knows two types of such loops, the \fIdefault\fR loop, which
421supports signals and child events, and dynamically created loops which do
422not.
414.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 423.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
415.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 424.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
416This will initialise the default event loop if it hasn't been initialised 425This will initialise the default event loop if it hasn't been initialised
417yet and return it. If the default loop could not be initialised, returns 426yet and return it. If the default loop could not be initialised, returns
418false. If it already was initialised it simply returns it (and ignores the 427false. If it already was initialised it simply returns it (and ignores the
421If you don't know what event loop to use, use the one returned from this 430If you don't know what event loop to use, use the one returned from this
422function. 431function.
423.Sp 432.Sp
424Note that this function is \fInot\fR thread-safe, so if you want to use it 433Note that this function is \fInot\fR thread-safe, so if you want to use it
425from multiple threads, you have to lock (note also that this is unlikely, 434from multiple threads, you have to lock (note also that this is unlikely,
426as loops cannot bes hared easily between threads anyway). 435as loops cannot be shared easily between threads anyway).
427.Sp 436.Sp
428The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and 437The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and
429\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler 438\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler
430for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your application you can either 439for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your application you can either
431create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you 440create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you
506.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 515.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
507.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 516.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
508For few fds, this backend is a bit little slower than poll and select, 517For few fds, this backend is a bit little slower than poll and select,
509but it scales phenomenally better. While poll and select usually scale 518but it scales phenomenally better. While poll and select usually scale
510like O(total_fds) where n is the total number of fds (or the highest fd), 519like O(total_fds) where n is the total number of fds (or the highest fd),
511epoll scales either O(1) or O(active_fds). The epoll design has a number 520epoll scales either O(1) or O(active_fds).
512of shortcomings, such as silently dropping events in some hard-to-detect 521.Sp
513cases and requiring a system call per fd change, no fork support and bad 522The epoll mechanism deserves honorable mention as the most misdesigned
514support for dup. 523of the more advanced event mechanisms: mere annoyances include silently
524dropping file descriptors, requiring a system call per change per file
525descriptor (and unnecessary guessing of parameters), problems with dup and
526so on. The biggest issue is fork races, however \- if a program forks then
527\&\fIboth\fR parent and child process have to recreate the epoll set, which can
528take considerable time (one syscall per file descriptor) and is of course
529hard to detect.
530.Sp
531Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but
532of course \fIdoesn't\fR, and epoll just loves to report events for totally
533\&\fIdifferent\fR file descriptors (even already closed ones, so one cannot
534even remove them from the set) than registered in the set (especially
535on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by
536employing an additional generation counter and comparing that against the
537events to filter out spurious ones, recreating the set when required.
515.Sp 538.Sp
516While stopping, setting and starting an I/O watcher in the same iteration 539While stopping, setting and starting an I/O watcher in the same iteration
517will result in some caching, there is still a system call per such incident 540will result in some caching, there is still a system call per such
518(because the fd could point to a different file description now), so its 541incident (because the same \fIfile descriptor\fR could point to a different
519best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work 542\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed
520very well if you register events for both fds. 543file descriptors might not work very well if you register events for both
521.Sp 544file descriptors.
522Please note that epoll sometimes generates spurious notifications, so you
523need to use non-blocking I/O or other means to avoid blocking when no data
524(or space) is available.
525.Sp 545.Sp
526Best performance from this backend is achieved by not unregistering all 546Best performance from this backend is achieved by not unregistering all
527watchers for a file descriptor until it has been closed, if possible, 547watchers for a file descriptor until it has been closed, if possible,
528i.e. keep at least one watcher active per fd at all times. Stopping and 548i.e. keep at least one watcher active per fd at all times. Stopping and
529starting a watcher (without re-setting it) also usually doesn't cause 549starting a watcher (without re-setting it) also usually doesn't cause
530extra overhead. 550extra overhead. A fork can both result in spurious notifications as well
551as in libev having to destroy and recreate the epoll object, which can
552take considerable time and thus should be avoided.
553.Sp
554All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
555faster than epoll for maybe up to a hundred file descriptors, depending on
556the usage. So sad.
531.Sp 557.Sp
532While nominally embeddable in other event loops, this feature is broken in 558While nominally embeddable in other event loops, this feature is broken in
533all kernel versions tested so far. 559all kernel versions tested so far.
534.Sp 560.Sp
535This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 561This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
536\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 562\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
537.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 563.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
538.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 564.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
539.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 565.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
540Kqueue deserves special mention, as at the time of this writing, it was 566Kqueue deserves special mention, as at the time of this writing, it
541broken on all BSDs except NetBSD (usually it doesn't work reliably with 567was broken on all BSDs except NetBSD (usually it doesn't work reliably
542anything but sockets and pipes, except on Darwin, where of course it's 568with anything but sockets and pipes, except on Darwin, where of course
543completely useless). For this reason it's not being \*(L"auto-detected\*(R" unless 569it's completely useless). Unlike epoll, however, whose brokenness
544you explicitly specify it in the flags (i.e. using \f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or 570is by design, these kqueue bugs can (and eventually will) be fixed
545libev was compiled on a known-to-be-good (\-enough) system like NetBSD. 571without \s-1API\s0 changes to existing programs. For this reason it's not being
572\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using
573\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough)
574system like NetBSD.
546.Sp 575.Sp
547You still can embed kqueue into a normal poll or select backend and use it 576You still can embed kqueue into a normal poll or select backend and use it
548only for sockets (after having made sure that sockets work with kqueue on 577only for sockets (after having made sure that sockets work with kqueue on
549the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 578the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
550.Sp 579.Sp
551It scales in the same way as the epoll backend, but the interface to the 580It scales in the same way as the epoll backend, but the interface to the
552kernel is more efficient (which says nothing about its actual speed, of 581kernel is more efficient (which says nothing about its actual speed, of
553course). While stopping, setting and starting an I/O watcher does never 582course). While stopping, setting and starting an I/O watcher does never
554cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 583cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
555two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it 584two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but
556drops fds silently in similarly hard-to-detect cases. 585sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
586cases
557.Sp 587.Sp
558This backend usually performs well under most conditions. 588This backend usually performs well under most conditions.
559.Sp 589.Sp
560While nominally embeddable in other event loops, this doesn't work 590While nominally embeddable in other event loops, this doesn't work
561everywhere, so you might need to test for this. And since it is broken 591everywhere, so you might need to test for this. And since it is broken
562almost everywhere, you should only use it when you have a lot of sockets 592almost everywhere, you should only use it when you have a lot of sockets
563(for which it usually works), by embedding it into another event loop 593(for which it usually works), by embedding it into another event loop
564(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR) and, did I mention it, 594(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course
565using it only for sockets. 595also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets.
566.Sp 596.Sp
567This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 597This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
568\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with 598\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with
569\&\f(CW\*(C`NOTE_EOF\*(C'\fR. 599\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
570.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 600.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
590might perform better. 620might perform better.
591.Sp 621.Sp
592On the positive side, with the exception of the spurious readiness 622On the positive side, with the exception of the spurious readiness
593notifications, this backend actually performed fully to specification 623notifications, this backend actually performed fully to specification
594in all tests and is fully embeddable, which is a rare feat among the 624in all tests and is fully embeddable, which is a rare feat among the
595OS-specific backends. 625OS-specific backends (I vastly prefer correctness over speed hacks).
596.Sp 626.Sp
597This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 627This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
598\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 628\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
599.ie n .IP """EVBACKEND_ALL""" 4 629.ie n .IP """EVBACKEND_ALL""" 4
600.el .IP "\f(CWEVBACKEND_ALL\fR" 4 630.el .IP "\f(CWEVBACKEND_ALL\fR" 4
660responsibility to either stop all watchers cleanly yourself \fIbefore\fR 690responsibility to either stop all watchers cleanly yourself \fIbefore\fR
661calling this function, or cope with the fact afterwards (which is usually 691calling this function, or cope with the fact afterwards (which is usually
662the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them 692the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
663for example). 693for example).
664.Sp 694.Sp
665Note that certain global state, such as signal state, will not be freed by 695Note that certain global state, such as signal state (and installed signal
666this function, and related watchers (such as signal and child watchers) 696handlers), will not be freed by this function, and related watchers (such
667would need to be stopped manually. 697as signal and child watchers) would need to be stopped manually.
668.Sp 698.Sp
669In general it is not advisable to call this function except in the 699In general it is not advisable to call this function except in the
670rare occasion where you really need to free e.g. the signal handling 700rare occasion where you really need to free e.g. the signal handling
671pipe fds. If you need dynamically allocated loops it is better to use 701pipe fds. If you need dynamically allocated loops it is better to use
672\&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR). 702\&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR).
711happily wraps around with enough iterations. 741happily wraps around with enough iterations.
712.Sp 742.Sp
713This value can sometimes be useful as a generation counter of sorts (it 743This value can sometimes be useful as a generation counter of sorts (it
714\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with 744\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
715\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. 745\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls.
746.IP "unsigned int ev_loop_depth (loop)" 4
747.IX Item "unsigned int ev_loop_depth (loop)"
748Returns the number of times \f(CW\*(C`ev_loop\*(C'\fR was entered minus the number of
749times \f(CW\*(C`ev_loop\*(C'\fR was exited, in other words, the recursion depth.
750.Sp
751Outside \f(CW\*(C`ev_loop\*(C'\fR, this number is zero. In a callback, this number is
752\&\f(CW1\fR, unless \f(CW\*(C`ev_loop\*(C'\fR was invoked recursively (or from another thread),
753in which case it is higher.
754.Sp
755Leaving \f(CW\*(C`ev_loop\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread
756etc.), doesn't count as exit.
716.IP "unsigned int ev_backend (loop)" 4 757.IP "unsigned int ev_backend (loop)" 4
717.IX Item "unsigned int ev_backend (loop)" 758.IX Item "unsigned int ev_backend (loop)"
718Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 759Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
719use. 760use.
720.IP "ev_tstamp ev_now (loop)" 4 761.IP "ev_tstamp ev_now (loop)" 4
733This function is rarely useful, but when some event callback runs for a 774This function is rarely useful, but when some event callback runs for a
734very long time without entering the event loop, updating libev's idea of 775very long time without entering the event loop, updating libev's idea of
735the current time is a good idea. 776the current time is a good idea.
736.Sp 777.Sp
737See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section. 778See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section.
779.IP "ev_suspend (loop)" 4
780.IX Item "ev_suspend (loop)"
781.PD 0
782.IP "ev_resume (loop)" 4
783.IX Item "ev_resume (loop)"
784.PD
785These two functions suspend and resume a loop, for use when the loop is
786not used for a while and timeouts should not be processed.
787.Sp
788A typical use case would be an interactive program such as a game: When
789the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it
790would be best to handle timeouts as if no time had actually passed while
791the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR
792in your \f(CW\*(C`SIGTSTP\*(C'\fR handler, sending yourself a \f(CW\*(C`SIGSTOP\*(C'\fR and calling
793\&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing.
794.Sp
795Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend
796between \f(CW\*(C`ev_suspend\*(C'\fR and \f(CW\*(C`ev_resume\*(C'\fR, and all \f(CW\*(C`ev_periodic\*(C'\fR watchers
797will be rescheduled (that is, they will lose any events that would have
798occured while suspended).
799.Sp
800After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the
801given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
802without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
803.Sp
804Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
805event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
738.IP "ev_loop (loop, int flags)" 4 806.IP "ev_loop (loop, int flags)" 4
739.IX Item "ev_loop (loop, int flags)" 807.IX Item "ev_loop (loop, int flags)"
740Finally, this is it, the event handler. This function usually is called 808Finally, this is it, the event handler. This function usually is called
741after you initialised all your watchers and you want to start handling 809after you initialised all your watchers and you want to start handling
742events. 810events.
757the loop. 825the loop.
758.Sp 826.Sp
759A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if 827A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if
760necessary) and will handle those and any already outstanding ones. It 828necessary) and will handle those and any already outstanding ones. It
761will block your process until at least one new event arrives (which could 829will block your process until at least one new event arrives (which could
762be an event internal to libev itself, so there is no guarentee that a 830be an event internal to libev itself, so there is no guarantee that a
763user-registered callback will be called), and will return after one 831user-registered callback will be called), and will return after one
764iteration of the loop. 832iteration of the loop.
765.Sp 833.Sp
766This is useful if you are waiting for some external event in conjunction 834This is useful if you are waiting for some external event in conjunction
767with something not expressible using other libev watchers (i.e. "roll your 835with something not expressible using other libev watchers (i.e. "roll your
813has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 881has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
814\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or 882\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or
815\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. 883\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return.
816.Sp 884.Sp
817This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again. 885This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again.
886.Sp
887It is safe to call \f(CW\*(C`ev_unloop\*(C'\fR from otuside any \f(CW\*(C`ev_loop\*(C'\fR calls.
818.IP "ev_ref (loop)" 4 888.IP "ev_ref (loop)" 4
819.IX Item "ev_ref (loop)" 889.IX Item "ev_ref (loop)"
820.PD 0 890.PD 0
821.IP "ev_unref (loop)" 4 891.IP "ev_unref (loop)" 4
822.IX Item "ev_unref (loop)" 892.IX Item "ev_unref (loop)"
827.Sp 897.Sp
828If you have a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR 898If you have a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR
829from returning, call \fIev_unref()\fR after starting, and \fIev_ref()\fR before 899from returning, call \fIev_unref()\fR after starting, and \fIev_ref()\fR before
830stopping it. 900stopping it.
831.Sp 901.Sp
832As an example, libev itself uses this for its internal signal pipe: It is 902As an example, libev itself uses this for its internal signal pipe: It
833not visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting 903is not visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from
834if no event watchers registered by it are active. It is also an excellent 904exiting if no event watchers registered by it are active. It is also an
835way to do this for generic recurring timers or from within third-party 905excellent way to do this for generic recurring timers or from within
836libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR 906third-party libraries. Just remember to \fIunref after start\fR and \fIref
837(but only if the watcher wasn't active before, or was active before, 907before stop\fR (but only if the watcher wasn't active before, or was active
838respectively). 908before, respectively. Note also that libev might stop watchers itself
909(e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR
910in the callback).
839.Sp 911.Sp
840Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 912Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
841running when nothing else is active. 913running when nothing else is active.
842.Sp 914.Sp
843.Vb 4 915.Vb 4
844\& struct ev_signal exitsig; 916\& ev_signal exitsig;
845\& ev_signal_init (&exitsig, sig_cb, SIGINT); 917\& ev_signal_init (&exitsig, sig_cb, SIGINT);
846\& ev_signal_start (loop, &exitsig); 918\& ev_signal_start (loop, &exitsig);
847\& evf_unref (loop); 919\& evf_unref (loop);
848.Ve 920.Ve
849.Sp 921.Sp
877.Sp 949.Sp
878By setting a higher \fIio collect interval\fR you allow libev to spend more 950By setting a higher \fIio collect interval\fR you allow libev to spend more
879time collecting I/O events, so you can handle more events per iteration, 951time collecting I/O events, so you can handle more events per iteration,
880at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and 952at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
881\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will 953\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will
882introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. 954introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The
955sleep time ensures that libev will not poll for I/O events more often then
956once per this interval, on average.
883.Sp 957.Sp
884Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 958Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
885to spend more time collecting timeouts, at the expense of increased 959to spend more time collecting timeouts, at the expense of increased
886latency/jitter/inexactness (the watcher callback will be called 960latency/jitter/inexactness (the watcher callback will be called
887later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null 961later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null
889.Sp 963.Sp
890Many (busy) programs can usually benefit by setting the I/O collect 964Many (busy) programs can usually benefit by setting the I/O collect
891interval to a value near \f(CW0.1\fR or so, which is often enough for 965interval to a value near \f(CW0.1\fR or so, which is often enough for
892interactive servers (of course not for games), likewise for timeouts. It 966interactive servers (of course not for games), likewise for timeouts. It
893usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, 967usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR,
894as this approaches the timing granularity of most systems. 968as this approaches the timing granularity of most systems. Note that if
969you do transactions with the outside world and you can't increase the
970parallelity, then this setting will limit your transaction rate (if you
971need to poll once per transaction and the I/O collect interval is 0.01,
972then you can't do more than 100 transations per second).
895.Sp 973.Sp
896Setting the \fItimeout collect interval\fR can improve the opportunity for 974Setting the \fItimeout collect interval\fR can improve the opportunity for
897saving power, as the program will \*(L"bundle\*(R" timer callback invocations that 975saving power, as the program will \*(L"bundle\*(R" timer callback invocations that
898are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of 976are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of
899times the process sleeps and wakes up again. Another useful technique to 977times the process sleeps and wakes up again. Another useful technique to
900reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure 978reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure
901they fire on, say, one-second boundaries only. 979they fire on, say, one-second boundaries only.
980.Sp
981Example: we only need 0.1s timeout granularity, and we wish not to poll
982more often than 100 times per second:
983.Sp
984.Vb 2
985\& ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
986\& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
987.Ve
988.IP "ev_invoke_pending (loop)" 4
989.IX Item "ev_invoke_pending (loop)"
990This call will simply invoke all pending watchers while resetting their
991pending state. Normally, \f(CW\*(C`ev_loop\*(C'\fR does this automatically when required,
992but when overriding the invoke callback this call comes handy.
993.IP "int ev_pending_count (loop)" 4
994.IX Item "int ev_pending_count (loop)"
995Returns the number of pending watchers \- zero indicates that no watchers
996are pending.
997.IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4
998.IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))"
999This overrides the invoke pending functionality of the loop: Instead of
1000invoking all pending watchers when there are any, \f(CW\*(C`ev_loop\*(C'\fR will call
1001this callback instead. This is useful, for example, when you want to
1002invoke the actual watchers inside another context (another thread etc.).
1003.Sp
1004If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1005callback.
1006.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4
1007.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))"
1008Sometimes you want to share the same loop between multiple threads. This
1009can be done relatively simply by putting mutex_lock/unlock calls around
1010each call to a libev function.
1011.Sp
1012However, \f(CW\*(C`ev_loop\*(C'\fR can run an indefinite time, so it is not feasible to
1013wait for it to return. One way around this is to wake up the loop via
1014\&\f(CW\*(C`ev_unloop\*(C'\fR and \f(CW\*(C`av_async_send\*(C'\fR, another way is to set these \fIrelease\fR
1015and \fIacquire\fR callbacks on the loop.
1016.Sp
1017When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is
1018suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just
1019afterwards.
1020.Sp
1021Ideally, \f(CW\*(C`release\*(C'\fR will just call your mutex_unlock function, and
1022\&\f(CW\*(C`acquire\*(C'\fR will just call the mutex_lock function again.
1023.Sp
1024While event loop modifications are allowed between invocations of
1025\&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no
1026modifications done will affect the event loop, i.e. adding watchers will
1027have no effect on the set of file descriptors being watched, or the time
1028waited. USe an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_loop\*(C'\fR when you want it
1029to take note of any changes you made.
1030.Sp
1031In theory, threads executing \f(CW\*(C`ev_loop\*(C'\fR will be async-cancel safe between
1032invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR.
1033.Sp
1034See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this
1035document.
1036.IP "ev_set_userdata (loop, void *data)" 4
1037.IX Item "ev_set_userdata (loop, void *data)"
1038.PD 0
1039.IP "ev_userdata (loop)" 4
1040.IX Item "ev_userdata (loop)"
1041.PD
1042Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When
1043\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns
1044\&\f(CW0.\fR
1045.Sp
1046These two functions can be used to associate arbitrary data with a loop,
1047and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and
1048\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for
1049any other purpose as well.
902.IP "ev_loop_verify (loop)" 4 1050.IP "ev_loop_verify (loop)" 4
903.IX Item "ev_loop_verify (loop)" 1051.IX Item "ev_loop_verify (loop)"
904This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been 1052This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been
905compiled in. which is the default for non-minimal builds. It tries to go 1053compiled in, which is the default for non-minimal builds. It tries to go
906through all internal structures and checks them for validity. If anything 1054through all internal structures and checks them for validity. If anything
907is found to be inconsistent, it will print an error message to standard 1055is found to be inconsistent, it will print an error message to standard
908error and call \f(CW\*(C`abort ()\*(C'\fR. 1056error and call \f(CW\*(C`abort ()\*(C'\fR.
909.Sp 1057.Sp
910This can be used to catch bugs inside libev itself: under normal 1058This can be used to catch bugs inside libev itself: under normal
911circumstances, this function will never abort as of course libev keeps its 1059circumstances, this function will never abort as of course libev keeps its
912data structures consistent. 1060data structures consistent.
913.SH "ANATOMY OF A WATCHER" 1061.SH "ANATOMY OF A WATCHER"
914.IX Header "ANATOMY OF A WATCHER" 1062.IX Header "ANATOMY OF A WATCHER"
1063In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the
1064watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer
1065watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers.
1066.PP
915A watcher is a structure that you create and register to record your 1067A watcher is a structure that you create and register to record your
916interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 1068interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to
917become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: 1069become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that:
918.PP 1070.PP
919.Vb 5 1071.Vb 5
920\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1072\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
921\& { 1073\& {
922\& ev_io_stop (w); 1074\& ev_io_stop (w);
923\& ev_unloop (loop, EVUNLOOP_ALL); 1075\& ev_unloop (loop, EVUNLOOP_ALL);
924\& } 1076\& }
925\& 1077\&
926\& struct ev_loop *loop = ev_default_loop (0); 1078\& struct ev_loop *loop = ev_default_loop (0);
1079\&
927\& struct ev_io stdin_watcher; 1080\& ev_io stdin_watcher;
1081\&
928\& ev_init (&stdin_watcher, my_cb); 1082\& ev_init (&stdin_watcher, my_cb);
929\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 1083\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
930\& ev_io_start (loop, &stdin_watcher); 1084\& ev_io_start (loop, &stdin_watcher);
1085\&
931\& ev_loop (loop, 0); 1086\& ev_loop (loop, 0);
932.Ve 1087.Ve
933.PP 1088.PP
934As you can see, you are responsible for allocating the memory for your 1089As you can see, you are responsible for allocating the memory for your
935watcher structures (and it is usually a bad idea to do this on the stack, 1090watcher structures (and it is \fIusually\fR a bad idea to do this on the
936although this can sometimes be quite valid). 1091stack).
1092.PP
1093Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR
1094or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs).
937.PP 1095.PP
938Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init 1096Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init
939(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This 1097(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This
940callback gets invoked each time the event occurs (or, in the case of I/O 1098callback gets invoked each time the event occurs (or, in the case of I/O
941watchers, each time the event loop detects that the file descriptor given 1099watchers, each time the event loop detects that the file descriptor given
942is readable and/or writable). 1100is readable and/or writable).
943.PP 1101.PP
944Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro 1102Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR
945with arguments specific to this watcher type. There is also a macro 1103macro to configure it, with arguments specific to the watcher type. There
946to combine initialisation and setting in one call: \f(CW\*(C`ev_<type>_init 1104is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR.
947(watcher *, callback, ...)\*(C'\fR.
948.PP 1105.PP
949To make the watcher actually watch out for events, you have to start it 1106To make the watcher actually watch out for events, you have to start it
950with a watcher-specific start function (\f(CW\*(C`ev_<type>_start (loop, watcher 1107with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher
951*)\*(C'\fR), and you can stop watching for events at any time by calling the 1108*)\*(C'\fR), and you can stop watching for events at any time by calling the
952corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. 1109corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR.
953.PP 1110.PP
954As long as your watcher is active (has been started but not stopped) you 1111As long as your watcher is active (has been started but not stopped) you
955must not touch the values stored in it. Most specifically you must never 1112must not touch the values stored in it. Most specifically you must never
956reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro. 1113reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro.
957.PP 1114.PP
958Each and every callback receives the event loop pointer as first, the 1115Each and every callback receives the event loop pointer as first, the
959registered watcher structure as second, and a bitset of received events as 1116registered watcher structure as second, and a bitset of received events as
960third argument. 1117third argument.
961.PP 1118.PP
1022\&\f(CW\*(C`ev_fork\*(C'\fR). 1179\&\f(CW\*(C`ev_fork\*(C'\fR).
1023.ie n .IP """EV_ASYNC""" 4 1180.ie n .IP """EV_ASYNC""" 4
1024.el .IP "\f(CWEV_ASYNC\fR" 4 1181.el .IP "\f(CWEV_ASYNC\fR" 4
1025.IX Item "EV_ASYNC" 1182.IX Item "EV_ASYNC"
1026The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). 1183The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
1184.ie n .IP """EV_CUSTOM""" 4
1185.el .IP "\f(CWEV_CUSTOM\fR" 4
1186.IX Item "EV_CUSTOM"
1187Not ever sent (or otherwise used) by libev itself, but can be freely used
1188by libev users to signal watchers (e.g. via \f(CW\*(C`ev_feed_event\*(C'\fR).
1027.ie n .IP """EV_ERROR""" 4 1189.ie n .IP """EV_ERROR""" 4
1028.el .IP "\f(CWEV_ERROR\fR" 4 1190.el .IP "\f(CWEV_ERROR\fR" 4
1029.IX Item "EV_ERROR" 1191.IX Item "EV_ERROR"
1030An unspecified error has occurred, the watcher has been stopped. This might 1192An unspecified error has occurred, the watcher has been stopped. This might
1031happen because the watcher could not be properly started because libev 1193happen because the watcher could not be properly started because libev
1032ran out of memory, a file descriptor was found to be closed or any other 1194ran out of memory, a file descriptor was found to be closed or any other
1195problem. Libev considers these application bugs.
1196.Sp
1033problem. You best act on it by reporting the problem and somehow coping 1197You best act on it by reporting the problem and somehow coping with the
1034with the watcher being stopped. 1198watcher being stopped. Note that well-written programs should not receive
1199an error ever, so when your watcher receives it, this usually indicates a
1200bug in your program.
1035.Sp 1201.Sp
1036Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1202Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
1037example it might indicate that a fd is readable or writable, and if your 1203example it might indicate that a fd is readable or writable, and if your
1038callbacks is well-written it can just attempt the operation and cope with 1204callbacks is well-written it can just attempt the operation and cope with
1039the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1205the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
1040programs, though, as the fd could already be closed and reused for another 1206programs, though, as the fd could already be closed and reused for another
1041thing, so beware. 1207thing, so beware.
1042.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1208.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
1043.IX Subsection "GENERIC WATCHER FUNCTIONS" 1209.IX Subsection "GENERIC WATCHER FUNCTIONS"
1044In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type,
1045e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers.
1046.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1210.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1047.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1211.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1048.IX Item "ev_init (ev_TYPE *watcher, callback)" 1212.IX Item "ev_init (ev_TYPE *watcher, callback)"
1049This macro initialises the generic portion of a watcher. The contents 1213This macro initialises the generic portion of a watcher. The contents
1050of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only 1214of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only
1054which rolls both calls into one. 1218which rolls both calls into one.
1055.Sp 1219.Sp
1056You can reinitialise a watcher at any time as long as it has been stopped 1220You can reinitialise a watcher at any time as long as it has been stopped
1057(or never started) and there are no pending events outstanding. 1221(or never started) and there are no pending events outstanding.
1058.Sp 1222.Sp
1059The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, 1223The callback is always of type \f(CW\*(C`void (*)(struct ev_loop *loop, ev_TYPE *watcher,
1060int revents)\*(C'\fR. 1224int revents)\*(C'\fR.
1061.Sp 1225.Sp
1062Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps. 1226Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps.
1063.Sp 1227.Sp
1064.Vb 3 1228.Vb 3
1104\& ev_io_start (EV_DEFAULT_UC, &w); 1268\& ev_io_start (EV_DEFAULT_UC, &w);
1105.Ve 1269.Ve
1106.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 1270.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4
1107.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 1271.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4
1108.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" 1272.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)"
1109Stops the given watcher again (if active) and clears the pending 1273Stops the given watcher if active, and clears the pending status (whether
1274the watcher was active or not).
1275.Sp
1110status. It is possible that stopped watchers are pending (for example, 1276It is possible that stopped watchers are pending \- for example,
1111non-repeating timers are being stopped when they become pending), but 1277non-repeating timers are being stopped when they become pending \- but
1112\&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If 1278calling \f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor
1113you want to free or reuse the memory used by the watcher it is therefore a 1279pending. If you want to free or reuse the memory used by the watcher it is
1114good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. 1280therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
1115.IP "bool ev_is_active (ev_TYPE *watcher)" 4 1281.IP "bool ev_is_active (ev_TYPE *watcher)" 4
1116.IX Item "bool ev_is_active (ev_TYPE *watcher)" 1282.IX Item "bool ev_is_active (ev_TYPE *watcher)"
1117Returns a true value iff the watcher is active (i.e. it has been started 1283Returns a true value iff the watcher is active (i.e. it has been started
1118and not yet been stopped). As long as a watcher is active you must not modify 1284and not yet been stopped). As long as a watcher is active you must not modify
1119it. 1285it.
1142integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR 1308integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
1143(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked 1309(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
1144before watchers with lower priority, but priority will not keep watchers 1310before watchers with lower priority, but priority will not keep watchers
1145from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). 1311from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
1146.Sp 1312.Sp
1147This means that priorities are \fIonly\fR used for ordering callback
1148invocation after new events have been received. This is useful, for
1149example, to reduce latency after idling, or more often, to bind two
1150watchers on the same event and make sure one is called first.
1151.Sp
1152If you need to suppress invocation when higher priority events are pending 1313If you need to suppress invocation when higher priority events are pending
1153you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. 1314you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
1154.Sp 1315.Sp
1155You \fImust not\fR change the priority of a watcher as long as it is active or 1316You \fImust not\fR change the priority of a watcher as long as it is active or
1156pending. 1317pending.
1157.Sp 1318.Sp
1319Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
1320fine, as long as you do not mind that the priority value you query might
1321or might not have been clamped to the valid range.
1322.Sp
1158The default priority used by watchers when no priority has been set is 1323The default priority used by watchers when no priority has been set is
1159always \f(CW0\fR, which is supposed to not be too high and not be too low :). 1324always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1160.Sp 1325.Sp
1161Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is 1326See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of
1162fine, as long as you do not mind that the priority value you query might 1327priorities.
1163or might not have been adjusted to be within valid range.
1164.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1328.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1165.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1329.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1166Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1330Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1167\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1331\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1168can deal with that fact, as both are simply passed through to the 1332can deal with that fact, as both are simply passed through to the
1173returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the 1337returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
1174watcher isn't pending it does nothing and returns \f(CW0\fR. 1338watcher isn't pending it does nothing and returns \f(CW0\fR.
1175.Sp 1339.Sp
1176Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its 1340Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its
1177callback to be invoked, which can be accomplished with this function. 1341callback to be invoked, which can be accomplished with this function.
1178.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 1342.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
1179.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 1343.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
1180Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 1344Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
1181and read at any time: libev will completely ignore it. This can be used 1345and read at any time: libev will completely ignore it. This can be used
1182to associate arbitrary data with your watcher. If you need more data and 1346to associate arbitrary data with your watcher. If you need more data and
1183don't want to allocate memory and store a pointer to it in that data 1347don't want to allocate memory and store a pointer to it in that data
1185data: 1349data:
1186.PP 1350.PP
1187.Vb 7 1351.Vb 7
1188\& struct my_io 1352\& struct my_io
1189\& { 1353\& {
1190\& struct ev_io io; 1354\& ev_io io;
1191\& int otherfd; 1355\& int otherfd;
1192\& void *somedata; 1356\& void *somedata;
1193\& struct whatever *mostinteresting; 1357\& struct whatever *mostinteresting;
1194\& }; 1358\& };
1195\& 1359\&
1200.PP 1364.PP
1201And since your callback will be called with a pointer to the watcher, you 1365And since your callback will be called with a pointer to the watcher, you
1202can cast it back to your own type: 1366can cast it back to your own type:
1203.PP 1367.PP
1204.Vb 5 1368.Vb 5
1205\& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) 1369\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1206\& { 1370\& {
1207\& struct my_io *w = (struct my_io *)w_; 1371\& struct my_io *w = (struct my_io *)w_;
1208\& ... 1372\& ...
1209\& } 1373\& }
1210.Ve 1374.Ve
1232.PP 1396.PP
1233.Vb 1 1397.Vb 1
1234\& #include <stddef.h> 1398\& #include <stddef.h>
1235\& 1399\&
1236\& static void 1400\& static void
1237\& t1_cb (EV_P_ struct ev_timer *w, int revents) 1401\& t1_cb (EV_P_ ev_timer *w, int revents)
1238\& { 1402\& {
1239\& struct my_biggy big = (struct my_biggy * 1403\& struct my_biggy big = (struct my_biggy *)
1240\& (((char *)w) \- offsetof (struct my_biggy, t1)); 1404\& (((char *)w) \- offsetof (struct my_biggy, t1));
1241\& } 1405\& }
1242\& 1406\&
1243\& static void 1407\& static void
1244\& t2_cb (EV_P_ struct ev_timer *w, int revents) 1408\& t2_cb (EV_P_ ev_timer *w, int revents)
1245\& { 1409\& {
1246\& struct my_biggy big = (struct my_biggy * 1410\& struct my_biggy big = (struct my_biggy *)
1247\& (((char *)w) \- offsetof (struct my_biggy, t2)); 1411\& (((char *)w) \- offsetof (struct my_biggy, t2));
1248\& } 1412\& }
1249.Ve 1413.Ve
1414.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0"
1415.IX Subsection "WATCHER PRIORITY MODELS"
1416Many event loops support \fIwatcher priorities\fR, which are usually small
1417integers that influence the ordering of event callback invocation
1418between watchers in some way, all else being equal.
1419.PP
1420In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1421description for the more technical details such as the actual priority
1422range.
1423.PP
1424There are two common ways how these these priorities are being interpreted
1425by event loops:
1426.PP
1427In the more common lock-out model, higher priorities \*(L"lock out\*(R" invocation
1428of lower priority watchers, which means as long as higher priority
1429watchers receive events, lower priority watchers are not being invoked.
1430.PP
1431The less common only-for-ordering model uses priorities solely to order
1432callback invocation within a single event loop iteration: Higher priority
1433watchers are invoked before lower priority ones, but they all get invoked
1434before polling for new events.
1435.PP
1436Libev uses the second (only-for-ordering) model for all its watchers
1437except for idle watchers (which use the lock-out model).
1438.PP
1439The rationale behind this is that implementing the lock-out model for
1440watchers is not well supported by most kernel interfaces, and most event
1441libraries will just poll for the same events again and again as long as
1442their callbacks have not been executed, which is very inefficient in the
1443common case of one high-priority watcher locking out a mass of lower
1444priority ones.
1445.PP
1446Static (ordering) priorities are most useful when you have two or more
1447watchers handling the same resource: a typical usage example is having an
1448\&\f(CW\*(C`ev_io\*(C'\fR watcher to receive data, and an associated \f(CW\*(C`ev_timer\*(C'\fR to handle
1449timeouts. Under load, data might be received while the program handles
1450other jobs, but since timers normally get invoked first, the timeout
1451handler will be executed before checking for data. In that case, giving
1452the timer a lower priority than the I/O watcher ensures that I/O will be
1453handled first even under adverse conditions (which is usually, but not
1454always, what you want).
1455.PP
1456Since idle watchers use the \*(L"lock-out\*(R" model, meaning that idle watchers
1457will only be executed when no same or higher priority watchers have
1458received events, they can be used to implement the \*(L"lock-out\*(R" model when
1459required.
1460.PP
1461For example, to emulate how many other event libraries handle priorities,
1462you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in
1463the normal watcher callback, you just start the idle watcher. The real
1464processing is done in the idle watcher callback. This causes libev to
1465continously poll and process kernel event data for the watcher, but when
1466the lock-out case is known to be rare (which in turn is rare :), this is
1467workable.
1468.PP
1469Usually, however, the lock-out model implemented that way will perform
1470miserably under the type of load it was designed to handle. In that case,
1471it might be preferable to stop the real watcher before starting the
1472idle watcher, so the kernel will not have to process the event in case
1473the actual processing will be delayed for considerable time.
1474.PP
1475Here is an example of an I/O watcher that should run at a strictly lower
1476priority than the default, and which should only process data when no
1477other events are pending:
1478.PP
1479.Vb 2
1480\& ev_idle idle; // actual processing watcher
1481\& ev_io io; // actual event watcher
1482\&
1483\& static void
1484\& io_cb (EV_P_ ev_io *w, int revents)
1485\& {
1486\& // stop the I/O watcher, we received the event, but
1487\& // are not yet ready to handle it.
1488\& ev_io_stop (EV_A_ w);
1489\&
1490\& // start the idle watcher to ahndle the actual event.
1491\& // it will not be executed as long as other watchers
1492\& // with the default priority are receiving events.
1493\& ev_idle_start (EV_A_ &idle);
1494\& }
1495\&
1496\& static void
1497\& idle_cb (EV_P_ ev_idle *w, int revents)
1498\& {
1499\& // actual processing
1500\& read (STDIN_FILENO, ...);
1501\&
1502\& // have to start the I/O watcher again, as
1503\& // we have handled the event
1504\& ev_io_start (EV_P_ &io);
1505\& }
1506\&
1507\& // initialisation
1508\& ev_idle_init (&idle, idle_cb);
1509\& ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1510\& ev_io_start (EV_DEFAULT_ &io);
1511.Ve
1512.PP
1513In the \*(L"real\*(R" world, it might also be beneficial to start a timer, so that
1514low-priority connections can not be locked out forever under load. This
1515enables your program to keep a lower latency for important connections
1516during short periods of high load, while not completely locking out less
1517important ones.
1250.SH "WATCHER TYPES" 1518.SH "WATCHER TYPES"
1251.IX Header "WATCHER TYPES" 1519.IX Header "WATCHER TYPES"
1252This section describes each watcher in detail, but will not repeat 1520This section describes each watcher in detail, but will not repeat
1253information given in the last section. Any initialisation/set macros, 1521information given in the last section. Any initialisation/set macros,
1254functions and members specific to the watcher type are explained. 1522functions and members specific to the watcher type are explained.
1259watcher is stopped to your hearts content), or \fI[read\-write]\fR, which 1527watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1260means you can expect it to have some sensible content while the watcher 1528means you can expect it to have some sensible content while the watcher
1261is active, but you can also modify it. Modifying it may not do something 1529is active, but you can also modify it. Modifying it may not do something
1262sensible or take immediate effect (or do anything at all), but libev will 1530sensible or take immediate effect (or do anything at all), but libev will
1263not crash or malfunction in any way. 1531not crash or malfunction in any way.
1264.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" 1532.ie n .SS """ev_io"" \- is this file descriptor readable or writable?"
1265.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" 1533.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?"
1266.IX Subsection "ev_io - is this file descriptor readable or writable?" 1534.IX Subsection "ev_io - is this file descriptor readable or writable?"
1267I/O watchers check whether a file descriptor is readable or writable 1535I/O watchers check whether a file descriptor is readable or writable
1268in each iteration of the event loop, or, more precisely, when reading 1536in each iteration of the event loop, or, more precisely, when reading
1269would not block the process and writing would at least be able to write 1537would not block the process and writing would at least be able to write
1270some data. This behaviour is called level-triggering because you keep 1538some data. This behaviour is called level-triggering because you keep
1277descriptors to non-blocking mode is also usually a good idea (but not 1545descriptors to non-blocking mode is also usually a good idea (but not
1278required if you know what you are doing). 1546required if you know what you are doing).
1279.PP 1547.PP
1280If you cannot use non-blocking mode, then force the use of a 1548If you cannot use non-blocking mode, then force the use of a
1281known-to-be-good backend (at the time of this writing, this includes only 1549known-to-be-good backend (at the time of this writing, this includes only
1282\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1550\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR). The same applies to file
1551descriptors for which non-blocking operation makes no sense (such as
1552files) \- libev doesn't guarentee any specific behaviour in that case.
1283.PP 1553.PP
1284Another thing you have to watch out for is that it is quite easy to 1554Another thing you have to watch out for is that it is quite easy to
1285receive \*(L"spurious\*(R" readiness notifications, that is your callback might 1555receive \*(L"spurious\*(R" readiness notifications, that is your callback might
1286be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block 1556be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
1287because there is no data. Not only are some backends known to create a 1557because there is no data. Not only are some backends known to create a
1383readable, but only once. Since it is likely line-buffered, you could 1653readable, but only once. Since it is likely line-buffered, you could
1384attempt to read a whole line in the callback. 1654attempt to read a whole line in the callback.
1385.PP 1655.PP
1386.Vb 6 1656.Vb 6
1387\& static void 1657\& static void
1388\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1658\& stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1389\& { 1659\& {
1390\& ev_io_stop (loop, w); 1660\& ev_io_stop (loop, w);
1391\& .. read from stdin here (or from w\->fd) and handle any I/O errors 1661\& .. read from stdin here (or from w\->fd) and handle any I/O errors
1392\& } 1662\& }
1393\& 1663\&
1394\& ... 1664\& ...
1395\& struct ev_loop *loop = ev_default_init (0); 1665\& struct ev_loop *loop = ev_default_init (0);
1396\& struct ev_io stdin_readable; 1666\& ev_io stdin_readable;
1397\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1667\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1398\& ev_io_start (loop, &stdin_readable); 1668\& ev_io_start (loop, &stdin_readable);
1399\& ev_loop (loop, 0); 1669\& ev_loop (loop, 0);
1400.Ve 1670.Ve
1401.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" 1671.ie n .SS """ev_timer"" \- relative and optionally repeating timeouts"
1402.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" 1672.el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
1403.IX Subsection "ev_timer - relative and optionally repeating timeouts" 1673.IX Subsection "ev_timer - relative and optionally repeating timeouts"
1404Timer watchers are simple relative timers that generate an event after a 1674Timer watchers are simple relative timers that generate an event after a
1405given time, and optionally repeating in regular intervals after that. 1675given time, and optionally repeating in regular intervals after that.
1406.PP 1676.PP
1407The timers are based on real time, that is, if you register an event that 1677The timers are based on real time, that is, if you register an event that
1409year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because 1679year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because
1410detecting time jumps is hard, and some inaccuracies are unavoidable (the 1680detecting time jumps is hard, and some inaccuracies are unavoidable (the
1411monotonic clock option helps a lot here). 1681monotonic clock option helps a lot here).
1412.PP 1682.PP
1413The callback is guaranteed to be invoked only \fIafter\fR its timeout has 1683The callback is guaranteed to be invoked only \fIafter\fR its timeout has
1414passed, but if multiple timers become ready during the same loop iteration 1684passed (not \fIat\fR, so on systems with very low-resolution clocks this
1415then order of execution is undefined. 1685might introduce a small delay). If multiple timers become ready during the
1686same loop iteration then the ones with earlier time-out values are invoked
1687before ones of the same priority with later time-out values (but this is
1688no longer true when a callback calls \f(CW\*(C`ev_loop\*(C'\fR recursively).
1689.PP
1690\fIBe smart about timeouts\fR
1691.IX Subsection "Be smart about timeouts"
1692.PP
1693Many real-world problems involve some kind of timeout, usually for error
1694recovery. A typical example is an \s-1HTTP\s0 request \- if the other side hangs,
1695you want to raise some error after a while.
1696.PP
1697What follows are some ways to handle this problem, from obvious and
1698inefficient to smart and efficient.
1699.PP
1700In the following, a 60 second activity timeout is assumed \- a timeout that
1701gets reset to 60 seconds each time there is activity (e.g. each time some
1702data or other life sign was received).
1703.IP "1. Use a timer and stop, reinitialise and start it on activity." 4
1704.IX Item "1. Use a timer and stop, reinitialise and start it on activity."
1705This is the most obvious, but not the most simple way: In the beginning,
1706start the watcher:
1707.Sp
1708.Vb 2
1709\& ev_timer_init (timer, callback, 60., 0.);
1710\& ev_timer_start (loop, timer);
1711.Ve
1712.Sp
1713Then, each time there is some activity, \f(CW\*(C`ev_timer_stop\*(C'\fR it, initialise it
1714and start it again:
1715.Sp
1716.Vb 3
1717\& ev_timer_stop (loop, timer);
1718\& ev_timer_set (timer, 60., 0.);
1719\& ev_timer_start (loop, timer);
1720.Ve
1721.Sp
1722This is relatively simple to implement, but means that each time there is
1723some activity, libev will first have to remove the timer from its internal
1724data structure and then add it again. Libev tries to be fast, but it's
1725still not a constant-time operation.
1726.ie n .IP "2. Use a timer and re-start it with ""ev_timer_again"" inactivity." 4
1727.el .IP "2. Use a timer and re-start it with \f(CWev_timer_again\fR inactivity." 4
1728.IX Item "2. Use a timer and re-start it with ev_timer_again inactivity."
1729This is the easiest way, and involves using \f(CW\*(C`ev_timer_again\*(C'\fR instead of
1730\&\f(CW\*(C`ev_timer_start\*(C'\fR.
1731.Sp
1732To implement this, configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value
1733of \f(CW60\fR and then call \f(CW\*(C`ev_timer_again\*(C'\fR at start and each time you
1734successfully read or write some data. If you go into an idle state where
1735you do not expect data to travel on the socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR
1736the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will automatically restart it if need be.
1737.Sp
1738That means you can ignore both the \f(CW\*(C`ev_timer_start\*(C'\fR function and the
1739\&\f(CW\*(C`after\*(C'\fR argument to \f(CW\*(C`ev_timer_set\*(C'\fR, and only ever use the \f(CW\*(C`repeat\*(C'\fR
1740member and \f(CW\*(C`ev_timer_again\*(C'\fR.
1741.Sp
1742At start:
1743.Sp
1744.Vb 3
1745\& ev_init (timer, callback);
1746\& timer\->repeat = 60.;
1747\& ev_timer_again (loop, timer);
1748.Ve
1749.Sp
1750Each time there is some activity:
1751.Sp
1752.Vb 1
1753\& ev_timer_again (loop, timer);
1754.Ve
1755.Sp
1756It is even possible to change the time-out on the fly, regardless of
1757whether the watcher is active or not:
1758.Sp
1759.Vb 2
1760\& timer\->repeat = 30.;
1761\& ev_timer_again (loop, timer);
1762.Ve
1763.Sp
1764This is slightly more efficient then stopping/starting the timer each time
1765you want to modify its timeout value, as libev does not have to completely
1766remove and re-insert the timer from/into its internal data structure.
1767.Sp
1768It is, however, even simpler than the \*(L"obvious\*(R" way to do it.
1769.IP "3. Let the timer time out, but then re-arm it as required." 4
1770.IX Item "3. Let the timer time out, but then re-arm it as required."
1771This method is more tricky, but usually most efficient: Most timeouts are
1772relatively long compared to the intervals between other activity \- in
1773our example, within 60 seconds, there are usually many I/O events with
1774associated activity resets.
1775.Sp
1776In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone,
1777but remember the time of last activity, and check for a real timeout only
1778within the callback:
1779.Sp
1780.Vb 1
1781\& ev_tstamp last_activity; // time of last activity
1782\&
1783\& static void
1784\& callback (EV_P_ ev_timer *w, int revents)
1785\& {
1786\& ev_tstamp now = ev_now (EV_A);
1787\& ev_tstamp timeout = last_activity + 60.;
1788\&
1789\& // if last_activity + 60. is older than now, we did time out
1790\& if (timeout < now)
1791\& {
1792\& // timeout occured, take action
1793\& }
1794\& else
1795\& {
1796\& // callback was invoked, but there was some activity, re\-arm
1797\& // the watcher to fire in last_activity + 60, which is
1798\& // guaranteed to be in the future, so "again" is positive:
1799\& w\->repeat = timeout \- now;
1800\& ev_timer_again (EV_A_ w);
1801\& }
1802\& }
1803.Ve
1804.Sp
1805To summarise the callback: first calculate the real timeout (defined
1806as \*(L"60 seconds after the last activity\*(R"), then check if that time has
1807been reached, which means something \fIdid\fR, in fact, time out. Otherwise
1808the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so
1809re-schedule the timer to fire at that future time, to see if maybe we have
1810a timeout then.
1811.Sp
1812Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the
1813\&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running.
1814.Sp
1815This scheme causes more callback invocations (about one every 60 seconds
1816minus half the average time between activity), but virtually no calls to
1817libev to change the timeout.
1818.Sp
1819To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR
1820to the current time (meaning we just have some activity :), then call the
1821callback, which will \*(L"do the right thing\*(R" and start the timer:
1822.Sp
1823.Vb 3
1824\& ev_init (timer, callback);
1825\& last_activity = ev_now (loop);
1826\& callback (loop, timer, EV_TIMEOUT);
1827.Ve
1828.Sp
1829And when there is some activity, simply store the current time in
1830\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all:
1831.Sp
1832.Vb 1
1833\& last_actiivty = ev_now (loop);
1834.Ve
1835.Sp
1836This technique is slightly more complex, but in most cases where the
1837time-out is unlikely to be triggered, much more efficient.
1838.Sp
1839Changing the timeout is trivial as well (if it isn't hard-coded in the
1840callback :) \- just change the timeout and invoke the callback, which will
1841fix things for you.
1842.IP "4. Wee, just use a double-linked list for your timeouts." 4
1843.IX Item "4. Wee, just use a double-linked list for your timeouts."
1844If there is not one request, but many thousands (millions...), all
1845employing some kind of timeout with the same timeout value, then one can
1846do even better:
1847.Sp
1848When starting the timeout, calculate the timeout value and put the timeout
1849at the \fIend\fR of the list.
1850.Sp
1851Then use an \f(CW\*(C`ev_timer\*(C'\fR to fire when the timeout at the \fIbeginning\fR of
1852the list is expected to fire (for example, using the technique #3).
1853.Sp
1854When there is some activity, remove the timer from the list, recalculate
1855the timeout, append it to the end of the list again, and make sure to
1856update the \f(CW\*(C`ev_timer\*(C'\fR if it was taken from the beginning of the list.
1857.Sp
1858This way, one can manage an unlimited number of timeouts in O(1) time for
1859starting, stopping and updating the timers, at the expense of a major
1860complication, and having to use a constant timeout. The constant timeout
1861ensures that the list stays sorted.
1862.PP
1863So which method the best?
1864.PP
1865Method #2 is a simple no-brain-required solution that is adequate in most
1866situations. Method #3 requires a bit more thinking, but handles many cases
1867better, and isn't very complicated either. In most case, choosing either
1868one is fine, with #3 being better in typical situations.
1869.PP
1870Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1871rather complicated, but extremely efficient, something that really pays
1872off after the first million or so of active timers, i.e. it's usually
1873overkill :)
1416.PP 1874.PP
1417\fIThe special problem of time updates\fR 1875\fIThe special problem of time updates\fR
1418.IX Subsection "The special problem of time updates" 1876.IX Subsection "The special problem of time updates"
1419.PP 1877.PP
1420Establishing the current time is a costly operation (it usually takes at 1878Establishing the current time is a costly operation (it usually takes at
1434.Ve 1892.Ve
1435.PP 1893.PP
1436If the event loop is suspended for a long time, you can also force an 1894If the event loop is suspended for a long time, you can also force an
1437update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 1895update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
1438()\*(C'\fR. 1896()\*(C'\fR.
1897.PP
1898\fIThe special problems of suspended animation\fR
1899.IX Subsection "The special problems of suspended animation"
1900.PP
1901When you leave the server world it is quite customary to hit machines that
1902can suspend/hibernate \- what happens to the clocks during such a suspend?
1903.PP
1904Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1905all processes, while the clocks (\f(CW\*(C`times\*(C'\fR, \f(CW\*(C`CLOCK_MONOTONIC\*(C'\fR) continue
1906to run until the system is suspended, but they will not advance while the
1907system is suspended. That means, on resume, it will be as if the program
1908was frozen for a few seconds, but the suspend time will not be counted
1909towards \f(CW\*(C`ev_timer\*(C'\fR when a monotonic clock source is used. The real time
1910clock advanced as expected, but if it is used as sole clocksource, then a
1911long suspend would be detected as a time jump by libev, and timers would
1912be adjusted accordingly.
1913.PP
1914I would not be surprised to see different behaviour in different between
1915operating systems, \s-1OS\s0 versions or even different hardware.
1916.PP
1917The other form of suspend (job control, or sending a \s-1SIGSTOP\s0) will see a
1918time jump in the monotonic clocks and the realtime clock. If the program
1919is suspended for a very long time, and monotonic clock sources are in use,
1920then you can expect \f(CW\*(C`ev_timer\*(C'\fRs to expire as the full suspension time
1921will be counted towards the timers. When no monotonic clock source is in
1922use, then libev will again assume a timejump and adjust accordingly.
1923.PP
1924It might be beneficial for this latter case to call \f(CW\*(C`ev_suspend\*(C'\fR
1925and \f(CW\*(C`ev_resume\*(C'\fR in code that handles \f(CW\*(C`SIGTSTP\*(C'\fR, to at least get
1926deterministic behaviour in this case (you can do nothing against
1927\&\f(CW\*(C`SIGSTOP\*(C'\fR).
1439.PP 1928.PP
1440\fIWatcher-Specific Functions and Data Members\fR 1929\fIWatcher-Specific Functions and Data Members\fR
1441.IX Subsection "Watcher-Specific Functions and Data Members" 1930.IX Subsection "Watcher-Specific Functions and Data Members"
1442.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 1931.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
1443.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 1932.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
1466If the timer is started but non-repeating, stop it (as if it timed out). 1955If the timer is started but non-repeating, stop it (as if it timed out).
1467.Sp 1956.Sp
1468If the timer is repeating, either start it if necessary (with the 1957If the timer is repeating, either start it if necessary (with the
1469\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 1958\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
1470.Sp 1959.Sp
1471This sounds a bit complicated, but here is a useful and typical 1960This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a
1472example: Imagine you have a \s-1TCP\s0 connection and you want a so-called idle 1961usage example.
1473timeout, that is, you want to be called when there have been, say, 60 1962.IP "ev_timer_remaining (loop, ev_timer *)" 4
1474seconds of inactivity on the socket. The easiest way to do this is to 1963.IX Item "ev_timer_remaining (loop, ev_timer *)"
1475configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call 1964Returns the remaining time until a timer fires. If the timer is active,
1476\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If 1965then this time is relative to the current event loop time, otherwise it's
1477you go into an idle state where you do not expect data to travel on the 1966the timeout value currently configured.
1478socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
1479automatically restart it if need be.
1480.Sp 1967.Sp
1481That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR 1968That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns
1482altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: 1969\&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remain\*(C'\fR
1483.Sp 1970will return \f(CW4\fR. When the timer expires and is restarted, it will return
1484.Vb 8 1971roughly \f(CW7\fR (likely slightly less as callback invocation takes some time,
1485\& ev_timer_init (timer, callback, 0., 5.); 1972too), and so on.
1486\& ev_timer_again (loop, timer);
1487\& ...
1488\& timer\->again = 17.;
1489\& ev_timer_again (loop, timer);
1490\& ...
1491\& timer\->again = 10.;
1492\& ev_timer_again (loop, timer);
1493.Ve
1494.Sp
1495This is more slightly efficient then stopping/starting the timer each time
1496you want to modify its timeout value.
1497.Sp
1498Note, however, that it is often even more efficient to remember the
1499time of the last activity and let the timer time-out naturally. In the
1500callback, you then check whether the time-out is real, or, if there was
1501some activity, you reschedule the watcher to time-out in \*(L"last_activity +
1502timeout \- ev_now ()\*(R" seconds.
1503.IP "ev_tstamp repeat [read\-write]" 4 1973.IP "ev_tstamp repeat [read\-write]" 4
1504.IX Item "ev_tstamp repeat [read-write]" 1974.IX Item "ev_tstamp repeat [read-write]"
1505The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 1975The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1506or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any), 1976or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any),
1507which is also when any modifications are taken into account. 1977which is also when any modifications are taken into account.
1511.PP 1981.PP
1512Example: Create a timer that fires after 60 seconds. 1982Example: Create a timer that fires after 60 seconds.
1513.PP 1983.PP
1514.Vb 5 1984.Vb 5
1515\& static void 1985\& static void
1516\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1986\& one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1517\& { 1987\& {
1518\& .. one minute over, w is actually stopped right here 1988\& .. one minute over, w is actually stopped right here
1519\& } 1989\& }
1520\& 1990\&
1521\& struct ev_timer mytimer; 1991\& ev_timer mytimer;
1522\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1992\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1523\& ev_timer_start (loop, &mytimer); 1993\& ev_timer_start (loop, &mytimer);
1524.Ve 1994.Ve
1525.PP 1995.PP
1526Example: Create a timeout timer that times out after 10 seconds of 1996Example: Create a timeout timer that times out after 10 seconds of
1527inactivity. 1997inactivity.
1528.PP 1998.PP
1529.Vb 5 1999.Vb 5
1530\& static void 2000\& static void
1531\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 2001\& timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1532\& { 2002\& {
1533\& .. ten seconds without any activity 2003\& .. ten seconds without any activity
1534\& } 2004\& }
1535\& 2005\&
1536\& struct ev_timer mytimer; 2006\& ev_timer mytimer;
1537\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 2007\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1538\& ev_timer_again (&mytimer); /* start timer */ 2008\& ev_timer_again (&mytimer); /* start timer */
1539\& ev_loop (loop, 0); 2009\& ev_loop (loop, 0);
1540\& 2010\&
1541\& // and in some piece of code that gets executed on any "activity": 2011\& // and in some piece of code that gets executed on any "activity":
1542\& // reset the timeout to start ticking again at 10 seconds 2012\& // reset the timeout to start ticking again at 10 seconds
1543\& ev_timer_again (&mytimer); 2013\& ev_timer_again (&mytimer);
1544.Ve 2014.Ve
1545.ie n .Sh """ev_periodic"" \- to cron or not to cron?" 2015.ie n .SS """ev_periodic"" \- to cron or not to cron?"
1546.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" 2016.el .SS "\f(CWev_periodic\fP \- to cron or not to cron?"
1547.IX Subsection "ev_periodic - to cron or not to cron?" 2017.IX Subsection "ev_periodic - to cron or not to cron?"
1548Periodic watchers are also timers of a kind, but they are very versatile 2018Periodic watchers are also timers of a kind, but they are very versatile
1549(and unfortunately a bit complex). 2019(and unfortunately a bit complex).
1550.PP 2020.PP
1551Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 2021Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
1552but on wall clock time (absolute time). You can tell a periodic watcher 2022relative time, the physical time that passes) but on wall clock time
1553to trigger after some specific point in time. For example, if you tell a 2023(absolute time, the thing you can read on your calender or clock). The
1554periodic watcher to trigger in 10 seconds (by specifying e.g. \f(CW\*(C`ev_now () 2024difference is that wall clock time can run faster or slower than real
1555+ 10.\*(C'\fR, that is, an absolute time not a delay) and then reset your system 2025time, and time jumps are not uncommon (e.g. when you adjust your
1556clock to January of the previous year, then it will take more than year 2026wrist-watch).
1557to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would still trigger
1558roughly 10 seconds later as it uses a relative timeout).
1559.PP 2027.PP
2028You can tell a periodic watcher to trigger after some specific point
2029in time: for example, if you tell a periodic watcher to trigger \*(L"in 10
2030seconds\*(R" (by specifying e.g. \f(CW\*(C`ev_now () + 10.\*(C'\fR, that is, an absolute time
2031not a delay) and then reset your system clock to January of the previous
2032year, then it will take a year or more to trigger the event (unlike an
2033\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2034it, as it uses a relative timeout).
2035.PP
1560\&\f(CW\*(C`ev_periodic\*(C'\fRs can also be used to implement vastly more complex timers, 2036\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
1561such as triggering an event on each \*(L"midnight, local time\*(R", or other 2037timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
1562complicated rules. 2038other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as
2039those cannot react to time jumps.
1563.PP 2040.PP
1564As with timers, the callback is guaranteed to be invoked only when the 2041As with timers, the callback is guaranteed to be invoked only when the
1565time (\f(CW\*(C`at\*(C'\fR) has passed, but if multiple periodic timers become ready 2042point in time where it is supposed to trigger has passed. If multiple
1566during the same loop iteration, then order of execution is undefined. 2043timers become ready during the same loop iteration then the ones with
2044earlier time-out values are invoked before ones with later time-out values
2045(but this is no longer true when a callback calls \f(CW\*(C`ev_loop\*(C'\fR recursively).
1567.PP 2046.PP
1568\fIWatcher-Specific Functions and Data Members\fR 2047\fIWatcher-Specific Functions and Data Members\fR
1569.IX Subsection "Watcher-Specific Functions and Data Members" 2048.IX Subsection "Watcher-Specific Functions and Data Members"
1570.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 2049.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1571.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 2050.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1572.PD 0 2051.PD 0
1573.IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 2052.IP "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4
1574.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 2053.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)"
1575.PD 2054.PD
1576Lots of arguments, lets sort it out... There are basically three modes of 2055Lots of arguments, let's sort it out... There are basically three modes of
1577operation, and we will explain them from simplest to most complex: 2056operation, and we will explain them from simplest to most complex:
1578.RS 4 2057.RS 4
1579.IP "\(bu" 4 2058.IP "\(bu" 4
1580absolute timer (at = time, interval = reschedule_cb = 0) 2059absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1581.Sp 2060.Sp
1582In this configuration the watcher triggers an event after the wall clock 2061In this configuration the watcher triggers an event after the wall clock
1583time \f(CW\*(C`at\*(C'\fR has passed. It will not repeat and will not adjust when a time 2062time \f(CW\*(C`offset\*(C'\fR has passed. It will not repeat and will not adjust when a
1584jump occurs, that is, if it is to be run at January 1st 2011 then it will 2063time jump occurs, that is, if it is to be run at January 1st 2011 then it
1585only run when the system clock reaches or surpasses this time. 2064will be stopped and invoked when the system clock reaches or surpasses
2065this point in time.
1586.IP "\(bu" 4 2066.IP "\(bu" 4
1587repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 2067repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1588.Sp 2068.Sp
1589In this mode the watcher will always be scheduled to time out at the next 2069In this mode the watcher will always be scheduled to time out at the next
1590\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) 2070\&\f(CW\*(C`offset + N * interval\*(C'\fR time (for some integer N, which can also be
1591and then repeat, regardless of any time jumps. 2071negative) and then repeat, regardless of any time jumps. The \f(CW\*(C`offset\*(C'\fR
2072argument is merely an offset into the \f(CW\*(C`interval\*(C'\fR periods.
1592.Sp 2073.Sp
1593This can be used to create timers that do not drift with respect to the 2074This can be used to create timers that do not drift with respect to the
1594system clock, for example, here is a \f(CW\*(C`ev_periodic\*(C'\fR that triggers each 2075system clock, for example, here is an \f(CW\*(C`ev_periodic\*(C'\fR that triggers each
1595hour, on the hour: 2076hour, on the hour (with respect to \s-1UTC\s0):
1596.Sp 2077.Sp
1597.Vb 1 2078.Vb 1
1598\& ev_periodic_set (&periodic, 0., 3600., 0); 2079\& ev_periodic_set (&periodic, 0., 3600., 0);
1599.Ve 2080.Ve
1600.Sp 2081.Sp
1603full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible 2084full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible
1604by 3600. 2085by 3600.
1605.Sp 2086.Sp
1606Another way to think about it (for the mathematically inclined) is that 2087Another way to think about it (for the mathematically inclined) is that
1607\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 2088\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
1608time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 2089time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps.
1609.Sp 2090.Sp
1610For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near 2091For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near
1611\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 2092\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
1612this value, and in fact is often specified as zero. 2093this value, and in fact is often specified as zero.
1613.Sp 2094.Sp
1614Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 2095Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
1615speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability 2096speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
1616will of course deteriorate. Libev itself tries to be exact to be about one 2097will of course deteriorate. Libev itself tries to be exact to be about one
1617millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). 2098millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
1618.IP "\(bu" 4 2099.IP "\(bu" 4
1619manual reschedule mode (at and interval ignored, reschedule_cb = callback) 2100manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1620.Sp 2101.Sp
1621In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 2102In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
1622ignored. Instead, each time the periodic watcher gets scheduled, the 2103ignored. Instead, each time the periodic watcher gets scheduled, the
1623reschedule callback will be called with the watcher as first, and the 2104reschedule callback will be called with the watcher as first, and the
1624current time as second argument. 2105current time as second argument.
1625.Sp 2106.Sp
1626\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, 2107\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever,
1627ever, or make \s-1ANY\s0 event loop modifications whatsoever\fR. 2108or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2109allowed by documentation here\fR.
1628.Sp 2110.Sp
1629If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2111If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
1630it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2112it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
1631only event loop modification you are allowed to do). 2113only event loop modification you are allowed to do).
1632.Sp 2114.Sp
1633The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic 2115The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(ev_periodic
1634*w, ev_tstamp now)\*(C'\fR, e.g.: 2116*w, ev_tstamp now)\*(C'\fR, e.g.:
1635.Sp 2117.Sp
1636.Vb 4 2118.Vb 5
2119\& static ev_tstamp
1637\& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 2120\& my_rescheduler (ev_periodic *w, ev_tstamp now)
1638\& { 2121\& {
1639\& return now + 60.; 2122\& return now + 60.;
1640\& } 2123\& }
1641.Ve 2124.Ve
1642.Sp 2125.Sp
1662when you changed some parameters or the reschedule callback would return 2145when you changed some parameters or the reschedule callback would return
1663a different time than the last time it was called (e.g. in a crond like 2146a different time than the last time it was called (e.g. in a crond like
1664program when the crontabs have changed). 2147program when the crontabs have changed).
1665.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4 2148.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4
1666.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)" 2149.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)"
1667When active, returns the absolute time that the watcher is supposed to 2150When active, returns the absolute time that the watcher is supposed
1668trigger next. 2151to trigger next. This is not the same as the \f(CW\*(C`offset\*(C'\fR argument to
2152\&\f(CW\*(C`ev_periodic_set\*(C'\fR, but indeed works even in interval and manual
2153rescheduling modes.
1669.IP "ev_tstamp offset [read\-write]" 4 2154.IP "ev_tstamp offset [read\-write]" 4
1670.IX Item "ev_tstamp offset [read-write]" 2155.IX Item "ev_tstamp offset [read-write]"
1671When repeating, this contains the offset value, otherwise this is the 2156When repeating, this contains the offset value, otherwise this is the
1672absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). 2157absolute point in time (the \f(CW\*(C`offset\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR,
2158although libev might modify this value for better numerical stability).
1673.Sp 2159.Sp
1674Can be modified any time, but changes only take effect when the periodic 2160Can be modified any time, but changes only take effect when the periodic
1675timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. 2161timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1676.IP "ev_tstamp interval [read\-write]" 4 2162.IP "ev_tstamp interval [read\-write]" 4
1677.IX Item "ev_tstamp interval [read-write]" 2163.IX Item "ev_tstamp interval [read-write]"
1678The current interval value. Can be modified any time, but changes only 2164The current interval value. Can be modified any time, but changes only
1679take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being 2165take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
1680called. 2166called.
1681.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 2167.IP "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read\-write]" 4
1682.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" 2168.IX Item "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]"
1683The current reschedule callback, or \f(CW0\fR, if this functionality is 2169The current reschedule callback, or \f(CW0\fR, if this functionality is
1684switched off. Can be changed any time, but changes only take effect when 2170switched off. Can be changed any time, but changes only take effect when
1685the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. 2171the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1686.PP 2172.PP
1687\fIExamples\fR 2173\fIExamples\fR
1691system time is divisible by 3600. The callback invocation times have 2177system time is divisible by 3600. The callback invocation times have
1692potentially a lot of jitter, but good long-term stability. 2178potentially a lot of jitter, but good long-term stability.
1693.PP 2179.PP
1694.Vb 5 2180.Vb 5
1695\& static void 2181\& static void
1696\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 2182\& clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1697\& { 2183\& {
1698\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 2184\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1699\& } 2185\& }
1700\& 2186\&
1701\& struct ev_periodic hourly_tick; 2187\& ev_periodic hourly_tick;
1702\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 2188\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1703\& ev_periodic_start (loop, &hourly_tick); 2189\& ev_periodic_start (loop, &hourly_tick);
1704.Ve 2190.Ve
1705.PP 2191.PP
1706Example: The same as above, but use a reschedule callback to do it: 2192Example: The same as above, but use a reschedule callback to do it:
1707.PP 2193.PP
1708.Vb 1 2194.Vb 1
1709\& #include <math.h> 2195\& #include <math.h>
1710\& 2196\&
1711\& static ev_tstamp 2197\& static ev_tstamp
1712\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 2198\& my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1713\& { 2199\& {
1714\& return now + (3600. \- fmod (now, 3600.)); 2200\& return now + (3600. \- fmod (now, 3600.));
1715\& } 2201\& }
1716\& 2202\&
1717\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 2203\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1718.Ve 2204.Ve
1719.PP 2205.PP
1720Example: Call a callback every hour, starting now: 2206Example: Call a callback every hour, starting now:
1721.PP 2207.PP
1722.Vb 4 2208.Vb 4
1723\& struct ev_periodic hourly_tick; 2209\& ev_periodic hourly_tick;
1724\& ev_periodic_init (&hourly_tick, clock_cb, 2210\& ev_periodic_init (&hourly_tick, clock_cb,
1725\& fmod (ev_now (loop), 3600.), 3600., 0); 2211\& fmod (ev_now (loop), 3600.), 3600., 0);
1726\& ev_periodic_start (loop, &hourly_tick); 2212\& ev_periodic_start (loop, &hourly_tick);
1727.Ve 2213.Ve
1728.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" 2214.ie n .SS """ev_signal"" \- signal me when a signal gets signalled!"
1729.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" 2215.el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1730.IX Subsection "ev_signal - signal me when a signal gets signalled!" 2216.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1731Signal watchers will trigger an event when the process receives a specific 2217Signal watchers will trigger an event when the process receives a specific
1732signal one or more times. Even though signals are very asynchronous, libev 2218signal one or more times. Even though signals are very asynchronous, libev
1733will try it's best to deliver signals synchronously, i.e. as part of the 2219will try it's best to deliver signals synchronously, i.e. as part of the
1734normal event processing, like any other event. 2220normal event processing, like any other event.
1765The signal the watcher watches out for. 2251The signal the watcher watches out for.
1766.PP 2252.PP
1767\fIExamples\fR 2253\fIExamples\fR
1768.IX Subsection "Examples" 2254.IX Subsection "Examples"
1769.PP 2255.PP
1770Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 2256Example: Try to exit cleanly on \s-1SIGINT\s0.
1771.PP 2257.PP
1772.Vb 5 2258.Vb 5
1773\& static void 2259\& static void
1774\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 2260\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1775\& { 2261\& {
1776\& ev_unloop (loop, EVUNLOOP_ALL); 2262\& ev_unloop (loop, EVUNLOOP_ALL);
1777\& } 2263\& }
1778\& 2264\&
1779\& struct ev_signal signal_watcher; 2265\& ev_signal signal_watcher;
1780\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 2266\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1781\& ev_signal_start (loop, &sigint_cb); 2267\& ev_signal_start (loop, &signal_watcher);
1782.Ve 2268.Ve
1783.ie n .Sh """ev_child"" \- watch out for process status changes" 2269.ie n .SS """ev_child"" \- watch out for process status changes"
1784.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 2270.el .SS "\f(CWev_child\fP \- watch out for process status changes"
1785.IX Subsection "ev_child - watch out for process status changes" 2271.IX Subsection "ev_child - watch out for process status changes"
1786Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 2272Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1787some child status changes (most typically when a child of yours dies or 2273some child status changes (most typically when a child of yours dies or
1788exits). It is permissible to install a child watcher \fIafter\fR the child 2274exits). It is permissible to install a child watcher \fIafter\fR the child
1789has been forked (which implies it might have already exited), as long 2275has been forked (which implies it might have already exited), as long
1790as the event loop isn't entered (or is continued from a watcher), i.e., 2276as the event loop isn't entered (or is continued from a watcher), i.e.,
1791forking and then immediately registering a watcher for the child is fine, 2277forking and then immediately registering a watcher for the child is fine,
1792but forking and registering a watcher a few event loop iterations later is 2278but forking and registering a watcher a few event loop iterations later or
1793not. 2279in the next callback invocation is not.
1794.PP 2280.PP
1795Only the default event loop is capable of handling signals, and therefore 2281Only the default event loop is capable of handling signals, and therefore
1796you can only register child watchers in the default event loop. 2282you can only register child watchers in the default event loop.
2283.PP
2284Due to some design glitches inside libev, child watchers will always be
2285handled at maximum priority (their priority is set to \f(CW\*(C`EV_MAXPRI\*(C'\fR by
2286libev)
1797.PP 2287.PP
1798\fIProcess Interaction\fR 2288\fIProcess Interaction\fR
1799.IX Subsection "Process Interaction" 2289.IX Subsection "Process Interaction"
1800.PP 2290.PP
1801Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is 2291Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
1859.PP 2349.PP
1860.Vb 1 2350.Vb 1
1861\& ev_child cw; 2351\& ev_child cw;
1862\& 2352\&
1863\& static void 2353\& static void
1864\& child_cb (EV_P_ struct ev_child *w, int revents) 2354\& child_cb (EV_P_ ev_child *w, int revents)
1865\& { 2355\& {
1866\& ev_child_stop (EV_A_ w); 2356\& ev_child_stop (EV_A_ w);
1867\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus); 2357\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1868\& } 2358\& }
1869\& 2359\&
1880\& { 2370\& {
1881\& ev_child_init (&cw, child_cb, pid, 0); 2371\& ev_child_init (&cw, child_cb, pid, 0);
1882\& ev_child_start (EV_DEFAULT_ &cw); 2372\& ev_child_start (EV_DEFAULT_ &cw);
1883\& } 2373\& }
1884.Ve 2374.Ve
1885.ie n .Sh """ev_stat"" \- did the file attributes just change?" 2375.ie n .SS """ev_stat"" \- did the file attributes just change?"
1886.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" 2376.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
1887.IX Subsection "ev_stat - did the file attributes just change?" 2377.IX Subsection "ev_stat - did the file attributes just change?"
1888This watches a file system path for attribute changes. That is, it calls 2378This watches a file system path for attribute changes. That is, it calls
1889\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed 2379\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
1890compared to the last time, invoking the callback if it did. 2380and sees if it changed compared to the last time, invoking the callback if
2381it did.
1891.PP 2382.PP
1892The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2383The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
1893not exist\*(R" is a status change like any other. The condition \*(L"path does 2384not exist\*(R" is a status change like any other. The condition \*(L"path does not
1894not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is 2385exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
1895otherwise always forced to be at least one) and all the other fields of 2386\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
1896the stat buffer having unspecified contents. 2387least one) and all the other fields of the stat buffer having unspecified
2388contents.
1897.PP 2389.PP
1898The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is 2390The path \fImust not\fR end in a slash or contain special components such as
2391\&\f(CW\*(C`.\*(C'\fR or \f(CW\*(C`..\*(C'\fR. The path \fIshould\fR be absolute: If it is relative and
1899relative and your working directory changes, the behaviour is undefined. 2392your working directory changes, then the behaviour is undefined.
1900.PP 2393.PP
1901Since there is no standard kernel interface to do this, the portable 2394Since there is no portable change notification interface available, the
1902implementation simply calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if 2395portable implementation simply calls \f(CWstat(2)\fR regularly on the path
1903it changed somehow. You can specify a recommended polling interval for 2396to see if it changed somehow. You can specify a recommended polling
1904this case. If you specify a polling interval of \f(CW0\fR (highly recommended!) 2397interval for this case. If you specify a polling interval of \f(CW0\fR (highly
1905then a \fIsuitable, unspecified default\fR value will be used (which 2398recommended!) then a \fIsuitable, unspecified default\fR value will be used
1906you can expect to be around five seconds, although this might change 2399(which you can expect to be around five seconds, although this might
1907dynamically). Libev will also impose a minimum interval which is currently 2400change dynamically). Libev will also impose a minimum interval which is
1908around \f(CW0.1\fR, but thats usually overkill. 2401currently around \f(CW0.1\fR, but that's usually overkill.
1909.PP 2402.PP
1910This watcher type is not meant for massive numbers of stat watchers, 2403This watcher type is not meant for massive numbers of stat watchers,
1911as even with OS-supported change notifications, this can be 2404as even with OS-supported change notifications, this can be
1912resource-intensive. 2405resource-intensive.
1913.PP 2406.PP
1914At the time of this writing, the only OS-specific interface implemented 2407At the time of this writing, the only OS-specific interface implemented
1915is the Linux inotify interface (implementing kqueue support is left as 2408is the Linux inotify interface (implementing kqueue support is left as an
1916an exercise for the reader. Note, however, that the author sees no way 2409exercise for the reader. Note, however, that the author sees no way of
1917of implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue). 2410implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue, except as a hint).
1918.PP 2411.PP
1919\fI\s-1ABI\s0 Issues (Largefile Support)\fR 2412\fI\s-1ABI\s0 Issues (Largefile Support)\fR
1920.IX Subsection "ABI Issues (Largefile Support)" 2413.IX Subsection "ABI Issues (Largefile Support)"
1921.PP 2414.PP
1922Libev by default (unless the user overrides this) uses the default 2415Libev by default (unless the user overrides this) uses the default
1924support disabled by default, you get the 32 bit version of the stat 2417support disabled by default, you get the 32 bit version of the stat
1925structure. When using the library from programs that change the \s-1ABI\s0 to 2418structure. When using the library from programs that change the \s-1ABI\s0 to
1926use 64 bit file offsets the programs will fail. In that case you have to 2419use 64 bit file offsets the programs will fail. In that case you have to
1927compile libev with the same flags to get binary compatibility. This is 2420compile libev with the same flags to get binary compatibility. This is
1928obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2421obviously the case with any flags that change the \s-1ABI\s0, but the problem is
1929most noticeably disabled with ev_stat and large file support. 2422most noticeably displayed with ev_stat and large file support.
1930.PP 2423.PP
1931The solution for this is to lobby your distribution maker to make large 2424The solution for this is to lobby your distribution maker to make large
1932file interfaces available by default (as e.g. FreeBSD does) and not 2425file interfaces available by default (as e.g. FreeBSD does) and not
1933optional. Libev cannot simply switch on large file support because it has 2426optional. Libev cannot simply switch on large file support because it has
1934to exchange stat structures with application programs compiled using the 2427to exchange stat structures with application programs compiled using the
1935default compilation environment. 2428default compilation environment.
1936.PP 2429.PP
1937\fIInotify and Kqueue\fR 2430\fIInotify and Kqueue\fR
1938.IX Subsection "Inotify and Kqueue" 2431.IX Subsection "Inotify and Kqueue"
1939.PP 2432.PP
1940When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only 2433When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev and present at
1941available with Linux) and present at runtime, it will be used to speed up 2434runtime, it will be used to speed up change detection where possible. The
1942change detection where possible. The inotify descriptor will be created lazily 2435inotify descriptor will be created lazily when the first \f(CW\*(C`ev_stat\*(C'\fR
1943when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started. 2436watcher is being started.
1944.PP 2437.PP
1945Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers 2438Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
1946except that changes might be detected earlier, and in some cases, to avoid 2439except that changes might be detected earlier, and in some cases, to avoid
1947making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support 2440making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support
1948there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling, 2441there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling,
1949but as long as the path exists, libev usually gets away without polling. 2442but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
2443many bugs), the path exists (i.e. stat succeeds), and the path resides on
2444a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
2445xfs are fully working) libev usually gets away without polling.
1950.PP 2446.PP
1951There is no support for kqueue, as apparently it cannot be used to 2447There is no support for kqueue, as apparently it cannot be used to
1952implement this functionality, due to the requirement of having a file 2448implement this functionality, due to the requirement of having a file
1953descriptor open on the object at all times, and detecting renames, unlinks 2449descriptor open on the object at all times, and detecting renames, unlinks
1954etc. is difficult. 2450etc. is difficult.
1955.PP 2451.PP
2452\fI\f(CI\*(C`stat ()\*(C'\fI is a synchronous operation\fR
2453.IX Subsection "stat () is a synchronous operation"
2454.PP
2455Libev doesn't normally do any kind of I/O itself, and so is not blocking
2456the process. The exception are \f(CW\*(C`ev_stat\*(C'\fR watchers \- those call \f(CW\*(C`stat
2457()\*(C'\fR, which is a synchronous operation.
2458.PP
2459For local paths, this usually doesn't matter: unless the system is very
2460busy or the intervals between stat's are large, a stat call will be fast,
2461as the path data is usually in memory already (except when starting the
2462watcher).
2463.PP
2464For networked file systems, calling \f(CW\*(C`stat ()\*(C'\fR can block an indefinite
2465time due to network issues, and even under good conditions, a stat call
2466often takes multiple milliseconds.
2467.PP
2468Therefore, it is best to avoid using \f(CW\*(C`ev_stat\*(C'\fR watchers on networked
2469paths, although this is fully supported by libev.
2470.PP
1956\fIThe special problem of stat time resolution\fR 2471\fIThe special problem of stat time resolution\fR
1957.IX Subsection "The special problem of stat time resolution" 2472.IX Subsection "The special problem of stat time resolution"
1958.PP 2473.PP
1959The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably, and 2474The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably,
1960even on systems where the resolution is higher, most file systems still 2475and even on systems where the resolution is higher, most file systems
1961only support whole seconds. 2476still only support whole seconds.
1962.PP 2477.PP
1963That means that, if the time is the only thing that changes, you can 2478That means that, if the time is the only thing that changes, you can
1964easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and 2479easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and
1965calls your callback, which does something. When there is another update 2480calls your callback, which does something. When there is another update
1966within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the 2481within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the
2080\& ... 2595\& ...
2081\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); 2596\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
2082\& ev_stat_start (loop, &passwd); 2597\& ev_stat_start (loop, &passwd);
2083\& ev_timer_init (&timer, timer_cb, 0., 1.02); 2598\& ev_timer_init (&timer, timer_cb, 0., 1.02);
2084.Ve 2599.Ve
2085.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 2600.ie n .SS """ev_idle"" \- when you've got nothing better to do..."
2086.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 2601.el .SS "\f(CWev_idle\fP \- when you've got nothing better to do..."
2087.IX Subsection "ev_idle - when you've got nothing better to do..." 2602.IX Subsection "ev_idle - when you've got nothing better to do..."
2088Idle watchers trigger events when no other events of the same or higher 2603Idle watchers trigger events when no other events of the same or higher
2089priority are pending (prepare, check and other idle watchers do not count 2604priority are pending (prepare, check and other idle watchers do not count
2090as receiving \*(L"events\*(R"). 2605as receiving \*(L"events\*(R").
2091.PP 2606.PP
2104\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the 2619\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2105event loop has handled all outstanding events. 2620event loop has handled all outstanding events.
2106.PP 2621.PP
2107\fIWatcher-Specific Functions and Data Members\fR 2622\fIWatcher-Specific Functions and Data Members\fR
2108.IX Subsection "Watcher-Specific Functions and Data Members" 2623.IX Subsection "Watcher-Specific Functions and Data Members"
2109.IP "ev_idle_init (ev_signal *, callback)" 4 2624.IP "ev_idle_init (ev_idle *, callback)" 4
2110.IX Item "ev_idle_init (ev_signal *, callback)" 2625.IX Item "ev_idle_init (ev_idle *, callback)"
2111Initialises and configures the idle watcher \- it has no parameters of any 2626Initialises and configures the idle watcher \- it has no parameters of any
2112kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 2627kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
2113believe me. 2628believe me.
2114.PP 2629.PP
2115\fIExamples\fR 2630\fIExamples\fR
2118Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 2633Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
2119callback, free it. Also, use no error checking, as usual. 2634callback, free it. Also, use no error checking, as usual.
2120.PP 2635.PP
2121.Vb 7 2636.Vb 7
2122\& static void 2637\& static void
2123\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 2638\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2124\& { 2639\& {
2125\& free (w); 2640\& free (w);
2126\& // now do something you wanted to do when the program has 2641\& // now do something you wanted to do when the program has
2127\& // no longer anything immediate to do. 2642\& // no longer anything immediate to do.
2128\& } 2643\& }
2129\& 2644\&
2130\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 2645\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2131\& ev_idle_init (idle_watcher, idle_cb); 2646\& ev_idle_init (idle_watcher, idle_cb);
2132\& ev_idle_start (loop, idle_cb); 2647\& ev_idle_start (loop, idle_watcher);
2133.Ve 2648.Ve
2134.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" 2649.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
2135.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 2650.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
2136.IX Subsection "ev_prepare and ev_check - customise your event loop!" 2651.IX Subsection "ev_prepare and ev_check - customise your event loop!"
2137Prepare and check watchers are usually (but not always) used in pairs: 2652Prepare and check watchers are usually (but not always) used in pairs:
2138prepare watchers get invoked before the process blocks and check watchers 2653prepare watchers get invoked before the process blocks and check watchers
2139afterwards. 2654afterwards.
2140.PP 2655.PP
2216.Vb 2 2731.Vb 2
2217\& static ev_io iow [nfd]; 2732\& static ev_io iow [nfd];
2218\& static ev_timer tw; 2733\& static ev_timer tw;
2219\& 2734\&
2220\& static void 2735\& static void
2221\& io_cb (ev_loop *loop, ev_io *w, int revents) 2736\& io_cb (struct ev_loop *loop, ev_io *w, int revents)
2222\& { 2737\& {
2223\& } 2738\& }
2224\& 2739\&
2225\& // create io watchers for each fd and a timer before blocking 2740\& // create io watchers for each fd and a timer before blocking
2226\& static void 2741\& static void
2227\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 2742\& adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
2228\& { 2743\& {
2229\& int timeout = 3600000; 2744\& int timeout = 3600000;
2230\& struct pollfd fds [nfd]; 2745\& struct pollfd fds [nfd];
2231\& // actual code will need to loop here and realloc etc. 2746\& // actual code will need to loop here and realloc etc.
2232\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2747\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2233\& 2748\&
2234\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */ 2749\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
2235\& ev_timer_init (&tw, 0, timeout * 1e\-3); 2750\& ev_timer_init (&tw, 0, timeout * 1e\-3, 0.);
2236\& ev_timer_start (loop, &tw); 2751\& ev_timer_start (loop, &tw);
2237\& 2752\&
2238\& // create one ev_io per pollfd 2753\& // create one ev_io per pollfd
2239\& for (int i = 0; i < nfd; ++i) 2754\& for (int i = 0; i < nfd; ++i)
2240\& { 2755\& {
2247\& } 2762\& }
2248\& } 2763\& }
2249\& 2764\&
2250\& // stop all watchers after blocking 2765\& // stop all watchers after blocking
2251\& static void 2766\& static void
2252\& adns_check_cb (ev_loop *loop, ev_check *w, int revents) 2767\& adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
2253\& { 2768\& {
2254\& ev_timer_stop (loop, &tw); 2769\& ev_timer_stop (loop, &tw);
2255\& 2770\&
2256\& for (int i = 0; i < nfd; ++i) 2771\& for (int i = 0; i < nfd; ++i)
2257\& { 2772\& {
2331\& ev_io_stop (EV_A_ iow [n]); 2846\& ev_io_stop (EV_A_ iow [n]);
2332\& 2847\&
2333\& return got_events; 2848\& return got_events;
2334\& } 2849\& }
2335.Ve 2850.Ve
2336.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 2851.ie n .SS """ev_embed"" \- when one backend isn't enough..."
2337.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 2852.el .SS "\f(CWev_embed\fP \- when one backend isn't enough..."
2338.IX Subsection "ev_embed - when one backend isn't enough..." 2853.IX Subsection "ev_embed - when one backend isn't enough..."
2339This is a rather advanced watcher type that lets you embed one event loop 2854This is a rather advanced watcher type that lets you embed one event loop
2340into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded 2855into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
2341loop, other types of watchers might be handled in a delayed or incorrect 2856loop, other types of watchers might be handled in a delayed or incorrect
2342fashion and must not be used). 2857fashion and must not be used).
2357some fds have to be watched and handled very quickly (with low latency), 2872some fds have to be watched and handled very quickly (with low latency),
2358and even priorities and idle watchers might have too much overhead. In 2873and even priorities and idle watchers might have too much overhead. In
2359this case you would put all the high priority stuff in one loop and all 2874this case you would put all the high priority stuff in one loop and all
2360the rest in a second one, and embed the second one in the first. 2875the rest in a second one, and embed the second one in the first.
2361.PP 2876.PP
2362As long as the watcher is active, the callback will be invoked every time 2877As long as the watcher is active, the callback will be invoked every
2363there might be events pending in the embedded loop. The callback must then 2878time there might be events pending in the embedded loop. The callback
2364call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke 2879must then call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single
2365their callbacks (you could also start an idle watcher to give the embedded 2880sweep and invoke their callbacks (the callback doesn't need to invoke the
2366loop strictly lower priority for example). You can also set the callback 2881\&\f(CW\*(C`ev_embed_sweep\*(C'\fR function directly, it could also start an idle watcher
2367to \f(CW0\fR, in which case the embed watcher will automatically execute the 2882to give the embedded loop strictly lower priority for example).
2368embedded loop sweep.
2369.PP 2883.PP
2370As long as the watcher is started it will automatically handle events. The 2884You can also set the callback to \f(CW0\fR, in which case the embed watcher
2371callback will be invoked whenever some events have been handled. You can 2885will automatically execute the embedded loop sweep whenever necessary.
2372set the callback to \f(CW0\fR to avoid having to specify one if you are not
2373interested in that.
2374.PP 2886.PP
2375Also, there have not currently been made special provisions for forking: 2887Fork detection will be handled transparently while the \f(CW\*(C`ev_embed\*(C'\fR watcher
2376when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops, 2888is active, i.e., the embedded loop will automatically be forked when the
2377but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers 2889embedding loop forks. In other cases, the user is responsible for calling
2378yourself \- but you can use a fork watcher to handle this automatically, 2890\&\f(CW\*(C`ev_loop_fork\*(C'\fR on the embedded loop.
2379and future versions of libev might do just that.
2380.PP 2891.PP
2381Unfortunately, not all backends are embeddable: only the ones returned by 2892Unfortunately, not all backends are embeddable: only the ones returned by
2382\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any 2893\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any
2383portable one. 2894portable one.
2384.PP 2895.PP
2428used). 2939used).
2429.PP 2940.PP
2430.Vb 3 2941.Vb 3
2431\& struct ev_loop *loop_hi = ev_default_init (0); 2942\& struct ev_loop *loop_hi = ev_default_init (0);
2432\& struct ev_loop *loop_lo = 0; 2943\& struct ev_loop *loop_lo = 0;
2433\& struct ev_embed embed; 2944\& ev_embed embed;
2434\& 2945\&
2435\& // see if there is a chance of getting one that works 2946\& // see if there is a chance of getting one that works
2436\& // (remember that a flags value of 0 means autodetection) 2947\& // (remember that a flags value of 0 means autodetection)
2437\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 2948\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2438\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 2949\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2454\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too). 2965\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
2455.PP 2966.PP
2456.Vb 3 2967.Vb 3
2457\& struct ev_loop *loop = ev_default_init (0); 2968\& struct ev_loop *loop = ev_default_init (0);
2458\& struct ev_loop *loop_socket = 0; 2969\& struct ev_loop *loop_socket = 0;
2459\& struct ev_embed embed; 2970\& ev_embed embed;
2460\& 2971\&
2461\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 2972\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2462\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 2973\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2463\& { 2974\& {
2464\& ev_embed_init (&embed, 0, loop_socket); 2975\& ev_embed_init (&embed, 0, loop_socket);
2468\& if (!loop_socket) 2979\& if (!loop_socket)
2469\& loop_socket = loop; 2980\& loop_socket = loop;
2470\& 2981\&
2471\& // now use loop_socket for all sockets, and loop for everything else 2982\& // now use loop_socket for all sockets, and loop for everything else
2472.Ve 2983.Ve
2473.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" 2984.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
2474.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 2985.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2475.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 2986.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2476Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 2987Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2477whoever is a good citizen cared to tell libev about it by calling 2988whoever is a good citizen cared to tell libev about it by calling
2478\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 2989\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the
2479event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 2990event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called,
2480and only in the child after the fork. If whoever good citizen calling 2991and only in the child after the fork. If whoever good citizen calling
2481\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 2992\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
2482handlers will be invoked, too, of course. 2993handlers will be invoked, too, of course.
2483.PP 2994.PP
2995\fIThe special problem of life after fork \- how is it possible?\fR
2996.IX Subsection "The special problem of life after fork - how is it possible?"
2997.PP
2998Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to ste
2999up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3000sequence should be handled by libev without any problems.
3001.PP
3002This changes when the application actually wants to do event handling
3003in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3004fork.
3005.PP
3006The default mode of operation (for libev, with application help to detect
3007forks) is to duplicate all the state in the child, as would be expected
3008when \fIeither\fR the parent \fIor\fR the child process continues.
3009.PP
3010When both processes want to continue using libev, then this is usually the
3011wrong result. In that case, usually one process (typically the parent) is
3012supposed to continue with all watchers in place as before, while the other
3013process typically wants to start fresh, i.e. without any active watchers.
3014.PP
3015The cleanest and most efficient way to achieve that with libev is to
3016simply create a new event loop, which of course will be \*(L"empty\*(R", and
3017use that for new watchers. This has the advantage of not touching more
3018memory than necessary, and thus avoiding the copy-on-write, and the
3019disadvantage of having to use multiple event loops (which do not support
3020signal watchers).
3021.PP
3022When this is not possible, or you want to use the default loop for
3023other reasons, then in the process that wants to start \*(L"fresh\*(R", call
3024\&\f(CW\*(C`ev_default_destroy ()\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR. Destroying
3025the default loop will \*(L"orphan\*(R" (not stop) all registered watchers, so you
3026have to be careful not to execute code that modifies those watchers. Note
3027also that in that case, you have to re-register any signal watchers.
3028.PP
2484\fIWatcher-Specific Functions and Data Members\fR 3029\fIWatcher-Specific Functions and Data Members\fR
2485.IX Subsection "Watcher-Specific Functions and Data Members" 3030.IX Subsection "Watcher-Specific Functions and Data Members"
2486.IP "ev_fork_init (ev_signal *, callback)" 4 3031.IP "ev_fork_init (ev_signal *, callback)" 4
2487.IX Item "ev_fork_init (ev_signal *, callback)" 3032.IX Item "ev_fork_init (ev_signal *, callback)"
2488Initialises and configures the fork watcher \- it has no parameters of any 3033Initialises and configures the fork watcher \- it has no parameters of any
2489kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, 3034kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
2490believe me. 3035believe me.
2491.ie n .Sh """ev_async"" \- how to wake up another event loop" 3036.ie n .SS """ev_async"" \- how to wake up another event loop"
2492.el .Sh "\f(CWev_async\fP \- how to wake up another event loop" 3037.el .SS "\f(CWev_async\fP \- how to wake up another event loop"
2493.IX Subsection "ev_async - how to wake up another event loop" 3038.IX Subsection "ev_async - how to wake up another event loop"
2494In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other 3039In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
2495asynchronous sources such as signal handlers (as opposed to multiple event 3040asynchronous sources such as signal handlers (as opposed to multiple event
2496loops \- those are of course safe to use in different threads). 3041loops \- those are of course safe to use in different threads).
2497.PP 3042.PP
2521queue. But at least I can tell you how to implement locking around your 3066queue. But at least I can tell you how to implement locking around your
2522queue: 3067queue:
2523.IP "queueing from a signal handler context" 4 3068.IP "queueing from a signal handler context" 4
2524.IX Item "queueing from a signal handler context" 3069.IX Item "queueing from a signal handler context"
2525To implement race-free queueing, you simply add to the queue in the signal 3070To implement race-free queueing, you simply add to the queue in the signal
2526handler but you block the signal handler in the watcher callback. Here is an example that does that for 3071handler but you block the signal handler in the watcher callback. Here is
2527some fictitious \s-1SIGUSR1\s0 handler: 3072an example that does that for some fictitious \s-1SIGUSR1\s0 handler:
2528.Sp 3073.Sp
2529.Vb 1 3074.Vb 1
2530\& static ev_async mysig; 3075\& static ev_async mysig;
2531\& 3076\&
2532\& static void 3077\& static void
2596\fIWatcher-Specific Functions and Data Members\fR 3141\fIWatcher-Specific Functions and Data Members\fR
2597.IX Subsection "Watcher-Specific Functions and Data Members" 3142.IX Subsection "Watcher-Specific Functions and Data Members"
2598.IP "ev_async_init (ev_async *, callback)" 4 3143.IP "ev_async_init (ev_async *, callback)" 4
2599.IX Item "ev_async_init (ev_async *, callback)" 3144.IX Item "ev_async_init (ev_async *, callback)"
2600Initialises and configures the async watcher \- it has no parameters of any 3145Initialises and configures the async watcher \- it has no parameters of any
2601kind. There is a \f(CW\*(C`ev_asynd_set\*(C'\fR macro, but using it is utterly pointless, 3146kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless,
2602trust me. 3147trust me.
2603.IP "ev_async_send (loop, ev_async *)" 4 3148.IP "ev_async_send (loop, ev_async *)" 4
2604.IX Item "ev_async_send (loop, ev_async *)" 3149.IX Item "ev_async_send (loop, ev_async *)"
2605Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds 3150Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
2606an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike 3151an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike
2607\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or 3152\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or
2608similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding 3153similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding
2609section below on what exactly this means). 3154section below on what exactly this means).
2610.Sp 3155.Sp
3156Note that, as with other watchers in libev, multiple events might get
3157compressed into a single callback invocation (another way to look at this
3158is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered, set on \f(CW\*(C`ev_async_send\*(C'\fR,
3159reset when the event loop detects that).
3160.Sp
2611This call incurs the overhead of a system call only once per loop iteration, 3161This call incurs the overhead of a system call only once per event loop
2612so while the overhead might be noticeable, it doesn't apply to repeated 3162iteration, so while the overhead might be noticeable, it doesn't apply to
2613calls to \f(CW\*(C`ev_async_send\*(C'\fR. 3163repeated calls to \f(CW\*(C`ev_async_send\*(C'\fR for the same event loop.
2614.IP "bool = ev_async_pending (ev_async *)" 4 3164.IP "bool = ev_async_pending (ev_async *)" 4
2615.IX Item "bool = ev_async_pending (ev_async *)" 3165.IX Item "bool = ev_async_pending (ev_async *)"
2616Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 3166Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
2617watcher but the event has not yet been processed (or even noted) by the 3167watcher but the event has not yet been processed (or even noted) by the
2618event loop. 3168event loop.
2620\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When 3170\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
2621the loop iterates next and checks for the watcher to have become active, 3171the loop iterates next and checks for the watcher to have become active,
2622it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very 3172it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
2623quickly check whether invoking the loop might be a good idea. 3173quickly check whether invoking the loop might be a good idea.
2624.Sp 3174.Sp
2625Not that this does \fInot\fR check whether the watcher itself is pending, only 3175Not that this does \fInot\fR check whether the watcher itself is pending,
2626whether it has been requested to make this watcher pending. 3176only whether it has been requested to make this watcher pending: there
3177is a time window between the event loop checking and resetting the async
3178notification, and the callback being invoked.
2627.SH "OTHER FUNCTIONS" 3179.SH "OTHER FUNCTIONS"
2628.IX Header "OTHER FUNCTIONS" 3180.IX Header "OTHER FUNCTIONS"
2629There are some other functions of possible interest. Described. Here. Now. 3181There are some other functions of possible interest. Described. Here. Now.
2630.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3182.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
2631.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3183.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
2632This function combines a simple timer and an I/O watcher, calls your 3184This function combines a simple timer and an I/O watcher, calls your
2633callback on whichever event happens first and automatically stop both 3185callback on whichever event happens first and automatically stops both
2634watchers. This is useful if you want to wait for a single event on an fd 3186watchers. This is useful if you want to wait for a single event on an fd
2635or timeout without having to allocate/configure/start/stop/free one or 3187or timeout without having to allocate/configure/start/stop/free one or
2636more watchers yourself. 3188more watchers yourself.
2637.Sp 3189.Sp
2638If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events 3190If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and the
2639is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and 3191\&\f(CW\*(C`events\*(C'\fR argument is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for
2640\&\f(CW\*(C`events\*(C'\fR set will be created and started. 3192the given \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`events\*(C'\fR set will be created and started.
2641.Sp 3193.Sp
2642If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be 3194If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be
2643started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and 3195started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and
2644repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of 3196repeat = 0) will be started. \f(CW0\fR is a valid timeout.
2645dubious value.
2646.Sp 3197.Sp
2647The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets 3198The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets
2648passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of 3199passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of
2649\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR 3200\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
2650value passed to \f(CW\*(C`ev_once\*(C'\fR: 3201value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3202a timeout and an io event at the same time \- you probably should give io
3203events precedence.
3204.Sp
3205Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0.
2651.Sp 3206.Sp
2652.Vb 7 3207.Vb 7
2653\& static void stdin_ready (int revents, void *arg) 3208\& static void stdin_ready (int revents, void *arg)
2654\& { 3209\& {
3210\& if (revents & EV_READ)
3211\& /* stdin might have data for us, joy! */;
2655\& if (revents & EV_TIMEOUT) 3212\& else if (revents & EV_TIMEOUT)
2656\& /* doh, nothing entered */; 3213\& /* doh, nothing entered */;
2657\& else if (revents & EV_READ)
2658\& /* stdin might have data for us, joy! */;
2659\& } 3214\& }
2660\& 3215\&
2661\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3216\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2662.Ve 3217.Ve
2663.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 3218.IP "ev_feed_event (struct ev_loop *, watcher *, int revents)" 4
2664.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" 3219.IX Item "ev_feed_event (struct ev_loop *, watcher *, int revents)"
2665Feeds the given event set into the event loop, as if the specified event 3220Feeds the given event set into the event loop, as if the specified event
2666had happened for the specified watcher (which must be a pointer to an 3221had happened for the specified watcher (which must be a pointer to an
2667initialised but not necessarily started event watcher). 3222initialised but not necessarily started event watcher).
2668.IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4 3223.IP "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" 4
2669.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" 3224.IX Item "ev_feed_fd_event (struct ev_loop *, int fd, int revents)"
2670Feed an event on the given fd, as if a file descriptor backend detected 3225Feed an event on the given fd, as if a file descriptor backend detected
2671the given events it. 3226the given events it.
2672.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 3227.IP "ev_feed_signal_event (struct ev_loop *loop, int signum)" 4
2673.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" 3228.IX Item "ev_feed_signal_event (struct ev_loop *loop, int signum)"
2674Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default 3229Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default
2675loop!). 3230loop!).
2676.SH "LIBEVENT EMULATION" 3231.SH "LIBEVENT EMULATION"
2677.IX Header "LIBEVENT EMULATION" 3232.IX Header "LIBEVENT EMULATION"
2678Libev offers a compatibility emulation layer for libevent. It cannot 3233Libev offers a compatibility emulation layer for libevent. It cannot
2725need one additional pointer for context. If you need support for other 3280need one additional pointer for context. If you need support for other
2726types of functors please contact the author (preferably after implementing 3281types of functors please contact the author (preferably after implementing
2727it). 3282it).
2728.PP 3283.PP
2729Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 3284Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
2730.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 3285.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
2731.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 3286.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
2732.IX Item "ev::READ, ev::WRITE etc." 3287.IX Item "ev::READ, ev::WRITE etc."
2733These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. 3288These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc.
2734macros from \fIev.h\fR. 3289macros from \fIev.h\fR.
2735.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 3290.ie n .IP """ev::tstamp"", ""ev::now""" 4
2736.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 3291.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4
2737.IX Item "ev::tstamp, ev::now" 3292.IX Item "ev::tstamp, ev::now"
2738Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. 3293Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix.
2739.ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4 3294.ie n .IP """ev::io"", ""ev::timer"", ""ev::periodic"", ""ev::idle"", ""ev::sig"" etc." 4
2740.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 3295.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
2741.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." 3296.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
2742For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of 3297For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
2743the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR 3298the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
2744which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 3299which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
2789\& } 3344\& }
2790\& 3345\&
2791\& myclass obj; 3346\& myclass obj;
2792\& ev::io iow; 3347\& ev::io iow;
2793\& iow.set <myclass, &myclass::io_cb> (&obj); 3348\& iow.set <myclass, &myclass::io_cb> (&obj);
3349.Ve
3350.IP "w\->set (object *)" 4
3351.IX Item "w->set (object *)"
3352This is an \fBexperimental\fR feature that might go away in a future version.
3353.Sp
3354This is a variation of a method callback \- leaving out the method to call
3355will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use
3356functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all
3357the time. Incidentally, you can then also leave out the template argument
3358list.
3359.Sp
3360The \f(CW\*(C`operator ()\*(C'\fR method prototype must be \f(CW\*(C`void operator ()(watcher &w,
3361int revents)\*(C'\fR.
3362.Sp
3363See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
3364.Sp
3365Example: use a functor object as callback.
3366.Sp
3367.Vb 7
3368\& struct myfunctor
3369\& {
3370\& void operator() (ev::io &w, int revents)
3371\& {
3372\& ...
3373\& }
3374\& }
3375\&
3376\& myfunctor f;
3377\&
3378\& ev::io w;
3379\& w.set (&f);
2794.Ve 3380.Ve
2795.IP "w\->set<function> (void *data = 0)" 4 3381.IP "w\->set<function> (void *data = 0)" 4
2796.IX Item "w->set<function> (void *data = 0)" 3382.IX Item "w->set<function> (void *data = 0)"
2797Also sets a callback, but uses a static method or plain function as 3383Also sets a callback, but uses a static method or plain function as
2798callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's 3384callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
2823Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 3409Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
2824constructor already stores the event loop. 3410constructor already stores the event loop.
2825.IP "w\->stop ()" 4 3411.IP "w\->stop ()" 4
2826.IX Item "w->stop ()" 3412.IX Item "w->stop ()"
2827Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 3413Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
2828.ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4 3414.ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4
2829.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 3415.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4
2830.IX Item "w->again () (ev::timer, ev::periodic only)" 3416.IX Item "w->again () (ev::timer, ev::periodic only)"
2831For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding 3417For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding
2832\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. 3418\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
2833.ie n .IP "w\->sweep () (""ev::embed"" only)" 4 3419.ie n .IP "w\->sweep () (""ev::embed"" only)" 4
2878It can be found and installed via \s-1CPAN\s0, its homepage is at 3464It can be found and installed via \s-1CPAN\s0, its homepage is at
2879<http://software.schmorp.de/pkg/EV>. 3465<http://software.schmorp.de/pkg/EV>.
2880.IP "Python" 4 3466.IP "Python" 4
2881.IX Item "Python" 3467.IX Item "Python"
2882Python bindings can be found at <http://code.google.com/p/pyev/>. It 3468Python bindings can be found at <http://code.google.com/p/pyev/>. It
2883seems to be quite complete and well-documented. Note, however, that the 3469seems to be quite complete and well-documented.
2884patch they require for libev is outright dangerous as it breaks the \s-1ABI\s0
2885for everybody else, and therefore, should never be applied in an installed
2886libev (if python requires an incompatible \s-1ABI\s0 then it needs to embed
2887libev).
2888.IP "Ruby" 4 3470.IP "Ruby" 4
2889.IX Item "Ruby" 3471.IX Item "Ruby"
2890Tony Arcieri has written a ruby extension that offers access to a subset 3472Tony Arcieri has written a ruby extension that offers access to a subset
2891of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and 3473of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and
2892more on top of it. It can be found via gem servers. Its homepage is at 3474more on top of it. It can be found via gem servers. Its homepage is at
2893<http://rev.rubyforge.org/>. 3475<http://rev.rubyforge.org/>.
3476.Sp
3477Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
3478makes rev work even on mingw.
3479.IP "Haskell" 4
3480.IX Item "Haskell"
3481A haskell binding to libev is available at
3482<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
2894.IP "D" 4 3483.IP "D" 4
2895.IX Item "D" 3484.IX Item "D"
2896Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 3485Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
2897be found at <http://proj.llucax.com.ar/wiki/evd>. 3486be found at <http://proj.llucax.com.ar/wiki/evd>.
3487.IP "Ocaml" 4
3488.IX Item "Ocaml"
3489Erkki Seppala has written Ocaml bindings for libev, to be found at
3490<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
2898.SH "MACRO MAGIC" 3491.SH "MACRO MAGIC"
2899.IX Header "MACRO MAGIC" 3492.IX Header "MACRO MAGIC"
2900Libev can be compiled with a variety of options, the most fundamental 3493Libev can be compiled with a variety of options, the most fundamental
2901of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 3494of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
2902functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 3495functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
2903.PP 3496.PP
2904To make it easier to write programs that cope with either variant, the 3497To make it easier to write programs that cope with either variant, the
2905following macros are defined: 3498following macros are defined:
2906.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 3499.ie n .IP """EV_A"", ""EV_A_""" 4
2907.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 3500.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
2908.IX Item "EV_A, EV_A_" 3501.IX Item "EV_A, EV_A_"
2909This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev 3502This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
2910loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, 3503loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
2911\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: 3504\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
2916\& ev_loop (EV_A_ 0); 3509\& ev_loop (EV_A_ 0);
2917.Ve 3510.Ve
2918.Sp 3511.Sp
2919It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, 3512It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
2920which is often provided by the following macro. 3513which is often provided by the following macro.
2921.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 3514.ie n .IP """EV_P"", ""EV_P_""" 4
2922.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 3515.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
2923.IX Item "EV_P, EV_P_" 3516.IX Item "EV_P, EV_P_"
2924This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev 3517This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
2925loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, 3518loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
2926\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: 3519\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
2933\& static void cb (EV_P_ ev_timer *w, int revents) 3526\& static void cb (EV_P_ ev_timer *w, int revents)
2934.Ve 3527.Ve
2935.Sp 3528.Sp
2936It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite 3529It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
2937suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 3530suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
2938.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 3531.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4
2939.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 3532.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
2940.IX Item "EV_DEFAULT, EV_DEFAULT_" 3533.IX Item "EV_DEFAULT, EV_DEFAULT_"
2941Similar to the other two macros, this gives you the value of the default 3534Similar to the other two macros, this gives you the value of the default
2942loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 3535loop, if multiple loops are supported (\*(L"ev loop default\*(R").
2943.ie n .IP """EV_DEFAULT_UC""\fR, \f(CW""EV_DEFAULT_UC_""" 4 3536.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4
2944.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 3537.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
2945.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" 3538.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
2946Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the 3539Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
2947default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour 3540default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
2948is undefined when the default loop has not been initialised by a previous 3541is undefined when the default loop has not been initialised by a previous
2976.PP 3569.PP
2977The goal is to enable you to just copy the necessary files into your 3570The goal is to enable you to just copy the necessary files into your
2978source directory without having to change even a single line in them, so 3571source directory without having to change even a single line in them, so
2979you can easily upgrade by simply copying (or having a checked-out copy of 3572you can easily upgrade by simply copying (or having a checked-out copy of
2980libev somewhere in your source tree). 3573libev somewhere in your source tree).
2981.Sh "\s-1FILESETS\s0" 3574.SS "\s-1FILESETS\s0"
2982.IX Subsection "FILESETS" 3575.IX Subsection "FILESETS"
2983Depending on what features you need you need to include one or more sets of files 3576Depending on what features you need you need to include one or more sets of files
2984in your application. 3577in your application.
2985.PP 3578.PP
2986\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 3579\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
3004\& #define EV_STANDALONE 1 3597\& #define EV_STANDALONE 1
3005\& #include "ev.h" 3598\& #include "ev.h"
3006.Ve 3599.Ve
3007.PP 3600.PP
3008Both header files and implementation files can be compiled with a \*(C+ 3601Both header files and implementation files can be compiled with a \*(C+
3009compiler (at least, thats a stated goal, and breakage will be treated 3602compiler (at least, that's a stated goal, and breakage will be treated
3010as a bug). 3603as a bug).
3011.PP 3604.PP
3012You need the following files in your source tree, or in a directory 3605You need the following files in your source tree, or in a directory
3013in your include path (e.g. in libev/ when using \-Ilibev): 3606in your include path (e.g. in libev/ when using \-Ilibev):
3014.PP 3607.PP
3065For this of course you need the m4 file: 3658For this of course you need the m4 file:
3066.PP 3659.PP
3067.Vb 1 3660.Vb 1
3068\& libev.m4 3661\& libev.m4
3069.Ve 3662.Ve
3070.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 3663.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
3071.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 3664.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
3072Libev can be configured via a variety of preprocessor symbols you have to 3665Libev can be configured via a variety of preprocessor symbols you have to
3073define before including any of its files. The default in the absence of 3666define before including any of its files. The default in the absence of
3074autoconf is documented for every option. 3667autoconf is documented for every option.
3075.IP "\s-1EV_STANDALONE\s0" 4 3668.IP "\s-1EV_STANDALONE\s0" 4
3077Must always be \f(CW1\fR if you do not use autoconf configuration, which 3670Must always be \f(CW1\fR if you do not use autoconf configuration, which
3078keeps libev from including \fIconfig.h\fR, and it also defines dummy 3671keeps libev from including \fIconfig.h\fR, and it also defines dummy
3079implementations for some libevent functions (such as logging, which is not 3672implementations for some libevent functions (such as logging, which is not
3080supported). It will also not define any of the structs usually found in 3673supported). It will also not define any of the structs usually found in
3081\&\fIevent.h\fR that are not directly supported by the libev core alone. 3674\&\fIevent.h\fR that are not directly supported by the libev core alone.
3675.Sp
3676In stanbdalone mode, libev will still try to automatically deduce the
3677configuration, but has to be more conservative.
3082.IP "\s-1EV_USE_MONOTONIC\s0" 4 3678.IP "\s-1EV_USE_MONOTONIC\s0" 4
3083.IX Item "EV_USE_MONOTONIC" 3679.IX Item "EV_USE_MONOTONIC"
3084If defined to be \f(CW1\fR, libev will try to detect the availability of the 3680If defined to be \f(CW1\fR, libev will try to detect the availability of the
3085monotonic clock option at both compile time and runtime. Otherwise no use 3681monotonic clock option at both compile time and runtime. Otherwise no
3086of the monotonic clock option will be attempted. If you enable this, you 3682use of the monotonic clock option will be attempted. If you enable this,
3087usually have to link against librt or something similar. Enabling it when 3683you usually have to link against librt or something similar. Enabling it
3088the functionality isn't available is safe, though, although you have 3684when the functionality isn't available is safe, though, although you have
3089to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR 3685to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
3090function is hiding in (often \fI\-lrt\fR). 3686function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
3091.IP "\s-1EV_USE_REALTIME\s0" 4 3687.IP "\s-1EV_USE_REALTIME\s0" 4
3092.IX Item "EV_USE_REALTIME" 3688.IX Item "EV_USE_REALTIME"
3093If defined to be \f(CW1\fR, libev will try to detect the availability of the 3689If defined to be \f(CW1\fR, libev will try to detect the availability of the
3094real-time clock option at compile time (and assume its availability at 3690real-time clock option at compile time (and assume its availability
3095runtime if successful). Otherwise no use of the real-time clock option will 3691at runtime if successful). Otherwise no use of the real-time clock
3096be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get 3692option will be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR
3097(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the 3693by \f(CW\*(C`clock_get (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect
3098note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. 3694correctness. See the note about libraries in the description of
3695\&\f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. Defaults to the opposite value of
3696\&\f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR.
3697.IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4
3698.IX Item "EV_USE_CLOCK_SYSCALL"
3699If defined to be \f(CW1\fR, libev will try to use a direct syscall instead
3700of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option
3701exists because on GNU/Linux, \f(CW\*(C`clock_gettime\*(C'\fR is in \f(CW\*(C`librt\*(C'\fR, but \f(CW\*(C`librt\*(C'\fR
3702unconditionally pulls in \f(CW\*(C`libpthread\*(C'\fR, slowing down single-threaded
3703programs needlessly. Using a direct syscall is slightly slower (in
3704theory), because no optimised vdso implementation can be used, but avoids
3705the pthread dependency. Defaults to \f(CW1\fR on GNU/Linux with glibc 2.x or
3706higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR).
3099.IP "\s-1EV_USE_NANOSLEEP\s0" 4 3707.IP "\s-1EV_USE_NANOSLEEP\s0" 4
3100.IX Item "EV_USE_NANOSLEEP" 3708.IX Item "EV_USE_NANOSLEEP"
3101If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available 3709If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
3102and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. 3710and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
3103.IP "\s-1EV_USE_EVENTFD\s0" 4 3711.IP "\s-1EV_USE_EVENTFD\s0" 4
3115will not be compiled in. 3723will not be compiled in.
3116.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 3724.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
3117.IX Item "EV_SELECT_USE_FD_SET" 3725.IX Item "EV_SELECT_USE_FD_SET"
3118If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR 3726If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
3119structure. This is useful if libev doesn't compile due to a missing 3727structure. This is useful if libev doesn't compile due to a missing
3120\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout on 3728\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout
3121exotic systems. This usually limits the range of file descriptors to some 3729on exotic systems. This usually limits the range of file descriptors to
3122low limit such as 1024 or might have other limitations (winsocket only 3730some low limit such as 1024 or might have other limitations (winsocket
3123allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might 3731only allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation,
3124influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. 3732configures the maximum size of the \f(CW\*(C`fd_set\*(C'\fR.
3125.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 3733.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
3126.IX Item "EV_SELECT_IS_WINSOCKET" 3734.IX Item "EV_SELECT_IS_WINSOCKET"
3127When defined to \f(CW1\fR, the select backend will assume that 3735When defined to \f(CW1\fR, the select backend will assume that
3128select/socket/connect etc. don't understand file descriptors but 3736select/socket/connect etc. don't understand file descriptors but
3129wants osf handles on win32 (this is the case when the select to 3737wants osf handles on win32 (this is the case when the select to
3259If undefined or defined to be \f(CW1\fR, then async watchers are supported. If 3867If undefined or defined to be \f(CW1\fR, then async watchers are supported. If
3260defined to be \f(CW0\fR, then they are not. 3868defined to be \f(CW0\fR, then they are not.
3261.IP "\s-1EV_MINIMAL\s0" 4 3869.IP "\s-1EV_MINIMAL\s0" 4
3262.IX Item "EV_MINIMAL" 3870.IX Item "EV_MINIMAL"
3263If you need to shave off some kilobytes of code at the expense of some 3871If you need to shave off some kilobytes of code at the expense of some
3264speed, define this symbol to \f(CW1\fR. Currently this is used to override some 3872speed (but with the full \s-1API\s0), define this symbol to \f(CW1\fR. Currently this
3265inlining decisions, saves roughly 30% code size on amd64. It also selects a 3873is used to override some inlining decisions, saves roughly 30% code size
3266much smaller 2\-heap for timer management over the default 4\-heap. 3874on amd64. It also selects a much smaller 2\-heap for timer management over
3875the default 4\-heap.
3876.Sp
3877You can save even more by disabling watcher types you do not need
3878and setting \f(CW\*(C`EV_MAXPRI\*(C'\fR == \f(CW\*(C`EV_MINPRI\*(C'\fR. Also, disabling \f(CW\*(C`assert\*(C'\fR
3879(\f(CW\*(C`\-DNDEBUG\*(C'\fR) will usually reduce code size a lot.
3880.Sp
3881Defining \f(CW\*(C`EV_MINIMAL\*(C'\fR to \f(CW2\fR will additionally reduce the core \s-1API\s0 to
3882provide a bare-bones event library. See \f(CW\*(C`ev.h\*(C'\fR for details on what parts
3883of the \s-1API\s0 are still available, and do not complain if this subset changes
3884over time.
3267.IP "\s-1EV_PID_HASHSIZE\s0" 4 3885.IP "\s-1EV_PID_HASHSIZE\s0" 4
3268.IX Item "EV_PID_HASHSIZE" 3886.IX Item "EV_PID_HASHSIZE"
3269\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 3887\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
3270pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 3888pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
3271than enough. If you need to manage thousands of children you might want to 3889than enough. If you need to manage thousands of children you might want to
3335and the way callbacks are invoked and set. Must expand to a struct member 3953and the way callbacks are invoked and set. Must expand to a struct member
3336definition and a statement, respectively. See the \fIev.h\fR header file for 3954definition and a statement, respectively. See the \fIev.h\fR header file for
3337their default definitions. One possible use for overriding these is to 3955their default definitions. One possible use for overriding these is to
3338avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 3956avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
3339method calls instead of plain function calls in \*(C+. 3957method calls instead of plain function calls in \*(C+.
3340.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 3958.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
3341.IX Subsection "EXPORTED API SYMBOLS" 3959.IX Subsection "EXPORTED API SYMBOLS"
3342If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 3960If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
3343exported symbols, you can use the provided \fISymbol.*\fR files which list 3961exported symbols, you can use the provided \fISymbol.*\fR files which list
3344all public symbols, one per line: 3962all public symbols, one per line:
3345.PP 3963.PP
3365\& #define ev_backend myprefix_ev_backend 3983\& #define ev_backend myprefix_ev_backend
3366\& #define ev_check_start myprefix_ev_check_start 3984\& #define ev_check_start myprefix_ev_check_start
3367\& #define ev_check_stop myprefix_ev_check_stop 3985\& #define ev_check_stop myprefix_ev_check_stop
3368\& ... 3986\& ...
3369.Ve 3987.Ve
3370.Sh "\s-1EXAMPLES\s0" 3988.SS "\s-1EXAMPLES\s0"
3371.IX Subsection "EXAMPLES" 3989.IX Subsection "EXAMPLES"
3372For a real-world example of a program the includes libev 3990For a real-world example of a program the includes libev
3373verbatim, you can have a look at the \s-1EV\s0 perl module 3991verbatim, you can have a look at the \s-1EV\s0 perl module
3374(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in 3992(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
3375the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public 3993the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
3398.PP 4016.PP
3399.Vb 2 4017.Vb 2
3400\& #include "ev_cpp.h" 4018\& #include "ev_cpp.h"
3401\& #include "ev.c" 4019\& #include "ev.c"
3402.Ve 4020.Ve
3403.SH "THREADS AND COROUTINES" 4021.SH "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES"
4022.IX Header "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES"
4023.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0"
3404.IX Header "THREADS AND COROUTINES" 4024.IX Subsection "THREADS AND COROUTINES"
3405.Sh "\s-1THREADS\s0" 4025\fI\s-1THREADS\s0\fR
3406.IX Subsection "THREADS" 4026.IX Subsection "THREADS"
4027.PP
3407All libev functions are reentrant and thread-safe unless explicitly 4028All libev functions are reentrant and thread-safe unless explicitly
3408documented otherwise, but it uses no locking itself. This means that you 4029documented otherwise, but libev implements no locking itself. This means
3409can use as many loops as you want in parallel, as long as there are no 4030that you can use as many loops as you want in parallel, as long as there
3410concurrent calls into any libev function with the same loop parameter 4031are no concurrent calls into any libev function with the same loop
3411(\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter, of 4032parameter (\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter,
3412course): libev guarantees that different event loops share no data 4033of course): libev guarantees that different event loops share no data
3413structures that need any locking. 4034structures that need any locking.
3414.PP 4035.PP
3415Or to put it differently: calls with different loop parameters can be done 4036Or to put it differently: calls with different loop parameters can be done
3416concurrently from multiple threads, calls with the same loop parameter 4037concurrently from multiple threads, calls with the same loop parameter
3417must be done serially (but can be done from different threads, as long as 4038must be done serially (but can be done from different threads, as long as
3452.Sp 4073.Sp
3453An example use would be to communicate signals or other events that only 4074An example use would be to communicate signals or other events that only
3454work in the default loop by registering the signal watcher with the 4075work in the default loop by registering the signal watcher with the
3455default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 4076default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
3456watcher callback into the event loop interested in the signal. 4077watcher callback into the event loop interested in the signal.
3457.Sh "\s-1COROUTINES\s0" 4078.PP
4079\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0
4080.IX Subsection "THREAD LOCKING EXAMPLE"
4081.PP
4082Here is a fictitious example of how to run an event loop in a different
4083thread than where callbacks are being invoked and watchers are
4084created/added/removed.
4085.PP
4086For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module,
4087which uses exactly this technique (which is suited for many high-level
4088languages).
4089.PP
4090The example uses a pthread mutex to protect the loop data, a condition
4091variable to wait for callback invocations, an async watcher to notify the
4092event loop thread and an unspecified mechanism to wake up the main thread.
4093.PP
4094First, you need to associate some data with the event loop:
4095.PP
4096.Vb 6
4097\& typedef struct {
4098\& mutex_t lock; /* global loop lock */
4099\& ev_async async_w;
4100\& thread_t tid;
4101\& cond_t invoke_cv;
4102\& } userdata;
4103\&
4104\& void prepare_loop (EV_P)
4105\& {
4106\& // for simplicity, we use a static userdata struct.
4107\& static userdata u;
4108\&
4109\& ev_async_init (&u\->async_w, async_cb);
4110\& ev_async_start (EV_A_ &u\->async_w);
4111\&
4112\& pthread_mutex_init (&u\->lock, 0);
4113\& pthread_cond_init (&u\->invoke_cv, 0);
4114\&
4115\& // now associate this with the loop
4116\& ev_set_userdata (EV_A_ u);
4117\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
4118\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4119\&
4120\& // then create the thread running ev_loop
4121\& pthread_create (&u\->tid, 0, l_run, EV_A);
4122\& }
4123.Ve
4124.PP
4125The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
4126solely to wake up the event loop so it takes notice of any new watchers
4127that might have been added:
4128.PP
4129.Vb 5
4130\& static void
4131\& async_cb (EV_P_ ev_async *w, int revents)
4132\& {
4133\& // just used for the side effects
4134\& }
4135.Ve
4136.PP
4137The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex
4138protecting the loop data, respectively.
4139.PP
4140.Vb 6
4141\& static void
4142\& l_release (EV_P)
4143\& {
4144\& userdata *u = ev_userdata (EV_A);
4145\& pthread_mutex_unlock (&u\->lock);
4146\& }
4147\&
4148\& static void
4149\& l_acquire (EV_P)
4150\& {
4151\& userdata *u = ev_userdata (EV_A);
4152\& pthread_mutex_lock (&u\->lock);
4153\& }
4154.Ve
4155.PP
4156The event loop thread first acquires the mutex, and then jumps straight
4157into \f(CW\*(C`ev_loop\*(C'\fR:
4158.PP
4159.Vb 4
4160\& void *
4161\& l_run (void *thr_arg)
4162\& {
4163\& struct ev_loop *loop = (struct ev_loop *)thr_arg;
4164\&
4165\& l_acquire (EV_A);
4166\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4167\& ev_loop (EV_A_ 0);
4168\& l_release (EV_A);
4169\&
4170\& return 0;
4171\& }
4172.Ve
4173.PP
4174Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will
4175signal the main thread via some unspecified mechanism (signals? pipe
4176writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers
4177have been called (in a while loop because a) spurious wakeups are possible
4178and b) skipping inter-thread-communication when there are no pending
4179watchers is very beneficial):
4180.PP
4181.Vb 4
4182\& static void
4183\& l_invoke (EV_P)
4184\& {
4185\& userdata *u = ev_userdata (EV_A);
4186\&
4187\& while (ev_pending_count (EV_A))
4188\& {
4189\& wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4190\& pthread_cond_wait (&u\->invoke_cv, &u\->lock);
4191\& }
4192\& }
4193.Ve
4194.PP
4195Now, whenever the main thread gets told to invoke pending watchers, it
4196will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop
4197thread to continue:
4198.PP
4199.Vb 4
4200\& static void
4201\& real_invoke_pending (EV_P)
4202\& {
4203\& userdata *u = ev_userdata (EV_A);
4204\&
4205\& pthread_mutex_lock (&u\->lock);
4206\& ev_invoke_pending (EV_A);
4207\& pthread_cond_signal (&u\->invoke_cv);
4208\& pthread_mutex_unlock (&u\->lock);
4209\& }
4210.Ve
4211.PP
4212Whenever you want to start/stop a watcher or do other modifications to an
4213event loop, you will now have to lock:
4214.PP
4215.Vb 2
4216\& ev_timer timeout_watcher;
4217\& userdata *u = ev_userdata (EV_A);
4218\&
4219\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4220\&
4221\& pthread_mutex_lock (&u\->lock);
4222\& ev_timer_start (EV_A_ &timeout_watcher);
4223\& ev_async_send (EV_A_ &u\->async_w);
4224\& pthread_mutex_unlock (&u\->lock);
4225.Ve
4226.PP
4227Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
4228an event loop currently blocking in the kernel will have no knowledge
4229about the newly added timer. By waking up the loop it will pick up any new
4230watchers in the next event loop iteration.
4231.PP
4232\fI\s-1COROUTINES\s0\fR
3458.IX Subsection "COROUTINES" 4233.IX Subsection "COROUTINES"
4234.PP
3459Libev is much more accommodating to coroutines (\*(L"cooperative threads\*(R"): 4235Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
3460libev fully supports nesting calls to it's functions from different 4236libev fully supports nesting calls to its functions from different
3461coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two 4237coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two
3462different coroutines and switch freely between both coroutines running the 4238different coroutines, and switch freely between both coroutines running
3463loop, as long as you don't confuse yourself). The only exception is that 4239the loop, as long as you don't confuse yourself). The only exception is
3464you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 4240that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
3465.PP 4241.PP
3466Care has been taken to ensure that libev does not keep local state inside 4242Care has been taken to ensure that libev does not keep local state inside
3467\&\f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow coroutine switches. 4243\&\f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow for coroutine switches as
4244they do not call any callbacks.
4245.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0"
4246.IX Subsection "COMPILER WARNINGS"
4247Depending on your compiler and compiler settings, you might get no or a
4248lot of warnings when compiling libev code. Some people are apparently
4249scared by this.
4250.PP
4251However, these are unavoidable for many reasons. For one, each compiler
4252has different warnings, and each user has different tastes regarding
4253warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when
4254targeting a specific compiler and compiler-version.
4255.PP
4256Another reason is that some compiler warnings require elaborate
4257workarounds, or other changes to the code that make it less clear and less
4258maintainable.
4259.PP
4260And of course, some compiler warnings are just plain stupid, or simply
4261wrong (because they don't actually warn about the condition their message
4262seems to warn about). For example, certain older gcc versions had some
4263warnings that resulted an extreme number of false positives. These have
4264been fixed, but some people still insist on making code warn-free with
4265such buggy versions.
4266.PP
4267While libev is written to generate as few warnings as possible,
4268\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
4269with any compiler warnings enabled unless you are prepared to cope with
4270them (e.g. by ignoring them). Remember that warnings are just that:
4271warnings, not errors, or proof of bugs.
4272.SS "\s-1VALGRIND\s0"
4273.IX Subsection "VALGRIND"
4274Valgrind has a special section here because it is a popular tool that is
4275highly useful. Unfortunately, valgrind reports are very hard to interpret.
4276.PP
4277If you think you found a bug (memory leak, uninitialised data access etc.)
4278in libev, then check twice: If valgrind reports something like:
4279.PP
4280.Vb 3
4281\& ==2274== definitely lost: 0 bytes in 0 blocks.
4282\& ==2274== possibly lost: 0 bytes in 0 blocks.
4283\& ==2274== still reachable: 256 bytes in 1 blocks.
4284.Ve
4285.PP
4286Then there is no memory leak, just as memory accounted to global variables
4287is not a memleak \- the memory is still being referenced, and didn't leak.
4288.PP
4289Similarly, under some circumstances, valgrind might report kernel bugs
4290as if it were a bug in libev (e.g. in realloc or in the poll backend,
4291although an acceptable workaround has been found here), or it might be
4292confused.
4293.PP
4294Keep in mind that valgrind is a very good tool, but only a tool. Don't
4295make it into some kind of religion.
4296.PP
4297If you are unsure about something, feel free to contact the mailing list
4298with the full valgrind report and an explanation on why you think this
4299is a bug in libev (best check the archives, too :). However, don't be
4300annoyed when you get a brisk \*(L"this is no bug\*(R" answer and take the chance
4301of learning how to interpret valgrind properly.
4302.PP
4303If you need, for some reason, empty reports from valgrind for your project
4304I suggest using suppression lists.
4305.SH "PORTABILITY NOTES"
4306.IX Header "PORTABILITY NOTES"
4307.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0"
4308.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
4309Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
4310requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
4311model. Libev still offers limited functionality on this platform in
4312the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
4313descriptors. This only applies when using Win32 natively, not when using
4314e.g. cygwin.
4315.PP
4316Lifting these limitations would basically require the full
4317re-implementation of the I/O system. If you are into these kinds of
4318things, then note that glib does exactly that for you in a very portable
4319way (note also that glib is the slowest event library known to man).
4320.PP
4321There is no supported compilation method available on windows except
4322embedding it into other applications.
4323.PP
4324Sensible signal handling is officially unsupported by Microsoft \- libev
4325tries its best, but under most conditions, signals will simply not work.
4326.PP
4327Not a libev limitation but worth mentioning: windows apparently doesn't
4328accept large writes: instead of resulting in a partial write, windows will
4329either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large,
4330so make sure you only write small amounts into your sockets (less than a
4331megabyte seems safe, but this apparently depends on the amount of memory
4332available).
4333.PP
4334Due to the many, low, and arbitrary limits on the win32 platform and
4335the abysmal performance of winsockets, using a large number of sockets
4336is not recommended (and not reasonable). If your program needs to use
4337more than a hundred or so sockets, then likely it needs to use a totally
4338different implementation for windows, as libev offers the \s-1POSIX\s0 readiness
4339notification model, which cannot be implemented efficiently on windows
4340(due to Microsoft monopoly games).
4341.PP
4342A typical way to use libev under windows is to embed it (see the embedding
4343section for details) and use the following \fIevwrap.h\fR header file instead
4344of \fIev.h\fR:
4345.PP
4346.Vb 2
4347\& #define EV_STANDALONE /* keeps ev from requiring config.h */
4348\& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
4349\&
4350\& #include "ev.h"
4351.Ve
4352.PP
4353And compile the following \fIevwrap.c\fR file into your project (make sure
4354you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!):
4355.PP
4356.Vb 2
4357\& #include "evwrap.h"
4358\& #include "ev.c"
4359.Ve
4360.IP "The winsocket select function" 4
4361.IX Item "The winsocket select function"
4362The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
4363requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
4364also extremely buggy). This makes select very inefficient, and also
4365requires a mapping from file descriptors to socket handles (the Microsoft
4366C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
4367discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
4368\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
4369.Sp
4370The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime
4371libraries and raw winsocket select is:
4372.Sp
4373.Vb 2
4374\& #define EV_USE_SELECT 1
4375\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4376.Ve
4377.Sp
4378Note that winsockets handling of fd sets is O(n), so you can easily get a
4379complexity in the O(nA\*^X) range when using win32.
4380.IP "Limited number of file descriptors" 4
4381.IX Item "Limited number of file descriptors"
4382Windows has numerous arbitrary (and low) limits on things.
4383.Sp
4384Early versions of winsocket's select only supported waiting for a maximum
4385of \f(CW64\fR handles (probably owning to the fact that all windows kernels
4386can only wait for \f(CW64\fR things at the same time internally; Microsoft
4387recommends spawning a chain of threads and wait for 63 handles and the
4388previous thread in each. Sounds great!).
4389.Sp
4390Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
4391to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
4392call (which might be in libev or elsewhere, for example, perl and many
4393other interpreters do their own select emulation on windows).
4394.Sp
4395Another limit is the number of file descriptors in the Microsoft runtime
4396libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR
4397fetish or something like this inside Microsoft). You can increase this
4398by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
4399(another arbitrary limit), but is broken in many versions of the Microsoft
4400runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
4401(depending on windows version and/or the phase of the moon). To get more,
4402you need to wrap all I/O functions and provide your own fd management, but
4403the cost of calling select (O(nA\*^X)) will likely make this unworkable.
4404.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0"
4405.IX Subsection "PORTABILITY REQUIREMENTS"
4406In addition to a working ISO-C implementation and of course the
4407backend-specific APIs, libev relies on a few additional extensions:
4408.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
4409.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
4410.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
4411Libev assumes not only that all watcher pointers have the same internal
4412structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also
4413assumes that the same (machine) code can be used to call any watcher
4414callback: The watcher callbacks have different type signatures, but libev
4415calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
4416.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
4417.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
4418.IX Item "sig_atomic_t volatile must be thread-atomic as well"
4419The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
4420\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different
4421threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is
4422believed to be sufficiently portable.
4423.ie n .IP """sigprocmask"" must work in a threaded environment" 4
4424.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4
4425.IX Item "sigprocmask must work in a threaded environment"
4426Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not
4427allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical
4428pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main
4429thread\*(R" or will block signals process-wide, both behaviours would
4430be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
4431\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
4432.Sp
4433The most portable way to handle signals is to block signals in all threads
4434except the initial one, and run the default loop in the initial thread as
4435well.
4436.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
4437.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
4438.IX Item "long must be large enough for common memory allocation sizes"
4439To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally
4440instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
4441systems (Microsoft...) this might be unexpectedly low, but is still at
4442least 31 bits everywhere, which is enough for hundreds of millions of
4443watchers.
4444.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
4445.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
4446.IX Item "double must hold a time value in seconds with enough accuracy"
4447The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
4448have at least 51 bits of mantissa (and 9 bits of exponent), which is good
4449enough for at least into the year 4000. This requirement is fulfilled by
4450implementations implementing \s-1IEEE\s0 754, which is basically all existing
4451ones. With \s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least
44522200.
4453.PP
4454If you know of other additional requirements drop me a note.
3468.SH "COMPLEXITIES" 4455.SH "ALGORITHMIC COMPLEXITIES"
3469.IX Header "COMPLEXITIES" 4456.IX Header "ALGORITHMIC COMPLEXITIES"
3470In this section the complexities of (many of) the algorithms used inside 4457In this section the complexities of (many of) the algorithms used inside
3471libev will be explained. For complexity discussions about backends see the 4458libev will be documented. For complexity discussions about backends see
3472documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 4459the documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
3473.PP 4460.PP
3474All of the following are about amortised time: If an array needs to be 4461All of the following are about amortised time: If an array needs to be
3475extended, libev needs to realloc and move the whole array, but this 4462extended, libev needs to realloc and move the whole array, but this
3476happens asymptotically never with higher number of elements, so O(1) might 4463happens asymptotically rarer with higher number of elements, so O(1) might
3477mean it might do a lengthy realloc operation in rare cases, but on average 4464mean that libev does a lengthy realloc operation in rare cases, but on
3478it is much faster and asymptotically approaches constant time. 4465average it is much faster and asymptotically approaches constant time.
3479.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 4466.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
3480.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4467.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
3481This means that, when you have a watcher that triggers in one hour and 4468This means that, when you have a watcher that triggers in one hour and
3482there are 100 watchers that would trigger before that then inserting will 4469there are 100 watchers that would trigger before that, then inserting will
3483have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers. 4470have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
3484.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4 4471.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
3485.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4472.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
3486That means that changing a timer costs less than removing/adding them 4473That means that changing a timer costs less than removing/adding them,
3487as only the relative motion in the event queue has to be paid for. 4474as only the relative motion in the event queue has to be paid for.
3488.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4 4475.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4
3489.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4476.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)"
3490These just add the watcher into an array or at the head of a list. 4477These just add the watcher into an array or at the head of a list.
3491.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4 4478.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4
3492.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)" 4479.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)"
3493.PD 0 4480.PD 0
3494.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 4481.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
3495.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" 4482.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
3496.PD 4483.PD
3497These watchers are stored in lists then need to be walked to find the 4484These watchers are stored in lists, so they need to be walked to find the
3498correct watcher to remove. The lists are usually short (you don't usually 4485correct watcher to remove. The lists are usually short (you don't usually
3499have many watchers waiting for the same fd or signal). 4486have many watchers waiting for the same fd or signal: one is typical, two
4487is rare).
3500.IP "Finding the next timer in each loop iteration: O(1)" 4 4488.IP "Finding the next timer in each loop iteration: O(1)" 4
3501.IX Item "Finding the next timer in each loop iteration: O(1)" 4489.IX Item "Finding the next timer in each loop iteration: O(1)"
3502By virtue of using a binary or 4\-heap, the next timer is always found at a 4490By virtue of using a binary or 4\-heap, the next timer is always found at a
3503fixed position in the storage array. 4491fixed position in the storage array.
3504.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 4492.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
3525.IX Item "Processing signals: O(max_signal_number)" 4513.IX Item "Processing signals: O(max_signal_number)"
3526.PD 4514.PD
3527Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 4515Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
3528calls in the current loop iteration. Checking for async and signal events 4516calls in the current loop iteration. Checking for async and signal events
3529involves iterating over all running async watchers or all signal numbers. 4517involves iterating over all running async watchers or all signal numbers.
3530.SH "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 4518.SH "GLOSSARY"
3531.IX Header "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 4519.IX Header "GLOSSARY"
3532Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 4520.IP "active" 4
3533requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 4521.IX Item "active"
3534model. Libev still offers limited functionality on this platform in 4522A watcher is active as long as it has been started (has been attached to
3535the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 4523an event loop) but not yet stopped (disassociated from the event loop).
3536descriptors. This only applies when using Win32 natively, not when using 4524.IP "application" 4
3537e.g. cygwin. 4525.IX Item "application"
3538.PP 4526In this document, an application is whatever is using libev.
3539Lifting these limitations would basically require the full 4527.IP "callback" 4
3540re-implementation of the I/O system. If you are into these kinds of 4528.IX Item "callback"
3541things, then note that glib does exactly that for you in a very portable 4529The address of a function that is called when some event has been
3542way (note also that glib is the slowest event library known to man). 4530detected. Callbacks are being passed the event loop, the watcher that
3543.PP 4531received the event, and the actual event bitset.
3544There is no supported compilation method available on windows except 4532.IP "callback invocation" 4
3545embedding it into other applications. 4533.IX Item "callback invocation"
3546.PP 4534The act of calling the callback associated with a watcher.
3547Not a libev limitation but worth mentioning: windows apparently doesn't 4535.IP "event" 4
3548accept large writes: instead of resulting in a partial write, windows will 4536.IX Item "event"
3549either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large, 4537A change of state of some external event, such as data now being available
3550so make sure you only write small amounts into your sockets (less than a 4538for reading on a file descriptor, time having passed or simply not having
3551megabyte seems safe, but this apparently depends on the amount of memory 4539any other events happening anymore.
3552available).
3553.PP
3554Due to the many, low, and arbitrary limits on the win32 platform and
3555the abysmal performance of winsockets, using a large number of sockets
3556is not recommended (and not reasonable). If your program needs to use
3557more than a hundred or so sockets, then likely it needs to use a totally
3558different implementation for windows, as libev offers the \s-1POSIX\s0 readiness
3559notification model, which cannot be implemented efficiently on windows
3560(Microsoft monopoly games).
3561.PP
3562A typical way to use libev under windows is to embed it (see the embedding
3563section for details) and use the following \fIevwrap.h\fR header file instead
3564of \fIev.h\fR:
3565.PP
3566.Vb 2
3567\& #define EV_STANDALONE /* keeps ev from requiring config.h */
3568\& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3569\&
3570\& #include "ev.h"
3571.Ve
3572.PP
3573And compile the following \fIevwrap.c\fR file into your project (make sure
3574you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!):
3575.PP
3576.Vb 2
3577\& #include "evwrap.h"
3578\& #include "ev.c"
3579.Ve
3580.IP "The winsocket select function" 4
3581.IX Item "The winsocket select function"
3582The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
3583requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
3584also extremely buggy). This makes select very inefficient, and also
3585requires a mapping from file descriptors to socket handles (the Microsoft
3586C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
3587discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
3588\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
3589.Sp 4540.Sp
3590The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime 4541In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or
3591libraries and raw winsocket select is: 4542\&\f(CW\*(C`EV_TIMEOUT\*(C'\fR).
4543.IP "event library" 4
4544.IX Item "event library"
4545A software package implementing an event model and loop.
4546.IP "event loop" 4
4547.IX Item "event loop"
4548An entity that handles and processes external events and converts them
4549into callback invocations.
4550.IP "event model" 4
4551.IX Item "event model"
4552The model used to describe how an event loop handles and processes
4553watchers and events.
4554.IP "pending" 4
4555.IX Item "pending"
4556A watcher is pending as soon as the corresponding event has been detected,
4557and stops being pending as soon as the watcher will be invoked or its
4558pending status is explicitly cleared by the application.
3592.Sp 4559.Sp
3593.Vb 2 4560A watcher can be pending, but not active. Stopping a watcher also clears
3594\& #define EV_USE_SELECT 1 4561its pending status.
3595\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 4562.IP "real time" 4
3596.Ve 4563.IX Item "real time"
3597.Sp 4564The physical time that is observed. It is apparently strictly monotonic :)
3598Note that winsockets handling of fd sets is O(n), so you can easily get a 4565.IP "wall-clock time" 4
3599complexity in the O(nA\*^X) range when using win32. 4566.IX Item "wall-clock time"
3600.IP "Limited number of file descriptors" 4 4567The time and date as shown on clocks. Unlike real time, it can actually
3601.IX Item "Limited number of file descriptors" 4568be wrong and jump forwards and backwards, e.g. when the you adjust your
3602Windows has numerous arbitrary (and low) limits on things. 4569clock.
3603.Sp 4570.IP "watcher" 4
3604Early versions of winsocket's select only supported waiting for a maximum 4571.IX Item "watcher"
3605of \f(CW64\fR handles (probably owning to the fact that all windows kernels 4572A data structure that describes interest in certain events. Watchers need
3606can only wait for \f(CW64\fR things at the same time internally; Microsoft 4573to be started (attached to an event loop) before they can receive events.
3607recommends spawning a chain of threads and wait for 63 handles and the 4574.IP "watcher invocation" 4
3608previous thread in each. Great). 4575.IX Item "watcher invocation"
3609.Sp 4576The act of calling the callback associated with a watcher.
3610Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
3611to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
3612call (which might be in libev or elsewhere, for example, perl does its own
3613select emulation on windows).
3614.Sp
3615Another limit is the number of file descriptors in the Microsoft runtime
3616libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish
3617or something like this inside Microsoft). You can increase this by calling
3618\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another
3619arbitrary limit), but is broken in many versions of the Microsoft runtime
3620libraries.
3621.Sp
3622This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on
3623windows version and/or the phase of the moon). To get more, you need to
3624wrap all I/O functions and provide your own fd management, but the cost of
3625calling select (O(nA\*^X)) will likely make this unworkable.
3626.SH "PORTABILITY REQUIREMENTS"
3627.IX Header "PORTABILITY REQUIREMENTS"
3628In addition to a working ISO-C implementation, libev relies on a few
3629additional extensions:
3630.ie n .IP """void (*)(ev_watcher_type *, int revents)""\fR must have compatible calling conventions regardless of \f(CW""ev_watcher_type *""." 4
3631.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
3632.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
3633Libev assumes not only that all watcher pointers have the same internal
3634structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also
3635assumes that the same (machine) code can be used to call any watcher
3636callback: The watcher callbacks have different type signatures, but libev
3637calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
3638.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
3639.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
3640.IX Item "sig_atomic_t volatile must be thread-atomic as well"
3641The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
3642\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different
3643threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is
3644believed to be sufficiently portable.
3645.ie n .IP """sigprocmask"" must work in a threaded environment" 4
3646.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4
3647.IX Item "sigprocmask must work in a threaded environment"
3648Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not
3649allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical
3650pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main
3651thread\*(R" or will block signals process-wide, both behaviours would
3652be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
3653\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
3654.Sp
3655The most portable way to handle signals is to block signals in all threads
3656except the initial one, and run the default loop in the initial thread as
3657well.
3658.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
3659.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
3660.IX Item "long must be large enough for common memory allocation sizes"
3661To improve portability and simplify using libev, libev uses \f(CW\*(C`long\*(C'\fR
3662internally instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On
3663non-POSIX systems (Microsoft...) this might be unexpectedly low, but
3664is still at least 31 bits everywhere, which is enough for hundreds of
3665millions of watchers.
3666.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
3667.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
3668.IX Item "double must hold a time value in seconds with enough accuracy"
3669The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
3670have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3671enough for at least into the year 4000. This requirement is fulfilled by
3672implementations implementing \s-1IEEE\s0 754 (basically all existing ones).
3673.PP
3674If you know of other additional requirements drop me a note.
3675.SH "COMPILER WARNINGS"
3676.IX Header "COMPILER WARNINGS"
3677Depending on your compiler and compiler settings, you might get no or a
3678lot of warnings when compiling libev code. Some people are apparently
3679scared by this.
3680.PP
3681However, these are unavoidable for many reasons. For one, each compiler
3682has different warnings, and each user has different tastes regarding
3683warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when
3684targeting a specific compiler and compiler-version.
3685.PP
3686Another reason is that some compiler warnings require elaborate
3687workarounds, or other changes to the code that make it less clear and less
3688maintainable.
3689.PP
3690And of course, some compiler warnings are just plain stupid, or simply
3691wrong (because they don't actually warn about the condition their message
3692seems to warn about).
3693.PP
3694While libev is written to generate as few warnings as possible,
3695\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
3696with any compiler warnings enabled unless you are prepared to cope with
3697them (e.g. by ignoring them). Remember that warnings are just that:
3698warnings, not errors, or proof of bugs.
3699.SH "VALGRIND"
3700.IX Header "VALGRIND"
3701Valgrind has a special section here because it is a popular tool that is
3702highly useful, but valgrind reports are very hard to interpret.
3703.PP
3704If you think you found a bug (memory leak, uninitialised data access etc.)
3705in libev, then check twice: If valgrind reports something like:
3706.PP
3707.Vb 3
3708\& ==2274== definitely lost: 0 bytes in 0 blocks.
3709\& ==2274== possibly lost: 0 bytes in 0 blocks.
3710\& ==2274== still reachable: 256 bytes in 1 blocks.
3711.Ve
3712.PP
3713Then there is no memory leak. Similarly, under some circumstances,
3714valgrind might report kernel bugs as if it were a bug in libev, or it
3715might be confused (it is a very good tool, but only a tool).
3716.PP
3717If you are unsure about something, feel free to contact the mailing list
3718with the full valgrind report and an explanation on why you think this is
3719a bug in libev. However, don't be annoyed when you get a brisk \*(L"this is
3720no bug\*(R" answer and take the chance of learning how to interpret valgrind
3721properly.
3722.PP
3723If you need, for some reason, empty reports from valgrind for your project
3724I suggest using suppression lists.
3725.SH "AUTHOR" 4577.SH "AUTHOR"
3726.IX Header "AUTHOR" 4578.IX Header "AUTHOR"
3727Marc Lehmann <libev@schmorp.de>. 4579Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines