[ViewVC] Diff of: cvs/EV/README

Comparing EV/README (file contents):
Revision 1.8 by root, Thu Nov 8 17:02:10 2007 UTC vs.
Revision 1.11 by root, Sat Nov 17 01:41:33 2007 UTC

       my $w = EV::timer 2, 0, sub {
          warn "is called after 2s";
       };
-      my $w = EV::timer 2, 1, sub {
+      my $w = EV::timer 2, 2, sub {
-         warn "is called roughly every 2s (repeat = 1)";
+         warn "is called roughly every 2s (repeat = 2)";
       };
       undef $w; # destroy event watcher again
       my $w = EV::periodic 0, 60, 0, sub {
       };
       # IO
       my $w = EV::io *STDIN, EV::READ, sub {
-         my ($w, $revents) = @_; # all callbacks get the watcher object and event mask
+         my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
          warn "stdin is readable, you entered: ", <STDIN>;
       };
       # SIGNALS
       my $w = EV::signal 'QUIT', sub {
          warn "sigquit received\n";
       };
-      my $w = EV::signal 3, sub {
-         warn "sigquit received (this is GNU/Linux, right?)\n";
-      };
       # CHILD/PID STATUS CHANGES
       my $w = EV::child 666, sub {
          my ($w, $revents) = @_;
-         # my $pid = $w->rpid;
          my $status = $w->rstatus;
       };
       # MAINLOOP
-      EV::loop;                   # loop until EV::loop_done is called
+      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
 DESCRIPTION
     This module provides an interface to libev
     $time = EV::now
         Returns the time the last event loop iteration has been started.
         This is the time that (relative) timers are based on, and refering
         to it is usually faster then calling EV::time.
-    $method = EV::ev_method
+    $method = EV::method
         Returns an integer describing the backend used by libev
         (EV::METHOD_SELECT or EV::METHOD_EPOLL).
     EV::loop [$flags]
         Begin checking for events and calling callbacks. It returns when a
-        callback calls EV::loop_done.
+        callback calls EV::unloop.
         The $flags argument can be one of the following:
            0                  as above
            EV::LOOP_ONESHOT   block at most once (wait, but do not loop)
            EV::LOOP_NONBLOCK  do not block at all (fetch/handle events but do not wait)
-    EV::loop_done [$how]
+    EV::unloop [$how]
-        When called with no arguments or an argument of 1, makes the
+        When called with no arguments or an argument of EV::UNLOOP_ONE,
-        innermost call to EV::loop return.
+        makes the innermost call to EV::loop return.
-        When called with an agrument of 2, all calls to EV::loop will return
+        When called with an argument of EV::UNLOOP_ALL, all calls to
-        as fast as possible.
+        EV::loop will return as fast as possible.
   WATCHER
     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:
         Calls the callback after $after seconds. If $repeat is non-zero, the
         timer will be restarted (with the $repeat value as $after) after the
         callback returns.
         This means that the callback would be called roughly after $after
-        seconds, and then every $repeat seconds. "Roughly" because the time
+        seconds, and then every $repeat seconds. The timer does his best not
-        of callback processing is not taken into account, so the timer will
+        to drift, but it will not invoke the timer more often then once per
-        slowly drift. If that isn't acceptable, look at EV::periodic.
+        event loop iteration, and might drift in other cases. If that isn't
+        acceptable, look at EV::periodic, which can provide long-term stable
+        timers.
-        The timer is based on a monotonic clock, that is if somebody is
+        The timer is based on a monotonic clock, that is, if somebody is
         sitting in front of the machine while the timer is running and
         changes the system clock, the timer will nevertheless run (roughly)
         the same time.
         The "timer_ns" variant doesn't start (activate) the newly created
     $w->again
         Similar to the "start" method, but has special semantics for
         repeating timers:
+        If the timer is active and non-repeating, it will be stopped.
         If the timer is active and repeating, reset the timeout to occur
         $repeat seconds after now.
-        If the timer is active and non-repeating, it will be stopped.
-        If the timer is in active and repeating, start it.
+        If the timer is inactive and repeating, start it using the repeat
+        value.
         Otherwise do nothing.
         This behaviour is useful when you have a timeout for some IO
         operation. You create a timer object with the same value for $after
             at the next possible time where "$time = $at (mod $interval)",
             regardless of any time jumps.
         * manual reschedule mode ($reschedule_cb = coderef)
             In this mode $interval and $at are both being ignored. Instead,
-            each time the periodic watcher gets scheduled, the first
+            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*. If you need to stop it, return 1e30 and
 THREADS
     Threads are not supported by this in any way. Perl pseudo-threads is
     evil stuff and must die.
 SEE ALSO
-      L<EV::DNS>, L<EV::AnyEvent>.
+      L<EV::DNS>.
 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.8 by root, Thu Nov 8 17:02:10 2007 UTC vs. Revision 1.11 by root, Sat Nov 17 01:41:33 2007 UTC

Diff Legend

Comparing EV/README (file contents):
Revision 1.8 by root, Thu Nov 8 17:02:10 2007 UTC vs.
Revision 1.11 by root, Sat Nov 17 01:41:33 2007 UTC