]> 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 4f5c8fb96c02bd18edbfaaa0c0b56fc76793f37e..4f2d1fc481f94c8bc27742b9d413d47b43877bfb 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:35:17 2007" />
+       <meta name="created" content="Tue Nov 13 04:04:09 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>
@@ -19,7 +19,8 @@
 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
 <li><a href="#FEATURES">FEATURES</a></li>
 <li><a href="#CONVENTIONS">CONVENTIONS</a></li>
 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
 <li><a href="#FEATURES">FEATURES</a></li>
 <li><a href="#CONVENTIONS">CONVENTIONS</a></li>
-<li><a href="#TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</a></li>
+<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li>
+<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li>
 <li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li>
 <li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a>
 <ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li>
 <li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li>
 <li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a>
 <ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li>
@@ -28,14 +29,16 @@
 <li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
 <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="#WATCHER_TYPES">WATCHER TYPES</a>
 <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 it</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="#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>
+<li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li>
 </ul>
 </li>
 <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
 </ul>
 </li>
 <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
+<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
+<li><a href="#C_SUPPORT">C++ SUPPORT</a></li>
 <li><a href="#AUTHOR">AUTHOR</a>
 </li>
 </ul><hr />
 <li><a href="#AUTHOR">AUTHOR</a>
 </li>
 </ul><hr />
@@ -89,13 +92,19 @@ argument of name <code>loop</code> (which is always of type <code>struct ev_loop
 will not have this argument.</p>
 
 </div>
 will not have this argument.</p>
 
 </div>
-<h1 id="TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="TIME_AND_OTHER_GLOBAL_FUNCTIONS_CONT">
+<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="TIME_REPRESENTATION_CONTENT">
 <p>Libev represents time as a single floating point number, representing the
 (fractional) number of seconds since the (POSIX) epoch (somewhere near
 the beginning of 1970, details are complicated, don't ask). This type is
 called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
 to the double type in C.</p>
 <p>Libev represents time as a single floating point number, representing the
 (fractional) number of seconds since the (POSIX) epoch (somewhere near
 the beginning of 1970, details are complicated, don't ask). This type is
 called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
 to the double type in C.</p>
+
+</div>
+<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="GLOBAL_FUNCTIONS_CONTENT">
+<p>These functions can be called anytime, even before initialising the
+library in any way.</p>
 <dl>
        <dt>ev_tstamp ev_time ()</dt>
        <dd>
 <dl>
        <dt>ev_tstamp ev_time ()</dt>
        <dd>
@@ -144,7 +153,7 @@ requested operation, or, if the condition doesn't go away, do bad stuff
 types of such loops, the <i>default</i> loop, which supports signals and child
 events, and dynamically created loops which do not.</p>
 <p>If you use threads, a common model is to run the default event loop
 types of such loops, the <i>default</i> loop, which supports signals and child
 events, and dynamically created loops which do not.</p>
 <p>If you use threads, a common model is to run the default event loop
-in your main thread (or in a separate thrad) and for each thread you
+in your main thread (or in a separate thread) and for each thread you
 create, you also create another event loop. Libev itself does no locking
 whatsoever, so if you mix calls to the same event loop in different
 threads, make sure you lock (this is usually a bad idea, though, even if
 create, you also create another event loop. Libev itself does no locking
 whatsoever, so if you mix calls to the same event loop in different
 threads, make sure you lock (this is usually a bad idea, though, even if
@@ -266,7 +275,7 @@ more generic mechanism.</p>
        <dd>
                <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it
 has processed all outstanding events). The <code>how</code> argument must be either
        <dd>
                <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it
 has processed all outstanding events). The <code>how</code> argument must be either
-<code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or
+<code>EVUNLOOP_ONE</code>, which will make the innermost <code>ev_loop</code> call return, or
 <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p>
        </dd>
        <dt>ev_ref (loop)</dt>
 <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p>
        </dd>
        <dt>ev_ref (loop)</dt>
@@ -324,14 +333,14 @@ 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>
@@ -391,7 +400,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
@@ -433,16 +442,17 @@ information given in the last section.</p>
 <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>
 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
+<p>In general you can register as many read and/or write event watchers per
 fd as you want (as long as you don't confuse yourself). Setting all file
 descriptors to non-blocking mode is also usually a good idea (but not
 required if you know what you are doing).</p>
 <p>You have to be careful with dup'ed file descriptors, though. Some backends
 (the linux epoll backend is a notable example) cannot handle dup'ed file
 descriptors correctly if you register interest in two or more fds pointing
 fd as you want (as long as you don't confuse yourself). Setting all file
 descriptors to non-blocking mode is also usually a good idea (but not
 required if you know what you are doing).</p>
 <p>You have to be careful with dup'ed file descriptors, though. Some backends
 (the linux epoll backend is a notable example) cannot handle dup'ed file
 descriptors correctly if you register interest in two or more fds pointing
-to the same file/socket etc. description.</p>
+to the same underlying file/socket etc. description (that is, they share
+the same underlying &quot;file open&quot;).</p>
 <p>If you must do this, then force the use of a known-to-be-good backend
 (at the time of this writing, this includes only EVMETHOD_SELECT and
 EVMETHOD_POLL).</p>
 <p>If you must do this, then force the use of a known-to-be-good backend
 (at the time of this writing, this includes only EVMETHOD_SELECT and
 EVMETHOD_POLL).</p>
@@ -462,7 +472,7 @@ EV_WRITE</code> to receive the given events.</p>
 <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
-times out after an hour and youreset your system clock to last years
+times out after an hour and you reset your system clock to last years
 time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because
 detecting time jumps is hard, and soem inaccuracies are unavoidable (the
 monotonic clock option helps a lot here).</p>
 time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because
 detecting time jumps is hard, and soem inaccuracies are unavoidable (the
 monotonic clock option helps a lot here).</p>
@@ -470,7 +480,7 @@ monotonic clock option helps a lot here).</p>
 time. This is usually the right thing as this timestamp refers to the time
 of the event triggering whatever timeout you are modifying/starting.  If
 you suspect event processing to be delayed and you *need* to base the timeout
 time. This is usually the right thing as this timestamp refers to the time
 of the event triggering whatever timeout you are modifying/starting.  If
 you suspect event processing to be delayed and you *need* to base the timeout
-ion the current time, use something like this to adjust for this:</p>
+on the current time, use something like this to adjust for this:</p>
 <pre>   ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.);
 
 </pre>
 <pre>   ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.);
 
 </pre>
@@ -485,7 +495,7 @@ later, again, and again, until stopped manually.</p>
                <p>The timer itself will do a best-effort at avoiding drift, that is, if you
 configure a timer to trigger every 10 seconds, then it will trigger at
 exactly 10 second intervals. If, however, your program cannot keep up with
                <p>The timer itself will do a best-effort at avoiding drift, that is, if you
 configure a timer to trigger every 10 seconds, then it will trigger at
 exactly 10 second intervals. If, however, your program cannot keep up with
-the timer (ecause it takes longer than those 10 seconds to do stuff) the
+the timer (because it takes longer than those 10 seconds to do stuff) the
 timer will not fire more than once per event loop iteration.</p>
        </dd>
        <dt>ev_timer_again (loop)</dt>
 timer will not fire more than once per event loop iteration.</p>
        </dd>
        <dt>ev_timer_again (loop)</dt>
@@ -507,7 +517,7 @@ the timer, and again will automatically restart it if need be.</p>
 </dl>
 
 </div>
 </dl>
 
 </div>
-<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron it</h2>
+<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>
 <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>
@@ -564,13 +574,12 @@ time where <code>time = at (mod interval)</code>, regardless of any time jumps.<
 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>
 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
-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>&lt;this callback must always return a time that is later than the
-passed <code>now</code> value </i>&gt;. Not even <code>now</code> itself will be ok.</p>
-                                       <p>Its prototype is c&lt;ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
-ev_tstamp now)&gt;, e.g.:</p>
+                                       <p>NOTE: <i>This callback MUST NOT stop or destroy any 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 (e.g. by
+starting a prepare watcher).</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.;
@@ -581,10 +590,13 @@ ev_tstamp now)&gt;, e.g.:</p>
 (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.</p>
 (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.</p>
+                                       <p>NOTE: <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 do, it <i>must</i> be larger.</p>
                                        <p>This can be used to create very complex timers, such as a timer that
 triggers on each midnight, local time. To do this, you would calculate the
                                        <p>This can be used to create very complex timers, such as a timer that
 triggers on each midnight, local time. To do this, you would calculate the
-next midnight after <code>now</code> and return the timestamp value for this. How you do this
-is, again, up to you (but it is not trivial).</p>
+next midnight after <code>now</code> and return the timestamp value for this. How
+you do this is, again, up to you (but it is not trivial, which is the main
+reason I omitted it as an example).</p>
                                </dd>
                        </dl>
                </p>
                                </dd>
                        </dl>
                </p>
@@ -605,7 +617,7 @@ program when the crontabs have changed).</p>
 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>
 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
@@ -632,19 +644,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>
 <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">
        </dd>
 </dl>
 
 </div>
 <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 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>
+<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,76 +676,85 @@ believe me.</p>
 </dl>
 
 </div>
 </dl>
 
 </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>
+<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2>
+<div id="code_ev_prepare_code_and_code_ev_che-2">
+<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 <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 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 nevertheless,
+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 (it's actually more complicated: it only runs coroutines
+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).</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>
                <p>This function combines a simple timer and an I/O watcher, calls your
 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
 <dl>
        <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
        <dd>
                <p>This function combines a simple timer and an I/O watcher, calls your
 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
+or timeout without having to allocate/configure/start/stop/free one or
 more watchers yourself.</p>
 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 <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>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 <code>ev_timer</code> 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 <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>
+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 <code>revents</code> set like normal event callbacks (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>
@@ -738,6 +762,31 @@ initialised but not necessarily active event watcher).</p>
        </dd>
 </dl>
 
        </dd>
 </dl>
 
+</div>
+<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="LIBEVENT_EMULATION_CONTENT">
+<p>Libev offers a compatibility emulation layer for libevent. It cannot
+emulate the internals of libevent, so here are some usage hints:</p>
+<dl>
+       <dt>* Use it by including &lt;event.h&gt;, as usual.</dt>
+       <dt>* The following members are fully supported: ev_base, ev_callback,
+ev_arg, ev_fd, ev_res, ev_events.</dt>
+       <dt>* Avoid using ev_flags and the EVLIST_*-macros, while it is
+maintained by libev, it does not work exactly the same way as in libevent (consider
+it a private API).</dt>
+       <dt>* Priorities are not currently supported. Initialising priorities
+will fail and all watchers will have the same priority, even though there
+is an ev_pri field.</dt>
+       <dt>* Other members are not supported.</dt>
+       <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
+to use the libev header file and library.</dt>
+</dl>
+
+</div>
+<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="C_SUPPORT_CONTENT">
+<p>TBD.</p>
+
 </div>
 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="AUTHOR_CONTENT">
 </div>
 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="AUTHOR_CONTENT">
High-performance event loop/event model with lots of features.