ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.157 by root, Wed Jul 22 23:07:13 2009 UTC vs.
Revision 1.182 by root, Thu Sep 3 12:35:01 2009 UTC

1package AnyEvent::Handle;
2
3use Scalar::Util ();
4use Carp ();
5use Errno qw(EAGAIN EINTR);
6
7use AnyEvent (); BEGIN { AnyEvent::common_sense }
8use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10=head1 NAME 1=head1 NAME
11 2
12AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 3AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
13
14=cut
15
16our $VERSION = 4.86;
17 4
18=head1 SYNOPSIS 5=head1 SYNOPSIS
19 6
20 use AnyEvent; 7 use AnyEvent;
21 use AnyEvent::Handle; 8 use AnyEvent::Handle;
44 $cv->recv; 31 $cv->recv;
45 32
46=head1 DESCRIPTION 33=head1 DESCRIPTION
47 34
48This module is a helper module to make it easier to do event-based I/O on 35This module is a helper module to make it easier to do event-based I/O on
49filehandles. For utility functions for doing non-blocking connects and accepts 36filehandles.
50on sockets see L<AnyEvent::Util>.
51 37
52The L<AnyEvent::Intro> tutorial contains some well-documented 38The L<AnyEvent::Intro> tutorial contains some well-documented
53AnyEvent::Handle examples. 39AnyEvent::Handle examples.
54 40
55In the following, when the documentation refers to of "bytes" then this 41In the following, when the documentation refers to of "bytes" then this
56means characters. As sysread and syswrite are used for all I/O, their 42means characters. As sysread and syswrite are used for all I/O, their
57treatment of characters applies to this module as well. 43treatment of characters applies to this module as well.
58 44
45At the very minimum, you should specify C<fh> or C<connect>, and the
46C<on_error> callback.
47
59All callbacks will be invoked with the handle object as their first 48All callbacks will be invoked with the handle object as their first
60argument. 49argument.
61 50
51=cut
52
53package AnyEvent::Handle;
54
55use Scalar::Util ();
56use List::Util ();
57use Carp ();
58use Errno qw(EAGAIN EINTR);
59
60use AnyEvent (); BEGIN { AnyEvent::common_sense }
61use AnyEvent::Util qw(WSAEWOULDBLOCK);
62
63our $VERSION = $AnyEvent::VERSION;
64
62=head1 METHODS 65=head1 METHODS
63 66
64=over 4 67=over 4
65 68
66=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 69=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
67 70
68The constructor supports these arguments (all as C<< key => value >> pairs). 71The constructor supports these arguments (all as C<< key => value >> pairs).
69 72
70=over 4 73=over 4
71 74
72=item fh => $filehandle [MANDATORY] 75=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
73 76
74The filehandle this L<AnyEvent::Handle> object will operate on. 77The filehandle this L<AnyEvent::Handle> object will operate on.
75
76NOTE: The filehandle will be set to non-blocking mode (using 78NOTE: The filehandle will be set to non-blocking mode (using
77C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in 79C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
78that mode. 80that mode.
81
82=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
83
84Try to connect to the specified host and service (port), using
85C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
86default C<peername>.
87
88You have to specify either this parameter, or C<fh>, above.
89
90It is possible to push requests on the read and write queues, and modify
91properties of the stream, even while AnyEvent::Handle is connecting.
92
93When this parameter is specified, then the C<on_prepare>,
94C<on_connect_error> and C<on_connect> callbacks will be called under the
95appropriate circumstances:
96
97=over 4
98
99=item on_prepare => $cb->($handle)
100
101This (rarely used) callback is called before a new connection is
102attempted, but after the file handle has been created. It could be used to
103prepare the file handle with parameters required for the actual connect
104(as opposed to settings that can be changed when the connection is already
105established).
106
107The return value of this callback should be the connect timeout value in
108seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
109timeout is to be used).
110
111=item on_connect => $cb->($handle, $host, $port, $retry->())
112
113This callback is called when a connection has been successfully established.
114
115The actual numeric host and port (the socket peername) are passed as
116parameters, together with a retry callback.
117
118When, for some reason, the handle is not acceptable, then calling
119C<$retry> will continue with the next conenction target (in case of
120multi-homed hosts or SRV records there can be multiple connection
121endpoints). When it is called then the read and write queues, eof status,
122tls status and similar properties of the handle are being reset.
123
124In most cases, ignoring the C<$retry> parameter is the way to go.
125
126=item on_connect_error => $cb->($handle, $message)
127
128This callback is called when the conenction could not be
129established. C<$!> will contain the relevant error code, and C<$message> a
130message describing it (usually the same as C<"$!">).
131
132If this callback isn't specified, then C<on_error> will be called with a
133fatal error instead.
134
135=back
136
137=item on_error => $cb->($handle, $fatal, $message)
138
139This is the error callback, which is called when, well, some error
140occured, such as not being able to resolve the hostname, failure to
141connect or a read error.
142
143Some errors are fatal (which is indicated by C<$fatal> being true). On
144fatal errors the handle object will be destroyed (by a call to C<< ->
145destroy >>) after invoking the error callback (which means you are free to
146examine the handle object). Examples of fatal errors are an EOF condition
147with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
148cases where the other side can close the connection at their will it is
149often easiest to not report C<EPIPE> errors in this callback.
150
151AnyEvent::Handle tries to find an appropriate error code for you to check
152against, but in some cases (TLS errors), this does not work well. It is
153recommended to always output the C<$message> argument in human-readable
154error messages (it's usually the same as C<"$!">).
155
156Non-fatal errors can be retried by simply returning, but it is recommended
157to simply ignore this parameter and instead abondon the handle object
158when this callback is invoked. Examples of non-fatal errors are timeouts
159C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
160
161On callback entrance, the value of C<$!> contains the operating system
162error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
163C<EPROTO>).
164
165While not mandatory, it is I<highly> recommended to set this callback, as
166you will not be notified of errors otherwise. The default simply calls
167C<croak>.
168
169=item on_read => $cb->($handle)
170
171This sets the default read callback, which is called when data arrives
172and no read request is in the queue (unlike read queue callbacks, this
173callback will only be called when at least one octet of data is in the
174read buffer).
175
176To access (and remove data from) the read buffer, use the C<< ->rbuf >>
177method or access the C<< $handle->{rbuf} >> member directly. Note that you
178must not enlarge or modify the read buffer, you can only remove data at
179the beginning from it.
180
181When an EOF condition is detected then AnyEvent::Handle will first try to
182feed all the remaining data to the queued callbacks and C<on_read> before
183calling the C<on_eof> callback. If no progress can be made, then a fatal
184error will be raised (with C<$!> set to C<EPIPE>).
185
186Note that, unlike requests in the read queue, an C<on_read> callback
187doesn't mean you I<require> some data: if there is an EOF and there
188are outstanding read requests then an error will be flagged. With an
189C<on_read> callback, the C<on_eof> callback will be invoked.
79 190
80=item on_eof => $cb->($handle) 191=item on_eof => $cb->($handle)
81 192
82Set the callback to be called when an end-of-file condition is detected, 193Set the callback to be called when an end-of-file condition is detected,
83i.e. in the case of a socket, when the other side has closed the 194i.e. in the case of a socket, when the other side has closed the
91down. 202down.
92 203
93If an EOF condition has been detected but no C<on_eof> callback has been 204If an EOF condition has been detected but no C<on_eof> callback has been
94set, then a fatal error will be raised with C<$!> set to <0>. 205set, then a fatal error will be raised with C<$!> set to <0>.
95 206
96=item on_error => $cb->($handle, $fatal, $message)
97
98This is the error callback, which is called when, well, some error
99occured, such as not being able to resolve the hostname, failure to
100connect or a read error.
101
102Some errors are fatal (which is indicated by C<$fatal> being true). On
103fatal errors the handle object will be destroyed (by a call to C<< ->
104destroy >>) after invoking the error callback (which means you are free to
105examine the handle object). Examples of fatal errors are an EOF condition
106with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
107
108AnyEvent::Handle tries to find an appropriate error code for you to check
109against, but in some cases (TLS errors), this does not work well. It is
110recommended to always output the C<$message> argument in human-readable
111error messages (it's usually the same as C<"$!">).
112
113Non-fatal errors can be retried by simply returning, but it is recommended
114to simply ignore this parameter and instead abondon the handle object
115when this callback is invoked. Examples of non-fatal errors are timeouts
116C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
117
118On callback entrance, the value of C<$!> contains the operating system
119error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
120C<EPROTO>).
121
122While not mandatory, it is I<highly> recommended to set this callback, as
123you will not be notified of errors otherwise. The default simply calls
124C<croak>.
125
126=item on_read => $cb->($handle)
127
128This sets the default read callback, which is called when data arrives
129and no read request is in the queue (unlike read queue callbacks, this
130callback will only be called when at least one octet of data is in the
131read buffer).
132
133To access (and remove data from) the read buffer, use the C<< ->rbuf >>
134method or access the C<< $handle->{rbuf} >> member directly. Note that you
135must not enlarge or modify the read buffer, you can only remove data at
136the beginning from it.
137
138When an EOF condition is detected then AnyEvent::Handle will first try to
139feed all the remaining data to the queued callbacks and C<on_read> before
140calling the C<on_eof> callback. If no progress can be made, then a fatal
141error will be raised (with C<$!> set to C<EPIPE>).
142
143Note that, unlike requests in the read queue, an C<on_read> callback
144doesn't mean you I<require> some data: if there is an EOF and there
145are outstanding read requests then an error will be flagged. With an
146C<on_read> callback, the C<on_eof> callback will be invoked.
147
148=item on_drain => $cb->($handle) 207=item on_drain => $cb->($handle)
149 208
150This sets the callback that is called when the write buffer becomes empty 209This sets the callback that is called when the write buffer becomes empty
151(or when the callback is set and the buffer is empty already). 210(or when the callback is set and the buffer is empty already).
152 211
158memory and push it into the queue, but instead only read more data from 217memory and push it into the queue, but instead only read more data from
159the file when the write queue becomes empty. 218the file when the write queue becomes empty.
160 219
161=item timeout => $fractional_seconds 220=item timeout => $fractional_seconds
162 221
222=item rtimeout => $fractional_seconds
223
224=item wtimeout => $fractional_seconds
225
163If non-zero, then this enables an "inactivity" timeout: whenever this many 226If non-zero, then these enables an "inactivity" timeout: whenever this
164seconds pass without a successful read or write on the underlying file 227many seconds pass without a successful read or write on the underlying
165handle, the C<on_timeout> callback will be invoked (and if that one is 228file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
166missing, a non-fatal C<ETIMEDOUT> error will be raised). 229will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
230error will be raised).
231
232There are three variants of the timeouts that work fully independent
233of each other, for both read and write, just read, and just write:
234C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
235C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
236C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
167 237
168Note that timeout processing is also active when you currently do not have 238Note that timeout processing is also active when you currently do not have
169any outstanding read or write requests: If you plan to keep the connection 239any outstanding read or write requests: If you plan to keep the connection
170idle then you should disable the timout temporarily or ignore the timeout 240idle then you should disable the timout temporarily or ignore the timeout
171in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 241in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
215accomplishd by setting this option to a true value. 285accomplishd by setting this option to a true value.
216 286
217The default is your opertaing system's default behaviour (most likely 287The default is your opertaing system's default behaviour (most likely
218enabled), this option explicitly enables or disables it, if possible. 288enabled), this option explicitly enables or disables it, if possible.
219 289
290=item keepalive => <boolean>
291
292Enables (default disable) the SO_KEEPALIVE option on the stream socket:
293normally, TCP connections have no time-out once established, so TCP
294conenctions, once established, can stay alive forever even when the other
295side has long gone. TCP keepalives are a cheap way to take down long-lived
296TCP connections whent he other side becomes unreachable. While the default
297is OS-dependent, TCP keepalives usually kick in after around two hours,
298and, if the other side doesn't reply, take down the TCP connection some 10
299to 15 minutes later.
300
301It is harmless to specify this option for file handles that do not support
302keepalives, and enabling it on connections that are potentially long-lived
303is usually a good idea.
304
305=item oobinline => <boolean>
306
307BSD majorly fucked up the implementation of TCP urgent data. The result
308is that almost no OS implements TCP according to the specs, and every OS
309implements it slightly differently.
310
311If you want to handle TCP urgent data, then setting this flag gives you
312the most portable way of getting urgent data, by putting it into the
313stream.
314
220=item read_size => <bytes> 315=item read_size => <bytes>
221 316
222The default read block size (the amount of bytes this module will 317The default read block size (the amount of bytes this module will
223try to read during each loop iteration, which affects memory 318try to read during each loop iteration, which affects memory
224requirements). Default: C<8192>. 319requirements). Default: C<8192>.
350 445
351sub new { 446sub new {
352 my $class = shift; 447 my $class = shift;
353 my $self = bless { @_ }, $class; 448 my $self = bless { @_ }, $class;
354 449
355 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 450 if ($self->{fh}) {
451 $self->_start;
452 return unless $self->{fh}; # could be gone by now
453
454 } elsif ($self->{connect}) {
455 require AnyEvent::Socket;
456
457 $self->{peername} = $self->{connect}[0]
458 unless exists $self->{peername};
459
460 $self->{_skip_drain_rbuf} = 1;
461
462 {
463 Scalar::Util::weaken (my $self = $self);
464
465 $self->{_connect} =
466 AnyEvent::Socket::tcp_connect (
467 $self->{connect}[0],
468 $self->{connect}[1],
469 sub {
470 my ($fh, $host, $port, $retry) = @_;
471
472 if ($fh) {
473 $self->{fh} = $fh;
474
475 delete $self->{_skip_drain_rbuf};
476 $self->_start;
477
478 $self->{on_connect}
479 and $self->{on_connect}($self, $host, $port, sub {
480 delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
481 $self->{_skip_drain_rbuf} = 1;
482 &$retry;
483 });
484
485 } else {
486 if ($self->{on_connect_error}) {
487 $self->{on_connect_error}($self, "$!");
488 $self->destroy;
489 } else {
490 $self->_error ($!, 1);
491 }
492 }
493 },
494 sub {
495 local $self->{fh} = $_[0];
496
497 $self->{on_prepare}
498 ? $self->{on_prepare}->($self)
499 : ()
500 }
501 );
502 }
503
504 } else {
505 Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
506 }
507
508 $self
509}
510
511sub _start {
512 my ($self) = @_;
356 513
357 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 514 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
358 515
516 $self->{_activity} =
517 $self->{_ractivity} =
359 $self->{_activity} = AnyEvent->now; 518 $self->{_wactivity} = AE::now;
360 $self->_timeout;
361 519
520 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
521 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
522 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
523
362 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 524 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay};
525 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive};
526 $self->oobinline (delete $self->{oobinline}) if exists $self->{oobinline};
363 527
364 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 528 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
365 if $self->{tls}; 529 if $self->{tls};
366 530
367 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 531 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
368 532
369 $self->start_read 533 $self->start_read
370 if $self->{on_read}; 534 if $self->{on_read} || @{ $self->{_queue} };
371 535
372 $self->{fh} && $self 536 $self->_drain_wbuf;
373} 537}
374
375#sub _shutdown {
376# my ($self) = @_;
377#
378# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
379# $self->{_eof} = 1; # tell starttls et. al to stop trying
380#
381# &_freetls;
382#}
383 538
384sub _error { 539sub _error {
385 my ($self, $errno, $fatal, $message) = @_; 540 my ($self, $errno, $fatal, $message) = @_;
386 541
387 $! = $errno; 542 $! = $errno;
424 $_[0]{on_eof} = $_[1]; 579 $_[0]{on_eof} = $_[1];
425} 580}
426 581
427=item $handle->on_timeout ($cb) 582=item $handle->on_timeout ($cb)
428 583
429Replace the current C<on_timeout> callback, or disables the callback (but 584=item $handle->on_rtimeout ($cb)
430not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431argument and method.
432 585
433=cut 586=item $handle->on_wtimeout ($cb)
434 587
435sub on_timeout { 588Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436 $_[0]{on_timeout} = $_[1]; 589callback, or disables the callback (but not the timeout) if C<$cb> =
437} 590C<undef>. See the C<timeout> constructor argument and method.
591
592=cut
593
594# see below
438 595
439=item $handle->autocork ($boolean) 596=item $handle->autocork ($boolean)
440 597
441Enables or disables the current autocork behaviour (see C<autocork> 598Enables or disables the current autocork behaviour (see C<autocork>
442constructor argument). Changes will only take effect on the next write. 599constructor argument). Changes will only take effect on the next write.
457sub no_delay { 614sub no_delay {
458 $_[0]{no_delay} = $_[1]; 615 $_[0]{no_delay} = $_[1];
459 616
460 eval { 617 eval {
461 local $SIG{__DIE__}; 618 local $SIG{__DIE__};
462 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; 619 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
620 if $_[0]{fh};
621 };
622}
623
624=item $handle->keepalive ($boolean)
625
626Enables or disables the C<keepalive> setting (see constructor argument of
627the same name for details).
628
629=cut
630
631sub keepalive {
632 $_[0]{keepalive} = $_[1];
633
634 eval {
635 local $SIG{__DIE__};
636 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
637 if $_[0]{fh};
638 };
639}
640
641=item $handle->oobinline ($boolean)
642
643Enables or disables the C<oobinline> setting (see constructor argument of
644the same name for details).
645
646=cut
647
648sub oobinline {
649 $_[0]{oobinline} = $_[1];
650
651 eval {
652 local $SIG{__DIE__};
653 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
654 if $_[0]{fh};
655 };
656}
657
658=item $handle->keepalive ($boolean)
659
660Enables or disables the C<keepalive> setting (see constructor argument of
661the same name for details).
662
663=cut
664
665sub keepalive {
666 $_[0]{keepalive} = $_[1];
667
668 eval {
669 local $SIG{__DIE__};
670 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
671 if $_[0]{fh};
463 }; 672 };
464} 673}
465 674
466=item $handle->on_starttls ($cb) 675=item $handle->on_starttls ($cb)
467 676
481 690
482sub on_starttls { 691sub on_starttls {
483 $_[0]{on_stoptls} = $_[1]; 692 $_[0]{on_stoptls} = $_[1];
484} 693}
485 694
695=item $handle->rbuf_max ($max_octets)
696
697Configures the C<rbuf_max> setting (C<undef> disables it).
698
699=cut
700
701sub rbuf_max {
702 $_[0]{rbuf_max} = $_[1];
703}
704
486############################################################################# 705#############################################################################
487 706
488=item $handle->timeout ($seconds) 707=item $handle->timeout ($seconds)
489 708
709=item $handle->rtimeout ($seconds)
710
711=item $handle->wtimeout ($seconds)
712
490Configures (or disables) the inactivity timeout. 713Configures (or disables) the inactivity timeout.
491 714
492=cut 715=item $handle->timeout_reset
493 716
494sub timeout { 717=item $handle->rtimeout_reset
718
719=item $handle->wtimeout_reset
720
721Reset the activity timeout, as if data was received or sent.
722
723These methods are cheap to call.
724
725=cut
726
727for my $dir ("", "r", "w") {
728 my $timeout = "${dir}timeout";
729 my $tw = "_${dir}tw";
730 my $on_timeout = "on_${dir}timeout";
731 my $activity = "_${dir}activity";
732 my $cb;
733
734 *$on_timeout = sub {
735 $_[0]{$on_timeout} = $_[1];
736 };
737
738 *$timeout = sub {
495 my ($self, $timeout) = @_; 739 my ($self, $new_value) = @_;
496 740
497 $self->{timeout} = $timeout; 741 $self->{$timeout} = $new_value;
498 $self->_timeout; 742 delete $self->{$tw}; &$cb;
499} 743 };
500 744
745 *{"${dir}timeout_reset"} = sub {
746 $_[0]{$activity} = AE::now;
747 };
748
749 # main workhorse:
501# reset the timeout watcher, as neccessary 750 # reset the timeout watcher, as neccessary
502# also check for time-outs 751 # also check for time-outs
503sub _timeout { 752 $cb = sub {
504 my ($self) = @_; 753 my ($self) = @_;
505 754
506 if ($self->{timeout}) { 755 if ($self->{$timeout} && $self->{fh}) {
507 my $NOW = AnyEvent->now; 756 my $NOW = AE::now;
508 757
509 # when would the timeout trigger? 758 # when would the timeout trigger?
510 my $after = $self->{_activity} + $self->{timeout} - $NOW; 759 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511 760
512 # now or in the past already? 761 # now or in the past already?
513 if ($after <= 0) { 762 if ($after <= 0) {
514 $self->{_activity} = $NOW; 763 $self->{$activity} = $NOW;
515 764
516 if ($self->{on_timeout}) { 765 if ($self->{$on_timeout}) {
517 $self->{on_timeout}($self); 766 $self->{$on_timeout}($self);
518 } else { 767 } else {
519 $self->_error (Errno::ETIMEDOUT); 768 $self->_error (Errno::ETIMEDOUT);
769 }
770
771 # callback could have changed timeout value, optimise
772 return unless $self->{$timeout};
773
774 # calculate new after
775 $after = $self->{$timeout};
520 } 776 }
521 777
522 # callback could have changed timeout value, optimise 778 Scalar::Util::weaken $self;
523 return unless $self->{timeout}; 779 return unless $self; # ->error could have destroyed $self
524 780
525 # calculate new after 781 $self->{$tw} ||= AE::timer $after, 0, sub {
526 $after = $self->{timeout}; 782 delete $self->{$tw};
783 $cb->($self);
784 };
785 } else {
786 delete $self->{$tw};
527 } 787 }
528
529 Scalar::Util::weaken $self;
530 return unless $self; # ->error could have destroyed $self
531
532 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
533 delete $self->{_tw};
534 $self->_timeout;
535 });
536 } else {
537 delete $self->{_tw};
538 } 788 }
539} 789}
540 790
541############################################################################# 791#############################################################################
542 792
590 my $len = syswrite $self->{fh}, $self->{wbuf}; 840 my $len = syswrite $self->{fh}, $self->{wbuf};
591 841
592 if (defined $len) { 842 if (defined $len) {
593 substr $self->{wbuf}, 0, $len, ""; 843 substr $self->{wbuf}, 0, $len, "";
594 844
595 $self->{_activity} = AnyEvent->now; 845 $self->{_activity} = $self->{_wactivity} = AE::now;
596 846
597 $self->{on_drain}($self) 847 $self->{on_drain}($self)
598 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 848 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
599 && $self->{on_drain}; 849 && $self->{on_drain};
600 850
606 856
607 # try to write data immediately 857 # try to write data immediately
608 $cb->() unless $self->{autocork}; 858 $cb->() unless $self->{autocork};
609 859
610 # if still data left in wbuf, we need to poll 860 # if still data left in wbuf, we need to poll
611 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 861 $self->{_ww} = AE::io $self->{fh}, 1, $cb
612 if length $self->{wbuf}; 862 if length $self->{wbuf};
613 }; 863 };
614} 864}
615 865
616our %WH; 866our %WH;
629 ->($self, @_); 879 ->($self, @_);
630 } 880 }
631 881
632 if ($self->{tls}) { 882 if ($self->{tls}) {
633 $self->{_tls_wbuf} .= $_[0]; 883 $self->{_tls_wbuf} .= $_[0];
634 884 &_dotls ($self) if $self->{fh};
635 &_dotls ($self);
636 } else { 885 } else {
637 $self->{wbuf} .= $_[0]; 886 $self->{wbuf} .= $_[0];
638 $self->_drain_wbuf; 887 $self->_drain_wbuf if $self->{fh};
639 } 888 }
640} 889}
641 890
642=item $handle->push_write (type => @args) 891=item $handle->push_write (type => @args)
643 892
707Other languages could read single lines terminated by a newline and pass 956Other languages could read single lines terminated by a newline and pass
708this line into their JSON decoder of choice. 957this line into their JSON decoder of choice.
709 958
710=cut 959=cut
711 960
961sub json_coder() {
962 eval { require JSON::XS; JSON::XS->new->utf8 }
963 || do { require JSON; JSON->new->utf8 }
964}
965
712register_write_type json => sub { 966register_write_type json => sub {
713 my ($self, $ref) = @_; 967 my ($self, $ref) = @_;
714 968
715 require JSON; 969 my $json = $self->{json} ||= json_coder;
716 970
717 $self->{json} ? $self->{json}->encode ($ref) 971 $json->encode ($ref)
718 : JSON::encode_json ($ref)
719}; 972};
720 973
721=item storable => $reference 974=item storable => $reference
722 975
723Freezes the given reference using L<Storable> and writes it to the 976Freezes the given reference using L<Storable> and writes it to the
860=cut 1113=cut
861 1114
862sub _drain_rbuf { 1115sub _drain_rbuf {
863 my ($self) = @_; 1116 my ($self) = @_;
864 1117
1118 # avoid recursion
1119 return if $self->{_skip_drain_rbuf};
865 local $self->{_in_drain} = 1; 1120 local $self->{_skip_drain_rbuf} = 1;
866
867 if (
868 defined $self->{rbuf_max}
869 && $self->{rbuf_max} < length $self->{rbuf}
870 ) {
871 $self->_error (Errno::ENOSPC, 1), return;
872 }
873 1121
874 while () { 1122 while () {
875 # we need to use a separate tls read buffer, as we must not receive data while 1123 # we need to use a separate tls read buffer, as we must not receive data while
876 # we are draining the buffer, and this can only happen with TLS. 1124 # we are draining the buffer, and this can only happen with TLS.
877 $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; 1125 $self->{rbuf} .= delete $self->{_tls_rbuf}
1126 if exists $self->{_tls_rbuf};
878 1127
879 my $len = length $self->{rbuf}; 1128 my $len = length $self->{rbuf};
880 1129
881 if (my $cb = shift @{ $self->{_queue} }) { 1130 if (my $cb = shift @{ $self->{_queue} }) {
882 unless ($cb->($self)) { 1131 unless ($cb->($self)) {
883 if ($self->{_eof}) { 1132 # no progress can be made
884 # no progress can be made (not enough data and no data forthcoming) 1133 # (not enough data and no data forthcoming)
885 $self->_error (Errno::EPIPE, 1), return; 1134 $self->_error (Errno::EPIPE, 1), return
886 } 1135 if $self->{_eof};
887 1136
888 unshift @{ $self->{_queue} }, $cb; 1137 unshift @{ $self->{_queue} }, $cb;
889 last; 1138 last;
890 } 1139 }
891 } elsif ($self->{on_read}) { 1140 } elsif ($self->{on_read}) {
911 last; 1160 last;
912 } 1161 }
913 } 1162 }
914 1163
915 if ($self->{_eof}) { 1164 if ($self->{_eof}) {
916 if ($self->{on_eof}) { 1165 $self->{on_eof}
917 $self->{on_eof}($self) 1166 ? $self->{on_eof}($self)
918 } else {
919 $self->_error (0, 1, "Unexpected end-of-file"); 1167 : $self->_error (0, 1, "Unexpected end-of-file");
920 } 1168
1169 return;
1170 }
1171
1172 if (
1173 defined $self->{rbuf_max}
1174 && $self->{rbuf_max} < length $self->{rbuf}
1175 ) {
1176 $self->_error (Errno::ENOSPC, 1), return;
921 } 1177 }
922 1178
923 # may need to restart read watcher 1179 # may need to restart read watcher
924 unless ($self->{_rw}) { 1180 unless ($self->{_rw}) {
925 $self->start_read 1181 $self->start_read
937 1193
938sub on_read { 1194sub on_read {
939 my ($self, $cb) = @_; 1195 my ($self, $cb) = @_;
940 1196
941 $self->{on_read} = $cb; 1197 $self->{on_read} = $cb;
942 $self->_drain_rbuf if $cb && !$self->{_in_drain}; 1198 $self->_drain_rbuf if $cb;
943} 1199}
944 1200
945=item $handle->rbuf 1201=item $handle->rbuf
946 1202
947Returns the read buffer (as a modifiable lvalue). 1203Returns the read buffer (as a modifiable lvalue).
999 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1255 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1000 ->($self, $cb, @_); 1256 ->($self, $cb, @_);
1001 } 1257 }
1002 1258
1003 push @{ $self->{_queue} }, $cb; 1259 push @{ $self->{_queue} }, $cb;
1004 $self->_drain_rbuf unless $self->{_in_drain}; 1260 $self->_drain_rbuf;
1005} 1261}
1006 1262
1007sub unshift_read { 1263sub unshift_read {
1008 my $self = shift; 1264 my $self = shift;
1009 my $cb = pop; 1265 my $cb = pop;
1013 1269
1014 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1270 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1015 ->($self, $cb, @_); 1271 ->($self, $cb, @_);
1016 } 1272 }
1017 1273
1018
1019 unshift @{ $self->{_queue} }, $cb; 1274 unshift @{ $self->{_queue} }, $cb;
1020 $self->_drain_rbuf unless $self->{_in_drain}; 1275 $self->_drain_rbuf;
1021} 1276}
1022 1277
1023=item $handle->push_read (type => @args, $cb) 1278=item $handle->push_read (type => @args, $cb)
1024 1279
1025=item $handle->unshift_read (type => @args, $cb) 1280=item $handle->unshift_read (type => @args, $cb)
1274=cut 1529=cut
1275 1530
1276register_read_type json => sub { 1531register_read_type json => sub {
1277 my ($self, $cb) = @_; 1532 my ($self, $cb) = @_;
1278 1533
1279 my $json = $self->{json} ||= 1534 my $json = $self->{json} ||= json_coder;
1280 eval { require JSON::XS; JSON::XS->new->utf8 }
1281 || do { require JSON; JSON->new->utf8 };
1282 1535
1283 my $data; 1536 my $data;
1284 my $rbuf = \$self->{rbuf}; 1537 my $rbuf = \$self->{rbuf};
1285 1538
1286 sub { 1539 sub {
1406 my ($self) = @_; 1659 my ($self) = @_;
1407 1660
1408 unless ($self->{_rw} || $self->{_eof}) { 1661 unless ($self->{_rw} || $self->{_eof}) {
1409 Scalar::Util::weaken $self; 1662 Scalar::Util::weaken $self;
1410 1663
1411 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1664 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1412 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1665 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1666 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1414 1667
1415 if ($len > 0) { 1668 if ($len > 0) {
1416 $self->{_activity} = AnyEvent->now; 1669 $self->{_activity} = $self->{_ractivity} = AE::now;
1417 1670
1418 if ($self->{tls}) { 1671 if ($self->{tls}) {
1419 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1672 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420 1673
1421 &_dotls ($self); 1674 &_dotls ($self);
1422 } else { 1675 } else {
1423 $self->_drain_rbuf unless $self->{_in_drain}; 1676 $self->_drain_rbuf;
1424 } 1677 }
1425 1678
1426 } elsif (defined $len) { 1679 } elsif (defined $len) {
1427 delete $self->{_rw}; 1680 delete $self->{_rw};
1428 $self->{_eof} = 1; 1681 $self->{_eof} = 1;
1429 $self->_drain_rbuf unless $self->{_in_drain}; 1682 $self->_drain_rbuf;
1430 1683
1431 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 1684 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432 return $self->_error ($!, 1); 1685 return $self->_error ($!, 1);
1433 } 1686 }
1434 }); 1687 };
1435 } 1688 }
1436} 1689}
1437 1690
1438our $ERROR_SYSCALL; 1691our $ERROR_SYSCALL;
1439our $ERROR_WANT_READ; 1692our $ERROR_WANT_READ;
1494 $self->{_eof} = 1; 1747 $self->{_eof} = 1;
1495 } 1748 }
1496 } 1749 }
1497 1750
1498 $self->{_tls_rbuf} .= $tmp; 1751 $self->{_tls_rbuf} .= $tmp;
1499 $self->_drain_rbuf unless $self->{_in_drain}; 1752 $self->_drain_rbuf;
1500 $self->{tls} or return; # tls session might have gone away in callback 1753 $self->{tls} or return; # tls session might have gone away in callback
1501 } 1754 }
1502 1755
1503 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 1756 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504 return $self->_tls_error ($tmp) 1757 return $self->_tls_error ($tmp)
1536The TLS connection object will end up in C<< $handle->{tls} >>, the TLS 1789The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1537context in C<< $handle->{tls_ctx} >> after this call and can be used or 1790context in C<< $handle->{tls_ctx} >> after this call and can be used or
1538changed to your liking. Note that the handshake might have already started 1791changed to your liking. Note that the handshake might have already started
1539when this function returns. 1792when this function returns.
1540 1793
1541If it an error to start a TLS handshake more than once per 1794Due to bugs in OpenSSL, it might or might not be possible to do multiple
1542AnyEvent::Handle object (this is due to bugs in OpenSSL). 1795handshakes on the same stream. Best do not attempt to use the stream after
1796stopping TLS.
1543 1797
1544=cut 1798=cut
1545 1799
1546our %TLS_CACHE; #TODO not yet documented, should we? 1800our %TLS_CACHE; #TODO not yet documented, should we?
1547 1801
1548sub starttls { 1802sub starttls {
1549 my ($self, $ssl, $ctx) = @_; 1803 my ($self, $tls, $ctx) = @_;
1804
1805 Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1806 if $self->{tls};
1807
1808 $self->{tls} = $tls;
1809 $self->{tls_ctx} = $ctx if @_ > 2;
1810
1811 return unless $self->{fh};
1550 1812
1551 require Net::SSLeay; 1813 require Net::SSLeay;
1552
1553 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1554 if $self->{tls};
1555 1814
1556 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1815 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1557 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1816 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1558 1817
1818 $tls = delete $self->{tls};
1559 $ctx ||= $self->{tls_ctx}; 1819 $ctx = $self->{tls_ctx};
1560 1820
1561 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1821 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1562 1822
1563 if ("HASH" eq ref $ctx) { 1823 if ("HASH" eq ref $ctx) {
1564 require AnyEvent::TLS; 1824 require AnyEvent::TLS;
1570 $ctx = new AnyEvent::TLS %$ctx; 1830 $ctx = new AnyEvent::TLS %$ctx;
1571 } 1831 }
1572 } 1832 }
1573 1833
1574 $self->{tls_ctx} = $ctx || TLS_CTX (); 1834 $self->{tls_ctx} = $ctx || TLS_CTX ();
1575 $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); 1835 $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1576 1836
1577 # basically, this is deep magic (because SSL_read should have the same issues) 1837 # basically, this is deep magic (because SSL_read should have the same issues)
1578 # but the openssl maintainers basically said: "trust us, it just works". 1838 # but the openssl maintainers basically said: "trust us, it just works".
1579 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1839 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1580 # and mismaintained ssleay-module doesn't even offer them). 1840 # and mismaintained ssleay-module doesn't even offer them).
1587 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to 1847 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1588 # have identity issues in that area. 1848 # have identity issues in that area.
1589# Net::SSLeay::CTX_set_mode ($ssl, 1849# Net::SSLeay::CTX_set_mode ($ssl,
1590# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1850# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1591# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1851# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1592 Net::SSLeay::CTX_set_mode ($ssl, 1|2); 1852 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1593 1853
1594 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1854 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1595 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1855 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1596 1856
1857 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
1858
1597 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1859 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1598 1860
1599 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 1861 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1600 if $self->{on_starttls}; 1862 if $self->{on_starttls};
1601 1863
1602 &_dotls; # need to trigger the initial handshake 1864 &_dotls; # need to trigger the initial handshake
1605 1867
1606=item $handle->stoptls 1868=item $handle->stoptls
1607 1869
1608Shuts down the SSL connection - this makes a proper EOF handshake by 1870Shuts down the SSL connection - this makes a proper EOF handshake by
1609sending a close notify to the other side, but since OpenSSL doesn't 1871sending a close notify to the other side, but since OpenSSL doesn't
1610support non-blocking shut downs, it is not possible to re-use the stream 1872support non-blocking shut downs, it is not guarenteed that you can re-use
1611afterwards. 1873the stream afterwards.
1612 1874
1613=cut 1875=cut
1614 1876
1615sub stoptls { 1877sub stoptls {
1616 my ($self) = @_; 1878 my ($self) = @_;
1629sub _freetls { 1891sub _freetls {
1630 my ($self) = @_; 1892 my ($self) = @_;
1631 1893
1632 return unless $self->{tls}; 1894 return unless $self->{tls};
1633 1895
1634 $self->{tls_ctx}->_put_session (delete $self->{tls}); 1896 $self->{tls_ctx}->_put_session (delete $self->{tls})
1897 if $self->{tls} > 0;
1635 1898
1636 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 1899 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1637} 1900}
1638 1901
1639sub DESTROY { 1902sub DESTROY {
1647 my $fh = delete $self->{fh}; 1910 my $fh = delete $self->{fh};
1648 my $wbuf = delete $self->{wbuf}; 1911 my $wbuf = delete $self->{wbuf};
1649 1912
1650 my @linger; 1913 my @linger;
1651 1914
1652 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { 1915 push @linger, AE::io $fh, 1, sub {
1653 my $len = syswrite $fh, $wbuf, length $wbuf; 1916 my $len = syswrite $fh, $wbuf, length $wbuf;
1654 1917
1655 if ($len > 0) { 1918 if ($len > 0) {
1656 substr $wbuf, 0, $len, ""; 1919 substr $wbuf, 0, $len, "";
1657 } else { 1920 } else {
1658 @linger = (); # end 1921 @linger = (); # end
1659 } 1922 }
1660 }); 1923 };
1661 push @linger, AnyEvent->timer (after => $linger, cb => sub { 1924 push @linger, AE::timer $linger, 0, sub {
1662 @linger = (); 1925 @linger = ();
1663 }); 1926 };
1664 } 1927 }
1665} 1928}
1666 1929
1667=item $handle->destroy 1930=item $handle->destroy
1668 1931
1669Shuts down the handle object as much as possible - this call ensures that 1932Shuts down the handle object as much as possible - this call ensures that
1670no further callbacks will be invoked and as many resources as possible 1933no further callbacks will be invoked and as many resources as possible
1671will be freed. You must not call any methods on the object afterwards. 1934will be freed. Any method you will call on the handle object after
1935destroying it in this way will be silently ignored (and it will return the
1936empty list).
1672 1937
1673Normally, you can just "forget" any references to an AnyEvent::Handle 1938Normally, you can just "forget" any references to an AnyEvent::Handle
1674object and it will simply shut down. This works in fatal error and EOF 1939object and it will simply shut down. This works in fatal error and EOF
1675callbacks, as well as code outside. It does I<NOT> work in a read or write 1940callbacks, as well as code outside. It does I<NOT> work in a read or write
1676callback, so when you want to destroy the AnyEvent::Handle object from 1941callback, so when you want to destroy the AnyEvent::Handle object from
1690sub destroy { 1955sub destroy {
1691 my ($self) = @_; 1956 my ($self) = @_;
1692 1957
1693 $self->DESTROY; 1958 $self->DESTROY;
1694 %$self = (); 1959 %$self = ();
1960 bless $self, "AnyEvent::Handle::destroyed";
1961}
1962
1963sub AnyEvent::Handle::destroyed::AUTOLOAD {
1964 #nop
1695} 1965}
1696 1966
1697=item AnyEvent::Handle::TLS_CTX 1967=item AnyEvent::Handle::TLS_CTX
1698 1968
1699This function creates and returns the AnyEvent::TLS object used by default 1969This function creates and returns the AnyEvent::TLS object used by default

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines