]> git.llucax.com Git - software/libev.git/blobdiff - ev.html
projects / software / libev.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
*** empty log message ***
[software/libev.git] / ev.html
diff --git a/ev.html b/ev.html
index abaebaa01cc90f3c82d85286b631875ee513b3f2..4837317b313e5cd5cbc5b025a9515372ca7ae9e6 100644 (file)
--- a/ev.html
+++ b/ev.html
@@ -6,7 +6,7 @@
        <meta name="description" content="Pod documentation for libev" />
        <meta name="inputfile" content="&lt;standard input&gt;" />
        <meta name="outputfile" content="&lt;standard output&gt;" />
        <meta name="description" content="Pod documentation for libev" />
        <meta name="inputfile" content="&lt;standard input&gt;" />
        <meta name="outputfile" content="&lt;standard output&gt;" />
-       <meta name="created" content="Mon Nov 12 09:29:10 2007" />
+       <meta name="created" content="Mon Nov 12 09:45:48 2007" />
        <meta name="generator" content="Pod::Xhtml 1.57" />
 <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
 <body>
        <meta name="generator" content="Pod::Xhtml 1.57" />
 <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
 <body>
@@ -26,12 +26,12 @@
 </ul>
 </li>
 <li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
 </ul>
 </li>
 <li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
-<ul><li><a href="#struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</a></li>
-<li><a href="#struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</a></li>
-<li><a href="#ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</a></li>
-<li><a href="#ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</a></li>
-<li><a href="#ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</a></li>
-<li><a href="#ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</a></li>
+<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</a></li>
+<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li>
+<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></li>
+<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</a></li>
+<li><a href="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</a></li>
+<li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li>
 <li><a href="#prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</a></li>
 </ul>
 </li>
 <li><a href="#prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</a></li>
 </ul>
 </li>
@@ -163,12 +163,12 @@ backends to use, and is usually specified as 0 (or EVFLAG_AUTO).</p>
                <p>It supports the following flags:</p>
                <p>
                        <dl>
                <p>It supports the following flags:</p>
                <p>
                        <dl>
-                               <dt>EVFLAG_AUTO</dt>
+                               <dt><code>EVFLAG_AUTO</code></dt>
                                <dd>
                                        <p>The default flags value. Use this if you have no clue (it's the right
 thing, believe me).</p>
                                </dd>
                                <dd>
                                        <p>The default flags value. Use this if you have no clue (it's the right
 thing, believe me).</p>
                                </dd>
-                               <dt>EVFLAG_NOENV</dt>
+                               <dt><code>EVFLAG_NOENV</code></dt>
                                <dd>
                                        <p>If this flag bit is ored into the flag value (or the program runs setuid
 or setgid) then libev will <i>not</i> look at the environment variable
                                <dd>
                                        <p>If this flag bit is ored into the flag value (or the program runs setuid
 or setgid) then libev will <i>not</i> look at the environment variable
@@ -177,12 +177,12 @@ 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
 around bugs.</p>
                                </dd>
 useful to try out specific backends to test their performance, or to work
 around bugs.</p>
                                </dd>
-                               <dt>EVMETHOD_SELECT  (portable select backend)</dt>
-                               <dt>EVMETHOD_POLL    (poll backend, available everywhere except on windows)</dt>
-                               <dt>EVMETHOD_EPOLL   (linux only)</dt>
-                               <dt>EVMETHOD_KQUEUE  (some bsds only)</dt>
-                               <dt>EVMETHOD_DEVPOLL (solaris 8 only)</dt>
-                               <dt>EVMETHOD_PORT    (solaris 10 only)</dt>
+                               <dt><code>EVMETHOD_SELECT</code>  (portable select backend)</dt>
+                               <dt><code>EVMETHOD_POLL</code>    (poll backend, available everywhere except on windows)</dt>
+                               <dt><code>EVMETHOD_EPOLL</code>   (linux only)</dt>
+                               <dt><code>EVMETHOD_KQUEUE</code>  (some bsds only)</dt>
+                               <dt><code>EVMETHOD_DEVPOLL</code> (solaris 8 only)</dt>
+                               <dt><code>EVMETHOD_PORT</code>    (solaris 10 only)</dt>
                                <dd>
                                        <p>If one or more of these are ored into the flags value, then only these
 backends will be tried (in the reverse order as given here). If one are
                                <dd>
                                        <p>If one or more of these are ored into the flags value, then only these
 backends will be tried (in the reverse order as given here). If one are
@@ -290,7 +290,7 @@ libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.
 <div id="ANATOMY_OF_A_WATCHER_CONTENT">
 <p>A watcher is a structure that you create and register to record your
 interest in some event. For instance, if you want to wait for STDIN to
 <div id="ANATOMY_OF_A_WATCHER_CONTENT">
 <p>A watcher is a structure that you create and register to record your
 interest in some event. For instance, if you want to wait for STDIN to
-become readable, you would create an ev_io watcher for that:</p>
+become readable, you would create an <code>ev_io</code> watcher for that:</p>
 <pre>  static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
   {
     ev_io_stop (w);
 <pre>  static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
   {
     ev_io_stop (w);
@@ -324,55 +324,55 @@ corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>
 <p>As long as your watcher is active (has been started but not stopped) you
 must not touch the values stored in it. Most specifically you must never
 reinitialise it or call its set method.</p>
 <p>As long as your watcher is active (has been started but not stopped) you
 must not touch the values stored in it. Most specifically you must never
 reinitialise it or call its set method.</p>
-<p>You cna check whether an event is active by calling the <code>ev_is_active
+<p>You can check whether an event is active by calling the <code>ev_is_active
 (watcher *)</code> macro. To see whether an event is outstanding (but the
 (watcher *)</code> macro. To see whether an event is outstanding (but the
-callback for it has not been called yet) you cna use the <code>ev_is_pending
+callback for it has not been called yet) you can use the <code>ev_is_pending
 (watcher *)</code> macro.</p>
 <p>Each and every callback receives the event loop pointer as first, the
 registered watcher structure as second, and a bitset of received events as
 third argument.</p>
 (watcher *)</code> macro.</p>
 <p>Each and every callback receives the event loop pointer as first, the
 registered watcher structure as second, and a bitset of received events as
 third argument.</p>
-<p>The rceeived events usually include a single bit per event type received
+<p>The received events usually include a single bit per event type received
 (you can receive multiple events at the same time). The possible bit masks
 are:</p>
 <dl>
 (you can receive multiple events at the same time). The possible bit masks
 are:</p>
 <dl>
-       <dt>EV_READ</dt>
-       <dt>EV_WRITE</dt>
+       <dt><code>EV_READ</code></dt>
+       <dt><code>EV_WRITE</code></dt>
        <dd>
        <dd>
-               <p>The file descriptor in the ev_io watcher has become readable and/or
+               <p>The file descriptor in the <code>ev_io</code> watcher has become readable and/or
 writable.</p>
        </dd>
 writable.</p>
        </dd>
-       <dt>EV_TIMEOUT</dt>
+       <dt><code>EV_TIMEOUT</code></dt>
        <dd>
        <dd>
-               <p>The ev_timer watcher has timed out.</p>
+               <p>The <code>ev_timer</code> watcher has timed out.</p>
        </dd>
        </dd>
-       <dt>EV_PERIODIC</dt>
+       <dt><code>EV_PERIODIC</code></dt>
        <dd>
        <dd>
-               <p>The ev_periodic watcher has timed out.</p>
+               <p>The <code>ev_periodic</code> watcher has timed out.</p>
        </dd>
        </dd>
-       <dt>EV_SIGNAL</dt>
+       <dt><code>EV_SIGNAL</code></dt>
        <dd>
        <dd>
-               <p>The signal specified in the ev_signal watcher has been received by a thread.</p>
+               <p>The signal specified in the <code>ev_signal</code> watcher has been received by a thread.</p>
        </dd>
        </dd>
-       <dt>EV_CHILD</dt>
+       <dt><code>EV_CHILD</code></dt>
        <dd>
        <dd>
-               <p>The pid specified in the ev_child watcher has received a status change.</p>
+               <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>
        </dd>
        </dd>
-       <dt>EV_IDLE</dt>
+       <dt><code>EV_IDLE</code></dt>
        <dd>
        <dd>
-               <p>The ev_idle watcher has determined that you have nothing better to do.</p>
+               <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>
        </dd>
        </dd>
-       <dt>EV_PREPARE</dt>
-       <dt>EV_CHECK</dt>
+       <dt><code>EV_PREPARE</code></dt>
+       <dt><code>EV_CHECK</code></dt>
        <dd>
        <dd>
-               <p>All ev_prepare watchers are invoked just <i>before</i> <code>ev_loop</code> starts
-to gather new events, and all ev_check watchers are invoked just after
+               <p>All <code>ev_prepare</code> watchers are invoked just <i>before</i> <code>ev_loop</code> starts
+to gather new events, and all <code>ev_check</code> watchers are invoked just after
 <code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
 received events. Callbacks of both watcher types can start and stop as
 many watchers as they want, and all of them will be taken into account
 <code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
 received events. Callbacks of both watcher types can start and stop as
 many watchers as they want, and all of them will be taken into account
-(for example, a ev_prepare watcher might start an idle watcher to keep
+(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep
 <code>ev_loop</code> from blocking).</p>
        </dd>
 <code>ev_loop</code> from blocking).</p>
        </dd>
-       <dt>EV_ERROR</dt>
+       <dt><code>EV_ERROR</code></dt>
        <dd>
                <p>An unspecified error has occured, the watcher has been stopped. This might
 happen because the watcher could not be properly started because libev
        <dd>
                <p>An unspecified error has occured, the watcher has been stopped. This might
 happen because the watcher could not be properly started because libev
@@ -391,7 +391,7 @@ programs, though, so beware.</p>
 <h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>
 <div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">
 <p>Each watcher has, by default, a member <code>void *data</code> that you can change
 <h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>
 <div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">
 <p>Each watcher has, by default, a member <code>void *data</code> that you can change
-and read at any time, libev will completely ignore it. This cna be used
+and read 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 and store a pointer to it in that data
 member, you can also &quot;subclass&quot; the watcher type and provide your own
 to associate arbitrary data with your watcher. If you need more data and
 don't want to allocate memory and store a pointer to it in that data
 member, you can also &quot;subclass&quot; the watcher type and provide your own
@@ -428,12 +428,12 @@ have been omitted....</p>
 information given in the last section.</p>
 
 </div>
 information given in the last section.</p>
 
 </div>
-<h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2>
-<div id="struct_ev_io_is_my_file_descriptor_r-2">
+<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2>
+<div id="code_ev_io_code_is_this_file_descrip-2">
 <p>I/O watchers check whether a file descriptor is readable or writable
 in each iteration of the event loop (This behaviour is called
 level-triggering because you keep receiving events as long as the
 <p>I/O watchers check whether a file descriptor is readable or writable
 in each iteration of the event loop (This behaviour is called
 level-triggering because you keep receiving events as long as the
-condition persists. Remember you cna stop the watcher if you don't want to
+condition persists. Remember you can stop the watcher if you don't want to
 act on the event and neither want to receive future events).</p>
 <p>In general you can register as many read and/or write event watchers oer
 fd as you want (as long as you don't confuse yourself). Setting all file
 act on the event and neither want to receive future events).</p>
 <p>In general you can register as many read and/or write event watchers oer
 fd as you want (as long as you don't confuse yourself). Setting all file
@@ -450,15 +450,15 @@ EVMETHOD_POLL).</p>
        <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
        <dt>ev_io_set (ev_io *, int fd, int events)</dt>
        <dd>
        <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
        <dt>ev_io_set (ev_io *, int fd, int events)</dt>
        <dd>
-               <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive
+               <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive
 events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ |
 EV_WRITE</code> to receive the given events.</p>
        </dd>
 </dl>
 
 </div>
 events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ |
 EV_WRITE</code> to receive the given events.</p>
        </dd>
 </dl>
 
 </div>
-<h2 id="struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</h2>
-<div id="struct_ev_timer_relative_and_optiona-2">
+<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2>
+<div id="code_ev_timer_code_relative_and_opti-2">
 <p>Timer watchers are simple relative timers that generate an event after a
 given time, and optionally repeating in regular intervals after that.</p>
 <p>The timers are based on real time, that is, if you register an event that
 <p>Timer watchers are simple relative timers that generate an event after a
 given time, and optionally repeating in regular intervals after that.</p>
 <p>The timers are based on real time, that is, if you register an event that
@@ -499,7 +499,7 @@ value), or reset the running timer to the repeat value.</p>
 example: Imagine you have a tcp connection and you want a so-called idle
 timeout, that is, you want to be called when there have been, say, 60
 seconds of inactivity on the socket. The easiest way to do this is to
 example: Imagine you have a tcp connection and you want a so-called idle
 timeout, that is, you want to be called when there have been, say, 60
 seconds of inactivity on the socket. The easiest way to do this is to
-configure an ev_timer with after=repeat=60 and calling ev_timer_again each
+configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each
 time you successfully read or write some data. If you go into an idle
 state where you do not expect data to travel on the socket, you can stop
 the timer, and again will automatically restart it if need be.</p>
 time you successfully read or write some data. If you go into an idle
 state where you do not expect data to travel on the socket, you can stop
 the timer, and again will automatically restart it if need be.</p>
@@ -507,16 +507,16 @@ the timer, and again will automatically restart it if need be.</p>
 </dl>
 
 </div>
 </dl>
 
 </div>
-<h2 id="ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</h2>
-<div id="ev_periodic_to_cron_or_not_to_cron_i-2">
+<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2>
+<div id="code_ev_periodic_code_to_cron_or_not-2">
 <p>Periodic watchers are also timers of a kind, but they are very versatile
 (and unfortunately a bit complex).</p>
 <p>Periodic watchers are also timers of a kind, but they are very versatile
 (and unfortunately a bit complex).</p>
-<p>Unlike ev_timer's, they are not based on real time (or relative time)
+<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)
 but on wallclock time (absolute time). You can tell a periodic watcher
 to trigger &quot;at&quot; some specific point in time. For example, if you tell a
 periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now ()
 + 10.&gt;) and then reset your system clock to the last year, then it will
 but on wallclock time (absolute time). You can tell a periodic watcher
 to trigger &quot;at&quot; some specific point in time. For example, if you tell a
 periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now ()
 + 10.&gt;) and then reset your system clock to the last year, then it will
-take a year to trigger the event (unlike an ev_timer, which would trigger
+take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
 roughly 10 seconds later and of course not if you reset your system time
 again).</p>
 <p>They can also be used to implement vastly more complex timers, such as
 roughly 10 seconds later and of course not if you reset your system time
 again).</p>
 <p>They can also be used to implement vastly more complex timers, such as
@@ -552,10 +552,10 @@ time:</p>
 </pre>
                                        <p>This doesn't mean there will always be 3600 seconds in between triggers,
 but only that the the callback will be called when the system time shows a
 </pre>
                                        <p>This doesn't mean there will always be 3600 seconds in between triggers,
 but only that the the callback will be called when the system time shows a
-full hour (UTC), or more correct, when the system time is evenly divisible
+full hour (UTC), or more correctly, when the system time is evenly divisible
 by 3600.</p>
                                        <p>Another way to think about it (for the mathematically inclined) is that
 by 3600.</p>
                                        <p>Another way to think about it (for the mathematically inclined) is that
-ev_periodic will try to run the callback in this mode at the next possible
+<code>ev_periodic</code> will try to run the callback in this mode at the next possible
 time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
                                </dd>
                                <dt>* manual reschedule mode (reschedule_cb = callback)</dt>
 time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
                                </dd>
                                <dt>* manual reschedule mode (reschedule_cb = callback)</dt>
@@ -565,10 +565,12 @@ 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.</p>
                                        <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other
 reschedule callback will be called with the watcher as first, and the
 current time as second argument.</p>
                                        <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other
-periodic watcher, ever, or make any event loop modificstions</i>. If you need
-to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.</p>
-                                       <p>Its prototype is c&lt;ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
-ev_tstamp now)&gt;, e.g.:</p>
+periodic watcher, ever, or make any event loop modifications</i>. If you need
+to stop it, return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards.</p>
+                                       <p>Also, <i>this callback must always return a time that is later than the
+passed <code>now</code> value</i>. Not even <code>now</code> itself will be ok.</p>
+                                       <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
+ev_tstamp now)</code>, e.g.:</p>
 <pre>   static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
    {
      return now + 60.;
 <pre>   static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
    {
      return now + 60.;
@@ -597,13 +599,13 @@ program when the crontabs have changed).</p>
 </dl>
 
 </div>
 </dl>
 
 </div>
-<h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2>
-<div id="ev_signal_signal_me_when_a_signal_ge-2">
+<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2>
+<div id="code_ev_signal_code_signal_me_when_a-2">
 <p>Signal watchers will trigger an event when the process receives a specific
 signal one or more times. Even though signals are very asynchronous, libev
 will try it's best to deliver signals synchronously, i.e. as part of the
 normal event processing, like any other event.</p>
 <p>Signal watchers will trigger an event when the process receives a specific
 signal one or more times. Even though signals are very asynchronous, libev
 will try it's best to deliver signals synchronously, i.e. as part of the
 normal event processing, like any other event.</p>
-<p>You cna configure as many watchers as you like per signal. Only when the
+<p>You can configure as many watchers as you like per signal. Only when the
 first watcher gets started will libev actually register a signal watcher
 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
 first watcher gets started will libev actually register a signal watcher
 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
@@ -619,8 +621,8 @@ of the <code>SIGxxx</code> constants).</p>
 </dl>
 
 </div>
 </dl>
 
 </div>
-<h2 id="ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</h2>
-<div id="ev_child_wait_for_pid_status_changes-2">
+<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2>
+<div id="code_ev_child_code_wait_for_pid_stat-2">
 <p>Child watchers trigger when your process receives a SIGCHLD in response to
 some child status changes (most typically when a child of yours dies).</p>
 <dl>
 <p>Child watchers trigger when your process receives a SIGCHLD in response to
 some child status changes (most typically when a child of yours dies).</p>
 <dl>
@@ -630,19 +632,22 @@ some child status changes (most typically when a child of yours dies).</p>
                <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
 <i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look
 at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
                <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
 <i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look
 at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
-the status word (use the macros from <code>sys/wait.h</code>). The <code>rpid</code> member
-contains the pid of the process causing the status change.</p>
+the status word (use the macros from <code>sys/wait.h</code> and see your systems
+<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the
+process causing the status change.</p>
        </dd>
 </dl>
 
 </div>
        </dd>
 </dl>
 
 </div>
-<h2 id="ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</h2>
-<div id="ev_idle_when_you_ve_got_nothing_bett-2">
-<p>Idle watchers trigger events when there are no other I/O or timer (or
-periodic) events pending. That is, as long as your process is busy
-handling sockets or timeouts it will not be called. But when your process
-is idle all idle watchers are being called again and again - until
-stopped, that is, or your process receives more events.</p>
+<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2>
+<div id="code_ev_idle_code_when_you_ve_got_no-2">
+<p>Idle watchers trigger events when there are no other events are pending
+(prepare, check and other idle watchers do not count). That is, as long
+as your process is busy handling sockets or timeouts (or even signals,
+imagine) it will not be triggered. But when your process is idle all idle
+watchers are being called again and again, once per event loop iteration -
+until stopped, that is, or your process receives more events and becomes
+busy.</p>
 <p>The most noteworthy effect is that as long as any idle watchers are
 active, the process will not block when waiting for new events.</p>
 <p>Apart from keeping your process non-blocking (which is a useful
 <p>The most noteworthy effect is that as long as any idle watchers are
 active, the process will not block when waiting for new events.</p>
 <p>Apart from keeping your process non-blocking (which is a useful
@@ -661,36 +666,42 @@ believe me.</p>
 </div>
 <h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2>
 <div id="prepare_and_check_your_hooks_into_th-2">
 </div>
 <h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2>
 <div id="prepare_and_check_your_hooks_into_th-2">
-<p>Prepare and check watchers usually (but not always) are used in
-tandom. Prepare watchers get invoked before the process blocks and check
-watchers afterwards.</p>
+<p>Prepare and check watchers are usually (but not always) used in tandem:
+Prepare watchers get invoked before the process blocks and check watchers
+afterwards.</p>
 <p>Their main purpose is to integrate other event mechanisms into libev. This
 could be used, for example, to track variable changes, implement your own
 watchers, integrate net-snmp or a coroutine library and lots more.</p>
 <p>This is done by examining in each prepare call which file descriptors need
 <p>Their main purpose is to integrate other event mechanisms into libev. This
 could be used, for example, to track variable changes, implement your own
 watchers, integrate net-snmp or a coroutine library and lots more.</p>
 <p>This is done by examining in each prepare call which file descriptors need
-to be watched by the other library, registering ev_io watchers for them
-and starting an ev_timer watcher for any timeouts (many libraries provide
-just this functionality). Then, in the check watcher you check for any
-events that occured (by making your callbacks set soem flags for example)
-and call back into the library.</p>
-<p>As another example, the perl Coro module uses these hooks to integrate
+to be watched by the other library, registering <code>ev_io</code> watchers for
+them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
+provide just this functionality). Then, in the check watcher you check for
+any events that occured (by checking the pending status of all watchers
+and stopping them) and call back into the library. The I/O and timer
+callbacks will never actually be called (but must be valid neverthelles,
+because you never know, you know?).</p>
+<p>As another example, the Perl Coro module uses these hooks to integrate
 coroutines into libev programs, by yielding to other active coroutines
 during each prepare and only letting the process block if no coroutines
 coroutines into libev programs, by yielding to other active coroutines
 during each prepare and only letting the process block if no coroutines
-are ready to run.</p>
+are ready to run (its actually more complicated, it only runs coroutines
+with priority higher than the event loop and one lower priority once,
+using idle watchers to keep the event loop from blocking if lower-priority
+coroutines exist, thus mapping low-priority coroutines to idle/background
+tasks).</p>
 <dl>
        <dt>ev_prepare_init (ev_prepare *, callback)</dt>
        <dt>ev_check_init (ev_check *, callback)</dt>
        <dd>
                <p>Initialises and configures the prepare or check watcher - they have no
 parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
 <dl>
        <dt>ev_prepare_init (ev_prepare *, callback)</dt>
        <dt>ev_check_init (ev_check *, callback)</dt>
        <dd>
                <p>Initialises and configures the prepare or check watcher - they have no
 parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
-macros, but using them is utterly, utterly pointless.</p>
+macros, but using them is utterly, utterly and completely pointless.</p>
        </dd>
 </dl>
 
 </div>
 <h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="OTHER_FUNCTIONS_CONTENT">
        </dd>
 </dl>
 
 </div>
 <h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="OTHER_FUNCTIONS_CONTENT">
-<p>There are some other fucntions of possible interest. Described. Here. Now.</p>
+<p>There are some other functions of possible interest. Described. Here. Now.</p>
 <dl>
        <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
        <dd>
 <dl>
        <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
        <dd>
@@ -699,36 +710,39 @@ callback on whichever event happens first and automatically stop both
 watchers. This is useful if you want to wait for a single event on an fd
 or timeout without havign to allocate/configure/start/stop/free one or
 more watchers yourself.</p>
 watchers. This is useful if you want to wait for a single event on an fd
 or timeout without havign to allocate/configure/start/stop/free one or
 more watchers yourself.</p>
-               <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events is
-ignored. Otherwise, an ev_io watcher for the given <code>fd</code> and <code>events</code> set
-will be craeted and started.</p>
+               <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events
+is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and
+<code>events</code> set will be craeted and started.</p>
                <p>If <code>timeout</code> is less than 0, then no timeout watcher will be
                <p>If <code>timeout</code> is less than 0, then no timeout watcher will be
-started. Otherwise an ev_timer watcher with after = <code>timeout</code> (and repeat
-= 0) will be started.</p>
-               <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and
-gets passed an events set (normally a combination of EV_ERROR, EV_READ,
-EV_WRITE or EV_TIMEOUT) and the <code>arg</code> value passed to <code>ev_once</code>:</p>
+started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and
+repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of
+dubious value.</p>
+               <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets
+passed an events set like normal event callbacks (with a combination of
+<code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code>
+value passed to <code>ev_once</code>:</p>
 <pre>  static void stdin_ready (int revents, void *arg)
   {
     if (revents &amp; EV_TIMEOUT)
 <pre>  static void stdin_ready (int revents, void *arg)
   {
     if (revents &amp; EV_TIMEOUT)
-      /* doh, nothing entered */
+      /* doh, nothing entered */;
     else if (revents &amp; EV_READ)
     else if (revents &amp; EV_READ)
-      /* stdin might have data for us, joy! */
+      /* stdin might have data for us, joy! */;
   }
 
   }
 
-  ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0);
+  ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
 
 </pre>
        </dd>
        <dt>ev_feed_event (loop, watcher, int events)</dt>
        <dd>
                <p>Feeds the given event set into the event loop, as if the specified event
 
 </pre>
        </dd>
        <dt>ev_feed_event (loop, watcher, int events)</dt>
        <dd>
                <p>Feeds the given event set into the event loop, as if the specified event
-has happened for the specified watcher (which must be a pointer to an
-initialised but not necessarily active event watcher).</p>
+had happened for the specified watcher (which must be a pointer to an
+initialised but not necessarily started event watcher).</p>
        </dd>
        <dt>ev_feed_fd_event (loop, int fd, int revents)</dt>
        <dd>
        </dd>
        <dt>ev_feed_fd_event (loop, int fd, int revents)</dt>
        <dd>
-               <p>Feed an event on the given fd, as if a file descriptor backend detected it.</p>
+               <p>Feed an event on the given fd, as if a file descriptor backend detected
+the given events it.</p>
        </dd>
        <dt>ev_feed_signal_event (loop, int signum)</dt>
        <dd>
        </dd>
        <dt>ev_feed_signal_event (loop, int signum)</dt>
        <dd>
High-performance event loop/event model with lots of features.