*** empty log message ***

16 years ago · 624c60e7ca
parent fcbcb8ef95
commit 624c60e7ca
2 changed files with 24 additions and 13 deletions
--- 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="created" content="Mon Nov 12 09:58:27 2007" />
+	<meta name="created" content="Mon Nov 12 10:01:12 2007" />
 	<meta name="generator" content="Pod::Xhtml 1.57" />
 <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
 <body>
@ -101,6 +101,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">
+<p>These functions can be called anytime, even before initialising the
+library in any way.</p>
 <dl>
 	<dt>ev_tstamp ev_time ()</dt>
 	<dd>
@ -569,11 +571,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>
-					<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)
@ -586,6 +587,8 @@ 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>
+					<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 must 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
 next midnight after <code>now</code> and return the timestamp value for this. How you do this
--- a/ev.pod
+++ b/ev.pod
@ -679,7 +679,7 @@ believe me.
 =head2 C<ev_prepare> and C<ev_check> - customise your event loop

 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.

 Their main purpose is to integrate other event mechanisms into libev. This
@ -692,17 +692,17 @@ them and starting an C<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 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?).

 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).
+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).

 =over 4

@ -771,6 +771,14 @@ Feed an event as if the given signal occured (loop must be the default loop!).

 =back

+=head1 LIBEVENT EMULATION
+
+TBD.
+
+=head1 C++ SUPPORT
+
+TBD.
+
 =head1 AUTHOR

 Marc Lehmann <libev@schmorp.de>.