[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.150 by root, Thu Jul 16 04:16:25 2009 UTC

 =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)
 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_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).
          $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};
    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 {
          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->{_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

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.150 by root, Thu Jul 16 04:16:25 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.150 by root, Thu Jul 16 04:16:25 2009 UTC