[ViewVC] Diff of: cvs/libev/ev.3

Comparing libev/ev.3 (file contents):
Revision 1.88 by root, Sat Feb 4 18:55:50 2012 UTC vs.
Revision 1.101 by root, Fri Dec 27 06:01:21 2013 UTC

-.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
+.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .el\{\
 .    ds -- \|\(em\|
 .    ds PI \(*p
 .    ds L" ``
 .    ds R" ''
+.    ds C`
+.    ds C'
 'br\}
 .\"
 .\" Escape single quotes in literal strings from groff's Unicode transform.
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.ie \nF \{\
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
-.    de IX
+.de IX
-.    tm Index:\\$1\t\\n%\t"\\$2"
 ..
-.    nr % 0
+.nr rF 0
-.    rr F
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+.    if \nF \{
+.        de IX
+.        tm Index:\\$1\t\\n%\t"\\$2"
+..
+.        if !\nF==2 \{
+.            nr % 0
+.            nr F 2
+.        \}
+.    \}
 .\}
-.el \{\
+.rr rF
-.    de IX
-..
-.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .    \" fudge factors for nroff and troff
 .if n \{\
 .\}
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
 .IX Title "LIBEV 3"
-.TH LIBEV 3 "2012-02-04" "libev-4.11" "libev - high performance full featured event loop"
+.TH LIBEV 3 "2013-12-27" "libev-4.15" "libev - high performance full featured event loop"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
 .nh
 .SH "NAME"
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
 \&   #include <ev.h>
 .Ve
-.SS "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
+.SS "\s-1EXAMPLE PROGRAM\s0"
 .IX Subsection "EXAMPLE PROGRAM"
 .Vb 2
 \&   // a single header file is required
 \&   #include <ev.h>
 \&
 throughout this document.
 .SH "WHAT TO READ WHEN IN A HURRY"
 .IX Header "WHAT TO READ WHEN IN A HURRY"
 This manual tries to be very detailed, but unfortunately, this also makes
 it very long. If you just want to know the basics of libev, I suggest
-reading \*(L"\s-1ANATOMY\s0 \s-1OF\s0 A \s-1WATCHER\s0\*(R", then the \*(L"\s-1EXAMPLE\s0 \s-1PROGRAM\s0\*(R" above and
+reading \*(L"\s-1ANATOMY OF A WATCHER\*(R"\s0, then the \*(L"\s-1EXAMPLE PROGRAM\*(R"\s0 above and
-look up the missing functions in \*(L"\s-1GLOBAL\s0 \s-1FUNCTIONS\s0\*(R" and the \f(CW\*(C`ev_io\*(C'\fR and
+look up the missing functions in \*(L"\s-1GLOBAL FUNCTIONS\*(R"\s0 and the \f(CW\*(C`ev_io\*(C'\fR and
-\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER\s0 \s-1TYPES\s0\*(R".
+\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER TYPES\*(R"\s0.
 .SH "ABOUT LIBEV"
 .IX Header "ABOUT LIBEV"
 Libev is an event loop: you register interest in certain events (such as a
 file descriptor being readable or a timeout occurring), and it will manage
 these event sources and provide your program with events.
 more info about various configuration options please have a look at
 \&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
 for multiple event loops, then all functions taking an initial argument of
 name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
 this argument.
-.SS "\s-1TIME\s0 \s-1REPRESENTATION\s0"
+.SS "\s-1TIME REPRESENTATION\s0"
 .IX Subsection "TIME REPRESENTATION"
 Libev represents time as a single floating point number, representing
 the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice
 somewhere near the beginning of 1970, details are complicated, don't
 ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use
 current system. To find which embeddable backends might be supported on
 the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
 & ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
 .Sp
 See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
-.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
+.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4
-.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
+.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())"
 Sets the allocation function to use (the prototype is similar \- the
 semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
 used to allocate and free memory (no surprises here). If it returns zero
 when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
 or take some potentially destructive action.
 \&   }
 \&
 \&   ...
 \&   ev_set_allocator (persistent_realloc);
 .Ve
-.IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4
+.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
-.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))"
+.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())"
 Set the callback function to call on a retryable system call error (such
 as failed select, poll, epoll_wait). The message is a printable string
 indicating the system call or subsystem causing the problem. If this
 callback is set, then libev will expect it to remedy the situation, no
 matter what, when it returns. That is, libev will generally retry the
 .IX Item "EVFLAG_NOENV"
 If this flag bit is or'ed into the flag value (or the program runs setuid
 or setgid) then libev will \fInot\fR look at the environment variable
 \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
 override the flags completely if it is found in the environment. This is
-useful to try out specific backends to test their performance, or to work
+useful to try out specific backends to test their performance, to work
-around bugs.
+around bugs, or to make libev threadsafe (accessing environment variables
+cannot be done in a threadsafe way, but usually it works if no other
+thread modifies them).
 .ie n .IP """EVFLAG_FORKCHECK""" 4
 .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
 .IX Item "EVFLAG_FORKCHECK"
 Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
 make libev check for a fork in each iteration by enabling this flag.
 \&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
 .Sp
 This flag's behaviour will become the default in future versions of libev.
 .ie n .IP """EVBACKEND_SELECT""  (value 1, portable select backend)" 4
 .el .IP "\f(CWEVBACKEND_SELECT\fR  (value 1, portable select backend)" 4
-.IX Item "EVBACKEND_SELECT  (value 1, portable select backend)"
+.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
 This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
 libev tries to roll its own fd_set with no limits on the number of fds,
 but if that fails, expect a fairly low limit on the number of fds when
 using this backend. It doesn't scale too well (O(highest_fd)), but its
 usually the fastest backend for a low number of (low-numbered :) fds.
 This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the
 \&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
 \&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
 .ie n .IP """EVBACKEND_POLL""    (value 2, poll backend, available everywhere except on windows)" 4
 .el .IP "\f(CWEVBACKEND_POLL\fR    (value 2, poll backend, available everywhere except on windows)" 4
-.IX Item "EVBACKEND_POLL    (value 2, poll backend, available everywhere except on windows)"
+.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
 And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
 than select, but handles sparse fds better and has no artificial
 limit on the number of fds you can use (except it will slow down
 considerably with a lot of inactive fds). It scales similarly to select,
 i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
 .Sp
 This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
 \&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
 .ie n .IP """EVBACKEND_EPOLL""   (value 4, Linux)" 4
 .el .IP "\f(CWEVBACKEND_EPOLL\fR   (value 4, Linux)" 4
-.IX Item "EVBACKEND_EPOLL   (value 4, Linux)"
+.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
 Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
 kernels).
 .Sp
 For few fds, this backend is a bit little slower than poll and select, but
 it scales phenomenally better. While poll and select usually scale like
 .Sp
 This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
 \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
 .ie n .IP """EVBACKEND_KQUEUE""  (value 8, most \s-1BSD\s0 clones)" 4
 .el .IP "\f(CWEVBACKEND_KQUEUE\fR  (value 8, most \s-1BSD\s0 clones)" 4
-.IX Item "EVBACKEND_KQUEUE  (value 8, most BSD clones)"
+.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
 Kqueue deserves special mention, as at the time of this writing, it
 was broken on all BSDs except NetBSD (usually it doesn't work reliably
 with anything but sockets and pipes, except on Darwin, where of course
 it's completely useless). Unlike epoll, however, whose brokenness
 is by design, these kqueue bugs can (and eventually will) be fixed
 .Sp
 It scales in the same way as the epoll backend, but the interface to the
 kernel is more efficient (which says nothing about its actual speed, of
 course). While stopping, setting and starting an I/O watcher does never
 cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
-two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but
+two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
-sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
+might have to leak fd's on fork, but it's more sane than epoll) and it
-cases
+drops fds silently in similarly hard-to-detect cases.
 .Sp
 This backend usually performs well under most conditions.
 .Sp
 While nominally embeddable in other event loops, this doesn't work
 everywhere, so you might need to test for this. And since it is broken
 almost everywhere, you should only use it when you have a lot of sockets
 (for which it usually works), by embedding it into another event loop
 (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
-also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets.
+also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
 .Sp
 This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
 \&\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
 \&\f(CW\*(C`NOTE_EOF\*(C'\fR.
 .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
 implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
 and is not embeddable, which would limit the usefulness of this backend
 immensely.
 .ie n .IP """EVBACKEND_PORT""    (value 32, Solaris 10)" 4
 .el .IP "\f(CWEVBACKEND_PORT\fR    (value 32, Solaris 10)" 4
-.IX Item "EVBACKEND_PORT    (value 32, Solaris 10)"
+.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
 This uses the Solaris 10 event port mechanism. As with everything on Solaris,
 it's really slow, but it still scales very well (O(active_fds)).
 .Sp
 While this backend scales well, it requires one system call per active
 file descriptor per loop iteration. For small and medium numbers of file
 reinitialise the kernel state for backends that have one. Despite the
 name, you can call it anytime, but it makes most sense after forking, in
 the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the
 child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
 .Sp
 Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
 a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
 because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
 during fork.
 .Sp
 On the other hand, you only need to call this function in the child
 given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
 without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
 .Sp
 Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
 event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
-.IP "ev_run (loop, int flags)" 4
+.IP "bool ev_run (loop, int flags)" 4
-.IX Item "ev_run (loop, int flags)"
+.IX Item "bool ev_run (loop, int flags)"
 Finally, this is it, the event handler. This function usually is called
 after you have initialised all your watchers and you want to start
 handling events. It will ask the operating system for any new events, call
-the watcher callbacks, an then repeat the whole process indefinitely: This
+the watcher callbacks, and then repeat the whole process indefinitely: This
 is why event loops are called \fIloops\fR.
 .Sp
 If the flags argument is specified as \f(CW0\fR, it will keep handling events
 until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
 called.
+.Sp
+The return value is false if there are no more active watchers (which
+usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
+(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
 .Sp
 Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
 relying on all watchers to be stopped when deciding when a program has
 finished (especially in interactive programs), but having a program
 that automatically loops as long as it has to and no longer by virtue
 of relying on its watchers stopping correctly, that is truly a thing of
 beauty.
 .Sp
-This function is also \fImostly\fR exception-safe \- you can break out of
+This function is \fImostly\fR exception-safe \- you can break out of a
-a \f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
+\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
 exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
 will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
 .Sp
 A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
 those events and any already outstanding ones, but will not wait and
 this callback instead. This is useful, for example, when you want to
 invoke the actual watchers inside another context (another thread etc.).
 .Sp
 If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
 callback.
-.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4
+.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
-.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))"
+.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
 Sometimes you want to share the same loop between multiple threads. This
 can be done relatively simply by putting mutex_lock/unlock calls around
 each call to a libev function.
 .Sp
 However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
 .PD 0
 .ie n .IP """EV_CHECK""" 4
 .el .IP "\f(CWEV_CHECK\fR" 4
 .IX Item "EV_CHECK"
 .PD
-All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts
+All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
-to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after
+gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
-\&\f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it invokes any callbacks for any
+just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
+for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
+watchers invoked before the event loop sleeps or polls for new events, and
+\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
+or lower priority within an event loop iteration.
+.Sp
-received events. Callbacks of both watcher types can start and stop as
+Callbacks of both watcher types can start and stop as many watchers as
-many watchers as they want, and all of them will be taken into account
+they want, and all of them will be taken into account (for example, a
-(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep
+\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
-\&\f(CW\*(C`ev_run\*(C'\fR from blocking).
+blocking).
 .ie n .IP """EV_EMBED""" 4
 .el .IP "\f(CWEV_EMBED\fR" 4
 .IX Item "EV_EMBED"
 The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
 .ie n .IP """EV_FORK""" 4
 example it might indicate that a fd is readable or writable, and if your
 callbacks is well-written it can just attempt the operation and cope with
 the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
 programs, though, as the fd could already be closed and reused for another
 thing, so beware.
-.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
+.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
 .IX Subsection "GENERIC WATCHER FUNCTIONS"
 .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
 .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
 .IX Item "ev_init (ev_TYPE *watcher, callback)"
 This macro initialises the generic portion of a watcher. The contents
 make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
 it).
 .IP "callback ev_cb (ev_TYPE *watcher)" 4
 .IX Item "callback ev_cb (ev_TYPE *watcher)"
 Returns the callback currently set on the watcher.
-.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
+.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
-.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
+.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
 Change the callback. You can change the callback at virtually any time
 (modulo threads).
 .IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
 .IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
 .PD 0
 or might not have been clamped to the valid range.
 .Sp
 The default priority used by watchers when no priority has been set is
 always \f(CW0\fR, which is supposed to not be too high and not be too low :).
 .Sp
-See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of
+See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
 priorities.
 .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
 .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
 Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
 \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
 not started in the first place.
 .Sp
 See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
 functions that do not need a watcher.
 .PP
-See also the \*(L"\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0\*(R" and \*(L"\s-1BUILDING\s0 \s-1YOUR\s0
+See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
-\&\s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0\*(R" idioms.
+OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
-.SS "\s-1WATCHER\s0 \s-1STATES\s0"
+.SS "\s-1WATCHER STATES\s0"
 .IX Subsection "WATCHER STATES"
 There are various watcher states mentioned throughout this manual \-
 active, pending and so on. In this section these states and the rules to
 transition between them will be described in more detail \- and while these
 rules might look complicated, they usually do \*(L"the right thing\*(R".
-.IP "initialiased" 4
+.IP "initialised" 4
-.IX Item "initialiased"
+.IX Item "initialised"
 Before a watcher can be registered with the event loop it has to be
 initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
 \&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
 .Sp
 In this state it is simply some block of memory that is suitable for
 .Sp
 While stopped (and not pending) the watcher is essentially in the
 initialised state, that is, it can be reused, moved, modified in any way
 you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
 it again).
-.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0"
+.SS "\s-1WATCHER PRIORITY MODELS\s0"
 .IX Subsection "WATCHER PRIORITY MODELS"
 Many event loops support \fIwatcher priorities\fR, which are usually small
 integers that influence the ordering of event callback invocation
 between watchers in some way, all else being equal.
 .PP
 wish to read \- you would first have to request some data.
 .PP
 Since files are typically not-so-well supported by advanced notification
 mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
 to files, even though you should not use it. The reason for this is
-convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT\s0, which is
+convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
 usually a tty, often a pipe, but also sometimes files or special devices
 (for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
 \&\fI/dev/urandom\fR), and even though the file might better be served with
 asynchronous I/O instead of with non-blocking I/O, it is still useful when
 it \*(L"just works\*(R" instead of freezing.
 .PP
 So avoid file descriptors pointing to files when you know it (e.g. use
-libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT\s0, or
+libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
 when you rarely read from a file instead of from a socket, and want to
 reuse the same code path.
 .PP
 \fIThe special problem of fork\fR
 .IX Subsection "The special problem of fork"
 \fIThe special problem of \s-1SIGPIPE\s0\fR
 .IX Subsection "The special problem of SIGPIPE"
 .PP
 While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
 when writing to a pipe whose other end has been closed, your program gets
-sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs
+sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
 this is sensible behaviour, for daemons, this is usually undesirable.
 .PP
 So when you encounter spurious, unexplained daemon exits, make sure you
-ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
+ignore \s-1SIGPIPE \s0(and maybe make sure you log the exit status of your daemon
 somewhere, as that would have given you a big clue).
 .PP
 \fIThe special problem of \fIaccept()\fIing when you can't\fR
 .IX Subsection "The special problem of accept()ing when you can't"
 .PP
-Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
+Many implementations of the \s-1POSIX \s0\f(CW\*(C`accept\*(C'\fR function (for example,
 found in post\-2004 Linux) have the peculiar behaviour of not removing a
 connection from the pending queue in all error cases.
 .PP
 For example, larger servers often run out of file descriptors (because
 of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not
 \&   callback (EV_P_ ev_timer *w, int revents)
 \&   {
 \&     // calculate when the timeout would happen
 \&     ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
 \&
-\&     // if negative, it means we the timeout already occured
+\&     // if negative, it means we the timeout already occurred
 \&     if (after < 0.)
 \&       {
 \&         // timeout occurred, take action
 \&       }
 \&     else
 .Sp
 Otherwise, we now the earliest time at which the timeout would trigger,
 and simply start the timer with this timeout value.
 .Sp
 In other words, each time the callback is invoked it will check whether
-the timeout cocured. If not, it will simply reschedule itself to check
+the timeout occurred. If not, it will simply reschedule itself to check
 again at the earliest time it could time out. Rinse. Repeat.
 .Sp
 This scheme causes more callback invocations (about one every 60 seconds
 minus half the average time between activity), but virtually no calls to
 libev to change the timeout.
 \&     last_activity = ev_now (EV_A);
 .Ve
 .Sp
 When your timeout value changes, then the timeout can be changed by simply
 providing a new value, stopping the timer and calling the callback, which
-will agaion do the right thing (for example, time out immediately :).
+will again do the right thing (for example, time out immediately :).
 .Sp
 .Vb 3
 \&   timeout = new_value;
 \&   ev_timer_stop (EV_A_ &timer);
 \&   callback (EV_A_ &timer, 0);
 In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
 ignored. Instead, each time the periodic watcher gets scheduled, the
 reschedule callback will be called with the watcher as first, and the
 current time as second argument.
 .Sp
-\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever,
+\&\s-1NOTE: \s0\fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
 or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
 allowed by documentation here\fR.
 .Sp
 If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
 it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
 It must return the next time to trigger, based on the passed time value
 (that is, the lowest time value larger than to the second argument). It
 will usually be called just before the callback will be triggered, but
 might be called at other times, too.
 .Sp
-\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
+\&\s-1NOTE: \s0\fIThis callback must always return a time that is higher than or
 equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
 .Sp
 This can be used to create very complex timers, such as a timer that
 triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the
 next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How
 only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
 default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
 \&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
 the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
 .PP
-When the first watcher gets started will libev actually register something
+Only after the first watcher for a signal is started will libev actually
-with the kernel (thus it coexists with your own signal handlers as long as
+register something with the kernel. It thus coexists with your own signal
-you don't register any with libev for the same signal).
+handlers as long as you don't register any with libev for the same signal.
 .PP
 If possible and supported, libev will install its handlers with
 \&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
 not be unduly interrupted. If you have a problem with system calls getting
 interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
 The simplest way to ensure that the signal mask is reset in the child is
 to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will
 catch fork calls done by libraries (such as the libc) as well.
 .PP
 In current versions of libev, the signal will not be blocked indefinitely
-unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API\s0 (\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
+unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API \s0(\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces
 the window of opportunity for problems, it will not go away, as libev
 \&\fIhas\fR to modify the signal mask, at least temporarily.
 .PP
 So I can't stress this enough: \fIIf you do not reset your signal mask when
 you expect it to be empty, you have a race condition in your code\fR. This
 The signal the watcher watches out for.
 .PP
 \fIExamples\fR
 .IX Subsection "Examples"
 .PP
-Example: Try to exit cleanly on \s-1SIGINT\s0.
+Example: Try to exit cleanly on \s-1SIGINT.\s0
 .PP
 .Vb 5
 \&   static void
 \&   sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
 \&   {
 .ie n .SS """ev_stat"" \- did the file attributes just change?"
 .el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
 .IX Subsection "ev_stat - did the file attributes just change?"
 This watches a file system path for attribute changes. That is, it calls
 \&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
-and sees if it changed compared to the last time, invoking the callback if
+and sees if it changed compared to the last time, invoking the callback
-it did.
+if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
+happen after the watcher has been started will be reported.
 .PP
 The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
 not exist\*(R" is a status change like any other. The condition \*(L"path does not
 exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
 \&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
 compilation environment, which means that on systems with large file
 support disabled by default, you get the 32 bit version of the stat
 structure. When using the library from programs that change the \s-1ABI\s0 to
 use 64 bit file offsets the programs will fail. In that case you have to
 compile libev with the same flags to get binary compatibility. This is
-obviously the case with any flags that change the \s-1ABI\s0, but the problem is
+obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
 most noticeably displayed with ev_stat and large file support.
 .PP
 The solution for this is to lobby your distribution maker to make large
 file interfaces available by default (as e.g. FreeBSD does) and not
 optional. Libev cannot simply switch on large file support because it has
 Apart from keeping your process non-blocking (which is a useful
 effect on its own sometimes), idle watchers are a good place to do
 \&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
 event loop has handled all outstanding events.
 .PP
+\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
+.IX Subsection "Abusing an ev_idle watcher for its side-effect"
+.PP
+As long as there is at least one active idle watcher, libev will never
+sleep unnecessarily. Or in other words, it will loop as fast as possible.
+For this to work, the idle watcher doesn't need to be invoked at all \- the
+lowest priority will do.
+.PP
+This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
+to do something on each event loop iteration \- for example to balance load
+between different connections.
+.PP
+See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
+example.
+.PP
 \fIWatcher-Specific Functions and Data Members\fR
 .IX Subsection "Watcher-Specific Functions and Data Members"
 .IP "ev_idle_init (ev_idle *, callback)" 4
 .IX Item "ev_idle_init (ev_idle *, callback)"
 Initialises and configures the idle watcher \- it has no parameters of any
 .IX Subsection "Examples"
 .PP
 Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
 callback, free it. Also, use no error checking, as usual.
 .PP
-.Vb 7
+.Vb 5
 \&   static void
 \&   idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
 \&   {
+\&     // stop the watcher
+\&     ev_idle_stop (loop, w);
+\&
+\&     // now we can free it
 \&     free (w);
+\&
 \&     // now do something you wanted to do when the program has
 \&     // no longer anything immediate to do.
 \&   }
 \&
 \&   ev_idle *idle_watcher = malloc (sizeof (ev_idle));
 \&   ev_idle_start (loop, idle_watcher);
 .Ve
 .ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
 .el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
 .IX Subsection "ev_prepare and ev_check - customise your event loop!"
-Prepare and check watchers are usually (but not always) used in pairs:
+Prepare and check watchers are often (but not always) used in pairs:
 prepare watchers get invoked before the process blocks and check watchers
 afterwards.
 .PP
 You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter
 the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
 with priority higher than or equal to the event loop and one coroutine
 of lower priority, but only once, using idle watchers to keep the event
 loop from blocking if lower-priority coroutines are active, thus mapping
 low-priority coroutines to idle/background tasks).
 .PP
-It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR)
+When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
-priority, to ensure that they are being run before any other watchers
+highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
-after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers).
+any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
+watchers).
 .PP
 Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
 activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
 might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
 \&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
 loops those other event loops might be in an unusable state until their
 \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
 others).
+.PP
+\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
+.IX Subsection "Abusing an ev_check watcher for its side-effect"
+.PP
+\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
+useful because they are called once per event loop iteration. For
+example, if you want to handle a large number of connections fairly, you
+normally only do a bit of work for each active connection, and if there
+is more work to do, you wait for the next event loop iteration, so other
+connections have a chance of making progress.
+.PP
+Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
+next event loop iteration. However, that isn't as soon as possible \-
+without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
+.PP
+This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
+single global idle watcher that is active as long as you have one active
+\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
+will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
+invoked. Neither watcher alone can do that.
 .PP
 \fIWatcher-Specific Functions and Data Members\fR
 .IX Subsection "Watcher-Specific Functions and Data Members"
 .IP "ev_prepare_init (ev_prepare *, callback)" 4
 .IX Item "ev_prepare_init (ev_prepare *, callback)"
 .Ve
 .PP
 Method 4: Do not use a prepare or check watcher because the module you
 want to embed is not flexible enough to support it. Instead, you can
 override their poll function. The drawback with this solution is that the
-main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses
+main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
 this approach, effectively embedding \s-1EV\s0 as a client into the horrible
 libglib event loop.
 .PP
 .Vb 4
 \&   static gint
 \fIWatcher-Specific Functions and Data Members\fR
 .IX Subsection "Watcher-Specific Functions and Data Members"
 .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
 .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
 .PD 0
-.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
+.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
-.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)"
+.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
 .PD
 Configures the watcher to embed the given loop, which must be
 embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
 invoked automatically, otherwise it is the responsibility of the callback
 to invoke it (it will continue to be called until the sweep has been done,
 .ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
 .el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
 .IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
 Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
 whoever is a good citizen cared to tell libev about it by calling
-\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the
+\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
-event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called,
+and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
-and only in the child after the fork. If whoever good citizen calling
+after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
-\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
+and calls it in the wrong process, the fork handlers will be invoked, too,
-handlers will be invoked, too, of course.
+of course.
 .PP
 \fIThe special problem of life after fork \- how is it possible?\fR
 .IX Subsection "The special problem of life after fork - how is it possible?"
 .PP
 Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set
 it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
 .PP
 This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
 too, are asynchronous in nature, and signals, too, will be compressed
 (i.e. the number of callback invocations may be less than the number of
-\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). In fact, you could use signal watchers as a kind
+\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
 of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
 signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
 even without knowing which loop owns the signal.
 .PP
 \fIQueueing\fR
 \&\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_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
 value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
 a timeout and an io event at the same time \- you probably should give io
 events precedence.
 .Sp
-Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0.
+Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
 .Sp
 .Vb 7
 \&   static void stdin_ready (int revents, void *arg)
 \&   {
 \&     if (revents & EV_READ)
 .SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
 .IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
 This section explains some common idioms that are not immediately
 obvious. Note that examples are sprinkled over the whole manual, and this
 section only contains stuff that wouldn't fit anywhere else.
-.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
+.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
 .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
 Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
 or modify at any time: libev will completely ignore it. This can be used
 to associate arbitrary data with your watcher. If you need more data and
 don't want to allocate memory separately and store a pointer to it in that
 \&   }
 .Ve
 .PP
 More interesting and less C\-conformant ways of casting your callback
 function type instead have been omitted.
-.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0"
+.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
 .IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
 Another common scenario is to use some data structure with multiple
 embedded watchers, in effect creating your own watcher that combines
 multiple libev event sources into one \*(L"super-watcher\*(R":
 .PP
 \&   {
 \&     struct my_biggy big = (struct my_biggy *)
 \&       (((char *)w) \- offsetof (struct my_biggy, t2));
 \&   }
 .Ve
-.SS "\s-1AVOIDING\s0 \s-1FINISHING\s0 \s-1BEFORE\s0 \s-1RETURNING\s0"
+.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
 .IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
 Often you have structures like this in event-based programs:
 .PP
 .Vb 4
 \&  callback ()
 already been invoked.
 .PP
 A common way around all these issues is to make sure that
 \&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
 \&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
-delay invoking the callback by e.g. using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher
+delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
-for example, or more sneakily, by reusing an existing (stopped) watcher
+example, or more sneakily, by reusing an existing (stopped) watcher and
-and pushing it into the pending queue:
+pushing it into the pending queue:
 .PP
 .Vb 2
 \&   ev_set_cb (watcher, callback);
 \&   ev_feed_event (EV_A_ watcher, 0);
 .Ve
 .PP
 This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
 invoked, while not delaying callback invocation too much.
-.SS "\s-1MODEL/NESTED\s0 \s-1EVENT\s0 \s-1LOOP\s0 \s-1INVOCATIONS\s0 \s-1AND\s0 \s-1EXIT\s0 \s-1CONDITIONS\s0"
+.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
 .IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
 Often (especially in \s-1GUI\s0 toolkits) there are places where you have
 \&\fImodal\fR interaction, which is most easily implemented by recursively
 invoking \f(CW\*(C`ev_run\*(C'\fR.
 .PP
 This brings the problem of exiting \- a callback might want to finish the
 main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
 a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
 and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
-other combination: In these cases, \f(CW\*(C`ev_break\*(C'\fR will not work alone.
+other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
 .PP
 The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
 invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
 triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
 .PP
 \&   exit_main_loop = 1;
 \&
 \&   // exit both
 \&   exit_main_loop = exit_nested_loop = 1;
 .Ve
-.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0"
+.SS "\s-1THREAD LOCKING EXAMPLE\s0"
 .IX Subsection "THREAD LOCKING EXAMPLE"
 Here is a fictitious example of how to run an event loop in a different
 thread from where callbacks are being invoked and watchers are
 created/added/removed.
 .PP
 .PP
 Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
 an event loop currently blocking in the kernel will have no knowledge
 about the newly added timer. By waking up the loop it will pick up any new
 watchers in the next event loop iteration.
-.SS "\s-1THREADS\s0, \s-1COROUTINES\s0, \s-1CONTINUATIONS\s0, \s-1QUEUES\s0... \s-1INSTEAD\s0 \s-1OF\s0 \s-1CALLBACKS\s0"
+.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
 .IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
 While the overhead of a callback that e.g. schedules a thread is small, it
 is still an overhead. If you embed libev, and your main usage is with some
 kind of threads or coroutines, you might want to customise libev so that
 doesn't need callbacks anymore.
 .PP
 .Vb 6
 \&   void
 \&   wait_for_event (ev_watcher *w)
 \&   {
-\&     ev_cb_set (w) = current_coro;
+\&     ev_set_cb (w, current_coro);
 \&     switch_to (libev_coro);
 \&   }
 .Ve
 .PP
 That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
 You can do similar tricks if you have, say, threads with an event queue \-
 instead of storing a coroutine, you store the queue object and instead of
 switching to a coroutine, you push the watcher onto the queue and notify
 any waiters.
 .PP
-To embed libev, see \s-1EMBEDDING\s0, but in short, it's easiest to create two
+To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
 files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
 .PP
 .Vb 4
 \&   // my_ev.h
 \&   #define EV_CB_DECLARE(type)   struct my_coro *cb;
 .IP "\(bu" 4
 The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
 to use the libev header file and library.
 .SH "\*(C+ SUPPORT"
 .IX Header " SUPPORT"
+.SS "C \s-1API\s0"
+.IX Subsection "C API"
+The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
+libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
+will work fine.
+.PP
+Proper exception specifications might have to be added to callbacks passed
+to libev: exceptions may be thrown only from watcher callbacks, all
+other callbacks (allocator, syserr, loop acquire/release and periodic
+reschedule callbacks) must not throw exceptions, and might need a \f(CW\*(C`throw
+()\*(C'\fR specification. If you have code that needs to be compiled as both C
+and \*(C+ you can use the \f(CW\*(C`EV_THROW\*(C'\fR macro for this:
+.PP
+.Vb 6
+\&   static void
+\&   fatal_error (const char *msg) EV_THROW
+\&   {
+\&     perror (msg);
+\&     abort ();
+\&   }
+\&
+\&   ...
+\&   ev_set_syserr_cb (fatal_error);
+.Ve
+.PP
+The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
+\&\f(CW\*(C`ev_invoke\*(C'\fR, \f(CW\*(C`ev_invoke_pending\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR (the latter
+because it runs cleanup watchers).
+.PP
+Throwing exceptions in watcher callbacks is only supported if libev itself
+is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
+throwing exceptions through C libraries (most do).
+.SS "\*(C+ \s-1API\s0"
+.IX Subsection " API"
 Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
 you to use some convenience methods to start/stop watchers and also change
 the callback model to a model using method callbacks on objects.
 .PP
 To use it,
 Currently, functions, static and non-static member functions and classes
 with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
 to add as long as they only need one additional pointer for context. If
 you need support for other types of functors please contact the author
 (preferably after implementing it).
+.PP
+For all this to work, your \*(C+ compiler either has to use the same calling
+conventions as your C compiler (for static member functions), or you have
+to embed libev and compile libev itself as \*(C+.
 .PP
 Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
 .ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
 .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
 .IX Item "ev::READ, ev::WRITE etc."
 .IX Item "w->set (loop)"
 Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
 do this when the watcher is inactive (and not pending either).
 .IP "w\->set ([arguments])" 4
 .IX Item "w->set ([arguments])"
-Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this
+Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
-method or a suitable start method must be called at least once. Unlike the
+with the same arguments. Either this method or a suitable start method
-C counterpart, an active watcher gets automatically stopped and restarted
+must be called at least once. Unlike the C counterpart, an active watcher
-when reconfiguring it with this method.
+gets automatically stopped and restarted when reconfiguring it with this
+method.
+.Sp
+For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
+clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
 .IP "w\->start ()" 4
 .IX Item "w->start ()"
 Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
 constructor already stores the event loop.
 .IP "w\->start ([arguments])" 4
 there are additional modules that implement libev-compatible interfaces
 to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
 \&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR
 and \f(CW\*(C`EV::Glib\*(C'\fR).
 .Sp
-It can be found and installed via \s-1CPAN\s0, its homepage is at
+It can be found and installed via \s-1CPAN,\s0 its homepage is at
 <http://software.schmorp.de/pkg/EV>.
 .IP "Python" 4
 .IX Item "Python"
 Python bindings can be found at <http://code.google.com/p/pyev/>. It
 seems to be quite complete and well-documented.
 Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
 makes rev work even on mingw.
 .IP "Haskell" 4
 .IX Item "Haskell"
 A haskell binding to libev is available at
-http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev <http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
+<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
 .IP "D" 4
 .IX Item "D"
 Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
 be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
 .IP "Ocaml" 4
 .IX Item "Ocaml"
 Erkki Seppala has written Ocaml bindings for libev, to be found at
-http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/ <http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
+<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
 .IP "Lua" 4
 .IX Item "Lua"
 Brian Maher has written a partial interface to libev for lua (at the
 time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
-http://github.com/brimworks/lua\-ev <http://github.com/brimworks/lua-ev>.
+<http://github.com/brimworks/lua\-ev>.
+.IP "Javascript" 4
+.IX Item "Javascript"
+Node.js (<http://nodejs.org>) uses libev as the underlying event library.
+.IP "Others" 4
+.IX Item "Others"
+There are others, and I stopped counting.
 .SH "MACRO MAGIC"
 .IX Header "MACRO MAGIC"
 Libev can be compiled with a variety of options, the most fundamental
 of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
 functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
 .SS "\s-1FILESETS\s0"
 .IX Subsection "FILESETS"
 Depending on what features you need you need to include one or more sets of files
 in your application.
 .PP
-\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
+\fI\s-1CORE EVENT LOOP\s0\fR
 .IX Subsection "CORE EVENT LOOP"
 .PP
 To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
 configuration (no autoconf):
 .PP
 \&   #include "ev.c"
 .Ve
 .PP
 This will automatically include \fIev.h\fR, too, and should be done in a
 single C source file only to provide the function implementations. To use
-it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
+it, do the same for \fIev.h\fR in all files wishing to use this \s-1API \s0(best
 done by writing a wrapper around \fIev.h\fR that you can include instead and
 where you can put other configuration options):
 .PP
 .Vb 2
 \&   #define EV_STANDALONE 1
 .Ve
 .PP
 \&\fIev.c\fR includes the backend files directly when enabled, so you only need
 to compile this single file.
 .PP
-\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR
+\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
 .IX Subsection "LIBEVENT COMPATIBILITY API"
 .PP
-To include the libevent compatibility \s-1API\s0, also include:
+To include the libevent compatibility \s-1API,\s0 also include:
 .PP
 .Vb 1
 \&   #include "event.c"
 .Ve
 .PP
 .PP
 .Vb 1
 \&   #include "event.h"
 .Ve
 .PP
-in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR.
+in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
 .PP
 You need the following additional files for this:
 .PP
 .Vb 2
 \&   event.h
 \&   event.c
 .Ve
 .PP
-\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR
+\fI\s-1AUTOCONF SUPPORT\s0\fR
 .IX Subsection "AUTOCONF SUPPORT"
 .PP
 Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
 whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
 \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
 For this of course you need the m4 file:
 .PP
 .Vb 1
 \&   libev.m4
 .Ve
-.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
+.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
 .IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
 Libev can be configured via a variety of preprocessor symbols you have to
 define before including (or compiling) any of its files. The default in
 the absence of autoconf is documented for every option.
 .PP
-Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different
+Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
 values when compiling libev vs. including \fIev.h\fR, so it is permissible
 to redefine them before including \fIev.h\fR without breaking compatibility
-to a compiled library. All other symbols change the \s-1ABI\s0, which means all
+to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
 users of libev and the libev code itself must be compiled with compatible
 settings.
-.IP "\s-1EV_COMPAT3\s0 (h)" 4
+.IP "\s-1EV_COMPAT3 \s0(h)" 4
 .IX Item "EV_COMPAT3 (h)"
 Backwards compatibility is a major concern for libev. This is why this
 release of libev comes with wrappers for the functions and symbols that
 have been renamed between libev version 3 and 4.
 .Sp
 typedef in that case.
 .Sp
 In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR,
 and in some even more future version the compatibility code will be
 removed completely.
-.IP "\s-1EV_STANDALONE\s0 (h)" 4
+.IP "\s-1EV_STANDALONE \s0(h)" 4
 .IX Item "EV_STANDALONE (h)"
 Must always be \f(CW1\fR if you do not use autoconf configuration, which
 keeps libev from including \fIconfig.h\fR, and it also defines dummy
 implementations for some libevent functions (such as logging, which is not
 supported). It will also not define any of the structs usually found in
 .IX Item "EV_WIN32_CLOSE_FD(fd)"
 If programs implement their own fd to handle mapping on win32, then this
 macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
 file descriptors again. Note that the replacement function has to close
 the underlying \s-1OS\s0 handle.
+.IP "\s-1EV_USE_WSASOCKET\s0" 4
+.IX Item "EV_USE_WSASOCKET"
+If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
+communication socket, which works better in some environments. Otherwise,
+the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
+environments.
 .IP "\s-1EV_USE_POLL\s0" 4
 .IX Item "EV_USE_POLL"
 If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
 backend. Otherwise it will be enabled on non\-win32 platforms. It
 takes precedence over select.
 between threads, that is, threads can be used, but threads never run on
 different cpus (or different cpu cores). This reduces dependencies
 and makes libev faster.
 .IP "\s-1EV_NO_THREADS\s0" 4
 .IX Item "EV_NO_THREADS"
-If defined to be \f(CW1\fR, libev will assume that it will never be called
+If defined to be \f(CW1\fR, libev will assume that it will never be called from
-from different threads, which is a stronger assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR,
+different threads (that includes signal handlers), which is a stronger
-above. This reduces dependencies and makes libev faster.
+assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
+libev faster.
 .IP "\s-1EV_ATOMIC_T\s0" 4
 .IX Item "EV_ATOMIC_T"
 Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
-access is atomic and serialised with respect to other threads or signal
+access is atomic with respect to other threads or signal contexts. No
-contexts. No such type is easily found in the C language, so you can
+such type is easily found in the C language, so you can provide your own
-provide your own type that you know is safe for your purposes. It is used
+type that you know is safe for your purposes. It is used both for signal
-both for signal handler \*(L"locking\*(R" as well as for signal and thread safety
+handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
-in \f(CW\*(C`ev_async\*(C'\fR watchers.
+watchers.
 .Sp
 In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
-(from \fIsignal.h\fR), which is usually good enough on most platforms,
+(from \fIsignal.h\fR), which is usually good enough on most platforms.
-although strictly speaking using a type that also implies a memory fence
-is required.
-.IP "\s-1EV_H\s0 (h)" 4
+.IP "\s-1EV_H \s0(h)" 4
 .IX Item "EV_H (h)"
 The name of the \fIev.h\fR header file used to include it. The default if
 undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
 used to virtually rename the \fIev.h\fR header file in case of conflicts.
-.IP "\s-1EV_CONFIG_H\s0 (h)" 4
+.IP "\s-1EV_CONFIG_H \s0(h)" 4
 .IX Item "EV_CONFIG_H (h)"
 If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
 \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
 \&\f(CW\*(C`EV_H\*(C'\fR, above.
-.IP "\s-1EV_EVENT_H\s0 (h)" 4
+.IP "\s-1EV_EVENT_H \s0(h)" 4
 .IX Item "EV_EVENT_H (h)"
 Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
 of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
-.IP "\s-1EV_PROTOTYPES\s0 (h)" 4
+.IP "\s-1EV_PROTOTYPES \s0(h)" 4
 .IX Item "EV_PROTOTYPES (h)"
 If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
 prototypes, but still define all the structs and other symbols. This is
 occasionally useful if you want to provide your own wrapper functions
 around libev functions.
 all the priorities, so having many of them (hundreds) uses a lot of space
 and time, so using the defaults of five priorities (\-2 .. +2) is usually
 fine.
 .Sp
 If your embedding application does not need any priorities, defining these
-both to \f(CW0\fR will save some memory and \s-1CPU\s0.
+both to \f(CW0\fR will save some memory and \s-1CPU.\s0
-.IP "\s-1EV_PERIODIC_ENABLE\s0, \s-1EV_IDLE_ENABLE\s0, \s-1EV_EMBED_ENABLE\s0, \s-1EV_STAT_ENABLE\s0, \s-1EV_PREPARE_ENABLE\s0, \s-1EV_CHECK_ENABLE\s0, \s-1EV_FORK_ENABLE\s0, \s-1EV_SIGNAL_ENABLE\s0, \s-1EV_ASYNC_ENABLE\s0, \s-1EV_CHILD_ENABLE\s0." 4
+.IP "\s-1EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE.\s0" 4
 .IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE."
 If undefined or defined to be \f(CW1\fR (and the platform supports it), then
 the respective watcher type is supported. If defined to be \f(CW0\fR, then it
 is not. Disabling watcher types mainly saves code size.
 .IP "\s-1EV_FEATURES\s0" 4
 \&   #define EV_CHILD_ENABLE 1
 \&   #define EV_ASYNC_ENABLE 1
 .Ve
 .Sp
 The actual value is a bitset, it can be a combination of the following
-values:
+values (by default, all of these are enabled):
 .RS 4
 .ie n .IP "1 \- faster/larger code" 4
 .el .IP "\f(CW1\fR \- faster/larger code" 4
 .IX Item "1 - faster/larger code"
 Use larger code to speed up some operations.
 code size by roughly 30% on amd64).
 .Sp
 When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
 gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
 assertions.
+.Sp
+The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
+(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
 .ie n .IP "2 \- faster/larger data structures" 4
 .el .IP "\f(CW2\fR \- faster/larger data structures" 4
 .IX Item "2 - faster/larger data structures"
 Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
 hash table sizes and so on. This will usually further increase code size
 and can additionally have an effect on the size of data structures at
 runtime.
+.Sp
+The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
+(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
 .ie n .IP "4 \- full \s-1API\s0 configuration" 4
 .el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
 .IX Item "4 - full API configuration"
 This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
 enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
 .Vb 3
 \&   #define EV_COMMON                       \e
 \&     SV *self; /* contains this struct */  \e
 \&     SV *cb_sv, *fh /* note no trailing ";" */
 .Ve
-.IP "\s-1EV_CB_DECLARE\s0 (type)" 4
+.IP "\s-1EV_CB_DECLARE \s0(type)" 4
 .IX Item "EV_CB_DECLARE (type)"
 .PD 0
-.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4
+.IP "\s-1EV_CB_INVOKE \s0(watcher, revents)" 4
 .IX Item "EV_CB_INVOKE (watcher, revents)"
 .IP "ev_set_cb (ev, cb)" 4
 .IX Item "ev_set_cb (ev, cb)"
 .PD
 Can be used to change the callback member declaration in each watcher,
 and the way callbacks are invoked and set. Must expand to a struct member
 definition and a statement, respectively. See the \fIev.h\fR header file for
 their default definitions. One possible use for overriding these is to
 avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
 method calls instead of plain function calls in \*(C+.
-.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
+.SS "\s-1EXPORTED API SYMBOLS\s0"
 .IX Subsection "EXPORTED API SYMBOLS"
-If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
+If you need to re-export the \s-1API \s0(e.g. via a \s-1DLL\s0) and you need a list of
 exported symbols, you can use the provided \fISymbol.*\fR files which list
 all public symbols, one per line:
 .PP
 .Vb 2
 \&   Symbols.ev      for libev proper
 \&   #include "ev_cpp.h"
 \&   #include "ev.c"
 .Ve
 .SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
 .IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
-.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0"
+.SS "\s-1THREADS AND COROUTINES\s0"
 .IX Subsection "THREADS AND COROUTINES"
 \fI\s-1THREADS\s0\fR
 .IX Subsection "THREADS"
 .PP
 All libev functions are reentrant and thread-safe unless explicitly
 An example use would be to communicate signals or other events that only
 work in the default loop by registering the signal watcher with the
 default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
 watcher callback into the event loop interested in the signal.
 .PP
-See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R".
+See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
 .PP
 \fI\s-1COROUTINES\s0\fR
 .IX Subsection "COROUTINES"
 .PP
 Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
 that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
 .PP
 Care has been taken to ensure that libev does not keep local state inside
 \&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
 they do not call any callbacks.
-.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0"
+.SS "\s-1COMPILER WARNINGS\s0"
 .IX Subsection "COMPILER WARNINGS"
 Depending on your compiler and compiler settings, you might get no or a
 lot of warnings when compiling libev code. Some people are apparently
 scared by this.
 .PP
 .PP
 If you need, for some reason, empty reports from valgrind for your project
 I suggest using suppression lists.
 .SH "PORTABILITY NOTES"
 .IX Header "PORTABILITY NOTES"
-.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0"
+.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
 .IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
 GNU/Linux is the only common platform that supports 64 bit file/large file
 interfaces but \fIdisables\fR them by default.
 .PP
 That means that libev compiled in the default environment doesn't support
 files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
 .PP
 Unfortunately, many programs try to work around this GNU/Linux issue
-by enabling the large file \s-1API\s0, which makes them incompatible with the
+by enabling the large file \s-1API,\s0 which makes them incompatible with the
 standard libev compiled for their system.
 .PP
 Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
 suddenly make it incompatible to the default compile time environment,
 i.e. all programs not using special compile switches.
-.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0"
+.SS "\s-1OS/X AND DARWIN BUGS\s0"
 .IX Subsection "OS/X AND DARWIN BUGS"
 The whole thing is a bug if you ask me \- basically any system interface
 you touch is broken, whether it is locales, poll, kqueue or even the
 OpenGL drivers.
 .PP
 .PP
 \fI\f(CI\*(C`select\*(C'\fI is buggy\fR
 .IX Subsection "select is buggy"
 .PP
 All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
-one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file
+one up as well: On \s-1OS/X, \s0\f(CW\*(C`select\*(C'\fR actively limits the number of file
 descriptors you can pass in to 1024 \- your program suddenly crashes when
 you use more.
 .PP
 There is an undocumented \*(L"workaround\*(R" for this \- defining
 \&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
-work on \s-1OS/X\s0.
+work on \s-1OS/X.\s0
-.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0"
+.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
 .IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
 \fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
 .IX Subsection "errno reentrancy"
 .PP
 The default compile environment on Solaris is unfortunately so
 great.
 .PP
 If you can't get it to work, you can try running the program by setting
 the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
 \&\f(CW\*(C`select\*(C'\fR backends.
-.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0"
+.SS "\s-1AIX POLL BUG\s0"
 .IX Subsection "AIX POLL BUG"
 \&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
 this by trying to avoid the poll backend altogether (i.e. it's not even
 compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
-with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway.
+with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
-.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0"
+.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
 .IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
 \fIGeneral issues\fR
 .IX Subsection "General issues"
 .PP
 Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
 \&   #define EV_USE_SELECT 1
 \&   #define EV_SELECT_IS_WINSOCKET 1   /* forces EV_SELECT_USE_FD_SET, too */
 .Ve
 .PP
 Note that winsockets handling of fd sets is O(n), so you can easily get a
-complexity in the O(nA\*^X) range when using win32.
+complexity in the O(nX) range when using win32.
 .PP
 \fILimited number of file descriptors\fR
 .IX Subsection "Limited number of file descriptors"
 .PP
 Windows has numerous arbitrary (and low) limits on things.
 by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
 (another arbitrary limit), but is broken in many versions of the Microsoft
 runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
 (depending on windows version and/or the phase of the moon). To get more,
 you need to wrap all I/O functions and provide your own fd management, but
-the cost of calling select (O(nA\*^X)) will likely make this unworkable.
+the cost of calling select (O(nX)) will likely make this unworkable.
-.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0"
+.SS "\s-1PORTABILITY REQUIREMENTS\s0"
 .IX Subsection "PORTABILITY REQUIREMENTS"
 In addition to a working ISO-C implementation and of course the
 backend-specific APIs, libev relies on a few additional extensions:
 .ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
 .el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
 .IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
 Libev assumes not only that all watcher pointers have the same internal
-structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also
+structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
 assumes that the same (machine) code can be used to call any watcher
 callback: The watcher callbacks have different type signatures, but libev
 calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
 .IP "pointer accesses must be thread-atomic" 4
 .IX Item "pointer accesses must be thread-atomic"
 thread\*(R" or will block signals process-wide, both behaviours would
 be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
 \&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
 .Sp
 The most portable way to handle signals is to block signals in all threads
-except the initial one, and run the default loop in the initial thread as
+except the initial one, and run the signal handling loop in the initial
-well.
+thread as well.
 .ie n .IP """long"" must be large enough for common memory allocation sizes" 4
 .el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
 .IX Item "long must be large enough for common memory allocation sizes"
-To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally
+To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
 instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
 systems (Microsoft...) this might be unexpectedly low, but is still at
 least 31 bits everywhere, which is enough for hundreds of millions of
 watchers.
 .ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
 .IX Item "double must hold a time value in seconds with enough accuracy"
 The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
 have at least 51 bits of mantissa (and 9 bits of exponent), which is
 good enough for at least into the year 4000 with millisecond accuracy
 (the design goal for libev). This requirement is overfulfilled by
-implementations using \s-1IEEE\s0 754, which is basically all existing ones.
+implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
 .Sp
-With \s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least the
+With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
 year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
 is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
 something like that, just kidding).
 .PP
 If you know of other additional requirements drop me a note.
 calls in the current loop iteration and the loop is currently
 blocked. Checking for async and signal events involves iterating over all
 running async watchers or all signal numbers.
 .SH "PORTING FROM LIBEV 3.X TO 4.X"
 .IX Header "PORTING FROM LIBEV 3.X TO 4.X"
-The major version 4 introduced some incompatible changes to the \s-1API\s0.
+The major version 4 introduced some incompatible changes to the \s-1API.\s0
 .PP
 At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
 for all changes, so most programs should still compile. The compatibility
 layer might be removed in later versions of libev, so better update to the
 new \s-1API\s0 early than late.
 .ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
 .el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
 .IX Item "EV_COMPAT3 backwards compatibility mechanism"
 The backward compatibility mechanism can be controlled by
-\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1MACROS\s0\*(R" in \s-1PREPROCESSOR\s0 \s-1SYMBOLS\s0 in the \s-1EMBEDDING\s0
+\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
 section.
 .ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
 .el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
 .IX Item "ev_default_destroy and ev_default_fork have been removed"
 These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
 .SH "GLOSSARY"
 .IX Header "GLOSSARY"
 .IP "active" 4
 .IX Item "active"
 A watcher is active as long as it has been started and not yet stopped.
-See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details.
+See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
 .IP "application" 4
 .IX Item "application"
 In this document, an application is whatever is using libev.
 .IP "backend" 4
 .IX Item "backend"
 The model used to describe how an event loop handles and processes
 watchers and events.
 .IP "pending" 4
 .IX Item "pending"
 A watcher is pending as soon as the corresponding event has been
-detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details.
+detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
 .IP "real time" 4
 .IX Item "real time"
 The physical time that is observed. It is apparently strictly monotonic :)
 .IP "wall-clock time" 4
 .IX Item "wall-clock time"

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing libev/ev.3 (file contents): Revision 1.88 by root, Sat Feb 4 18:55:50 2012 UTC vs. Revision 1.101 by root, Fri Dec 27 06:01:21 2013 UTC

Diff Legend

Comparing libev/ev.3 (file contents):
Revision 1.88 by root, Sat Feb 4 18:55:50 2012 UTC vs.
Revision 1.101 by root, Fri Dec 27 06:01:21 2013 UTC