[ViewVC] Diff of: cvs/AnyEvent/README

Comparing AnyEvent/README (file contents):
Revision 1.58 by root, Sun Dec 20 22:49:52 2009 UTC vs.
Revision 1.60 by root, Mon Apr 12 02:50:31 2010 UTC

     Qt and POE are various supported event loops/environments.
 SYNOPSIS
        use AnyEvent;
+       # if you prefer function calls, look at the L<AE> manpage for
+       # an alternative API.
-       # file descriptor readable
+       # file handle or descriptor readable
        my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ...  });
        # one-shot or repeating timers
        my $w = AnyEvent->timer (after => $seconds, cb => sub { ...  });
        my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
        $done->recv;
   IDLE WATCHERS
        $w = AnyEvent->idle (cb => <callback>);
-    Sometimes there is a need to do something, but it is not so important to
+    Repeatedly invoke the callback after the process becomes idle, until
-    do it instantly, but only when there is nothing better to do. This
+    either the watcher is destroyed or new events have been detected.
-    "nothing better to do" is usually defined to be "no other events need
-    attention by the event loop".
-    Idle watchers ideally get invoked when the event loop has nothing better
+    Idle watchers are useful when there is a need to do something, but it is
-    to do, just before it would block the process to wait for new events.
+    not so important (or wise) to do it instantly. The callback will be
-    Instead of blocking, the idle watcher is invoked.
+    invoked only when there is "nothing better to do", which is usually
+    defined as "all outstanding events have been handled and no new events
+    have been detected". That means that idle watchers ideally get invoked
+    when the event loop has just polled for new events but none have been
+    detected. Instead of blocking to wait for more events, the idle watchers
+    will be invoked.
-    Most event loops unfortunately do not really support idle watchers (only
+    Unfortunately, most event loops do not really support idle watchers
-    EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
+    (only EV, Event and Glib do it in a usable fashion) - for the rest,
-    will simply call the callback "from time to time".
+    AnyEvent will simply call the callback "from time to time".
     Example: read lines from STDIN, but only process them when the program
     is otherwise idle:
        my @lines; # read data
     which eventually calls "-> send", and the "consumer side", which waits
     for the send to occur.
     Example: wait for a timer.
-       # wait till the result is ready
+       # condition: "wait till the timer is fired"
-       my $result_ready = AnyEvent->condvar;
+       my $timer_fired = AnyEvent->condvar;
-       # do something such as adding a timer
+       # create the timer - we could wait for, say
-       # or socket watcher the calls $result_ready->send
+       # a handle becomign ready, or even an
-       # when the "result" is ready.
+       # AnyEvent::HTTP request to finish, but
        # in this case, we simply use a timer:
        my $w = AnyEvent->timer (
           after => 1,
-          cb    => sub { $result_ready->send },
+          cb    => sub { $timer_fired->send },
        );
        # this "blocks" (while handling events) till the callback
        # calls ->send
-       $result_ready->recv;
+       $timer_fired->recv;
     Example: wait for a timer, but take advantage of the fact that condition
     variables are also callable directly.
        my $done = AnyEvent->condvar;
         Has special support for AnyEvent via Coro::AnyEvent.
 SIMPLIFIED AE API
     Starting with version 5.0, AnyEvent officially supports a second, much
     simpler, API that is designed to reduce the calling, typing and memory
-    overhead.
+    overhead by using function call syntax and a fixed number of parameters.
     See the AE manpage for details.
 ERROR AND EXCEPTION HANDLING
     In general, AnyEvent does not do any error handling - it relies on the
     The actual code goes further and collects all errors ("die"s,
     exceptions) that occurred during request processing. The "result" method
     detects whether an exception as thrown (it is stored inside the $txn
     object) and just throws the exception, which means connection errors and
-    other problems get reported tot he code that tries to use the result,
+    other problems get reported to the code that tries to use the result,
     not in a random callback.
     All of this enables the following usage styles:
     1. Blocking:
         clock is available, can take avdantage of advanced kernel interfaces
         such as "epoll" and "kqueue", and is the fastest backend *by far*.
         You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and
         Glib::EV).
+        If you only use backends that rely on another event loop (e.g.
+        "Tk"), then this module will do nothing for you.
     Guard
         The guard module, when used, will be used to implement
         "AnyEvent::Util::guard". This speeds up guards considerably (and
         uses a lot less memory), but otherwise doesn't affect guard
         operation much. It is purely used for performance.
     JSON and JSON::XS
         One of these modules is required when you want to read or write JSON
-        data via AnyEvent::Handle. It is also written in pure-perl, but can
+        data via AnyEvent::Handle. JSON is also written in pure-perl, but
-        take advantage of the ultra-high-speed JSON::XS module when it is
+        can take advantage of the ultra-high-speed JSON::XS module when it
-        installed.
+        is installed.
-        In fact, AnyEvent::Handle will use JSON::XS by default if it is
-        installed.
     Net::SSLeay
         Implementing TLS/SSL in Perl is certainly interesting, but not very
         worthwhile: If this module is installed, then AnyEvent::Handle (with
         the help of AnyEvent::TLS), gains the ability to do TLS/SSL.
         additionally use it to try to use a monotonic clock for timing
         stability.
 FORK
     Most event libraries are not fork-safe. The ones who are usually are
-    because they rely on inefficient but fork-safe "select" or "poll" calls.
+    because they rely on inefficient but fork-safe "select" or "poll" calls
-    Only EV is fully fork-aware.
+    - higher performance APIs such as BSD's kqueue or the dreaded Linux
+    epoll are usually badly thought-out hacks that are incompatible with
+    fork in one way or another. Only EV is fully fork-aware and ensures that
+    you continue event-processing in both parent and child (or both, if you
+    know what you are doing).
     This means that, in general, you cannot fork and do event processing in
-    the child if a watcher was created before the fork (which in turn
+    the child if the event library was initialised before the fork (which
-    initialises the event library).
+    usually happens when the first AnyEvent watcher is created, or the
+    library is loaded).
     If you have to fork, you must either do so *before* creating your first
     watcher OR you must not use AnyEvent at all in the child OR you must do
     something completely out of the scope of AnyEvent.
     The problem of doing event processing in the parent *and* the child is
     much more complicated: even for backends that *are* fork-aware or
     fork-safe, their behaviour is not usually what you want: fork clones all
     watchers, that means all timers, I/O watchers etc. are active in both
-    parent and child, which is almost never what you want.
+    parent and child, which is almost never what you want. USing "exec" to
+    start worker children from some kind of manage rprocess is usually
+    preferred, because it is much easier and cleaner, at the expense of
+    having to have another binary.
 SECURITY CONSIDERATIONS
     AnyEvent can be forced to load any event model via
     $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used
     to execute arbitrary code or directly gain access, it can easily be used

Diff Legend

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

Comparing AnyEvent/README (file contents): Revision 1.58 by root, Sun Dec 20 22:49:52 2009 UTC vs. Revision 1.60 by root, Mon Apr 12 02:50:31 2010 UTC

Diff Legend

Comparing AnyEvent/README (file contents):
Revision 1.58 by root, Sun Dec 20 22:49:52 2009 UTC vs.
Revision 1.60 by root, Mon Apr 12 02:50:31 2010 UTC