[ViewVC] Diff of: cvs/EV/README

Comparing EV/README (file contents):
Revision 1.39 by root, Tue Jan 11 13:45:28 2011 UTC vs.
Revision 1.47 by root, Tue Nov 19 20:11:01 2019 UTC

           my ($w, $revents) = @_;
           warn $w->path, " has changed somehow.\n";
        };
        # MAINLOOP
-       EV::loop;           # loop until EV::unloop is called or all watchers stop
+       EV::run;                # loop until EV::break is called or all watchers stop
-       EV::loop EV::LOOP_ONESHOT;  # block until at least one event could be handled
+       EV::run EV::RUN_ONCE;   # block until at least one event could be handled
-       EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
+       EV::run EV::RUN_NOWAIT; # 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.
         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
         some performance loss (refer to the libev documentation).
-    $loop->loop_verify
+    $loop->verify
         Calls "ev_verify" to make internal consistency checks (for debugging
         libev) and abort the program if any data structures were found to be
         corrupted.
     $loop = EV::default_loop [$flags]
     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".
+        operation and is usually done automatically within "EV::run".
         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.
     $backend = EV::backend
     $backend = $loop->backend
         Returns an integer describing the backend used by libev
         (EV::BACKEND_SELECT or EV::BACKEND_EPOLL).
-    EV::loop [$flags]
+    $active = EV::run [$flags]
-    $loop->loop ([$flags])
+    $active = $loop->run ([$flags])
         Begin checking for events and calling callbacks. It returns when a
-        callback calls EV::unloop.
+        callback calls EV::break or the flags are nonzero (in which case the
+        return value is true) or when there are no active watchers which
+        reference the loop (keepalive is true), in which case the return
+        value will be false. The return value can generally be interpreted
+        as "if true, there is more work left to do".
         The $flags argument can be one of the following:
-           0                as above
+           0               as above
-           EV::LOOP_ONCE    block at most once (wait, but do not loop)
+           EV::RUN_ONCE    block at most once (wait, but do not loop)
-           EV::LOOP_NOWAIT  do not block at all (fetch/handle events but do not wait)
+           EV::RUN_NOWAIT  do not block at all (fetch/handle events but do not wait)
     EV::break [$how]
     $loop->break ([$how])
         When called with no arguments or an argument of EV::BREAK_ONE, makes
-        the innermost call to EV::loop return.
+        the innermost call to EV::run return.
-        When called with an argument of EV::BREAK_ALL, all calls to EV::loop
+        When called with an argument of EV::BREAK_ALL, all calls to EV::run
         will return as fast as possible.
         When called with an argument of EV::BREAK_CANCEL, any pending break
         will be cancelled.
-    $count = EV::loop_count
+    $count = EV::iteration
-    $count = $loop->loop_count
+    $count = $loop->iteration
         Return the number of times the event loop has polled for new events.
         Sometimes useful as a generation counter.
     EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
     $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
         "EV::READ | EV::WRITE", indicating the type of I/O event you want to
         wait for. If you do not want to wait for some I/O event, specify
         "undef" for $fh_or_undef and 0 for $events).
         If timeout is "undef" or negative, then there will be no timeout.
-        Otherwise a EV::timer with this value will be started.
+        Otherwise an "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::TIMER").
         call as if the signal specified by $signal had occured.
     EV::feed_signal $signal
         Feed a signal event into EV - unlike "EV::feed_signal_event", this
         works regardless of which loop has registered the signal, and is
-        mainly useful fro custom signal implementations.
+        mainly useful for custom signal implementations.
     EV::set_io_collect_interval $time
     $loop->set_io_collect_interval ($time)
     EV::set_timeout_collect_interval $time
     $loop->set_timeout_collect_interval ($time)
         If the watcher is pending, this function clears its pending status
         and returns its $revents bitset (as if its callback was invoked). If
         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
+        Normally, "EV::run" will return when there are no active watchers
         (which is a "deadlock" because no progress can be made anymore).
         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
+        your jobs), call "EV::run" 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
-        module that calls "EV::loop" (usually the main program) is not the
+        module that calls "EV::run" (usually the main program) is not the
         same module as a long-living watcher (for example a DNS client
         module written by somebody else even). Then you might want any
         outstanding requests to be handled, but you would not want to keep
-        "EV::loop" from returning just because you happen to have this
+        "EV::run" from returning just because you happen to have this
         long-running UDP port watcher.
         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
+        even though your watcher is active, it won't keep "EV::run" from
         returning.
         The initial value for keepalive is true (enabled), and you can
         change it any time.
    TIMER WATCHERS - relative and optionally repeating timeouts
     $w = EV::timer $after, $repeat, $callback
     $w = EV::timer_ns $after, $repeat, $callback
     $w = $loop->timer ($after, $repeat, $callback)
     $w = $loop->timer_ns ($after, $repeat, $callback)
-        Calls the callback after $after seconds (which may be fractional).
+        Calls the callback after $after seconds (which may be fractional or
-        If $repeat is non-zero, the timer will be restarted (with the
+        negative). If $repeat is non-zero, the timer will be restarted (with
-        $repeat value as $after) after the callback returns.
+        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. The timer does his best not
         to drift, but it will not invoke the timer more often then once per
         event loop iteration, and might drift in other cases. If that isn't
         the same time.
         The "timer_ns" variant doesn't start (activate) the newly created
         watcher.
-    $w->set ($after, $repeat)
+    $w->set ($after, $repeat = 0)
         Reconfigures the watcher, see the constructor above for details. Can
         be called at any time.
     $w->again
+    $w->again ($repeat)
         Similar to the "start" method, but has special semantics for
         repeating timers:
         If the timer is active and non-repeating, it will be stopped.
         This behaviour is useful when you have a timeout for some IO
         operation. You create a timer object with the same value for $after
         and $repeat, and then, in the read/write watcher, run the "again"
         method on the timeout.
+        If called with a $repeat argument, then it uses this a timer repeat
+        value.
+    $after = $w->remaining
+        Calculates and returns the remaining time till the timer will fire.
    PERIODIC WATCHERS - to cron or not to cron?
     $w = EV::periodic $at, $interval, $reschedule_cb, $callback
     $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
     $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
             system time reaches or surpasses this time.
         *   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
+            the next "$at + N * $interval" time (for the lowest integer N)
-            then repeat, regardless of any time jumps.
+            and then repeat, regardless of any time jumps. Note that, since
+            "N" can be negative, the first trigger can happen before $at.
             This can be used to create timers that do not drift with respect
             to system time:
                my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
             That doesn't mean there will always be 3600 seconds in between
-            triggers, but only that the the clalback will be called when the
+            triggers, but only that the the callback will be called when the
             system time shows a full hour (UTC).
             Another way to think about it (for the mathematically inclined)
             is that EV::periodic will try to run the callback in this mode
             at the next possible time where "$time = $at (mod $interval)",
             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
             functions or methods*. If you need to stop it, return 1e30 and
-            stop it afterwards. You may create and start a "EV::prepare"
+            stop it afterwards. You may create and start an "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 or equal
             to to the second argument). It will usually be called just
             before the callback will be triggered, but might be called at
             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
+            that triggers on each midnight, local time (actually one day
-            after the last midnight, to keep the example simple. If you know
+            after the last midnight, to keep the example simple):
-            a way to do it correctly in about the same space (without
-            requiring elaborate modules), drop me a note :):
                my $daily = EV::periodic 0, 0, sub {
                   my ($w, $now) = @_;
                   use Time::Local ();
                   my (undef, undef, undef, $d, $m, $y) = localtime $now;
-                  86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
+                  Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y
                }, sub {
                   print "it's midnight or likely shortly after, now\n";
                };
         The "periodic_ns" variant doesn't start (activate) the newly created
     Please see the libev documentation for further details.
     $w = EV::async $callback
     $w = EV::async_ns $callback
+    $w = $loop->async ($callback)
+    $w = $loop->async_ns ($callback)
     $w->send
     $bool = $w->async_pending
+   CLEANUP WATCHERS - how to clean up when the event loop goes away
+    Cleanup watchers are not supported on the Perl level, they can only be
+    used via XS currently.
 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

Diff Legend

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

Comparing EV/README (file contents): Revision 1.39 by root, Tue Jan 11 13:45:28 2011 UTC vs. Revision 1.47 by root, Tue Nov 19 20:11:01 2019 UTC

Diff Legend

Comparing EV/README (file contents):
Revision 1.39 by root, Tue Jan 11 13:45:28 2011 UTC vs.
Revision 1.47 by root, Tue Nov 19 20:11:01 2019 UTC