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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.128 by root, Sat May 24 02:50:45 2008 UTC vs.
Revision 1.132 by root, Sun May 25 01:05:27 2008 UTC

 Although the callback might get passed parameters, their value and
 presence is undefined and you cannot rely on them. Portable AnyEvent
 callbacks cannot use arguments passed to signal watcher callbacks.
-Multiple signal occurances can be clumped together into one callback
+Multiple signal occurrences can be clumped together into one callback
-invocation, and callback invocation will be synchronous. synchronous means
+invocation, and callback invocation will be synchronous. Synchronous means
 that it might take a while until the signal gets handled by the process,
-but it is guarenteed not to interrupt any other callbacks.
+but it is guaranteed not to interrupt any other callbacks.
 The main advantage of using these watchers is that you can share a signal
 between multiple watchers.
 This watcher might use C<%SIG>, so programs overwriting those signals
 Condition variables can be created by calling the C<< AnyEvent->condvar
 >> 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.
-After creation, the conditon variable is "false" until it becomes "true"
+After creation, the condition variable is "false" until it becomes "true"
-by calling the C<send> method.
+by calling the C<send> method (or calling the condition variable as if it
+were a callback).
 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
+in time where multiple outstanding events have been processed. And yet
-another way to call them is transations - each condition variable can be
+another way to call them is transactions - 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,
 for example, if you write a module that does asynchronous http requests,
 you can block your main program until an event occurs - for example, you
 could C<< ->recv >> in your main program until the user clicks the Quit
 button of your app, which would C<< ->send >> the "quit" event.
 Note that condition variables recurse into the event loop - if you have
-two pieces of code that call C<< ->recv >> in a round-robbin fashion, you
+two pieces of code that call C<< ->recv >> in a round-robin 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.
 Condition variables are represented by hash refs in perl, and the keys
 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:
+Example: wait for a timer.
    # wait till the result is ready
    my $result_ready = AnyEvent->condvar;
    # do something such as adding a timer
    # this "blocks" (while handling events) till the callback
    # calls send
    $result_ready->recv;
+Example: wait for a timer, but take advantage of the fact that
+condition variables are also code references.
+   my $done = AnyEvent->condvar;
+   my $delay = AnyEvent->timer (after => 5, cb => $done);
+   $done->recv;
 =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
 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<< ->recv >> calls.
+Condition variables are overloaded so one can call them directly (as a
+code reference). Calling them directly is the same as calling C<send>.
 =item $cv->croak ($error)
 Similar to send, but causes all call's to C<< ->recv >> to invoke
 C<Carp::croak> with the given error message/object/scalar.
 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>.
+C<begin> and for each subrequest you finish, call C<end>.
 =back
 =head3 METHODS FOR CONSUMERS
 (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
 condition variables with some kind of request results and supporting
 callbacks so the caller knows that getting the result will not block,
-while still suppporting blocking waits if the caller so desires).
+while still supporting blocking waits if the caller so desires).
 Another reason I<never> to C<< ->recv >> in a module is that you cannot
 sensibly have two C<< ->recv >>'s in parallel, as that would require
 multiple interpreters or coroutines/threads, none of which C<AnyEvent>
 can supply.
 no warnings;
 use strict;
 use Carp;
-our $VERSION = '3.6';
+our $VERSION = '4.03';
 our $MODEL;
 our $AUTOLOAD;
 our @ISA;
 our @ISA = AnyEvent::CondVar::Base::;
 package AnyEvent::CondVar::Base;
+use overload
+   '&{}'    => sub { my $self = shift; sub { $self->send (@_) } },
+   fallback => 1;
 sub _send {
    # nop
 }
 sub send {
 speed most when you have lots of watchers, not when you only have a few of
 them).
 EV is again fastest.
-Perl again comes second. It is noticably faster than the C-based event
+Perl again comes second. It is noticeably faster than the C-based event
 loops Event and Glib, although the difference is too small to really
 matter.
 POE also performs much better in this case, but is is still far behind the
 others.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.128 by root, Sat May 24 02:50:45 2008 UTC vs. Revision 1.132 by root, Sun May 25 01:05:27 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.128 by root, Sat May 24 02:50:45 2008 UTC vs.
Revision 1.132 by root, Sun May 25 01:05:27 2008 UTC