workaround for solaris 9's lack of standard C language header files

[software/libev.git] / ev.pod

diff --git a/ev.pod b/ev.pod
index bbc0893ac55b234753e14a3a45d75ff0e1bfb94f..c162b216f66b3d563389785ddc096ccc41c17139 100644 (file)
--- a/ev.pod
+++ b/ev.pod
@@ -51,6 +51,9 @@ to the double type in C.
 
 =head1 GLOBAL FUNCTIONS
 
 
 =head1 GLOBAL FUNCTIONS
 

+These functions can be called anytime, even before initialising the
+library in any way.
+

 =over 4
 
 =item ev_tstamp ev_time ()
 =over 4
 
 =item ev_tstamp ev_time ()


@@ -424,7 +427,8 @@ required if you know what you are doing).
 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
 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.
+to the same file/socket etc. description (that is, they share the same
+underlying "file open").

 
 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
 
 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


@@ -448,7 +452,7 @@ Timer watchers are simple relative timers that generate an event after a
 given time, and optionally repeating in regular intervals after that.
 
 The timers are based on real time, that is, if you register an event that
 given time, and optionally repeating in regular intervals after that.
 
 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. "Roughly" because
 detecting time jumps is hard, and soem inaccuracies are unavoidable (the
 monotonic clock option helps a lot here).
 time, it will still time out after (roughly) and hour. "Roughly" because
 detecting time jumps is hard, and soem inaccuracies are unavoidable (the
 monotonic clock option helps a lot here).


@@ -457,7 +461,7 @@ The relative timeouts are calculated relative to the C<ev_now ()>
 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:
+on the current time, use something like this to adjust for this:

 
    ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
 
 
    ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
 


@@ -475,7 +479,7 @@ later, again, and again, until stopped manually.
 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 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.
 
 =item ev_timer_again (loop)
 timer will not fire more than once per event loop iteration.
 
 =item ev_timer_again (loop)


@@ -562,12 +566,10 @@ 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.
 
 reschedule callback will be called with the watcher as first, and the
 current time as second argument.
 

-NOTE: I<This callback MUST NOT stop or destroy the periodic or any other
-periodic watcher, ever, or make any event loop modifications>. If you need
-to stop it, return C<now + 1e30> (or so, fudge fudge) and stop it afterwards.
-
-Also, I<< this callback must always return a time that is later than the
-passed C<now> value >>. Not even C<now> itself will be ok.
+NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
+ever, or make any event loop modifications>. If you need to stop it,
+return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
+starting a prepare watcher).

 
 Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
 ev_tstamp now)>, e.g.:
 
 Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
 ev_tstamp now)>, e.g.:


@@ -582,10 +584,14 @@ It must return the next time to trigger, based on the passed time value
 will usually be called just before the callback will be triggered, but
 might be called at other times, too.
 
 will usually be called just before the callback will be triggered, but
 might be called at other times, too.
 

+NOTE: I<< This callback must always return a time that is later than the
+passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.
+

 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
 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 C<now> and return the timestamp value for this. How you do this
-is, again, up to you (but it is not trivial).
+next midnight after C<now> 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).

 
 =back
 
 
 =back
 


@@ -674,7 +680,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:
 =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
 afterwards.
 
 Their main purpose is to integrate other event mechanisms into libev. This


@@ -687,17 +693,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
 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
 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
 
 
 =over 4
 


@@ -722,7 +728,7 @@ There are some other functions of possible interest. Described. Here. Now.
 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
 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.
 
 If C<fd> is less than 0, then no I/O watcher will be started and events
 more watchers yourself.
 
 If C<fd> is less than 0, then no I/O watcher will be started and events


@@ -735,7 +741,7 @@ repeat = 0) will be started. While C<0> is a valid timeout, it is of
 dubious value.
 
 The callback has the type C<void (*cb)(int revents, void *arg)> and gets
 dubious value.
 
 The callback has the type C<void (*cb)(int revents, void *arg)> and gets

-passed an events set like normal event callbacks (with a combination of
+passed an C<revents> set like normal event callbacks (a combination of

 C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
 value passed to C<ev_once>:
 
 C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
 value passed to C<ev_once>:
 


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

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

 =head1 AUTHOR
 
 Marc Lehmann <libev@schmorp.de>.
 =head1 AUTHOR
 
 Marc Lehmann <libev@schmorp.de>.