do a lot of minor tweaking

[software/libev.git] / ev.html
diff --git a/ev.html b/ev.html

index 6658a2ed2b50a48862e823018052e29b262443d7..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:58:24 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>
@@ -37,6 +37,8 @@
  </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 />
@@ -101,6 +103,8 @@ 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">
  </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>
@@ -271,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>
@@ -440,14 +444,15 @@ 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 can stop the watcher if you don't want to
  act on the event and neither want to receive future events).</p>
  level-triggering because you keep receiving events as long as the
  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
+<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>
@@ -467,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>
@@ -475,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>
@@ -490,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>
@@ -569,11 +574,10 @@ 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>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>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)
                                         <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)
@@ -586,10 +590,13 @@ ev_tstamp now)</code>, 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>
@@ -672,7 +679,7 @@ believe me.</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:
  <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
+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
  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
@@ -683,16 +690,16 @@ them and starting an <code>ev_timer</code> watcher for any timeouts (many librar
  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
  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,
+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
  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
-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>
+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>
  <dl>
         <dt>ev_prepare_init (ev_prepare *, callback)</dt>
         <dt>ev_check_init (ev_check *, callback)</dt>
@@ -713,7 +720,7 @@ macros, but using them is utterly, utterly and completely pointless.</p>
                 <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
                 <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>
                 <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
  more watchers yourself.</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
@@ -723,7 +730,7 @@ started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</
  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
  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
+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)
  <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)
@@ -755,6 +762,31 @@ the given events it.</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">