*** empty log message ***

[software/libev.git] / ev.3

diff --git a/ev.3 b/ev.3
index 1f33e819abcd70e0ec45634a66888759cf955a37..86f8a570ee1e85089d785e65f6a60c32f3c1e3ae 100644 (file)
--- a/ev.3
+++ b/ev.3
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title ""<STANDARD INPUT>" 1"
 .\" ========================================================================
 .\"
 .IX Title ""<STANDARD INPUT>" 1"

-.TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH "<STANDARD INPUT>" 1 "2007-12-12" "perl v5.8.8" "User Contributed Perl Documentation"

 .SH "NAME"
 libev \- a high performance full\-featured event loop written in C
 .SH "SYNOPSIS"
 .SH "NAME"
 libev \- a high performance full\-featured event loop written in C
 .SH "SYNOPSIS"


@@ -261,14 +261,17 @@ you actually want to know.
 .IP "int ev_version_minor ()" 4
 .IX Item "int ev_version_minor ()"
 .PD
 .IP "int ev_version_minor ()" 4
 .IX Item "int ev_version_minor ()"
 .PD

-You can find out the major and minor version numbers of the library
+You can find out the major and minor \s-1ABI\s0 version numbers of the library

 you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and
 \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global
 symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the
 version of the library your program was compiled against.
 .Sp
 you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and
 \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global
 symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the
 version of the library your program was compiled against.
 .Sp

+These version numbers refer to the \s-1ABI\s0 version of the library, not the
+release version.
+.Sp

 Usually, it's a good idea to terminate if the major versions mismatch,
 Usually, it's a good idea to terminate if the major versions mismatch,

-as this indicates an incompatible change.  Minor versions are usually
+as this indicates an incompatible change. Minor versions are usually

 compatible to older versions, so a larger minor version alone is usually
 not a problem.
 .Sp
 compatible to older versions, so a larger minor version alone is usually
 not a problem.
 .Sp


@@ -636,9 +639,10 @@ usually a better approach for this kind of thing.
 .Sp
 Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
 .Sp
 .Sp
 Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
 .Sp

-.Vb 18
+.Vb 19
+\&   - Before the first iteration, call any pending watchers.

 \&   * If there are no active watchers (reference count is zero), return.
 \&   * If there are no active watchers (reference count is zero), return.

-\&   - Queue prepare watchers and then call all outstanding watchers.
+\&   - Queue all prepare watchers and then call all outstanding watchers.

 \&   - If we have been forked, recreate the kernel state.
 \&   - Update the kernel state with all outstanding changes.
 \&   - Update the "event loop time".
 \&   - If we have been forked, recreate the kernel state.
 \&   - Update the kernel state with all outstanding changes.
 \&   - Update the "event loop time".


@@ -891,8 +895,9 @@ it.
 Returns a true value iff the watcher is pending, (i.e. it has outstanding
 events but its callback has not yet been invoked). As long as a watcher
 is pending (but not active) you must not call an init function on it (but
 Returns a true value iff the watcher is pending, (i.e. it has outstanding
 events but its callback has not yet been invoked). As long as a watcher
 is pending (but not active) you must not call an init function on it (but

-\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to
-libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it).
+\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
+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 "callback ev_cb (ev_TYPE *watcher)" 4
 .IX Item "callback ev_cb (ev_TYPE *watcher)"
 Returns the callback currently set on the watcher.


@@ -920,12 +925,25 @@ watchers on the same event and make sure one is called first.
 If you need to suppress invocation when higher priority events are pending
 you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
 .Sp
 If you need to suppress invocation when higher priority events are pending
 you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
 .Sp

+You \fImust not\fR change the priority of a watcher as long as it is active or
+pending.
+.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
 Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
 fine, as long as you do not mind that the priority value you query might
 or might not have been adjusted to be within valid range.
 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
 Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
 fine, as long as you do not mind that the priority value you query might
 or might not have been adjusted to be within valid range.

+.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
+can deal with that fact.
+.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
+.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
+If the watcher is pending, this function returns clears its pending status
+and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
+watcher isn't pending it does nothing and returns \f(CW0\fR.

 .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
 .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
 Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
 .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
 .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
 Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change


@@ -1049,6 +1067,31 @@ play around with an Xlib connection), then you have to seperately re-test
 whether a file descriptor is really ready with a known-to-be good interface
 such as poll (fortunately in our Xlib example, Xlib already does this on
 its own, so its quite safe to use).
 whether a file descriptor is really ready with a known-to-be good interface
 such as poll (fortunately in our Xlib example, Xlib already does this on
 its own, so its quite safe to use).

+.PP
+\fIThe special problem of disappearing file descriptors\fR
+.IX Subsection "The special problem of disappearing file descriptors"
+.PP
+Some backends (e.g kqueue, epoll) need to be told about closing a file
+descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means,
+such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file
+descriptor, but when it goes away, the operating system will silently drop
+this interest. If another file descriptor with the same number then is
+registered with libev, there is no efficient way to see that this is, in
+fact, a different file descriptor.
+.PP
+To avoid having to explicitly tell libev about such cases, libev follows
+the following policy:  Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
+will assume that this is potentially a new file descriptor, otherwise
+it is assumed that the file descriptor stays the same. That means that
+you \fIhave\fR to call \f(CW\*(C`ev_io_set\*(C'\fR (or \f(CW\*(C`ev_io_init\*(C'\fR) when you change the
+descriptor even if the file descriptor number itself did not change.
+.PP
+This is how one would do it normally anyway, the important point is that
+the libev application should not optimise around libev but should leave
+optimisations to libev.
+.PP
+\fIWatcher-Specific Functions\fR
+.IX Subsection "Watcher-Specific Functions"

 .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
 .IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
 .PD 0
 .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
 .IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
 .PD 0


@@ -1111,6 +1154,9 @@ on the current time, use something like this to adjust for this:
 The callback is guarenteed to be invoked only when its timeout has passed,
 but if multiple timers become ready during the same loop iteration then
 order of execution is undefined.
 The callback is guarenteed to be invoked only when its timeout has passed,
 but if multiple timers become ready during the same loop iteration then
 order of execution is undefined.

+.PP
+\fIWatcher-Specific Functions and Data Members\fR
+.IX Subsection "Watcher-Specific Functions and Data Members"

 .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
 .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
 .PD 0
 .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4
 .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
 .PD 0


@@ -1222,15 +1268,18 @@ to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a
 periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now ()
 + 10.\*(C'\fR) and then reset your system clock to the last year, then it will
 take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger
 periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now ()
 + 10.\*(C'\fR) and then reset your system clock to the last year, then it will
 take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger

-roughly 10 seconds later and of course not if you reset your system time
-again).
+roughly 10 seconds later).

 .PP
 They can also be used to implement vastly more complex timers, such as
 .PP
 They can also be used to implement vastly more complex timers, such as

-triggering an event on eahc midnight, local time.
+triggering an event on each midnight, local time or other, complicated,
+rules.

 .PP
 As with timers, the callback is guarenteed to be invoked only when the
 time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready
 during the same loop iteration then order of execution is undefined.
 .PP
 As with timers, the callback is guarenteed to be invoked only when the
 time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready
 during the same loop iteration then order of execution is undefined.

+.PP
+\fIWatcher-Specific Functions and Data Members\fR
+.IX Subsection "Watcher-Specific Functions and Data Members"

 .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4
 .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)"
 .PD 0
 .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4
 .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)"
 .PD 0


@@ -1240,17 +1289,17 @@ during the same loop iteration then order of execution is undefined.
 Lots of arguments, lets sort it out... There are basically three modes of
 operation, and we will explain them from simplest to complex:
 .RS 4
 Lots of arguments, lets sort it out... There are basically three modes of
 operation, and we will explain them from simplest to complex:
 .RS 4

-.IP "* absolute timer (interval = reschedule_cb = 0)" 4
-.IX Item "absolute timer (interval = reschedule_cb = 0)"
+.IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4
+.IX Item "absolute timer (at = time, interval = reschedule_cb = 0)"

 In this configuration the watcher triggers an event at the wallclock time
 \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs,
 that is, if it is to be run at January 1st 2011 then it will run when the
 system time reaches or surpasses this time.
 In this configuration the watcher triggers an event at the wallclock time
 \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs,
 that is, if it is to be run at January 1st 2011 then it will run when the
 system time reaches or surpasses this time.

-.IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4
-.IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)"
+.IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4
+.IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)"

 In this mode the watcher will always be scheduled to time out at the next
 In this mode the watcher will always be scheduled to time out at the next

-\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless
-of any time jumps.
+\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative)
+and then repeat, regardless of any time jumps.

 .Sp
 This can be used to create timers that do not drift with respect to system
 time:
 .Sp
 This can be used to create timers that do not drift with respect to system
 time:


@@ -1267,8 +1316,12 @@ by 3600.
 Another way to think about it (for the mathematically inclined) is that
 \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
 time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps.
 Another way to think about it (for the mathematically inclined) is that
 \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
 time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps.

-.IP "* manual reschedule mode (reschedule_cb = callback)" 4
-.IX Item "manual reschedule mode (reschedule_cb = callback)"
+.Sp
+For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near
+\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
+this value.
+.IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4
+.IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)"

 In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(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
 In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(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


@@ -1277,7 +1330,7 @@ current time as second argument.
 \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher,
 ever, or make any event loop modifications\fR. 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
 \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher,
 ever, or make any event loop modifications\fR. 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 a prepare watcher).
+starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal).

 .Sp
 Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
 ev_tstamp now)\*(C'\fR, e.g.:
 .Sp
 Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
 ev_tstamp now)\*(C'\fR, e.g.:


@@ -1311,6 +1364,13 @@ Simply stops and restarts the periodic watcher again. This is only useful
 when you changed some parameters or the reschedule callback would return
 a different time than the last time it was called (e.g. in a crond like
 program when the crontabs have changed).
 when you changed some parameters or the reschedule callback would return
 a different time than the last time it was called (e.g. in a crond like
 program when the crontabs have changed).

+.IP "ev_tstamp offset [read\-write]" 4
+.IX Item "ev_tstamp offset [read-write]"
+When repeating, this contains the offset value, otherwise this is the
+absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR).
+.Sp
+Can be modified any time, but changes only take effect when the periodic
+timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.

 .IP "ev_tstamp interval [read\-write]" 4
 .IX Item "ev_tstamp interval [read-write]"
 The current interval value. Can be modified any time, but changes only
 .IP "ev_tstamp interval [read\-write]" 4
 .IX Item "ev_tstamp interval [read-write]"
 The current interval value. Can be modified any time, but changes only


@@ -1380,6 +1440,9 @@ with the kernel (thus it coexists with your own signal handlers as long
 as you don't register any with libev). Similarly, when the last signal
 watcher for a signal is stopped libev will reset the signal handler to
 \&\s-1SIG_DFL\s0 (regardless of what it was set to before).
 as you don't register any with libev). Similarly, when the last signal
 watcher for a signal is stopped libev will reset the signal handler to
 \&\s-1SIG_DFL\s0 (regardless of what it was set to before).

+.PP
+\fIWatcher-Specific Functions and Data Members\fR
+.IX Subsection "Watcher-Specific Functions and Data Members"

 .IP "ev_signal_init (ev_signal *, callback, int signum)" 4
 .IX Item "ev_signal_init (ev_signal *, callback, int signum)"
 .PD 0
 .IP "ev_signal_init (ev_signal *, callback, int signum)" 4
 .IX Item "ev_signal_init (ev_signal *, callback, int signum)"
 .PD 0


@@ -1396,6 +1459,9 @@ The signal the watcher watches out for.
 .IX Subsection "ev_child - watch out for process status changes"
 Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
 some child status changes (most typically when a child of yours dies).
 .IX Subsection "ev_child - watch out for process status changes"
 Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
 some child status changes (most typically when a child of yours dies).

+.PP
+\fIWatcher-Specific Functions and Data Members\fR
+.IX Subsection "Watcher-Specific Functions and Data Members"

 .IP "ev_child_init (ev_child *, callback, int pid)" 4
 .IX Item "ev_child_init (ev_child *, callback, int pid)"
 .PD 0
 .IP "ev_child_init (ev_child *, callback, int pid)" 4
 .IX Item "ev_child_init (ev_child *, callback, int pid)"
 .PD 0


@@ -1470,6 +1536,9 @@ semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometime
 to fall back to regular polling again even with inotify, but changes are
 usually detected immediately, and if the file exists there will be no
 polling.
 to fall back to regular polling again even with inotify, but changes are
 usually detected immediately, and if the file exists there will be no
 polling.

+.PP
+\fIWatcher-Specific Functions and Data Members\fR
+.IX Subsection "Watcher-Specific Functions and Data Members"

 .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
 .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
 .PD 0
 .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
 .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
 .PD 0


@@ -1558,6 +1627,9 @@ 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.
 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
+\fIWatcher-Specific Functions and Data Members\fR
+.IX Subsection "Watcher-Specific Functions and Data Members"

 .IP "ev_idle_init (ev_signal *, callback)" 4
 .IX Item "ev_idle_init (ev_signal *, callback)"
 Initialises and configures the idle watcher \- it has no parameters of any
 .IP "ev_idle_init (ev_signal *, callback)" 4
 .IX Item "ev_idle_init (ev_signal *, callback)"
 Initialises and configures the idle watcher \- it has no parameters of any


@@ -1622,6 +1694,19 @@ 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).
 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)
+priority, to ensure that they are being run before any other watchers
+after the poll. 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 will be called 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 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
+\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)"
 .PD 0
 .IP "ev_prepare_init (ev_prepare *, callback)" 4
 .IX Item "ev_prepare_init (ev_prepare *, callback)"
 .PD 0


@@ -1632,25 +1717,28 @@ Initialises and configures the prepare or check watcher \- they have no
 parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
 macros, but using them is utterly, utterly and completely pointless.
 .PP
 parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
 macros, but using them is utterly, utterly and completely pointless.
 .PP

-Example: To include a library such as adns, you would add \s-1IO\s0 watchers
-and a timeout watcher in a prepare handler, as required by libadns, and
-in a check watcher, destroy them and call into libadns. What follows is
-pseudo-code only of course:
+There are a number of principal ways to embed other event loops or modules
+into libev. Here are some ideas on how to include libadns into libev
+(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
+use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR
+embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0
+into the Glib event loop).
+.PP
+Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler,
+and in a check watcher, destroy them and call into libadns. What follows
+is pseudo-code only of course. This requires you to either use a low
+priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as
+the callbacks for the IO/timeout watchers might not have been called yet.

 .PP
 .Vb 2
 \&  static ev_io iow [nfd];
 \&  static ev_timer tw;
 .Ve
 .PP
 .PP
 .Vb 2
 \&  static ev_io iow [nfd];
 \&  static ev_timer tw;
 .Ve
 .PP

-.Vb 9
+.Vb 4

 \&  static void
 \&  io_cb (ev_loop *loop, ev_io *w, int revents)
 \&  {
 \&  static void
 \&  io_cb (ev_loop *loop, ev_io *w, int revents)
 \&  {

-\&    // set the relevant poll flags
-\&    // could also call adns_processreadable etc. here
-\&    struct pollfd *fd = (struct pollfd *)w->data;
-\&    if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
-\&    if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;

 \&  }
 .Ve
 .PP
 \&  }
 .Ve
 .PP


@@ -1672,7 +1760,7 @@ pseudo-code only of course:
 .Ve
 .PP
 .Vb 6
 .Ve
 .PP
 .Vb 6

-\&    // create on ev_io per pollfd
+\&    // create one ev_io per pollfd

 \&    for (int i = 0; i < nfd; ++i)
 \&      {
 \&        ev_io_init (iow + i, io_cb, fds [i].fd,
 \&    for (int i = 0; i < nfd; ++i)
 \&      {
 \&        ev_io_init (iow + i, io_cb, fds [i].fd,


@@ -1680,9 +1768,8 @@ pseudo-code only of course:
 \&           | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
 .Ve
 .PP
 \&           | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
 .Ve
 .PP

-.Vb 5
+.Vb 4

 \&        fds [i].revents = 0;
 \&        fds [i].revents = 0;

-\&        iow [i].data = fds + i;

 \&        ev_io_start (loop, iow + i);
 \&      }
 \&  }
 \&        ev_io_start (loop, iow + i);
 \&      }
 \&  }


@@ -1696,15 +1783,110 @@ pseudo-code only of course:
 \&    ev_timer_stop (loop, &tw);
 .Ve
 .PP
 \&    ev_timer_stop (loop, &tw);
 .Ve
 .PP

-.Vb 2
+.Vb 8

 \&    for (int i = 0; i < nfd; ++i)
 \&    for (int i = 0; i < nfd; ++i)

-\&      ev_io_stop (loop, iow + i);
+\&      {
+\&        // set the relevant poll flags
+\&        // could also call adns_processreadable etc. here
+\&        struct pollfd *fd = fds + i;
+\&        int revents = ev_clear_pending (iow + i);
+\&        if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
+\&        if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
+.Ve
+.PP
+.Vb 3
+\&        // now stop the watcher
+\&        ev_io_stop (loop, iow + i);
+\&      }

 .Ve
 .PP
 .Vb 2
 \&    adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
 \&  }
 .Ve
 .Ve
 .PP
 .Vb 2
 \&    adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
 \&  }
 .Ve

+.PP
+Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
+in the prepare watcher and would dispose of the check watcher.
+.PP
+Method 3: If the module to be embedded supports explicit event
+notification (adns does), you can also make use of the actual watcher
+callbacks, and only destroy/create the watchers in the prepare watcher.
+.PP
+.Vb 5
+\&  static void
+\&  timer_cb (EV_P_ ev_timer *w, int revents)
+\&  {
+\&    adns_state ads = (adns_state)w->data;
+\&    update_now (EV_A);
+.Ve
+.PP
+.Vb 2
+\&    adns_processtimeouts (ads, &tv_now);
+\&  }
+.Ve
+.PP
+.Vb 5
+\&  static void
+\&  io_cb (EV_P_ ev_io *w, int revents)
+\&  {
+\&    adns_state ads = (adns_state)w->data;
+\&    update_now (EV_A);
+.Ve
+.PP
+.Vb 3
+\&    if (revents & EV_READ ) adns_processreadable  (ads, w->fd, &tv_now);
+\&    if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
+\&  }
+.Ve
+.PP
+.Vb 1
+\&  // do not ever call adns_afterpoll
+.Ve
+.PP
+Method 4: Do not use a prepare or check watcher because the module you
+want to embed is too inflexible to support it. Instead, youc na 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 does
+this.
+.PP
+.Vb 4
+\&  static gint
+\&  event_poll_func (GPollFD *fds, guint nfds, gint timeout)
+\&  {
+\&    int got_events = 0;
+.Ve
+.PP
+.Vb 2
+\&    for (n = 0; n < nfds; ++n)
+\&      // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
+.Ve
+.PP
+.Vb 2
+\&    if (timeout >= 0)
+\&      // create/start timer
+.Ve
+.PP
+.Vb 2
+\&    // poll
+\&    ev_loop (EV_A_ 0);
+.Ve
+.PP
+.Vb 3
+\&    // stop timer again
+\&    if (timeout >= 0)
+\&      ev_timer_stop (EV_A_ &to);
+.Ve
+.PP
+.Vb 3
+\&    // stop io watchers again - their callbacks should have set
+\&    for (n = 0; n < nfds; ++n)
+\&      ev_io_stop (EV_A_ iow [n]);
+.Ve
+.PP
+.Vb 2
+\&    return got_events;
+\&  }
+.Ve

 .ie n .Sh """ev_embed"" \- when one backend isn't enough..."
 .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
 .IX Subsection "ev_embed - when one backend isn't enough..."
 .ie n .Sh """ev_embed"" \- when one backend isn't enough..."
 .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
 .IX Subsection "ev_embed - when one backend isn't enough..."


@@ -1781,6 +1963,9 @@ create it, and if that fails, use the normal loop for everything:
 \&  else
 \&    loop_lo = loop_hi;
 .Ve
 \&  else
 \&    loop_lo = loop_hi;
 .Ve

+.PP
+\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_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


@@ -1810,6 +1995,9 @@ event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being
 and only in the child after the fork. If whoever good citizen calling
 \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
 handlers will be invoked, too, of course.
 and only in the child after the fork. If whoever good citizen calling
 \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
 handlers will be invoked, too, of course.

+.PP
+\fIWatcher-Specific Functions and Data Members\fR
+.IX Subsection "Watcher-Specific Functions and Data Members"

 .IP "ev_fork_init (ev_signal *, callback)" 4
 .IX Item "ev_fork_init (ev_signal *, callback)"
 Initialises and configures the fork watcher \- it has no parameters of any
 .IP "ev_fork_init (ev_signal *, callback)" 4
 .IX Item "ev_fork_init (ev_signal *, callback)"
 Initialises and configures the fork watcher \- it has no parameters of any


@@ -1980,13 +2168,22 @@ Example: simple class declaration and watcher initialisation
 \&  ev::io iow;
 \&  iow.set <myclass, &myclass::io_cb> (&obj);
 .Ve
 \&  ev::io iow;
 \&  iow.set <myclass, &myclass::io_cb> (&obj);
 .Ve

-.IP "w\->set (void (*function)(watcher &w, int), void *data = 0)" 4
-.IX Item "w->set (void (*function)(watcher &w, int), void *data = 0)"
+.IP "w\->set<function> (void *data = 0)" 4
+.IX Item "w->set<function> (void *data = 0)"

 Also sets a callback, but uses a static method or plain function as
 callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
 \&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
 .Sp
 Also sets a callback, but uses a static method or plain function as
 callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
 \&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
 .Sp

+The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
+.Sp

 See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
 See the method\-\f(CW\*(C`set\*(C'\fR above for more details.

+.Sp
+Example:
+.Sp
+.Vb 2
+\&  static void io_cb (ev::io &w, int revents) { }
+\&  iow.set <io_cb> ();
+.Ve

 .IP "w\->set (struct ev_loop *)" 4
 .IX Item "w->set (struct ev_loop *)"
 Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
 .IP "w\->set (struct ev_loop *)" 4
 .IX Item "w->set (struct ev_loop *)"
 Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only