[ViewVC] Diff of: cvs/EV/README

Comparing EV/README (file contents):
Revision 1.28 by root, Tue Jul 8 18:56:48 2008 UTC vs.
Revision 1.31 by root, Wed Nov 19 10:33:32 2008 UTC

 DESCRIPTION
     This module provides an interface to libev
     (<http://software.schmorp.de/pkg/libev.html>). While the documentation
     below is comprehensive, one might also consult the documentation of
-    libev itself (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>)
+    libev itself (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
-    for more subtle details on watcher semantics or some discussion on the
+    perldoc EV::libev) for more subtle details on watcher semantics or some
-    available backends, or how to force a specific backend with
+    discussion on the available backends, or how to force a specific backend
-    "LIBEV_FLAGS", or just about in any case because it has much more
+    with "LIBEV_FLAGS", or just about in any case because it has much more
     detailed information.
     This module is very fast and scalable. It is actually so fast that you
     can use it through the AnyEvent module, stay portable to other event
     loops (if you don't rely on any watcher types not available through it)
     and still be faster than with any other event loop currently supported
     in Perl.
+  MODULE EXPORTS
+    This module does not export any symbols.
 EVENT LOOPS
     EV supports multiple event loops: There is a single "default event loop"
     that can handle everything including signals and child watchers, and any
     number of "dynamic event loops" that can use different backends (with
     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]
         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>) for more info.
+        ONS>, or locally-installed as EV::libev manpage) for more info.
         The loop will automatically be destroyed when it is no longer
         referenced by any watcher and the loop object goes out of scope.
-        Using "EV::FLAG_FORKCHECK" is recommended, as only the default event
+        If you are not embedding the loop, then Using "EV::FLAG_FORKCHECK"
-        loop is protected by this module.
+        is recommended, as only the default event loop is protected by this
+        module. If you *are* embedding this loop in the default loop, this
+        is not necessary, as "EV::embed" automatically does the right thing
+        on fork.
     $loop->loop_fork
         Must be called after a fork in the child, before entering or
         continuing the event loop. An alternative is to use
         "EV::FLAG_FORKCHECK" which calls this function automatically, at
         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.
     $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.
     $loop->set_timeout_collect_interval ($time)
         These advanced functions set the minimum block interval when polling
         for I/O events and the minimum wait interval for timer events. See
         the libev documentation at
         <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT
-        ROLLING_THE_EVENT_LOOP> for a more detailed discussion.
+        ROLLING_THE_EVENT_LOOP> (locally installed as EV::libev) for a more
+        detailed discussion.
 WATCHER OBJECTS
     A watcher is an object that gets created to record your interest in some
     event. For instance, if you want to wait for STDIN to become readable,
     you would create an EV::io watcher for that:
     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.
     embedded loop, other types of watchers might be handled in a delayed or
     incorrect fashion and must not be used).
     See the libev documentation at
     <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code
-    _when_one_backend_> for more details.
+    _when_one_backend_> (locally installed as EV::libev) for more details.
     In short, this watcher is most useful on BSD systems without working
     kqueue to still be able to handle a large number of sockets:
        my $socket_loop;
        }
    # use the default loop otherwise
        $socket_loop ||= EV::default_loop;
-    $w = EV::embed $otherloop, $callback
+    $w = EV::embed $otherloop[, $callback]
-    $w = EV::embed_ns $otherloop, $callback
+    $w = EV::embed_ns $otherloop[, $callback]
-    $w = $loop->embed ($otherloop, $callback)
+    $w = $loop->embed ($otherloop[, $callback])
-    $w = $loop->embed_ns ($otherloop, $callback)
+    $w = $loop->embed_ns ($otherloop[, $callback])
         Call the callback when the embedded event loop ($otherloop) has any
-        I/O activity. The $callback should alwas be specified as "undef" in
+        I/O activity. The $callback is optional: if it is missing, then the
-        this version of EV, which means the embedded event loop will be
+        embedded event loop will be managed automatically (which is
-        managed automatically.
+        recommended), otherwise you have to invoke "sweep" yourself.
         The "embed_ns" variant doesn't start (activate) the newly created
         watcher.
    ASYNC WATCHERS - how to wake up another event loop

Diff Legend

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

Comparing EV/README (file contents): Revision 1.28 by root, Tue Jul 8 18:56:48 2008 UTC vs. Revision 1.31 by root, Wed Nov 19 10:33:32 2008 UTC

Diff Legend

Comparing EV/README (file contents):
Revision 1.28 by root, Tue Jul 8 18:56:48 2008 UTC vs.
Revision 1.31 by root, Wed Nov 19 10:33:32 2008 UTC