[ViewVC] Diff of: cvs/EV/README

Comparing EV/README (file contents):
Revision 1.33 by root, Fri Jul 17 14:49:33 2009 UTC vs.
Revision 1.38 by root, Mon Oct 25 11:30:45 2010 UTC

        # MAINLOOP
        EV::loop;           # loop until EV::unloop is called or all watchers stop
        EV::loop EV::LOOP_ONESHOT;  # block until at least one event could be handled
        EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
+BEFORE YOU START USING THIS MODULE
+    If you only need timer, I/O, signal, child and idle watchers and not the
+    advanced functionality of this module, consider using AnyEvent instead,
+    specifically the simplified API described in AE.
+    When used with EV as backend, the AE API is as fast as the native EV
+    API, but your programs/modules will still run with many other event
+    loops.
 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> or
     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.
+  PORTING FROM EV 3.X to 4.X
+    EV version 4 introduces a number of incompatible changes summarised
+    here. According to the depreciation strategy used by libev, there is a
+    compatibility layer in place so programs should continue to run
+    unchanged (the XS interface lacks this layer, so programs using that one
+    need to be updated).
+    This compatibility layer will be switched off in some future release.
+    All changes relevant to Perl are renames of symbols, functions and
+    methods:
+      EV::loop          => EV::run
+      EV::LOOP_NONBLOCK => EV::RUN_NOWAIT
+      EV::LOOP_ONESHOT  => EV::RUN_ONCE
+      EV::unloop        => EV::break
+      EV::UNLOOP_CANCEL => EV::BREAK_CANCEL
+      EV::UNLOOP_ONE    => EV::BREAK_ONE
+      EV::UNLOOP_ALL    => EV::BREAK_ALL
+      EV::TIMEOUT       => EV::TIMER
+      EV::loop_count    => EV::iteration
+      EV::loop_depth    => EV::depth
+      EV::loop_verify   => EV::verify
+    The loop object methods corresponding to the functions above have been
+    similarly renamed.
   MODULE EXPORTS
     This module does not export any symbols.
 EVENT LOOPS
     EV supports multiple event loops: There is a single "default event loop"
         Otherwise a EV::timer with this value will be started.
         When an error occurs or either the timeout or I/O watcher triggers,
         then the callback will be called with the received event set (in
         general you can expect it to be a combination of "EV::ERROR",
-        "EV::READ", "EV::WRITE" and "EV::TIMEOUT").
+        "EV::READ", "EV::WRITE" and "EV::TIMER").
         EV::once doesn't return anything: the watchers stay active till
         either of them triggers, then they will be stopped and freed, and
         the callback invoked.
     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,
     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
+    events (which can set both EV::READ and EV::WRITE bits).
-    (which uses EV::TIMEOUT).
     In the rare case where one wants to create a watcher but not start it at
     the same time, each constructor has a variant with a trailing "_ns" in
     its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
         the watcher isn't pending it does nothing and returns 0.
     $previous_state = $w->keepalive ($bool)
         Normally, "EV::loop" will return when there are no active watchers
         (which is a "deadlock" because no progress can be made anymore).
-        This is convinient because it allows you to start your watchers (and
+        This is convenient because it allows you to start your watchers (and
         your jobs), call "EV::loop" once and when it returns you know that
         all your jobs are finished (or they forgot to register some watchers
         for their task :).
         Sometimes, however, this gets in your way, for example when the
         Return the time that the watcher is expected to trigger next.
    SIGNAL WATCHERS - signal me when a signal gets signalled!
     $w = EV::signal $signal, $callback
     $w = EV::signal_ns $signal, $callback
+    $w = $loop->signal ($signal, $callback)
+    $w = $loop->signal_ns ($signal, $callback)
         Call the callback when $signal is received (the signal can be
         specified by number or by name, just as with "kill" or %SIG).
+        Only one event loop can grab a given signal - attempting to grab the
+        same signal from two EV loops will crash the program immediately or
+        cause data corruption.
         EV will grab the signal for the process (the kernel only allows one
         component to receive a signal at a time) when you start a signal
         watcher, and removes it again when you stop it. Perl does the same
         when you add/remove callbacks to %SIG, so watch out.
     $w = $loop->check_ns ($callback)
         Call the callback just after the process wakes up again (after it
         has gathered events), but before any other callbacks have been
         invoked.
-        This is used to integrate other event-based software into the EV
+        This can be used to integrate other event-based software into the EV
         mainloop: You register a prepare callback and in there, you create
         io and timer watchers as required by the other software. Here is a
         real-world example of integrating Net::SNMP (with some details left
         out):
         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.
+    EV::CHECK constant issues
+        Like all other watcher types, there is a bitmask constant for use in
+        $revents and other places. The "EV::CHECK" is special as it has the
+        same name as the "CHECK" sub called by Perl. This doesn't cause big
+        issues on newer perls (beginning with 5.8.9), but it means thatthe
+        constant must be *inlined*, i.e. runtime calls will not work. That
+        means that as long as you always "use EV" and then "EV::CHECK" you
+        are on the safe side.
    FORK WATCHERS - the audacity to resume the event loop after a fork
     Fork watchers are called when a "fork ()" was detected. The invocation
     is done before the event loop blocks next and before "check" watchers
     are being called, and only in the child after the fork.
     On win32, there is no notion of fork so all this doesn't apply, of
     course.
 SEE ALSO
-    EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event
+    EV::MakeMaker - MakeMaker interface to XS API, EV::ADNS (asynchronous
-    loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines
+    DNS), Glib::EV (makes Glib/Gtk2 use EV as event loop), EV::Glib (embed
-    with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop
+    Glib into EV), Coro::EV (efficient thread integration), Net::SNMP::EV
-    agnostic and portable event driven programming.
+    (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.33 by root, Fri Jul 17 14:49:33 2009 UTC vs. Revision 1.38 by root, Mon Oct 25 11:30:45 2010 UTC

Diff Legend

Comparing EV/README (file contents):
Revision 1.33 by root, Fri Jul 17 14:49:33 2009 UTC vs.
Revision 1.38 by root, Mon Oct 25 11:30:45 2010 UTC