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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC

 package AnyEvent::Handle;
-no warnings;
-use strict qw(subs vars);
-use AnyEvent ();
-use AnyEvent::Util qw(WSAEWOULDBLOCK);
 use Scalar::Util ();
 use Carp ();
-use Fcntl ();
 use Errno qw(EAGAIN EINTR);
+use AnyEvent (); BEGIN { AnyEvent::common_sense }
+use AnyEvent::Util qw(WSAEWOULDBLOCK);
 =head1 NAME
 AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
 =cut
-our $VERSION = 4.82;
+our $VERSION = 4.86;
 =head1 SYNOPSIS
    use AnyEvent;
    use AnyEvent::Handle;
    my $cv = AnyEvent->condvar;
    my $hdl; $hdl = new AnyEvent::Handle
       fh => \*STDIN,
       on_error => sub {
+         my ($hdl, $fatal, $msg) = @_;
-         warn "got error $_[2]\n";
+         warn "got error $msg\n";
+         $hdl->destroy;
          $cv->send;
       );
    # send some request line
    $hdl->push_write ("getinfo\015\012");
    $cv->recv;
 =head1 DESCRIPTION
 This module is a helper module to make it easier to do event-based I/O on
-filehandles. For utility functions for doing non-blocking connects and accepts
+filehandles.
-on sockets see L<AnyEvent::Util>.
 The L<AnyEvent::Intro> tutorial contains some well-documented
 AnyEvent::Handle examples.
 In the following, when the documentation refers to of "bytes" then this
 means characters. As sysread and syswrite are used for all I/O, their
 treatment of characters applies to this module as well.
+At the very minimum, you should specify C<fh> or C<connect>, and the
+C<on_error> callback.
 All callbacks will be invoked with the handle object as their first
 argument.
 =head1 METHODS
 The constructor supports these arguments (all as C<< key => value >> pairs).
 =over 4
-=item fh => $filehandle [MANDATORY]
+=item fh => $filehandle     [C<fh> or C<connect> MANDATORY]
 The filehandle this L<AnyEvent::Handle> object will operate on.
 NOTE: The filehandle will be set to non-blocking mode (using
 C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
 that mode.
+=item connect => [$host, $service]      [C<fh> or C<connect> MANDATORY]
+Try to connect to the specified host and service (port), using
+C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
+default C<peername>.
+You have to specify either this parameter, or C<fh>, above.
+When this parameter is specified, then the C<on_prepare>,
+C<on_connect_error> and C<on_connect> callbacks will be called under the
+appropriate circumstances:
+=over 4
+=item on_prepare => $cb->($handle)
+This (rarely used) callback is called before a new connection is
+attempted, but after the file handle has been created. It could be used to
+prepare the file handle with parameters required for the actual connect
+(as opposed to settings that can be changed when the connection is already
+established).
+=item on_connect => $cb->($handle, $host, $port, $retry->())
+This callback is called when a connection has been successfully established.
+The actual numeric host and port (the socket peername) are passed as
+parameters, together with a retry callback.
+When, for some reason, the handle is not acceptable, then calling
+C<$retry> will continue with the next conenction target (in case of
+multi-homed hosts or SRV records there can be multiple connection
+endpoints). When it is called then the read and write queues, eof status,
+tls status and similar properties of the handle are being reset.
+In most cases, ignoring the C<$retry> parameter is the way to go.
+=item on_connect_error => $cb->($handle, $message)
+This callback is called when the conenction could not be
+established. C<$!> will contain the relevant error code, and C<$message> a
+message describing it (usually the same as C<"$!">).
+If this callback isn't specified, then C<on_error> will be called with a
+fatal error instead.
+=back
+=item on_error => $cb->($handle, $fatal, $message)
+This is the error callback, which is called when, well, some error
+occured, such as not being able to resolve the hostname, failure to
+connect or a read error.
+Some errors are fatal (which is indicated by C<$fatal> being true). On
+fatal errors the handle object will be destroyed (by a call to C<< ->
+destroy >>) after invoking the error callback (which means you are free to
+examine the handle object). Examples of fatal errors are an EOF condition
+with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
+cases where the other side can close the connection at their will it is
+often easiest to not report C<EPIPE> errors in this callback.
+AnyEvent::Handle tries to find an appropriate error code for you to check
+against, but in some cases (TLS errors), this does not work well. It is
+recommended to always output the C<$message> argument in human-readable
+error messages (it's usually the same as C<"$!">).
+Non-fatal errors can be retried by simply returning, but it is recommended
+to simply ignore this parameter and instead abondon the handle object
+when this callback is invoked. Examples of non-fatal errors are timeouts
+C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
+On callback entrance, the value of C<$!> contains the operating system
+error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
+C<EPROTO>).
+While not mandatory, it is I<highly> recommended to set this callback, as
+you will not be notified of errors otherwise. The default simply calls
+C<croak>.
+=item on_read => $cb->($handle)
+This sets the default read callback, which is called when data arrives
+and no read request is in the queue (unlike read queue callbacks, this
+callback will only be called when at least one octet of data is in the
+read buffer).
+To access (and remove data from) the read buffer, use the C<< ->rbuf >>
+method or access the C<< $handle->{rbuf} >> member directly. Note that you
+must not enlarge or modify the read buffer, you can only remove data at
+the beginning from it.
+When an EOF condition is detected then AnyEvent::Handle will first try to
+feed all the remaining data to the queued callbacks and C<on_read> before
+calling the C<on_eof> callback. If no progress can be made, then a fatal
+error will be raised (with C<$!> set to C<EPIPE>).
+Note that, unlike requests in the read queue, an C<on_read> callback
+doesn't mean you I<require> some data: if there is an EOF and there
+are outstanding read requests then an error will be flagged. With an
+C<on_read> callback, the C<on_eof> callback will be invoked.
 =item on_eof => $cb->($handle)
 Set the callback to be called when an end-of-file condition is detected,
 i.e. in the case of a socket, when the other side has closed the
-connection cleanly.
+connection cleanly, and there are no outstanding read requests in the
+queue (if there are read requests, then an EOF counts as an unexpected
+connection close and will be flagged as an error).
 For sockets, this just means that the other side has stopped sending data,
 you can still try to write data, and, in fact, one can return from the EOF
 callback and continue writing data, as only the read part has been shut
 down.
-While not mandatory, it is I<highly> recommended to set an EOF callback,
-otherwise you might end up with a closed socket while you are still
-waiting for data.
 If an EOF condition has been detected but no C<on_eof> callback has been
 set, then a fatal error will be raised with C<$!> set to <0>.
-=item on_error => $cb->($handle, $fatal, $message)
-This is the error callback, which is called when, well, some error
-occured, such as not being able to resolve the hostname, failure to
-connect or a read error.
-Some errors are fatal (which is indicated by C<$fatal> being true). On
-fatal errors the handle object will be destroyed (by a call to C<< ->
-destroy >>) after invoking the error callback (which means you are free to
-examine the handle object). Examples of fatal errors are an EOF condition
-with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
-AnyEvent::Handle tries to find an appropriate error code for you to check
-against, but in some cases (TLS errors), this does not work well. It is
-recommended to always output the C<$message> argument in human-readable
-error messages (it's usually the same as C<"$!">).
-Non-fatal errors can be retried by simply returning, but it is recommended
-to simply ignore this parameter and instead abondon the handle object
-when this callback is invoked. Examples of non-fatal errors are timeouts
-C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
-On callback entrance, the value of C<$!> contains the operating system
-error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
-C<EPROTO>).
-While not mandatory, it is I<highly> recommended to set this callback, as
-you will not be notified of errors otherwise. The default simply calls
-C<croak>.
-=item on_read => $cb->($handle)
-This sets the default read callback, which is called when data arrives
-and no read request is in the queue (unlike read queue callbacks, this
-callback will only be called when at least one octet of data is in the
-read buffer).
-To access (and remove data from) the read buffer, use the C<< ->rbuf >>
-method or access the C<< $handle->{rbuf} >> member directly. Note that you
-must not enlarge or modify the read buffer, you can only remove data at
-the beginning from it.
-When an EOF condition is detected then AnyEvent::Handle will first try to
-feed all the remaining data to the queued callbacks and C<on_read> before
-calling the C<on_eof> callback. If no progress can be made, then a fatal
-error will be raised (with C<$!> set to C<EPIPE>).
 =item on_drain => $cb->($handle)
 This sets the callback that is called when the write buffer becomes empty
 (or when the callback is set and the buffer is empty already).
 sub new {
    my $class = shift;
    my $self = bless { @_ }, $class;
-   $self->{fh} or Carp::croak "mandatory argument fh is missing";
+   if ($self->{fh}) {
+      $self->_start;
+      return unless $self->{fh}; # could be gone by now
+   } elsif ($self->{connect}) {
+      require AnyEvent::Socket;
+      $self->{peername} = $self->{connect}[0]
+         unless exists $self->{peername};
+      $self->{_skip_drain_rbuf} = 1;
+      {
+         Scalar::Util::weaken (my $self = $self);
+         $self->{_connect} =
+            AnyEvent::Socket::tcp_connect (
+               $self->{connect}[0],
+               $self->{connect}[1],
+               sub {
+                  my ($fh, $host, $port, $retry) = @_;
+                  if ($fh) {
+                     $self->{fh} = $fh;
+                     delete $self->{_skip_drain_rbuf};
+                     $self->_start;
+                     $self->{on_connect}
+                        and $self->{on_connect}($self, $host, $port, sub {
+                               delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
+                               $self->{_skip_drain_rbuf} = 1;
+                               &$retry;
+                            });
+                  } else {
+                     if ($self->{on_connect_error}) {
+                        $self->{on_connect_error}($self, "$!");
+                        $self->destroy;
+                     } else {
+                        $self->fatal ($!, 1);
+                     }
+                  }
+               },
+               sub {
+                  local $self->{fh} = $_[0];
+                  $self->{on_prepare}->($self)
+                     if $self->{on_prepare};
+               }
+            );
+      }
+   } else {
+      Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
+   }
+   $self
+}
+sub _start {
+   my ($self) = @_;
    AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
    $self->{_activity} = AnyEvent->now;
    $self->_timeout;
       if $self->{tls};
    $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
    $self->start_read
-      if $self->{on_read};
+      if $self->{on_read} || @{ $self->{_queue} };
-   $self->{fh} && $self
 }
 #sub _shutdown {
 #   my ($self) = @_;
 #
    $! = $errno;
    $message ||= "$!";
    if ($self->{on_error}) {
       $self->{on_error}($self, $fatal, $message);
-      $self->destroy;
+      $self->destroy if $fatal;
    } elsif ($self->{fh}) {
       $self->destroy;
       Carp::croak "AnyEvent::Handle uncaught error: $message";
    }
 }
 sub no_delay {
    $_[0]{no_delay} = $_[1];
    eval {
       local $SIG{__DIE__};
-      setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
+      setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
+         if $_[0]{fh};
    };
 }
 =item $handle->on_starttls ($cb)
 # reset the timeout watcher, as neccessary
 # also check for time-outs
 sub _timeout {
    my ($self) = @_;
-   if ($self->{timeout}) {
+   if ($self->{timeout} && $self->{fh}) {
       my $NOW = AnyEvent->now;
       # when would the timeout trigger?
       my $after = $self->{_activity} + $self->{timeout} - $NOW;
          $self->{_activity} = $NOW;
          if ($self->{on_timeout}) {
             $self->{on_timeout}($self);
          } else {
-            $self->_error (&Errno::ETIMEDOUT);
+            $self->_error (Errno::ETIMEDOUT);
          }
          # callback could have changed timeout value, optimise
          return unless $self->{timeout};
       $self->{_tls_wbuf} .= $_[0];
       &_dotls ($self);
    } else {
       $self->{wbuf} .= $_[0];
-      $self->_drain_wbuf;
+      $self->_drain_wbuf if $self->{fh};
    }
 }
 =item $handle->push_write (type => @args)
 =cut
 sub _drain_rbuf {
    my ($self) = @_;
+   # avoid recursion
+   return if exists $self->{_skip_drain_rbuf};
-   local $self->{_in_drain} = 1;
+   local $self->{_skip_drain_rbuf} = 1;
    if (
       defined $self->{rbuf_max}
       && $self->{rbuf_max} < length $self->{rbuf}
    ) {
-      $self->_error (&Errno::ENOSPC, 1), return;
+      $self->_error (Errno::ENOSPC, 1), return;
    }
    while () {
       # we need to use a separate tls read buffer, as we must not receive data while
       # we are draining the buffer, and this can only happen with TLS.
       if (my $cb = shift @{ $self->{_queue} }) {
          unless ($cb->($self)) {
             if ($self->{_eof}) {
                # no progress can be made (not enough data and no data forthcoming)
-               $self->_error (&Errno::EPIPE, 1), return;
+               $self->_error (Errno::EPIPE, 1), return;
             }
             unshift @{ $self->{_queue} }, $cb;
             last;
          }
             && !@{ $self->{_queue} }     # and the queue is still empty
             && $self->{on_read}          # but we still have on_read
          ) {
             # no further data will arrive
             # so no progress can be made
-            $self->_error (&Errno::EPIPE, 1), return
+            $self->_error (Errno::EPIPE, 1), return
                if $self->{_eof};
             last; # more data might arrive
          }
       } else {
 sub on_read {
    my ($self, $cb) = @_;
    $self->{on_read} = $cb;
-   $self->_drain_rbuf if $cb && !$self->{_in_drain};
+   $self->_drain_rbuf if $cb;
 }
 =item $handle->rbuf
 Returns the read buffer (as a modifiable lvalue).
       $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
             ->($self, $cb, @_);
    }
    push @{ $self->{_queue} }, $cb;
-   $self->_drain_rbuf unless $self->{_in_drain};
+   $self->_drain_rbuf;
 }
 sub unshift_read {
    my $self = shift;
    my $cb = pop;
             ->($self, $cb, @_);
    }
    unshift @{ $self->{_queue} }, $cb;
-   $self->_drain_rbuf unless $self->{_in_drain};
+   $self->_drain_rbuf;
 }
 =item $handle->push_read (type => @args, $cb)
 =item $handle->unshift_read (type => @args, $cb)
          return 1;
       }
       # reject
       if ($reject && $$rbuf =~ $reject) {
-         $self->_error (&Errno::EBADMSG);
+         $self->_error (Errno::EBADMSG);
       }
       # skip
       if ($skip && $$rbuf =~ $skip) {
          $data .= substr $$rbuf, 0, $+[0], "";
    my ($self, $cb) = @_;
    sub {
       unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
          if ($_[0]{rbuf} =~ /[^0-9]/) {
-            $self->_error (&Errno::EBADMSG);
+            $self->_error (Errno::EBADMSG);
          }
          return;
       }
       my $len = $1;
          my $string = $_[1];
          $_[0]->unshift_read (chunk => 1, sub {
             if ($_[1] eq ",") {
                $cb->($_[0], $string);
             } else {
-               $self->_error (&Errno::EBADMSG);
+               $self->_error (Errno::EBADMSG);
             }
          });
       });
       1
          $json->incr_skip;
          $self->{rbuf} = $json->incr_text;
          $json->incr_text = "";
-         $self->_error (&Errno::EBADMSG);
+         $self->_error (Errno::EBADMSG);
          ()
       } else {
          $self->{rbuf} = "";
          # read remaining chunk
          $_[0]->unshift_read (chunk => $len, sub {
             if (my $ref = eval { Storable::thaw ($_[1]) }) {
                $cb->($_[0], $ref);
             } else {
-               $self->_error (&Errno::EBADMSG);
+               $self->_error (Errno::EBADMSG);
             }
          });
       }
       1
             if ($self->{tls}) {
                Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
                &_dotls ($self);
             } else {
-               $self->_drain_rbuf unless $self->{_in_drain};
+               $self->_drain_rbuf;
             }
          } elsif (defined $len) {
             delete $self->{_rw};
             $self->{_eof} = 1;
-            $self->_drain_rbuf unless $self->{_in_drain};
+            $self->_drain_rbuf;
          } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
             return $self->_error ($!, 1);
          }
       });
    if ($self->{_on_starttls}) {
       (delete $self->{_on_starttls})->($self, undef, $err);
       &_freetls;
    } else {
       &_freetls;
-      $self->_error (&Errno::EPROTO, 1, $err);
+      $self->_error (Errno::EPROTO, 1, $err);
    }
 }
 # poll the write BIO and send the data if applicable
 # also decode read data if possible
             $self->{_eof} = 1;
          }
       }
       $self->{_tls_rbuf} .= $tmp;
-      $self->_drain_rbuf unless $self->{_in_drain};
+      $self->_drain_rbuf;
       $self->{tls} or return; # tls session might have gone away in callback
    }
    $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
    return $self->_tls_error ($tmp)
 Instead of starting TLS negotiation immediately when the AnyEvent::Handle
 object is created, you can also do that at a later time by calling
 C<starttls>.
+Starting TLS is currently an asynchronous operation - when you push some
+write data and then call C<< ->starttls >> then TLS negotiation will start
+immediately, after which the queued write data is then sent.
 The first argument is the same as the C<tls> constructor argument (either
 C<"connect">, C<"accept"> or an existing Net::SSLeay object).
 The second argument is the optional C<AnyEvent::TLS> object that is used
 when AnyEvent::Handle has to create its own TLS connection object, or
    $ERROR_SYSCALL   = Net::SSLeay::ERROR_SYSCALL     ();
    $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ   ();
    $ctx ||= $self->{tls_ctx};
+   local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
    if ("HASH" eq ref $ctx) {
       require AnyEvent::TLS;
-      local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
       if ($ctx->{cache}) {
          my $key = $ctx+0;
          $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
       } else {
    &_freetls;
    my $linger = exists $self->{linger} ? $self->{linger} : 3600;
-   if ($linger && length $self->{wbuf}) {
+   if ($linger && length $self->{wbuf} && $self->{fh}) {
       my $fh   = delete $self->{fh};
       my $wbuf = delete $self->{wbuf};
       my @linger;

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs. Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC