[ViewVC] Diff of: cvs/AnyEvent/README

Comparing AnyEvent/README (file contents):
Revision 1.59 by root, Tue Jan 5 10:45:25 2010 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 => ...
     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.

Diff Legend

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

Comparing AnyEvent/README (file contents): Revision 1.59 by root, Tue Jan 5 10:45:25 2010 UTC vs. Revision 1.60 by root, Mon Apr 12 02:50:31 2010 UTC

Diff Legend

Comparing AnyEvent/README (file contents):
Revision 1.59 by root, Tue Jan 5 10:45:25 2010 UTC vs.
Revision 1.60 by root, Mon Apr 12 02:50:31 2010 UTC