[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.104 by root, Wed Apr 30 11:40:22 2008 UTC vs.
Revision 1.108 by root, Sat May 10 00:22:02 2008 UTC

 =head1 NAME
 AnyEvent - provide framework for multiple event loops
-EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops
+EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops
 =head1 SYNOPSIS
    use AnyEvent;
    my $w = AnyEvent->timer (after => $seconds, cb => sub {
       ...
    });
    my $w = AnyEvent->condvar; # stores whether a condition was flagged
-   $w->wait; # enters "main loop" till $condvar gets ->broadcast
+   $w->wait; # enters "main loop" till $condvar gets ->send
-   $w->broadcast; # wake up current and all future wait's
+   $w->send; # wake up current and all future wait's
 =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
 Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
 nowadays. So what is different about AnyEvent?
 The interface itself is vaguely similar, but not identical to the L<Event>
 module.
 During the first call of any watcher-creation method, the module tries
 to detect the currently loaded event loop by probing whether one of the
-following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>,
+following modules is already loaded: L<EV>,
 L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
 L<POE>. The first one found is used. If none are found, the module tries
 to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
 adaptor should always succeed) in the order given. The first one that can
 be successfully loaded will be used. If, after this, still none could be
   my $w = AnyEvent->child (
      pid => $pid,
      cb  => sub {
         my ($pid, $status) = @_;
         warn "pid $pid exited with status $status";
-        $done->broadcast;
+        $done->send;
      },
   );
   # do something else, then wait for process exit
   $done->wait;
 =head2 CONDITION VARIABLES
+If you are familiar with some event loops you will know that all of them
+require you to run some blocking "loop", "run" or similar function that
+will actively watch for new events and call your callbacks.
+AnyEvent is different, it expects somebody else to run the event loop and
+will only block when necessary (usually when told by the user).
+The instrument to do that is called a "condition variable", so called
+because they represent a condition that must become true.
-Condition variables can be created by calling the C<< AnyEvent->condvar >>
+Condition variables can be created by calling the C<< AnyEvent->condvar
-method without any arguments.
+>> method, usually without arguments. The only argument pair allowed is
+C<cb>, which specifies a callback to be called when the condition variable
+becomes true.
-A condition variable waits for a condition - precisely that the C<<
+After creation, the conditon variable is "false" until it becomes "true"
-->broadcast >> method has been called.
+by calling the C<send> method.
-They are very useful to signal that a condition has been fulfilled, for
+Condition variables are similar to callbacks, except that you can
+optionally wait for them. They can also be called merge points - points
+in time where multiple outstandign events have been processed. And yet
+another way to call them is transations - each condition variable can be
+used to represent a transaction, which finishes at some point and delivers
+a result.
+Condition variables are very useful to signal that something has finished,
-example, if you write a module that does asynchronous http requests,
+for example, if you write a module that does asynchronous http requests,
 then a condition variable would be the ideal candidate to signal the
-availability of results.
+availability of results. The user can either act when the callback is
+called or can synchronously C<< ->wait >> for the results.
-You can also use condition variables to block your main program until
+You can also use them to simulate traditional event loops - for example,
-an event occurs - for example, you could C<< ->wait >> in your main
+you can block your main program until an event occurs - for example, you
-program until the user clicks the Quit button in your app, which would C<<
+could C<< ->wait >> in your main program until the user clicks the Quit
-->broadcast >> the "quit" event.
+button of your app, which would C<< ->send >> the "quit" event.
 Note that condition variables recurse into the event loop - if you have
-two pirces of code that call C<< ->wait >> in a round-robbin fashion, you
+two pieces of code that call C<< ->wait >> in a round-robbin fashion, you
 lose. Therefore, condition variables are good to export to your caller, but
 you should avoid making a blocking wait yourself, at least in callbacks,
 as this asks for trouble.
-This object has two methods:
+Condition variables are represented by hash refs in perl, and the keys
+used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
+easy (it is often useful to build your own transaction class on top of
+AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
+it's C<new> method in your own C<new> method.
+There are two "sides" to a condition variable - the "producer side" which
+eventually calls C<< -> send >>, and the "consumer side", which waits
+for the send to occur.
+Example:
+   # wait till the result is ready
+   my $result_ready = AnyEvent->condvar;
+   # do something such as adding a timer
+   # or socket watcher the calls $result_ready->send
+   # when the "result" is ready.
+   # in this case, we simply use a timer:
+   my $w = AnyEvent->timer (
+      after => 1,
+      cb    => sub { $result_ready->send },
+   );
+   # this "blocks" (while handling events) till the callback
+   # calls send
+   $result_ready->wait;
+=head3 METHODS FOR PRODUCERS
+These methods should only be used by the producing side, i.e. the
+code/module that eventually sends the signal. Note that it is also
+the producer side which creates the condvar in most cases, but it isn't
+uncommon for the consumer to create it as well.
 =over 4
+=item $cv->send (...)
+Flag the condition as ready - a running C<< ->wait >> and all further
+calls to C<wait> will (eventually) return after this method has been
+called. If nobody is waiting the send will be remembered.
+If a callback has been set on the condition variable, it is called
+immediately from within send.
+Any arguments passed to the C<send> call will be returned by all
+future C<< ->wait >> calls.
+=item $cv->croak ($error)
+Similar to send, but causes all call's wait C<< ->wait >> to invoke
+C<Carp::croak> with the given error message/object/scalar.
+This can be used to signal any errors to the condition variable
+user/consumer.
+=item $cv->begin ([group callback])
+=item $cv->end
+These two methods can be used to combine many transactions/events into
+one. For example, a function that pings many hosts in parallel might want
+to use a condition variable for the whole process.
+Every call to C<< ->begin >> will increment a counter, and every call to
+C<< ->end >> will decrement it.  If the counter reaches C<0> in C<< ->end
+>>, the (last) callback passed to C<begin> will be executed. That callback
+is I<supposed> to call C<< ->send >>, but that is not required. If no
+callback was set, C<send> will be called without any arguments.
+Let's clarify this with the ping example:
+   my $cv = AnyEvent->condvar;
+   my %result;
+   $cv->begin (sub { $cv->send (\%result) });
+   for my $host (@list_of_hosts) {
+      $cv->begin;
+      ping_host_then_call_callback $host, sub {
+         $result{$host} = ...;
+         $cv->end;
+      };
+   }
+   $cv->end;
+This code fragment supposedly pings a number of hosts and calls
+C<send> after results for all then have have been gathered - in any
+order. To achieve this, the code issues a call to C<begin> when it starts
+each ping request and calls C<end> when it has received some result for
+it. Since C<begin> and C<end> only maintain a counter, the order in which
+results arrive is not relevant.
+There is an additional bracketing call to C<begin> and C<end> outside the
+loop, which serves two important purposes: first, it sets the callback
+to be called once the counter reaches C<0>, and second, it ensures that
+C<send> is called even when C<no> hosts are being pinged (the loop
+doesn't execute once).
+This is the general pattern when you "fan out" into multiple subrequests:
+use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
+is called at least once, and then, for each subrequest you start, call
+C<begin> and for eahc subrequest you finish, call C<end>.
+=back
+=head3 METHODS FOR CONSUMERS
+These methods should only be used by the consuming side, i.e. the
+code awaits the condition.
+=over 4
 =item $cv->wait
-Wait (blocking if necessary) until the C<< ->broadcast >> method has been
+Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
-called on c<$cv>, while servicing other watchers normally.
+>> methods have been called on c<$cv>, while servicing other watchers
+normally.
-You can only wait once on a condition - additional calls will return
+You can only wait once on a condition - additional calls are valid but
-immediately.
+will return immediately.
+If an error condition has been set by calling C<< ->croak >>, then this
+function will call C<croak>.
+In list context, all parameters passed to C<send> will be returned,
+in scalar context only the first one will be returned.
 Not all event models support a blocking wait - some die in that case
 (programs might want to do that to stay interactive), so I<if you are
 using this from a module, never require a blocking wait>, but let the
 caller decide whether the call will block or not (for example, by coupling
 while still suppporting blocking waits if the caller so desires).
 Another reason I<never> to C<< ->wait >> in a module is that you cannot
 sensibly have two C<< ->wait >>'s in parallel, as that would require
 multiple interpreters or coroutines/threads, none of which C<AnyEvent>
-can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and
+can supply.
-L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
-from different coroutines, however).
-=item $cv->broadcast
+The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
+fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
+versions and also integrates coroutines into AnyEvent, making blocking
+C<< ->wait >> calls perfectly safe as long as they are done from another
+coroutine (one that doesn't run the event loop).
-Flag the condition as ready - a running C<< ->wait >> and all further
+You can ensure that C<< -wait >> never blocks by setting a callback and
-calls to C<wait> will (eventually) return after this method has been
+only calling C<< ->wait >> from within that callback (or at a later
-called. If nobody is waiting the broadcast will be remembered..
+time). This will work even when the event loop does not support blocking
+waits otherwise.
+=item $bool = $cv->ready
+Returns true when the condition is "true", i.e. whether C<send> or
+C<croak> have been called.
+=item $cb = $cv->cb ([new callback])
+This is a mutator function that returns the callback set and optionally
+replaces it before doing so.
+The callback will be called when the condition becomes "true", i.e. when
+C<send> or C<croak> are called. Calling C<wait> inside the callback
+or at any later time is guaranteed not to block.
 =back
-Example:
-   # wait till the result is ready
-   my $result_ready = AnyEvent->condvar;
-   # do something such as adding a timer
-   # or socket watcher the calls $result_ready->broadcast
-   # when the "result" is ready.
-   # in this case, we simply use a timer:
-   my $w = AnyEvent->timer (
-      after => 1,
-      cb    => sub { $result_ready->broadcast },
-   );
-   # this "blocks" (while handling events) till the watcher
-   # calls broadcast
-   $result_ready->wait;
 =head1 GLOBAL VARIABLES AND FUNCTIONS
 =over 4
 C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
 AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
 The known classes so far are:
-   AnyEvent::Impl::CoroEV    based on Coro::EV, best choice.
-   AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
    AnyEvent::Impl::EV        based on EV (an interface to libev, best choice).
    AnyEvent::Impl::Event     based on Event, second best choice.
    AnyEvent::Impl::Perl      pure-perl implementation, fast and portable.
    AnyEvent::Impl::Glib      based on Glib, third-best choice.
    AnyEvent::Impl::Tk        based on Tk, very bad choice.
 Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
 if necessary. You should only call this function right before you would
 have created an AnyEvent watcher anyway, that is, as late as possible at
 runtime.
+=item @AnyEvent::detect
+If there are any code references in this array (you can C<push> to it
+before or after loading AnyEvent), then they will called directly after
+the event loop has been chosen.
+You should check C<$AnyEvent::MODEL> before adding to this array, though:
+if it contains a true value then the event loop has already been detected,
+and the array will be ignored.
 =back
 =head1 WHAT TO DO IN A MODULE
 As a module author, you should C<use AnyEvent> and call AnyEvent methods
 decide which event module to use as soon as the first method is called, so
 by calling AnyEvent in your module body you force the user of your module
 to load the event module first.
 Never call C<< ->wait >> on a condition variable unless you I<know> that
-the C<< ->broadcast >> method has been called on it already. This is
+the C<< ->send >> method has been called on it already. This is
 because it will stall the whole program, and the whole point of using
 events is to stay interactive.
 It is fine, however, to call C<< ->wait >> when the user of your module
 requests it (i.e. if you create a http request object ad have a method
 High level API for event-based execution flow control.
 =item L<Coro>
-Has special support for AnyEvent.
+Has special support for AnyEvent via L<Coro::AnyEvent>.
 =item L<IO::Lambda>
 The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
 no warnings;
 use strict;
 use Carp;
-our $VERSION = '3.3';
+our $VERSION = '3.4';
 our $MODEL;
 our $AUTOLOAD;
 our @ISA;
 our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
 our @REGISTRY;
 my @models = (
-   [Coro::EV::             => AnyEvent::Impl::CoroEV::],
-   [Coro::Event::          => AnyEvent::Impl::CoroEvent::],
    [EV::                   => AnyEvent::Impl::EV::],
    [Event::                => AnyEvent::Impl::Event::],
    [Tk::                   => AnyEvent::Impl::Tk::],
    [Wx::                   => AnyEvent::Impl::POE::],
    [Prima::                => AnyEvent::Impl::POE::],
    [Event::Lib::           => AnyEvent::Impl::EventLib::], # too buggy
    [Qt::                   => AnyEvent::Impl::Qt::],       # requires special main program
    [POE::Kernel::          => AnyEvent::Impl::POE::],      # lasciate ogni speranza
 );
-our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);
+our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);
+our @detect;
 sub detect() {
    unless ($MODEL) {
       no strict 'refs';
                   last;
                }
             }
             $MODEL
-              or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event) or Glib.";
+              or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
          }
       }
       unshift @ISA, $MODEL;
       push @{"$MODEL\::ISA"}, "AnyEvent::Base";
+      (shift @detect)->() while @detect;
    }
    $MODEL
 }
   BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
   use AnyEvent;
+Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
+be used to probe what backend is used and gain other information (which is
+probably even less useful to an attacker than PERL_ANYEVENT_MODEL).
 =head1 SEE ALSO
-Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,
+Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
-L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,
-L<Event::Lib>, L<Qt>, L<POE>.
+L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
-Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,
+Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
-L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,
+L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
-L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,
+L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
-L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>.
+L<AnyEvent::Impl::POE>.
+Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
 Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.
 =head1 AUTHOR

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.104 by root, Wed Apr 30 11:40:22 2008 UTC vs. Revision 1.108 by root, Sat May 10 00:22:02 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.104 by root, Wed Apr 30 11:40:22 2008 UTC vs.
Revision 1.108 by root, Sat May 10 00:22:02 2008 UTC