[ViewVC] Diff of: cvs/AnyEvent/README

Comparing AnyEvent/README (file contents):
Revision 1.72 by root, Tue Dec 17 16:43:15 2013 UTC vs.
Revision 1.79 by root, Tue Feb 26 02:08:34 2019 UTC

 NAME
     AnyEvent - the DBI of event loop programming
-    EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,
+    EV, Event, Glib, Tk, UV, Perl, Event::Lib, Irssi, rxvt-unicode,
-    Qt, FLTK and POE are various supported event loops/environments.
+    IO::Async, Qt, FLTK and POE are various supported event
+    loops/environments.
 SYNOPSIS
        use AnyEvent;
        # if you prefer function calls, look at the AE manpage for
     $bool = $cv->ready
         Returns true when the condition is "true", i.e. whether "send" or
         "croak" have been called.
     $cb = $cv->cb ($cb->($cv))
-        This is a mutator function that returns the callback set and
+        This is a mutator function that returns the callback set (or "undef"
-        optionally replaces it before doing so.
+        if not) and optionally replaces it before doing so.
         The callback will be called when the condition becomes "true", i.e.
         when "send" or "croak" are called, with the only argument being the
         condition variable itself. If the condition is already true, the
         callback is called immediately when it is set. Calling "recv" inside
         the callback or at any later time is guaranteed not to block.
+        Additionally, when the callback is invoked, it is also removed from
+        the condvar (reset to "undef"), so the condvar does not keep a
+        reference to the callback after invocation.
 SUPPORTED EVENT LOOPS/BACKENDS
-    The available backend classes are (every class has its own manpage):
+    The following backend classes are part of the AnyEvent distribution
+    (every class has its own manpage):
     Backends that are autoprobed when no other event loop can be found.
         EV is the preferred backend when no other event loop seems to be in
         use. If EV is not installed, then AnyEvent will fall back to its own
         pure-perl implementation, which is available everywhere as it comes
         by the main program.
            AnyEvent::Impl::Event     based on Event, very stable, few glitches.
            AnyEvent::Impl::Glib      based on Glib, slow but very stable.
            AnyEvent::Impl::Tk        based on Tk, very broken.
+           AnyEvent::Impl::UV        based on UV, innovated square wheels.
            AnyEvent::Impl::EventLib  based on Event::Lib, leaks memory and worse.
            AnyEvent::Impl::POE       based on POE, very slow, some limitations.
            AnyEvent::Impl::Irssi     used when running within irssi.
            AnyEvent::Impl::IOAsync   based on IO::Async.
            AnyEvent::Impl::Cocoa     based on Cocoa::EventLoop.
         AnyEvent knows about both Prima and Wx, however, and will try to
         load POE when detecting them, in the hope that POE will pick them
         up, in which case everything will be automatic.
+    Known event loops outside the AnyEvent distribution
+        The following event loops or programs support AnyEvent by providing
+        their own AnyEvent backend. They will be picked up automatically.
+           urxvt::anyevent           available to rxvt-unicode extensions
 GLOBAL VARIABLES AND FUNCTIONS
     These are not normally required to use AnyEvent, but can be useful to
     write AnyEvent extension modules.
     $AnyEvent::MODEL
     $guard = AnyEvent::post_detect { BLOCK }
         Arranges for the code block to be executed as soon as the event
         model is autodetected (or immediately if that has already happened).
         The block will be executed *after* the actual backend has been
-        detected ($AnyEvent::MODEL is set), but *before* any watchers have
+        detected ($AnyEvent::MODEL is set), so it is possible to do some
-        been created, so it is possible to e.g. patch @AnyEvent::ISA or do
+        initialisation only when AnyEvent is actually initialised - see the
-        other initialisations - see the sources of AnyEvent::Strict or
-        AnyEvent::AIO to see how this is used.
+        sources of AnyEvent::AIO to see how this is used.
         The most common usage is to create some global watchers, without
-        forcing event module detection too early, for example, AnyEvent::AIO
+        forcing event module detection too early. For example, AnyEvent::AIO
         creates and installs the global IO::AIO watcher in a "post_detect"
         block to avoid autodetecting the event module at load time.
         If called in scalar or list context, then it creates and returns an
         object that automatically removes the callback again when it is
            # able to just C<undef $WATCHER> if the watcher causes them grief.
            $WATCHER ||= $guard;
     @AnyEvent::post_detect
-        If there are any code references in this array (you can "push" to it
+        This is a lower level interface then "AnyEvent::post_detect" (the
-        before or after loading AnyEvent), then they will be called directly
+        function). This variable is mainly useful for modules that can do
+        something useful when AnyEvent is used and thus want to know when it
+        is initialised, but do not need to even load it by default. This
+        array provides the means to hook into AnyEvent passively, without
+        loading it.
+        Here is how it works: If there are any code references in this array
+        (you can "push" to it before or after loading AnyEvent), then they
-        after the event loop has been chosen.
+        will be called directly after the event loop has been chosen.
         You should check $AnyEvent::MODEL before adding to this array,
         though: if it is defined then the event loop has already been
         detected, and the array will be ignored.
         Best use "AnyEvent::post_detect { BLOCK }" when your application
         allows it, as it takes care of these details.
-        This variable is mainly useful for modules that can do something
-        useful when AnyEvent is used and thus want to know when it is
-        initialised, but do not need to even load it by default. This array
-        provides the means to hook into AnyEvent passively, without loading
-        it.
         Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
         together, you could put this into Coro (this is the actual code used
         by Coro to accomplish this):
         To understand the usefulness of this function, consider a function
         that asynchronously does something for you and returns some
         transaction object or guard to let you cancel the operation. For
         example, "AnyEvent::Socket::tcp_connect":
-           # start a conenction attempt unless one is active
+           # start a connection attempt unless one is active
            $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
               delete $self->{connect_guard};
               ...
            };
         If you want to sprinkle loads of logging calls around your code,
         consider creating a logger callback with the "AnyEvent::Log::logger"
         function, which can reduce typing, codesize and can reduce the
         logging overhead enourmously.
+    AnyEvent::fh_block $filehandle
+    AnyEvent::fh_unblock $filehandle
+        Sets blocking or non-blocking behaviour for the given filehandle.
 WHAT TO DO IN A MODULE
     As a module author, you should "use AnyEvent" and call AnyEvent methods
     freely, but you should not load a specific event module or rely on it.
     Be careful when you create watchers in the module body - AnyEvent will
         mentioned will be used, and preference will be given to protocols
         mentioned earlier in the list.
         This variable can effectively be used for denial-of-service attacks
         against local programs (e.g. when setuid), although the impact is
-        likely small, as the program has to handle conenction and other
+        likely small, as the program has to handle connection and other
         failures anyways.
         Examples: "PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6" - prefer IPv4 over
         IPv6, but support both and try to use both.
         "PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to
           my $txn = shift;
           my $data = $txn->result;
           ...
        });
-       EV::loop;
+       EV::run;
     3b. The module user could use AnyEvent, too:
        use AnyEvent;
     Development/Debugging: AnyEvent::Strict (stricter checking),
     AnyEvent::Debug (interactive shell, watcher tracing).
     Supported event modules: AnyEvent::Loop, EV, EV::Glib, Glib::EV, Event,
-    Glib::Event, Glib, Tk, Event::Lib, Qt, POE, FLTK.
+    Glib::Event, Glib, Tk, Event::Lib, Qt, POE, FLTK, Cocoa::EventLoop, UV.
     Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,
     AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,
     AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,
-    AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi, AnyEvent::Impl::FLTK.
+    AnyEvent::Impl::IOAsync, AnyEvent::Impl::Irssi, AnyEvent::Impl::FLTK,
+    AnyEvent::Impl::Cocoa, AnyEvent::Impl::UV.
     Non-blocking handles, pipes, stream sockets, TCP clients and servers:
     AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.
     Asynchronous File I/O: AnyEvent::IO.

Diff Legend

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

Comparing AnyEvent/README (file contents): Revision 1.72 by root, Tue Dec 17 16:43:15 2013 UTC vs. Revision 1.79 by root, Tue Feb 26 02:08:34 2019 UTC

Diff Legend

Comparing AnyEvent/README (file contents):
Revision 1.72 by root, Tue Dec 17 16:43:15 2013 UTC vs.
Revision 1.79 by root, Tue Feb 26 02:08:34 2019 UTC