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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.168 by root, Tue Jul 8 23:53:37 2008 UTC vs.
Revision 1.179 by root, Thu Sep 4 10:58:58 2008 UTC

 =head1 SYNOPSIS
    use AnyEvent;
-   my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub {
+   my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ...  });
-      ...
-   });
-   my $w = AnyEvent->timer (after => $seconds, cb => sub {
+   my $w = AnyEvent->timer (after => $seconds, cb => sub { ...  });
+   my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
+   print AnyEvent->now;  # prints current event loop time
+   print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
+   my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
+   my $w = AnyEvent->child (pid => $pid, cb => sub {
+      my ($pid, $status) = @_;
       ...
    });
    my $w = AnyEvent->condvar; # stores whether a condition was flagged
    $w->send; # wake up current and all future recv's
    $w->recv; # enters "main loop" till $condvar gets ->send
+   # use a condvar in callback mode:
+   $w->cb (sub { $_[0]->recv });
 =head1 INTRODUCTION/TUTORIAL
 This manpage is mainly a reference manual. If you are interested
 in a tutorial or some gentle introduction, have a look at the
 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
 >> 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.
+becomes true, with the condition variable as the first argument (but not
+the results).
 After creation, the condition variable is "false" until it becomes "true"
 by calling the C<send> method (or calling the condition variable as if it
 were a callback, read about the caveats in the description for the C<<
 ->send >> method).
    my $done = AnyEvent->condvar;
    my $delay = AnyEvent->timer (after => 5, cb => $done);
    $done->recv;
+Example: Imagine an API that returns a condvar and doesn't support
+callbacks. This is how you make a synchronous call, for example from
+the main program:
+   use AnyEvent::CouchDB;
+   ...
+   my @info = $couchdb->info->recv;
+And this is how you would just ste a callback to be called whenever the
+results are available:
+   $couchdb->info->cb (sub {
+      my @info = $_[0]->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
 =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])
+=item $cb = $cv->cb ($cb->($cv))
 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
 no warnings;
 use strict;
 use Carp;
-our $VERSION = 4.2;
+our $VERSION = 4.233;
 our $MODEL;
 our $AUTOLOAD;
 our @ISA;
    my $class = shift;
    $class->$func (@_);
 }
+# utility function to dup a filehandle. this is used by many backends
+# to support binding more than one watcher per filehandle (they usually
+# allow only one watcher per fd, so we dup it to get a different one).
+sub _dupfh($$$$) {
+   my ($poll, $fh, $r, $w) = @_;
+   require Fcntl;
+   # cygwin requires the fh mode to be matching, unix doesn't
+   my ($rw, $mode) = $poll eq "r" ? ($r, "<")
+                   : $poll eq "w" ? ($w, ">")
+                   : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
+   open my $fh2, "$mode&" . fileno $fh
+      or die "cannot dup() filehandle: $!";
+   # we assume CLOEXEC is already set by perl in all important cases
+   ($fh2, $rw)
+}
 package AnyEvent::Base;
 # default implementation for now and time
-use Time::HiRes ();
+BEGIN {
+   if (eval "use Time::HiRes (); time (); 1") {
+      *_time = \&Time::HiRes::time;
+      # if (eval "use POSIX (); (POSIX::times())...
+   } else {
+      *_time = \&CORE::time; # epic fail
+   }
+}
-sub time { Time::HiRes::time }
+sub time { _time }
-sub now  { Time::HiRes::time }
+sub now  { _time }
 # default implementation for ->condvar
 sub condvar {
    bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
 =item C<PERL_ANYEVENT_STRICT>
 AnyEvent does not do much argument checking by default, as thorough
 argument checking is very costly. Setting this variable to a true value
-will cause AnyEvent to thoroughly check the arguments passed to most
+will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
-method calls and croaks if it finds any problems. In other words, enables
+check the arguments passed to most method calls. If it finds any problems
+it will croak.
+In other words, enables "strict" mode.
-"strict" mode.  Unlike C<use strict> it is definitely recommended ot keep
+Unlike C<use strict> it is definitely recommended ot keep it off in
-it off in production.
+production.
 =item C<PERL_ANYEVENT_MODEL>
 This can be used to specify the event model to be used by AnyEvent, before
 auto detection and -probing kicks in. It must be a string consisting

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.168 by root, Tue Jul 8 23:53:37 2008 UTC vs. Revision 1.179 by root, Thu Sep 4 10:58:58 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.168 by root, Tue Jul 8 23:53:37 2008 UTC vs.
Revision 1.179 by root, Thu Sep 4 10:58:58 2008 UTC