[ViewVC] Diff of: cvs/EV/README

Comparing EV/README (file contents):
Revision 1.30 by root, Thu Oct 23 04:56:49 2008 UTC vs.
Revision 1.32 by root, Tue Apr 28 00:50:57 2009 UTC

     default loop as this is fastest (perl-wise), best supported by other
     modules (e.g. AnyEvent or Coro) and most portable event loop.
     For specific programs you can create additional event loops dynamically.
-    If you want to take avdantage of kqueue (which often works properly for
+    If you want to take advantage of kqueue (which often works properly for
     sockets only) even though the default loop doesn't enable it, you can
     *embed* a kqueue loop into the default loop: running the default loop
     will then also service the kqueue loop to some extent. See the example
     in the section about embed watchers for an example on how to achieve
     that.
-    $loop = new EV::loop [$flags]
+    $loop = new EV::Loop [$flags]
         Create a new event loop as per the specified flags. Please refer to
         the "ev_loop_new ()" function description in the libev documentation
         (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTI
         ONS>, or locally-installed as EV::libev manpage) for more info.
         Returns the current time in (fractional) seconds since the epoch.
     $time = EV::now
     $time = $loop->now
         Returns the time the last event loop iteration has been started.
-        This is the time that (relative) timers are based on, and refering
+        This is the time that (relative) timers are based on, and referring
         to it is usually faster then calling EV::time.
+    EV::now_update
+    $loop->now_update
+        Establishes the current time by querying the kernel, updating the
+        time returned by "EV::now" in the progress. This is a costly
+        operation and is usually done automatically within "EV::loop".
+        This function is rarely useful, but when some event callback runs
+        for a very long time without entering the event loop, updating
+        libev's idea of the current time is a good idea.
+    EV::suspend
+    $loop->suspend
+    EV::resume
+    $loop->resume
+        These two functions suspend and resume a loop, for use when the loop
+        is not used for a while and timeouts should not be processed.
+        A typical use case would be an interactive program such as a game:
+        When the user presses "^Z" to suspend the game and resumes it an
+        hour later it would be best to handle timeouts as if no time had
+        actually passed while the program was suspended. This can be
+        achieved by calling "suspend" in your "SIGTSTP" handler, sending
+        yourself a "SIGSTOP" and calling "resume" directly afterwards to
+        resume timer processing.
+        Effectively, all "timer" watchers will be delayed by the time spend
+        between "suspend" and "resume", and all "periodic" watchers will be
+        rescheduled (that is, they will lose any events that would have
+        occured while suspended).
+        After calling "suspend" you must not call *any* function on the
+        given loop other than "resume", and you must not call "resume"
+        without a previous call to "suspend".
+        Calling "suspend"/"resume" has the side effect of updating the event
+        loop time (see "now_update").
     $backend = EV::backend
     $backend = $loop->backend
         Returns an integer describing the backend used by libev
-        (EV::METHOD_SELECT or EV::METHOD_EPOLL).
+        (EV::BACKEND_SELECT or EV::BACKEND_EPOLL).
     EV::loop [$flags]
     $loop->loop ([$flags])
         Begin checking for events and calling callbacks. It returns when a
         callback calls EV::unloop.
         EV::loop will return as fast as possible.
     $count = EV::loop_count
     $count = $loop->loop_count
         Return the number of times the event loop has polled for new events.
-        Sometiems useful as a generation counter.
+        Sometimes useful as a generation counter.
     EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
     $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
         This function rolls together an I/O and a timer watcher for a single
         one-shot event without the need for managing a watcher object.
     will be called with at least two arguments: the watcher and a bitmask of
     received events.
     Each watcher type has its associated bit in revents, so you can use the
     same callback for multiple watchers. The event mask is named after the
-    type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
+    type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
     EV::periodic sets EV::PERIODIC and so on, with the exception of I/O
     events (which can set both EV::READ and EV::WRITE bits), and EV::timer
     (which uses EV::TIMEOUT).
     In the rare case where one wants to create a watcher but not start it at
         In this case you can clear the keepalive status, which means that
         even though your watcher is active, it won't keep "EV::loop" from
         returning.
-        The initial value for keepalive is true (enabled), and you cna
+        The initial value for keepalive is true (enabled), and you can
         change it any time.
         Example: Register an I/O watcher for some UDP socket but do not keep
         the event loop from running just because of that watcher.
               # make the dispatcher handle any new stuff
               ... not shown
            };
         The callbacks of the created watchers will not be called as the
-        watchers are destroyed before this cna happen (remember EV::check
+        watchers are destroyed before this can happen (remember EV::check
         gets called first).
         The "check_ns" variant doesn't start (activate) the newly created
         watcher.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing EV/README (file contents): Revision 1.30 by root, Thu Oct 23 04:56:49 2008 UTC vs. Revision 1.32 by root, Tue Apr 28 00:50:57 2009 UTC

Diff Legend

Comparing EV/README (file contents):
Revision 1.30 by root, Thu Oct 23 04:56:49 2008 UTC vs.
Revision 1.32 by root, Tue Apr 28 00:50:57 2009 UTC