[ViewVC] Diff of: cvs/EV/README

Comparing EV/README (file contents):
Revision 1.14 by root, Wed Nov 28 19:22:16 2007 UTC vs.
Revision 1.18 by root, Tue Dec 11 21:18:25 2007 UTC

     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
     details on watcher semantics or some discussion on the available
-    backends, or how to force a specific backend with "LIBEV_FLAGS".
+    backends, or how to force a specific backend with "LIBEV_FLAGS", or just
+    about in any case because it has much more detailed information.
 BASIC INTERFACE
     $EV::DIED
         Must contain a reference to a function that is called when a
-        callback throws an exception (with $@ containing thr error). The
+        callback throws an exception (with $@ containing the error). The
         default prints an informative message and continues.
         If this callback throws an exception it will be silently ignored.
     $time = EV::time
         When called with no arguments or an argument of EV::UNLOOP_ONE,
         makes the innermost call to EV::loop return.
         When called with an argument of EV::UNLOOP_ALL, all calls to
         EV::loop will return as fast as possible.
+    $count = EV::loop_count
+        Return the number of times the event loop has polled for new events.
+        Sometiems useful as a generation counter.
     EV::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.
         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.
+    EV::feed_fd_event ($fd, $revents)
+        Feed an event on a file descriptor into EV. EV will react to this
+        call as if the readyness notifications specified by $revents (a
+        combination of "EV::READ" and "EV::WRITE") happened on the file
+        descriptor $fd.
+    EV::feed_signal_event ($signal)
+        Feed a signal event into EV. EV will react to this call as if the
+        signal specified by $signal had occured.
   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:
     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,
-    EV::periodic sets EV::PERIODIC and so on, with the exception of IO
+    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
     the same time, each constructor has a variant with a trailing "_ns" in
         stopped watchers).
     $w->stop
         Stop a watcher if it is active. Also clear any pending events
         (events that have been received but that didn't yet result in a
-        callback invocation), regardless of wether the watcher was active or
+        callback invocation), regardless of whether the watcher was active
-        not.
+        or not.
     $bool = $w->is_active
         Returns true if the watcher is active, false otherwise.
     $current_data = $w->data
         The default priority of any newly-created watcher is 0.
         Note that the priority semantics have not yet been fleshed out and
         are subject to almost certain change.
-    $w->trigger ($revents)
+    $w->invoke ($revents)
         Call the callback *now* with the given event mask.
+    $w->feed_event ($revents)
+        Feed some events on this watcher into EV. EV will react to this call
+        as if the watcher had received the given $revents mask.
+    $revents = $w->clear_pending
+        If the watcher is pending, this function returns 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
         (which is a "deadlock" because no progress can be made anymore).
         This is convinient because it allows you to start your watchers (and
         returning.
         The initial value for keepalive is true (enabled), and you cna
         change it any time.
-        Example: Register an IO watcher for some UDP socket but do not keep
+        Example: Register an I/O watcher for some UDP socket but do not keep
         the event loop from running just because of that watcher.
            my $udp_socket = ...
            my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
            $udp_watcher->keepalive (0);
   WATCHER TYPES
     Each of the following subsections describes a single watcher type.
-   IO WATCHERS - is this file descriptor readable or writable?
+   I/O WATCHERS - is this file descriptor readable or writable?
     $w = EV::io $fileno_or_fh, $eventmask, $callback
     $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
         As long as the returned watcher object is alive, call the $callback
         when at least one of events specified in $eventmask occurs.
         Can be used to query the actual interval used.
    IDLE WATCHERS - when you've got nothing better to do...
     $w = EV::idle $callback
     $w = EV::idle_ns $callback
-        Call the callback when there are no pending io, timer/periodic,
+        Call the callback when there are no other pending watchers of the
-        signal or child events, i.e. when the process is idle.
+        same or higher priority (excluding check, prepare and other idle
+        watchers of the same or lower priority, of course). They are called
+        idle watchers because when the watcher is the highest priority
+        pending event in the process, the process is considered to be idle
+        at that priority.
+        If you want a watcher that is only ever called when *no* other
+        events are outstanding you have to set the priority to "EV::MINPRI".
         The process will not block as long as any idle watchers are active,
         and they will be called repeatedly until stopped.
+        For example, if you have idle watchers at priority 0 and 1, and an
+        I/O watcher at priority 0, then the idle watcher at priority 1 and
+        the I/O watcher will always run when ready. Only when the idle
+        watcher at priority 1 is stopped and the I/O watcher at priority 0
+        is not pending with the 0-priority idle watcher be invoked.
         The "idle_ns" variant doesn't start (activate) the newly created
         watcher.
    PREPARE WATCHERS - customise your event loop!
                  or return;
               # make the dispatcher handle any outstanding stuff
               ... not shown
-              # create an IO watcher for each and every socket
+              # create an I/O watcher for each and every socket
               @snmp_watcher = (
                  (map { EV::io $_, EV::READ, sub { } }
                      keys %{ $dispatcher->{_descriptors} }),
                  EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
         Call the callback before the event loop is resumed in the child
         process after a fork.
         The "fork_ns" variant doesn't start (activate) the newly created
         watcher.
+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.
+    The solution is to use EV signal watchers (see "EV::signal"), which will
+    ensure proper operations with regards to other event watchers.
+    If you cannot do this for whatever reason, you can also force a watcher
+    to be called on every event loop iteration by installing a "EV::check"
+    watcher:
+       my $async_check = EV::check sub { };
+    This ensures that perl shortly gets into control for a short time, and
+    also ensures slower overall operation.
 THREADS
     Threads are not supported by this module in any way. Perl pseudo-threads
     is evil stuff and must die. As soon as Perl gains real threads I will
     work on thread support for it.
     On win32, there is no notion of fork so all this doesn't apply, of
     course.
 SEE ALSO
-    EV::DNS.
+    EV::ADNS (asynchronous dns), Glib::EV (makes Glib/Gtk2 use EV as event
+    loop), Coro::EV (efficient coroutines with EV).
 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.14 by root, Wed Nov 28 19:22:16 2007 UTC vs. Revision 1.18 by root, Tue Dec 11 21:18:25 2007 UTC

Diff Legend

Comparing EV/README (file contents):
Revision 1.14 by root, Wed Nov 28 19:22:16 2007 UTC vs.
Revision 1.18 by root, Tue Dec 11 21:18:25 2007 UTC