--- AnyEvent/lib/AnyEvent/Handle.pm 2009/07/22 05:37:32 1.156 +++ AnyEvent/lib/AnyEvent/Handle.pm 2009/07/27 22:49:23 1.165 @@ -13,7 +13,7 @@ =cut -our $VERSION = 4.86; +our $VERSION = 4.87; =head1 SYNOPSIS @@ -46,8 +46,7 @@ =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 -on sockets see L. +filehandles. The L tutorial contains some well-documented AnyEvent::Handle examples. @@ -56,6 +55,9 @@ 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 or C, and the +C callback. + All callbacks will be invoked with the handle object as their first argument. @@ -69,29 +71,67 @@ =over 4 -=item fh => $filehandle [MANDATORY] +=item fh => $filehandle [C or C MANDATORY] The filehandle this L object will operate on. - NOTE: The filehandle will be set to non-blocking mode (using C) by the constructor and needs to stay in that mode. -=item on_eof => $cb->($handle) +=item connect => [$host, $service] [C or C MANDATORY] -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, 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). +Try to connect to the specified host and service (port), using +C. The C<$host> additionally becomes the +default C. -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. +You have to specify either this parameter, or C, above. -If an EOF condition has been detected but no C callback has been -set, then a fatal error will be raised with C<$!> set to <0>. +It is possible to push requests on the read and write queues, and modify +properties of the stream, even while AnyEvent::Handle is connecting. + +When this parameter is specified, then the C, +C and C 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). + +The return value of this callback should be the connect timeout value in +seconds (or C<0>, or C, or the empty list, to indicate the default +timeout is to be used). + +=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 will be called with a +fatal error instead. + +=back =item on_error => $cb->($handle, $fatal, $message) @@ -103,7 +143,9 @@ 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) or I/O errors. +with active (but unsatisifable) read watchers (C) 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 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 @@ -145,6 +187,22 @@ are outstanding read requests then an error will be flagged. With an C callback, the C 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, 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. + +If an EOF condition has been detected but no C callback has been +set, then a fatal error will be raised with C<$!> set to <0>. + =item on_drain => $cb->($handle) This sets the callback that is called when the write buffer becomes empty @@ -352,7 +410,69 @@ 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->_error ($!, 1); + } + } + }, + sub { + local $self->{fh} = $_[0]; + + $self->{on_prepare} + ? $self->{on_prepare}->($self) + : () + } + ); + } + + } 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; @@ -367,9 +487,9 @@ $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 + $self->_drain_wbuf; } #sub _shutdown { @@ -459,7 +579,8 @@ 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}; }; } @@ -503,7 +624,7 @@ sub _timeout { my ($self) = @_; - if ($self->{timeout}) { + if ($self->{timeout} && $self->{fh}) { my $NOW = AnyEvent->now; # when would the timeout trigger? @@ -631,11 +752,10 @@ if ($self->{tls}) { $self->{_tls_wbuf} .= $_[0]; - - &_dotls ($self); + &_dotls ($self) if $self->{fh}; } else { - $self->{wbuf} .= $_[0]; - $self->_drain_wbuf; + $self->{wbuf} .= $_[0]; + $self->_drain_wbuf if $self->{fh}; } } @@ -862,7 +982,9 @@ sub _drain_rbuf { my ($self) = @_; - local $self->{_in_drain} = 1; + # avoid recursion + return if exists $self->{_skip_drain_rbuf}; + local $self->{_skip_drain_rbuf} = 1; if ( defined $self->{rbuf_max} @@ -874,16 +996,17 @@ 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. - $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; + $self->{rbuf} .= delete $self->{_tls_rbuf} + if exists $self->{_tls_rbuf}; 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) - $self->_error (Errno::EPIPE, 1), return; - } + # no progress can be made + # (not enough data and no data forthcoming) + $self->_error (Errno::EPIPE, 1), return + if $self->{_eof}; unshift @{ $self->{_queue} }, $cb; last; @@ -913,11 +1036,11 @@ } if ($self->{_eof}) { - if ($self->{on_eof}) { - $self->{on_eof}($self) - } else { - $self->_error (0, 1, "Unexpected end-of-file"); - } + $self->{on_eof} + ? $self->{on_eof}($self) + : $self->_error (0, 1, "Unexpected end-of-file"); + + return; } # may need to restart read watcher @@ -939,7 +1062,7 @@ my ($self, $cb) = @_; $self->{on_read} = $cb; - $self->_drain_rbuf if $cb && !$self->{_in_drain}; + $self->_drain_rbuf if $cb; } =item $handle->rbuf @@ -1001,7 +1124,7 @@ } push @{ $self->{_queue} }, $cb; - $self->_drain_rbuf unless $self->{_in_drain}; + $self->_drain_rbuf; } sub unshift_read { @@ -1017,7 +1140,7 @@ unshift @{ $self->{_queue} }, $cb; - $self->_drain_rbuf unless $self->{_in_drain}; + $self->_drain_rbuf; } =item $handle->push_read (type => @args, $cb) @@ -1420,13 +1543,13 @@ &_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); @@ -1496,7 +1619,7 @@ } $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 } @@ -1521,6 +1644,10 @@ object is created, you can also do that at a later time by calling C. +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 constructor argument (either C<"connect">, C<"accept"> or an existing Net::SSLeay object). @@ -1534,31 +1661,38 @@ changed to your liking. Note that the handshake might have already started when this function returns. -If it an error to start a TLS handshake more than once per -AnyEvent::Handle object (this is due to bugs in OpenSSL). +Due to bugs in OpenSSL, it might or might not be possible to do multiple +handshakes on the same stream. Best do not attempt to use the stream after +stopping TLS. =cut our %TLS_CACHE; #TODO not yet documented, should we? sub starttls { - my ($self, $ssl, $ctx) = @_; - - require Net::SSLeay; + my ($self, $tls, $ctx) = @_; - Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" + Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" if $self->{tls}; + $self->{tls} = $tls; + $self->{tls_ctx} = $ctx if @_ > 2; + + return unless $self->{fh}; + + require Net::SSLeay; + $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); - $ctx ||= $self->{tls_ctx}; + $tls = $self->{tls}; + $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; @@ -1568,7 +1702,7 @@ } $self->{tls_ctx} = $ctx || TLS_CTX (); - $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); + $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername}); # basically, this is deep magic (because SSL_read should have the same issues) # but the openssl maintainers basically said: "trust us, it just works". @@ -1585,12 +1719,12 @@ # Net::SSLeay::CTX_set_mode ($ssl, # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); - Net::SSLeay::CTX_set_mode ($ssl, 1|2); + Net::SSLeay::CTX_set_mode ($tls, 1|2); $self->{_rbio} = 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->{_rbio}, $self->{_wbio}); + Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } if $self->{on_starttls}; @@ -1603,8 +1737,8 @@ Shuts down the SSL connection - this makes a proper EOF handshake by sending a close notify to the other side, but since OpenSSL doesn't -support non-blocking shut downs, it is not possible to re-use the stream -afterwards. +support non-blocking shut downs, it is not guarenteed that you can re-use +the stream afterwards. =cut @@ -1627,7 +1761,8 @@ return unless $self->{tls}; - $self->{tls_ctx}->_put_session (delete $self->{tls}); + $self->{tls_ctx}->_put_session (delete $self->{tls}) + if ref $self->{tls}; delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; } @@ -1664,7 +1799,9 @@ Shuts down the handle object as much as possible - this call ensures that no further callbacks will be invoked and as many resources as possible -will be freed. You must not call any methods on the object afterwards. +will be freed. Any method you will call on the handle object after +destroying it in this way will be silently ignored (and it will return the +empty list). Normally, you can just "forget" any references to an AnyEvent::Handle object and it will simply shut down. This works in fatal error and EOF @@ -1688,6 +1825,11 @@ $self->DESTROY; %$self = (); + bless $self, "AnyEvent::Handle::destroyed"; +} + +sub AnyEvent::Handle::destroyed::AUTOLOAD { + #nop } =item AnyEvent::Handle::TLS_CTX