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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC

 AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
 =cut
-our $VERSION = 4.12;
+our $VERSION = 4.22;
 =head1 SYNOPSIS
    use AnyEvent;
    use AnyEvent::Handle;
 NOTE: The filehandle will be set to non-blocking (using
 AnyEvent::Util::fh_nonblocking).
 =item on_eof => $cb->($handle)
-Set the callback to be called when an end-of-file condition is detcted,
+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.
 While not mandatory, it is highly recommended to set an eof callback,
 otherwise you might end up with a closed socket while you are still
 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.
+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.
 When an EOF condition is detected then AnyEvent::Handle will first try to
 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).
 To append to the write buffer, use the C<< ->push_write >> method.
+This callback is useful when you don't want to put all of your write data
+into the queue at once, for example, when you want to write the contents
+of some file to the socket you might not want to read the whole file into
+memory and push it into the queue, but instead only read more data from
+the file when the write queue becomes empty.
 =item timeout => $fractional_seconds
 If non-zero, then this enables an "inactivity" timeout: whenever this many
 seconds pass without a successful read or write on the underlying file
 be configured to accept only so-and-so much data that it cannot act on
 (for example, when expecting a line, an attacker could send an unlimited
 amount of data without a callback ever being called as long as the line
 isn't finished).
+=item autocork => <boolean>
+When disabled (the default), then C<push_write> will try to immediately
+write the data to the handle if possible. This avoids having to register
+a write watcher and wait for the next event loop iteration, but can be
+inefficient if you write multiple small chunks (this disadvantage is
+usually avoided by your kernel's nagle algorithm, see C<low_delay>).
+When enabled, then writes will always be queued till the next event loop
+iteration. This is efficient when you do many small writes per iteration,
+but less efficient when you do a single write only.
+=item no_delay => <boolean>
+When doing small writes on sockets, your operating system kernel might
+wait a bit for more data before actually sending it out. This is called
+the Nagle algorithm, and usually it is beneficial.
+In some situations you want as low a delay as possible, which cna be
+accomplishd by setting this option to true.
+The default is your opertaing system's default behaviour, this option
+explicitly enables or disables it, if possible.
 =item read_size => <bytes>
 The default read block size (the amount of bytes this module will try to read
 during each (loop iteration). Default: C<8192>.
 =item low_water_mark => <bytes>
 Sets the amount of bytes (default: C<0>) that make up an "empty" write
 buffer: If the write reaches this size or gets even samller it is
 considered empty.
+=item linger => <seconds>
+If non-zero (default: C<3600>), then the destructor of the
+AnyEvent::Handle object will check wether there is still outstanding write
+data and will install a watcher that will write out this data. No errors
+will be reported (this mostly matches how the operating system treats
+outstanding data at socket close time).
+This will not work for partial TLS data that could not yet been
+encoded. This data will be lost.
 =item tls => "accept" | "connect" | Net::SSLeay::SSL object
 When this parameter is given, it enables TLS (SSL) mode, that means it
 will start making tls handshake and will transparently encrypt/decrypt
 You can also provide your own TLS connection object, but you have
 to make sure that you call either C<Net::SSLeay::set_connect_state>
 or C<Net::SSLeay::set_accept_state> on it before you pass it to
 AnyEvent::Handle.
-See the C<starttls> method if you need to start TLs negotiation later.
+See the C<starttls> method if you need to start TLS negotiation later.
 =item tls_ctx => $ssl_ctx
 Use the given Net::SSLeay::CTX object to create the new TLS connection
 (unless a connection object was specified directly). If this parameter is
    if ($self->{tls}) {
       require Net::SSLeay;
       $self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
    }
-#   $self->on_eof   (delete $self->{on_eof}  ) if $self->{on_eof};   # nop
-#   $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
-#   $self->on_read  (delete $self->{on_read} ) if $self->{on_read};  # nop
-   $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
    $self->{_activity} = AnyEvent->now;
    $self->_timeout;
+   $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
+   $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
-   $self->start_read;
+   $self->start_read
+      if $self->{on_read};
    $self
 }
 sub _shutdown {
 =cut
 sub on_timeout {
    $_[0]{on_timeout} = $_[1];
+}
+=item $handle->autocork ($boolean)
+Enables or disables the current autocork behaviour (see C<autocork>
+constructor argument).
+=cut
+=item $handle->no_delay ($boolean)
+Enables or disables the C<no_delay> setting (see constructor argument of
+the same name for details).
+=cut
+sub no_delay {
+   $_[0]{no_delay} = $_[1];
+   eval {
+      local $SIG{__DIE__};
+      setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
+   };
 }
 #############################################################################
 =item $handle->timeout ($seconds)
             $self->_error ($!, 1);
          }
       };
       # try to write data immediately
-      $cb->();
+      $cb->() unless $self->{autocork};
       # if still data left in wbuf, we need to poll
       $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
          if length $self->{wbuf};
    };
    my ($self, $string) = @_;
    sprintf "%d:%s,", (length $string), $string
 };
+=item packstring => $format, $data
+An octet string prefixed with an encoded length. The encoding C<$format>
+uses the same format as a Perl C<pack> format, but must specify a single
+integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
+optional C<!>, C<< < >> or C<< > >> modifier).
+=cut
+register_write_type packstring => sub {
+   my ($self, $format, $string) = @_;
+   pack "$format/a*", $string
+};
 =item json => $array_or_hashref
 Encodes the given hash or array reference into a JSON object. Unless you
 provide your own JSON object, this means it will be encoded to JSON text
 in UTF-8.
    $self->{json} ? $self->{json}->encode ($ref)
                  : JSON::encode_json ($ref)
 };
+=item storable => $reference
+Freezes the given reference using L<Storable> and writes it to the
+handle. Uses the C<nfreeze> format.
+=cut
+register_write_type storable => sub {
+   my ($self, $ref) = @_;
+   require Storable;
+   pack "w/a*", Storable::nfreeze ($ref)
+};
 =back
 =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
 This function (not method) lets you add your own types to C<push_write>.
 ways, the "simple" way, using only C<on_read> and the "complex" way, using
 a queue.
 In the simple case, you just install an C<on_read> callback and whenever
 new data arrives, it will be called. You can then remove some data (if
-enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
+enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
-or not.
+leave the data there if you want to accumulate more (e.g. when only a
+partial message has been received so far).
 In the more complex case, you want to queue multiple callbacks. In this
 case, AnyEvent::Handle will call the first queued callback each time new
-data arrives and removes it when it has done its job (see C<push_read>,
+data arrives (also the first time it is queued) and removes it when it has
-below).
+done its job (see C<push_read>, below).
 This way you can, for example, push three line-reads, followed by reading
 a chunk of data, and AnyEvent::Handle will execute them in order.
 Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
             # handle xml
          });
       });
    });
-Example 2: Implement a client for a protocol that replies either with
+Example 2: Implement a client for a protocol that replies either with "OK"
-"OK" and another line or "ERROR" for one request, and 64 bytes for the
+and another line or "ERROR" for the first request that is sent, and 64
-second request. Due tot he availability of a full queue, we can just
+bytes for the second request. Due to the availability of a queue, we can
-pipeline sending both requests and manipulate the queue as necessary in
+just pipeline sending both requests and manipulate the queue as necessary
-the callbacks:
+in the callbacks.
-   # request one
+When the first callback is called and sees an "OK" response, it will
+C<unshift> another line-read. This line-read will be queued I<before> the
+64-byte chunk callback.
+   # request one, returns either "OK + extra line" or "ERROR"
    $handle->push_write ("request 1\015\012");
    # we expect "ERROR" or "OK" as response, so push a line read
    $handle->push_read (line => sub {
       # if we got an "OK", we have to _prepend_ another line,
             ...
          });
       }
    });
-   # request two
+   # request two, simply returns 64 octets
    $handle->push_write ("request 2\015\012");
    # simply read 64 bytes, always
    $handle->push_read (chunk => 64, sub {
       my $response = $_[1];
 =cut
 sub _drain_rbuf {
    my ($self) = @_;
+   local $self->{_in_drain} = 1;
    if (
       defined $self->{rbuf_max}
       && $self->{rbuf_max} < length $self->{rbuf}
    ) {
       return $self->_error (&Errno::ENOSPC, 1);
    }
-   return if $self->{in_drain};
+   while () {
-   local $self->{in_drain} = 1;
-   while (my $len = length $self->{rbuf}) {
       no strict 'refs';
+      my $len = length $self->{rbuf};
       if (my $cb = shift @{ $self->{_queue} }) {
          unless ($cb->($self)) {
             if ($self->{_eof}) {
                # no progress can be made (not enough data and no data forthcoming)
-               return $self->_error (&Errno::EPIPE, 1);
+               $self->_error (&Errno::EPIPE, 1), last;
             }
             unshift @{ $self->{_queue} }, $cb;
             last;
          }
       } elsif ($self->{on_read}) {
+         last unless $len;
          $self->{on_read}($self);
          if (
             $len == length $self->{rbuf} # if no data has been consumed
             && !@{ $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
-            return $self->_error (&Errno::EPIPE, 1)
+            $self->_error (&Errno::EPIPE, 1), last
                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};
 }
 =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;
+   $self->_drain_rbuf unless $self->{_in_drain};
 }
 sub unshift_read {
    my $self = shift;
    my $cb = pop;
             ->($self, $cb, @_);
    }
    unshift @{ $self->{_queue} }, $cb;
-   $self->_drain_rbuf;
+   $self->_drain_rbuf unless $self->{_in_drain};
 }
 =item $handle->push_read (type => @args, $cb)
 =item $handle->unshift_read (type => @args, $cb)
 =cut
 register_read_type line => sub {
    my ($self, $cb, $eol) = @_;
-   $eol = qr|(\015?\012)| if @_ < 3;
+   if (@_ < 3) {
+      # this is more than twice as fast as the generic code below
+      sub {
+         $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
+         $cb->($_[0], $1, $2);
+         1
+      }
+   } else {
-   $eol = quotemeta $eol unless ref $eol;
+      $eol = quotemeta $eol unless ref $eol;
-   $eol = qr|^(.*?)($eol)|s;
+      $eol = qr|^(.*?)($eol)|s;
-   sub {
+      sub {
-      $_[0]{rbuf} =~ s/$eol// or return;
+         $_[0]{rbuf} =~ s/$eol// or return;
-      $cb->($_[0], $1, $2);
+         $cb->($_[0], $1, $2);
+         1
-      1
+      }
    }
 };
 # compatibility with older API
 sub push_read_line {
 sub unshift_read_line {
    my $self = shift;
    $self->unshift_read (line => @_);
 }
-=item netstring => $cb->($handle, $string)
-A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
-Throws an error with C<$!> set to EBADMSG on format violations.
-=cut
-register_read_type netstring => sub {
-   my ($self, $cb) = @_;
-   sub {
-      unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
-         if ($_[0]{rbuf} =~ /[^0-9]/) {
-            $self->_error (&Errno::EBADMSG);
-         }
-         return;
-      }
-      my $len = $1;
-      $self->unshift_read (chunk => $len, sub {
-         my $string = $_[1];
-         $_[0]->unshift_read (chunk => 1, sub {
-            if ($_[1] eq ",") {
-               $cb->($_[0], $string);
-            } else {
-               $self->_error (&Errno::EBADMSG);
-            }
-         });
-      });
-      1
-   }
-};
 =item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
 Makes a regex match against the regex object C<$accept> and returns
 everything up to and including the match.
       ()
    }
 };
+=item netstring => $cb->($handle, $string)
+A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
+Throws an error with C<$!> set to EBADMSG on format violations.
+=cut
+register_read_type netstring => sub {
+   my ($self, $cb) = @_;
+   sub {
+      unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
+         if ($_[0]{rbuf} =~ /[^0-9]/) {
+            $self->_error (&Errno::EBADMSG);
+         }
+         return;
+      }
+      my $len = $1;
+      $self->unshift_read (chunk => $len, sub {
+         my $string = $_[1];
+         $_[0]->unshift_read (chunk => 1, sub {
+            if ($_[1] eq ",") {
+               $cb->($_[0], $string);
+            } else {
+               $self->_error (&Errno::EBADMSG);
+            }
+         });
+      });
+      1
+   }
+};
+=item packstring => $format, $cb->($handle, $string)
+An octet string prefixed with an encoded length. The encoding C<$format>
+uses the same format as a Perl C<pack> format, but must specify a single
+integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
+optional C<!>, C<< < >> or C<< > >> modifier).
+DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
+Example: read a block of data prefixed by its length in BER-encoded
+format (very efficient).
+   $handle->push_read (packstring => "w", sub {
+      my ($handle, $data) = @_;
+   });
+=cut
+register_read_type packstring => sub {
+   my ($self, $cb, $format) = @_;
+   sub {
+      # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
+      defined (my $len = eval { unpack $format, $_[0]{rbuf} })
+         or return;
+      $format = length pack $format, $len;
+      # bypass unshift if we already have the remaining chunk
+      if ($format + $len <= length $_[0]{rbuf}) {
+         my $data = substr $_[0]{rbuf}, $format, $len;
+         substr $_[0]{rbuf}, 0, $format + $len, "";
+         $cb->($_[0], $data);
+      } else {
+         # remove prefix
+         substr $_[0]{rbuf}, 0, $format, "";
+         # read remaining chunk
+         $_[0]->unshift_read (chunk => $len, $cb);
+      }
+      1
+   }
+};
 =item json => $cb->($handle, $hash_or_arrayref)
 Reads a JSON object or array, decodes it and passes it to the callback.
 If a C<json> object was passed to the constructor, then that will be used
 the C<json> write type description, above, for an actual example.
 =cut
 register_read_type json => sub {
-   my ($self, $cb, $accept, $reject, $skip) = @_;
+   my ($self, $cb) = @_;
    require JSON;
    my $data;
    my $rbuf = \$self->{rbuf};
          ()
       }
    }
 };
+=item storable => $cb->($handle, $ref)
+Deserialises a L<Storable> frozen representation as written by the
+C<storable> write type (BER-encoded length prefix followed by nfreeze'd
+data).
+Raises C<EBADMSG> error if the data could not be decoded.
+=cut
+register_read_type storable => sub {
+   my ($self, $cb) = @_;
+   require Storable;
+   sub {
+      # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
+      defined (my $len = eval { unpack "w", $_[0]{rbuf} })
+         or return;
+      my $format = length pack "w", $len;
+      # bypass unshift if we already have the remaining chunk
+      if ($format + $len <= length $_[0]{rbuf}) {
+         my $data = substr $_[0]{rbuf}, $format, $len;
+         substr $_[0]{rbuf}, 0, $format + $len, "";
+         $cb->($_[0], Storable::thaw ($data));
+      } else {
+         # remove prefix
+         substr $_[0]{rbuf}, 0, $format, "";
+         # read remaining chunk
+         $_[0]->unshift_read (chunk => $len, sub {
+            if (my $ref = eval { Storable::thaw ($_[1]) }) {
+               $cb->($_[0], $ref);
+            } else {
+               $self->_error (&Errno::EBADMSG);
+            }
+         });
+      }
+      1
+   }
+};
 =back
 =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
 This function (not method) lets you add your own types to C<push_read>.
 =item $handle->stop_read
 =item $handle->start_read
 In rare cases you actually do not want to read anything from the
-socket. In this case you can call C<stop_read>. Neither C<on_read> no
+socket. In this case you can call C<stop_read>. Neither C<on_read> nor
 any queued callbacks will be executed then. To start reading again, call
 C<start_read>.
 Note that AnyEvent::Handle will automatically C<start_read> for you when
 you change the C<on_read> callback or push/unshift a read callback, and it
          if ($len > 0) {
             $self->{_activity} = AnyEvent->now;
             $self->{filter_r}
                ? $self->{filter_r}($self, $rbuf)
-               : $self->_drain_rbuf;
+               : $self->{_in_drain} || $self->_drain_rbuf;
          } elsif (defined $len) {
             delete $self->{_rw};
             $self->{_eof} = 1;
-            $self->_drain_rbuf;
+            $self->_drain_rbuf unless $self->{_in_drain};
          } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
             return $self->_error ($!, 1);
          }
       });
    }
    while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
       if (length $buf) {
          $self->{rbuf} .= $buf;
-         $self->_drain_rbuf;
+         $self->_drain_rbuf unless $self->{_in_drain};
       } else {
          # let's treat SSL-eof as we treat normal EOF
          $self->{_eof} = 1;
          $self->_shutdown;
          return;
 sub DESTROY {
    my $self = shift;
    $self->stoptls;
+   my $linger = exists $self->{linger} ? $self->{linger} : 3600;
+   if ($linger && length $self->{wbuf}) {
+      my $fh   = delete $self->{fh};
+      my $wbuf = delete $self->{wbuf};
+      my @linger;
+      push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
+         my $len = syswrite $fh, $wbuf, length $wbuf;
+         if ($len > 0) {
+            substr $wbuf, 0, $len, "";
+         } else {
+            @linger = (); # end
+         }
+      });
+      push @linger, AnyEvent->timer (after => $linger, cb => sub {
+         @linger = ();
+      });
+   }
 }
 =item AnyEvent::Handle::TLS_CTX
 This function creates and returns the Net::SSLeay::CTX object used by
 =over 4
 =item * all constructor arguments become object members.
 At least initially, when you pass a C<tls>-argument to the constructor it
-will end up in C<< $handle->{tls} >>. Those members might be changes or
+will end up in C<< $handle->{tls} >>. Those members might be changed or
 mutated later on (for example C<tls> will hold the TLS connection object).
 =item * other object member names are prefixed with an C<_>.
 All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs. Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC