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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC

 The filehandle this L<AnyEvent::Handle> object will operate on.
 NOTE: The filehandle will be set to non-blocking (using
 AnyEvent::Util::fh_nonblocking).
-=item on_eof => $cb->($self)
+=item on_eof => $cb->($handle)
 Set the callback to be called on EOF.
 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
 waiting for data.
-=item on_error => $cb->($self)
+=item on_error => $cb->($handle)
 This is the fatal error callback, that is called when, well, a fatal error
 occurs, such as not being able to resolve the hostname, failure to connect
 or a read error.
 called.
 On callback entrance, the value of C<$!> contains the operating system
 error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
-The callbakc should throw an exception. If it returns, then
+The callback should throw an exception. If it returns, then
 AnyEvent::Handle will C<croak> for you.
 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
 die.
-=item on_read => $cb->($self)
+=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.
 To access (and remove data from) the read buffer, use the C<< ->rbuf >>
-method or access the C<$self->{rbuf}> member directly.
+method or access the C<$handle->{rbuf}> member directly.
 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->()
+=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).
 To append to the write buffer, use the C<< ->push_write >> method.
 Use the given Net::SSLeay::CTX object to create the new TLS connection
 (unless a connection object was specified directly). If this parameter is
 missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
+=item json => JSON or JSON::XS object
+This is the json coder object used by the C<json> read and write types.
+If you don't supply it, then AnyEvent::Handle will use C<encode_json> and
+C<decode_json>.
+Note that you are responsible to depend on the JSON module if you want to
+use this functionality, as AnyEvent does not have a dependency itself.
+=item filter_r => $cb
+=item filter_w => $cb
+These exist, but are undocumented at this time.
 =back
 =cut
 sub new {
 }
 sub _shutdown {
    my ($self) = @_;
-   delete $self->{rw};
+   delete $self->{_rw};
-   delete $self->{ww};
+   delete $self->{_ww};
    delete $self->{fh};
 }
 sub error {
    my ($self) = @_;
 This method returns the file handle of the L<AnyEvent::Handle> object.
 =cut
-sub fh { $_[0]->{fh} }
+sub fh { $_[0]{fh} }
 =item $handle->on_error ($cb)
 Replace the current C<on_error> callback (see the C<on_error> constructor argument).
 =cut
 sub _drain_wbuf {
    my ($self) = @_;
-   if (!$self->{ww} && length $self->{wbuf}) {
+   if (!$self->{_ww} && length $self->{wbuf}) {
       Scalar::Util::weaken $self;
       my $cb = sub {
          my $len = syswrite $self->{fh}, $self->{wbuf};
             $self->{on_drain}($self)
                if $self->{low_water_mark} >= length $self->{wbuf}
                   && $self->{on_drain};
-            delete $self->{ww} unless length $self->{wbuf};
+            delete $self->{_ww} unless length $self->{wbuf};
          } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
             $self->error;
          }
       };
       # try to write data immediately
       $cb->();
       # if still data left in wbuf, we need to poll
-      $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
+      $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
          if length $self->{wbuf};
    };
 }
 our %WH;
    my ($self, $string) = @_;
    sprintf "%d:%s,", (length $string), $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.
+JSON objects (and arrays) are self-delimiting, so you can write JSON at
+one end of a handle and read them at the other end without using any
+additional framing.
+=cut
+register_write_type json => sub {
+   my ($self, $ref) = @_;
+   require JSON;
+   $self->{json} ? $self->{json}->encode ($ref)
+                 : JSON::encode_json ($ref)
+};
-=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)
+=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
 This function (not method) lets you add your own types to C<push_write>.
 Whenever the given C<type> is used, C<push_write> will invoke the code
 reference with the handle object and the remaining arguments.
    return if $self->{in_drain};
    local $self->{in_drain} = 1;
    while (my $len = length $self->{rbuf}) {
       no strict 'refs';
-      if (my $cb = shift @{ $self->{queue} }) {
+      if (my $cb = shift @{ $self->{_queue} }) {
          unless ($cb->($self)) {
-            if ($self->{eof}) {
+            if ($self->{_eof}) {
                # no progress can be made (not enough data and no data forthcoming)
                $! = &Errno::EPIPE;
                $self->error;
             }
-            unshift @{ $self->{queue} }, $cb;
+            unshift @{ $self->{_queue} }, $cb;
             return;
          }
       } elsif ($self->{on_read}) {
          $self->{on_read}($self);
          if (
-            $self->{eof}                    # if no further data will arrive
+            $self->{_eof}                   # if no further data will arrive
             && $len == length $self->{rbuf} # and no data has been consumed
-            && !@{ $self->{queue} }         # and the queue is still empty
+            && !@{ $self->{_queue} }        # and the queue is still empty
             && $self->{on_read}             # and we still want to read data
          ) {
             # then no progress can be made
             $! = &Errno::EPIPE;
             $self->error;
          }
       } else {
          # read side becomes idle
-         delete $self->{rw};
+         delete $self->{_rw};
          return;
       }
    }
-   if ($self->{eof}) {
+   if ($self->{_eof}) {
       $self->_shutdown;
       $self->{on_eof}($self)
          if $self->{on_eof};
    }
 }
       $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
             ->($self, $cb, @_);
    }
-   push @{ $self->{queue} }, $cb;
+   push @{ $self->{_queue} }, $cb;
    $self->_drain_rbuf;
 }
 sub unshift_read {
    my $self = shift;
       $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
             ->($self, $cb, @_);
    }
-   unshift @{ $self->{queue} }, $cb;
+   unshift @{ $self->{_queue} }, $cb;
    $self->_drain_rbuf;
 }
 =item $handle->push_read (type => @args, $cb)
 Predefined types are (if you have ideas for additional types, feel free to
 drop by and tell us):
 =over 4
-=item chunk => $octets, $cb->($self, $data)
+=item chunk => $octets, $cb->($handle, $data)
 Invoke the callback only once C<$octets> bytes have been read. Pass the
 data read to the callback. The callback will never be called with less
 data.
 sub unshift_read_chunk {
    $_[0]->unshift_read (chunk => $_[1], $_[2]);
 }
-=item line => [$eol, ]$cb->($self, $line, $eol)
+=item line => [$eol, ]$cb->($handle, $line, $eol)
 The callback will be called only once a full line (including the end of
 line marker, C<$eol>) has been read. This line (excluding the end of line
 marker) will be passed to the callback as second argument (C<$line>), and
 the end of line marker as the third argument (C<$eol>).
 sub unshift_read_line {
    my $self = shift;
    $self->unshift_read (line => @_);
 }
-=item netstring => $cb->($string)
+=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.
       1
    }
 };
-=item regex => $accept[, $reject[, $skip], $cb->($data)
+=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.
 Example: read a single line terminated by '\n'.
       ()
    }
 };
+=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
+for the final decode, otherwise it will create a JSON coder expecting UTF-8.
+This read type uses the incremental parser available with JSON version
+2.09 (and JSON::XS version 2.2) and above. You have to provide a
+dependency on your own: this module will load the JSON module, but
+AnyEvent does not depend on it itself.
+Since JSON texts are fully self-delimiting, the C<json> read and write
+types are an ideal simple RPC protocol: just exchange JSON datagrams.
+=cut
+register_read_type json => sub {
+   my ($self, $cb, $accept, $reject, $skip) = @_;
+   require JSON;
+   my $data;
+   my $rbuf = \$self->{rbuf};
+   my $json = $self->{json} ||= JSON::XS->new->utf8;
+   sub {
+      my $ref = $json->incr_parse ($self->{rbuf});
+      if ($ref) {
+         $self->{rbuf} = $json->incr_text;
+         $json->incr_text = "";
+         $cb->($self, $ref);
+         1
+      } else {
+         $self->{rbuf} = "";
+         ()
+      }
+   }
+};
 =back
-=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
+=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>.
 Whenever the given C<type> is used, C<push_read> will invoke the code
 reference with the handle object, the callback and the remaining
 The code reference is supposed to return a callback (usually a closure)
 that works as a plain read callback (see C<< ->push_read ($cb) >>).
 It should invoke the passed callback when it is done reading (remember to
-pass C<$self> as first argument as all other callbacks do that).
+pass C<$handle> as first argument as all other callbacks do that).
 Note that this is a function, and all types registered this way will be
 global, so try to use unique names.
 For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
 =cut
 sub stop_read {
    my ($self) = @_;
-   delete $self->{rw};
+   delete $self->{_rw};
 }
 sub start_read {
    my ($self) = @_;
-   unless ($self->{rw} || $self->{eof}) {
+   unless ($self->{_rw} || $self->{_eof}) {
       Scalar::Util::weaken $self;
-      $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
+      $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
          my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
          my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
          if ($len > 0) {
             $self->{filter_r}
                ? $self->{filter_r}->($self, $rbuf)
                : $self->_drain_rbuf;
          } elsif (defined $len) {
-            delete $self->{rw};
+            delete $self->{_rw};
-            $self->{eof} = 1;
+            $self->{_eof} = 1;
             $self->_drain_rbuf;
          } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
             return $self->error;
          }
 }
 sub _dotls {
    my ($self) = @_;
-   if (length $self->{tls_wbuf}) {
+   if (length $self->{_tls_wbuf}) {
-      while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {
+      while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
-         substr $self->{tls_wbuf}, 0, $len, "";
+         substr $self->{_tls_wbuf}, 0, $len, "";
       }
    }
-   if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {
+   if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
       $self->{wbuf} .= $buf;
       $self->_drain_wbuf;
    }
    while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
 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<Net::SSLeay::CTX> object that is
 used when AnyEvent::Handle has to create its own TLS connection object.
+The TLS connection object will end up in C<< $handle->{tls} >> after this
+call and can be used or changed to your liking. Note that the handshake
+might have already started when this function returns.
 =cut
 # TODO: maybe document...
 sub starttls {
    # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
    Net::SSLeay::CTX_set_mode ($self->{tls},
       (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
       | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
-   $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
+   $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
-   $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
+   $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
-   Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});
+   Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
    $self->{filter_w} = sub {
-      $_[0]{tls_wbuf} .= ${$_[1]};
+      $_[0]{_tls_wbuf} .= ${$_[1]};
       &_dotls;
    };
    $self->{filter_r} = sub {
-      Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
+      Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
       &_dotls;
    };
 }
 =item $handle->stoptls
 sub stoptls {
    my ($self) = @_;
    Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
-   delete $self->{tls_rbio};
+   delete $self->{_rbio};
-   delete $self->{tls_wbio};
+   delete $self->{_wbio};
-   delete $self->{tls_wbuf};
+   delete $self->{_tls_wbuf};
    delete $self->{filter_r};
    delete $self->{filter_w};
 }
 sub DESTROY {
    }
 }
 =back
+=head1 SUBCLASSING AnyEvent::Handle
+In many cases, you might want to subclass AnyEvent::Handle.
+To make this easier, a given version of AnyEvent::Handle uses these
+conventions:
+=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
+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
+with an underscore character, so the remaining non-C<_>-namespace is free
+for use for subclasses.
+=item * all members not documented here and not prefixed with an underscore
+are free to use in subclasses.
+Of course, new versions of AnyEvent::Handle may introduce more "public"
+member variables, but thats just life, at least it is documented.
+=back
 =head1 AUTHOR
 Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
 =cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs. Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC