X-Git-Url: https://git.llucax.com/software/libev.git/blobdiff_plain/303b36d19decccc02135b0771a0fb0c07277fb17..a728e62d7c25b8d8852e332e729e70248520a925:/ev.pod diff --git a/ev.pod b/ev.pod index ba95246..ee17cb2 100644 --- a/ev.pod +++ b/ev.pod @@ -41,7 +41,7 @@ support for multiple event loops, then all functions taking an initial argument of name C (which is always of type C) will not have this argument. -=head1 TIME AND OTHER GLOBAL FUNCTIONS +=head1 TIME REPRESENTATION Libev represents time as a single floating point number, representing the (fractional) number of seconds since the (POSIX) epoch (somewhere near @@ -49,6 +49,11 @@ the beginning of 1970, details are complicated, don't ask). This type is called C, which is what you should use too. It usually aliases to the double type in C. +=head1 GLOBAL FUNCTIONS + +These functions can be called anytime, even before initialising the +library in any way. + =over 4 =item ev_tstamp ev_time () @@ -101,7 +106,7 @@ types of such loops, the I loop, which supports signals and child events, and dynamically created loops which do not. 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 @@ -560,12 +565,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. -NOTE: I. If you need -to stop it, return C (or so, fudge fudge) and stop it afterwards. - -Also, I<< this callback must always return a time that is later than the -passed C value >>. Not even C itself will be ok. +NOTE: I. If you need to stop it, +return C (or so, fudge fudge) and stop it afterwards (e.g. by +starting a prepare watcher). Its prototype is C, e.g.: @@ -580,10 +583,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. +NOTE: I<< This callback must always return a time that is later than the +passed C value >>. Not even C itself will do, it I 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 -next midnight after C 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 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 @@ -672,7 +679,7 @@ believe me. =head2 C and C - 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 @@ -685,17 +692,17 @@ them and starting an C 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 @@ -764,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 .