[ViewVC] Diff of: cvs/EV/README

Comparing EV/README (file contents):
Revision 1.22 by root, Mon Jan 28 12:24:05 2008 UTC vs.
Revision 1.27 by root, Mon May 26 05:37:18 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://cvs.schmorp.de/libev/ev.html>) for more subtle
+    libev itself (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>)
-    details on watcher semantics or some discussion on the available
+    for more subtle details on watcher semantics or some discussion on the
-    backends, or how to force a specific backend with "LIBEV_FLAGS", or just
+    available backends, or how to force a specific backend with
-    about in any case because it has much more detailed information.
+    "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.
 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
         loop is protected by this module.
     $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 fucntion automatically, at
+        "EV::FLAG_FORKCHECK" which calls this function automatically, at
         some performance loss (refer to the libev documentation).
+    $loop->loop_verify
+        Calls "ev_verify" to make internal consistency checks (for debugging
+        libev) and abort the program if any data structures wree found to be
+        corrupted.
     $loop = EV::default_loop [$flags]
-        Return the default loop (which is a singleton object).
+        Return the default loop (which is a singleton object). Since this
+        module already creates the default loop with default flags,
+        specifying flags here will not have any effect unless you destroy
+        the default loop.
 BASIC INTERFACE
     $EV::DIED
         Must contain a reference to a function that is called when a
         callback throws an exception (with $@ containing the error). The
             This time simply fires at the wallclock time $at and doesn't
             repeat. It will not adjust when a time jump occurs, that is, if
             it is to be run at January 1st 2011 then it will run when the
             system time reaches or surpasses this time.
-        *   non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
+        *   repeating interval timer ($interval > 0, $reschedule_cb = 0)
             In this mode the watcher will always be scheduled to time out at
             the next "$at + N * $interval" time (for some integer N) and
             then repeat, regardless of any time jumps.
             each time the periodic watcher gets scheduled, the reschedule
             callback ($reschedule_cb) will be called with the watcher as
             first, and the current time as second argument.
             *This callback MUST NOT stop or destroy this or any other
+            periodic watcher, ever, and MUST NOT call any event loop
-            periodic watcher, ever*. If you need to stop it, return 1e30 and
+            functions or methods*. If you need to stop it, return 1e30 and
-            stop it afterwards.
+            stop it afterwards. You may create and start a "EV::prepare"
+            watcher for this task.
             It must return the next time to trigger, based on the passed
-            time value (that is, the lowest time value larger than to the
+            time value (that is, the lowest time value larger than or equal
-            second argument). It will usually be called just before the
+            to to the second argument). It will usually be called just
-            callback will be triggered, but might be called at other times,
+            before the callback will be triggered, but might be called at
-            too.
+            other times, too.
             This can be used to create very complex timers, such as a timer
             that triggers on each midnight, local time (actually 24 hours
             after the last midnight, to keep the example simple. If you know
             a way to do it correctly in about the same space (without
         managed automatically.
         The "embed_ns" variant doesn't start (activate) the newly created
         watcher.
+   ASYNC WATCHERS - how to wake up another event loop
+    Async watchers are provided by EV, but have little use in perl directly,
+    as perl neither supports threads nor direct access to signal handlers or
+    other contexts where they could be of value.
+    It is, however, possible to use them from the XS level.
+    Please see the libev documentation for further details.
+    $w = EV::async $callback
+    $w = EV::async_ns $callback
+    $w->send
+    $bool = $w->async_pending
 PERL SIGNALS
     While Perl signal handling (%SIG) is not affected by EV, the behaviour
     with EV is as the same as any other C library: Perl-signals will only be
     handled when Perl runs, which means your signal handler might be invoked
     only the next time an event callback is invoked.
     course.
 SEE ALSO
     EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event
     loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines
-    with EV), Net::SNMP::EV (asynchronous SNMP).
+    with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop
+    agnostic and portable event driven programming.
 AUTHOR
      Marc Lehmann <schmorp@schmorp.de>
      http://home.schmorp.de/

Diff Legend

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

Comparing EV/README (file contents): Revision 1.22 by root, Mon Jan 28 12:24:05 2008 UTC vs. Revision 1.27 by root, Mon May 26 05:37:18 2008 UTC

Diff Legend

Comparing EV/README (file contents):
Revision 1.22 by root, Mon Jan 28 12:24:05 2008 UTC vs.
Revision 1.27 by root, Mon May 26 05:37:18 2008 UTC