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.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.177 by root, Sun Aug 9 00:24:35 2009 UTC

1package AnyEvent::Handle;
2
3no warnings;
4use strict qw(subs vars);
5
6use AnyEvent ();
7use AnyEvent::Util qw(WSAEWOULDBLOCK);
8use Scalar::Util ();
9use Carp ();
10use Fcntl ();
11use Errno qw(EAGAIN EINTR);
12
13=head1 NAME 1=head1 NAME
14 2
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 3AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17=cut
18
19our $VERSION = 4.82;
20 4
21=head1 SYNOPSIS 5=head1 SYNOPSIS
22 6
23 use AnyEvent; 7 use AnyEvent;
24 use AnyEvent::Handle; 8 use AnyEvent::Handle;
26 my $cv = AnyEvent->condvar; 10 my $cv = AnyEvent->condvar;
27 11
28 my $hdl; $hdl = new AnyEvent::Handle 12 my $hdl; $hdl = new AnyEvent::Handle
29 fh => \*STDIN, 13 fh => \*STDIN,
30 on_error => sub { 14 on_error => sub {
15 my ($hdl, $fatal, $msg) = @_;
31 warn "got error $_[2]\n"; 16 warn "got error $msg\n";
17 $hdl->destroy;
32 $cv->send; 18 $cv->send;
33 ); 19 );
34 20
35 # send some request line 21 # send some request line
36 $hdl->push_write ("getinfo\015\012"); 22 $hdl->push_write ("getinfo\015\012");
45 $cv->recv; 31 $cv->recv;
46 32
47=head1 DESCRIPTION 33=head1 DESCRIPTION
48 34
49This 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
50filehandles. For utility functions for doing non-blocking connects and accepts 36filehandles.
51on sockets see L<AnyEvent::Util>.
52 37
53The L<AnyEvent::Intro> tutorial contains some well-documented 38The L<AnyEvent::Intro> tutorial contains some well-documented
54AnyEvent::Handle examples. 39AnyEvent::Handle examples.
55 40
56In the following, when the documentation refers to of "bytes" then this 41In the following, when the documentation refers to of "bytes" then this
57means 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
58treatment of characters applies to this module as well. 43treatment of characters applies to this module as well.
59 44
45At the very minimum, you should specify C<fh> or C<connect>, and the
46C<on_error> callback.
47
60All callbacks will be invoked with the handle object as their first 48All callbacks will be invoked with the handle object as their first
61argument. 49argument.
62 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
63=head1 METHODS 65=head1 METHODS
64 66
65=over 4 67=over 4
66 68
67=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 69=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
68 70
69The constructor supports these arguments (all as C<< key => value >> pairs). 71The constructor supports these arguments (all as C<< key => value >> pairs).
70 72
71=over 4 73=over 4
72 74
73=item fh => $filehandle [MANDATORY] 75=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74 76
75The filehandle this L<AnyEvent::Handle> object will operate on. 77The filehandle this L<AnyEvent::Handle> object will operate on.
76
77NOTE: The filehandle will be set to non-blocking mode (using 78NOTE: The filehandle will be set to non-blocking mode (using
78C<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
79that mode. 80that mode.
80 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.
190
81=item on_eof => $cb->($handle) 191=item on_eof => $cb->($handle)
82 192
83Set 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,
84i.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
85connection cleanly. 195connection cleanly, and there are no outstanding read requests in the
196queue (if there are read requests, then an EOF counts as an unexpected
197connection close and will be flagged as an error).
86 198
87For sockets, this just means that the other side has stopped sending data, 199For sockets, this just means that the other side has stopped sending data,
88you can still try to write data, and, in fact, one can return from the EOF 200you can still try to write data, and, in fact, one can return from the EOF
89callback and continue writing data, as only the read part has been shut 201callback and continue writing data, as only the read part has been shut
90down. 202down.
91 203
92While not mandatory, it is I<highly> recommended to set an EOF callback,
93otherwise you might end up with a closed socket while you are still
94waiting for data.
95
96If 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
97set, 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>.
98
99=item on_error => $cb->($handle, $fatal, $message)
100
101This is the error callback, which is called when, well, some error
102occured, such as not being able to resolve the hostname, failure to
103connect or a read error.
104
105Some errors are fatal (which is indicated by C<$fatal> being true). On
106fatal errors the handle object will be destroyed (by a call to C<< ->
107destroy >>) after invoking the error callback (which means you are free to
108examine the handle object). Examples of fatal errors are an EOF condition
109with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
110
111AnyEvent::Handle tries to find an appropriate error code for you to check
112against, but in some cases (TLS errors), this does not work well. It is
113recommended to always output the C<$message> argument in human-readable
114error messages (it's usually the same as C<"$!">).
115
116Non-fatal errors can be retried by simply returning, but it is recommended
117to simply ignore this parameter and instead abondon the handle object
118when this callback is invoked. Examples of non-fatal errors are timeouts
119C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
120
121On callback entrance, the value of C<$!> contains the operating system
122error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
123C<EPROTO>).
124
125While not mandatory, it is I<highly> recommended to set this callback, as
126you will not be notified of errors otherwise. The default simply calls
127C<croak>.
128
129=item on_read => $cb->($handle)
130
131This sets the default read callback, which is called when data arrives
132and no read request is in the queue (unlike read queue callbacks, this
133callback will only be called when at least one octet of data is in the
134read buffer).
135
136To access (and remove data from) the read buffer, use the C<< ->rbuf >>
137method or access the C<< $handle->{rbuf} >> member directly. Note that you
138must not enlarge or modify the read buffer, you can only remove data at
139the beginning from it.
140
141When an EOF condition is detected then AnyEvent::Handle will first try to
142feed all the remaining data to the queued callbacks and C<on_read> before
143calling the C<on_eof> callback. If no progress can be made, then a fatal
144error will be raised (with C<$!> set to C<EPIPE>).
145 206
146=item on_drain => $cb->($handle) 207=item on_drain => $cb->($handle)
147 208
148This 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
149(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).
156memory 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
157the file when the write queue becomes empty. 218the file when the write queue becomes empty.
158 219
159=item timeout => $fractional_seconds 220=item timeout => $fractional_seconds
160 221
222=item rtimeout => $fractional_seconds
223
224=item wtimeout => $fractional_seconds
225
161If non-zero, then this enables an "inactivity" timeout: whenever this many 226If non-zero, then these enables an "inactivity" timeout: whenever this
162seconds pass without a successful read or write on the underlying file 227many seconds pass without a successful read or write on the underlying
163handle, 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
164missing, 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>.
165 237
166Note 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
167any 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
168idle then you should disable the timout temporarily or ignore the timeout 240idle then you should disable the timout temporarily or ignore the timeout
169in 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
348 420
349sub new { 421sub new {
350 my $class = shift; 422 my $class = shift;
351 my $self = bless { @_ }, $class; 423 my $self = bless { @_ }, $class;
352 424
353 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 425 if ($self->{fh}) {
426 $self->_start;
427 return unless $self->{fh}; # could be gone by now
428
429 } elsif ($self->{connect}) {
430 require AnyEvent::Socket;
431
432 $self->{peername} = $self->{connect}[0]
433 unless exists $self->{peername};
434
435 $self->{_skip_drain_rbuf} = 1;
436
437 {
438 Scalar::Util::weaken (my $self = $self);
439
440 $self->{_connect} =
441 AnyEvent::Socket::tcp_connect (
442 $self->{connect}[0],
443 $self->{connect}[1],
444 sub {
445 my ($fh, $host, $port, $retry) = @_;
446
447 if ($fh) {
448 $self->{fh} = $fh;
449
450 delete $self->{_skip_drain_rbuf};
451 $self->_start;
452
453 $self->{on_connect}
454 and $self->{on_connect}($self, $host, $port, sub {
455 delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
456 $self->{_skip_drain_rbuf} = 1;
457 &$retry;
458 });
459
460 } else {
461 if ($self->{on_connect_error}) {
462 $self->{on_connect_error}($self, "$!");
463 $self->destroy;
464 } else {
465 $self->_error ($!, 1);
466 }
467 }
468 },
469 sub {
470 local $self->{fh} = $_[0];
471
472 $self->{on_prepare}
473 ? $self->{on_prepare}->($self)
474 : ()
475 }
476 );
477 }
478
479 } else {
480 Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
481 }
482
483 $self
484}
485
486sub _start {
487 my ($self) = @_;
354 488
355 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 489 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
356 490
491 $self->{_activity} =
492 $self->{_ractivity} =
357 $self->{_activity} = AnyEvent->now; 493 $self->{_wactivity} = AE::now;
358 $self->_timeout; 494
495 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
496 $self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout};
497 $self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout};
359 498
360 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 499 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
361 500
362 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 501 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
363 if $self->{tls}; 502 if $self->{tls};
364 503
365 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 504 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
366 505
367 $self->start_read 506 $self->start_read
368 if $self->{on_read}; 507 if $self->{on_read} || @{ $self->{_queue} };
369 508
370 $self->{fh} && $self 509 $self->_drain_wbuf;
371} 510}
372 511
373#sub _shutdown { 512#sub _shutdown {
374# my ($self) = @_; 513# my ($self) = @_;
375# 514#
385 $! = $errno; 524 $! = $errno;
386 $message ||= "$!"; 525 $message ||= "$!";
387 526
388 if ($self->{on_error}) { 527 if ($self->{on_error}) {
389 $self->{on_error}($self, $fatal, $message); 528 $self->{on_error}($self, $fatal, $message);
390 $self->destroy; 529 $self->destroy if $fatal;
391 } elsif ($self->{fh}) { 530 } elsif ($self->{fh}) {
392 $self->destroy; 531 $self->destroy;
393 Carp::croak "AnyEvent::Handle uncaught error: $message"; 532 Carp::croak "AnyEvent::Handle uncaught error: $message";
394 } 533 }
395} 534}
422 $_[0]{on_eof} = $_[1]; 561 $_[0]{on_eof} = $_[1];
423} 562}
424 563
425=item $handle->on_timeout ($cb) 564=item $handle->on_timeout ($cb)
426 565
427Replace the current C<on_timeout> callback, or disables the callback (but 566=item $handle->on_rtimeout ($cb)
428not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
429argument and method.
430 567
431=cut 568=item $handle->on_wtimeout ($cb)
432 569
433sub on_timeout { 570Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
434 $_[0]{on_timeout} = $_[1]; 571callback, or disables the callback (but not the timeout) if C<$cb> =
435} 572C<undef>. See the C<timeout> constructor argument and method.
573
574=cut
575
576# see below
436 577
437=item $handle->autocork ($boolean) 578=item $handle->autocork ($boolean)
438 579
439Enables or disables the current autocork behaviour (see C<autocork> 580Enables or disables the current autocork behaviour (see C<autocork>
440constructor argument). Changes will only take effect on the next write. 581constructor argument). Changes will only take effect on the next write.
455sub no_delay { 596sub no_delay {
456 $_[0]{no_delay} = $_[1]; 597 $_[0]{no_delay} = $_[1];
457 598
458 eval { 599 eval {
459 local $SIG{__DIE__}; 600 local $SIG{__DIE__};
460 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; 601 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
602 if $_[0]{fh};
461 }; 603 };
462} 604}
463 605
464=item $handle->on_starttls ($cb) 606=item $handle->on_starttls ($cb)
465 607
479 621
480sub on_starttls { 622sub on_starttls {
481 $_[0]{on_stoptls} = $_[1]; 623 $_[0]{on_stoptls} = $_[1];
482} 624}
483 625
626=item $handle->rbuf_max ($max_octets)
627
628Configures the C<rbuf_max> setting (C<undef> disables it).
629
630=cut
631
632sub rbuf_max {
633 $_[0]{rbuf_max} = $_[1];
634}
635
484############################################################################# 636#############################################################################
485 637
486=item $handle->timeout ($seconds) 638=item $handle->timeout ($seconds)
487 639
640=item $handle->rtimeout ($seconds)
641
642=item $handle->wtimeout ($seconds)
643
488Configures (or disables) the inactivity timeout. 644Configures (or disables) the inactivity timeout.
489 645
490=cut 646=item $handle->timeout_reset
491 647
492sub timeout { 648=item $handle->rtimeout_reset
649
650=item $handle->wtimeout_reset
651
652Reset the activity timeout, as if data was received or sent.
653
654These methods are cheap to call.
655
656=cut
657
658for my $dir ("", "r", "w") {
659 my $timeout = "${dir}timeout";
660 my $tw = "_${dir}tw";
661 my $on_timeout = "on_${dir}timeout";
662 my $activity = "_${dir}activity";
663 my $cb;
664
665 *$on_timeout = sub {
666 $_[0]{$on_timeout} = $_[1];
667 };
668
669 *$timeout = sub {
493 my ($self, $timeout) = @_; 670 my ($self, $new_value) = @_;
494 671
495 $self->{timeout} = $timeout; 672 $self->{$timeout} = $new_value;
496 $self->_timeout; 673 delete $self->{$tw}; &$cb;
497} 674 };
498 675
676 *{"${dir}timeout_reset"} = sub {
677 $_[0]{$activity} = AE::now;
678 };
679
680 # main workhorse:
499# reset the timeout watcher, as neccessary 681 # reset the timeout watcher, as neccessary
500# also check for time-outs 682 # also check for time-outs
501sub _timeout { 683 $cb = sub {
502 my ($self) = @_; 684 my ($self) = @_;
503 685
504 if ($self->{timeout}) { 686 if ($self->{$timeout} && $self->{fh}) {
505 my $NOW = AnyEvent->now; 687 my $NOW = AE::now;
506 688
507 # when would the timeout trigger? 689 # when would the timeout trigger?
508 my $after = $self->{_activity} + $self->{timeout} - $NOW; 690 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
509 691
510 # now or in the past already? 692 # now or in the past already?
511 if ($after <= 0) { 693 if ($after <= 0) {
512 $self->{_activity} = $NOW; 694 $self->{$activity} = $NOW;
513 695
514 if ($self->{on_timeout}) { 696 if ($self->{$on_timeout}) {
515 $self->{on_timeout}($self); 697 $self->{$on_timeout}($self);
516 } else { 698 } else {
517 $self->_error (&Errno::ETIMEDOUT); 699 $self->_error (Errno::ETIMEDOUT);
700 }
701
702 # callback could have changed timeout value, optimise
703 return unless $self->{$timeout};
704
705 # calculate new after
706 $after = $self->{$timeout};
518 } 707 }
519 708
520 # callback could have changed timeout value, optimise 709 Scalar::Util::weaken $self;
521 return unless $self->{timeout}; 710 return unless $self; # ->error could have destroyed $self
522 711
523 # calculate new after 712 $self->{$tw} ||= AE::timer $after, 0, sub {
524 $after = $self->{timeout}; 713 delete $self->{$tw};
714 $cb->($self);
715 };
716 } else {
717 delete $self->{$tw};
525 } 718 }
526
527 Scalar::Util::weaken $self;
528 return unless $self; # ->error could have destroyed $self
529
530 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
531 delete $self->{_tw};
532 $self->_timeout;
533 });
534 } else {
535 delete $self->{_tw};
536 } 719 }
537} 720}
538 721
539############################################################################# 722#############################################################################
540 723
588 my $len = syswrite $self->{fh}, $self->{wbuf}; 771 my $len = syswrite $self->{fh}, $self->{wbuf};
589 772
590 if (defined $len) { 773 if (defined $len) {
591 substr $self->{wbuf}, 0, $len, ""; 774 substr $self->{wbuf}, 0, $len, "";
592 775
593 $self->{_activity} = AnyEvent->now; 776 $self->{_activity} = $self->{_wactivity} = AE::now;
594 777
595 $self->{on_drain}($self) 778 $self->{on_drain}($self)
596 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 779 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
597 && $self->{on_drain}; 780 && $self->{on_drain};
598 781
604 787
605 # try to write data immediately 788 # try to write data immediately
606 $cb->() unless $self->{autocork}; 789 $cb->() unless $self->{autocork};
607 790
608 # if still data left in wbuf, we need to poll 791 # if still data left in wbuf, we need to poll
609 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 792 $self->{_ww} = AE::io $self->{fh}, 1, $cb
610 if length $self->{wbuf}; 793 if length $self->{wbuf};
611 }; 794 };
612} 795}
613 796
614our %WH; 797our %WH;
627 ->($self, @_); 810 ->($self, @_);
628 } 811 }
629 812
630 if ($self->{tls}) { 813 if ($self->{tls}) {
631 $self->{_tls_wbuf} .= $_[0]; 814 $self->{_tls_wbuf} .= $_[0];
632 815 &_dotls ($self) if $self->{fh};
633 &_dotls ($self);
634 } else { 816 } else {
635 $self->{wbuf} .= $_[0]; 817 $self->{wbuf} .= $_[0];
636 $self->_drain_wbuf; 818 $self->_drain_wbuf if $self->{fh};
637 } 819 }
638} 820}
639 821
640=item $handle->push_write (type => @args) 822=item $handle->push_write (type => @args)
641 823
858=cut 1040=cut
859 1041
860sub _drain_rbuf { 1042sub _drain_rbuf {
861 my ($self) = @_; 1043 my ($self) = @_;
862 1044
1045 # avoid recursion
1046 return if $self->{_skip_drain_rbuf};
863 local $self->{_in_drain} = 1; 1047 local $self->{_skip_drain_rbuf} = 1;
864
865 if (
866 defined $self->{rbuf_max}
867 && $self->{rbuf_max} < length $self->{rbuf}
868 ) {
869 $self->_error (&Errno::ENOSPC, 1), return;
870 }
871 1048
872 while () { 1049 while () {
873 # we need to use a separate tls read buffer, as we must not receive data while 1050 # we need to use a separate tls read buffer, as we must not receive data while
874 # we are draining the buffer, and this can only happen with TLS. 1051 # we are draining the buffer, and this can only happen with TLS.
875 $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; 1052 $self->{rbuf} .= delete $self->{_tls_rbuf}
1053 if exists $self->{_tls_rbuf};
876 1054
877 my $len = length $self->{rbuf}; 1055 my $len = length $self->{rbuf};
878 1056
879 if (my $cb = shift @{ $self->{_queue} }) { 1057 if (my $cb = shift @{ $self->{_queue} }) {
880 unless ($cb->($self)) { 1058 unless ($cb->($self)) {
881 if ($self->{_eof}) { 1059 # no progress can be made
882 # no progress can be made (not enough data and no data forthcoming) 1060 # (not enough data and no data forthcoming)
883 $self->_error (&Errno::EPIPE, 1), return; 1061 $self->_error (Errno::EPIPE, 1), return
884 } 1062 if $self->{_eof};
885 1063
886 unshift @{ $self->{_queue} }, $cb; 1064 unshift @{ $self->{_queue} }, $cb;
887 last; 1065 last;
888 } 1066 }
889 } elsif ($self->{on_read}) { 1067 } elsif ($self->{on_read}) {
896 && !@{ $self->{_queue} } # and the queue is still empty 1074 && !@{ $self->{_queue} } # and the queue is still empty
897 && $self->{on_read} # but we still have on_read 1075 && $self->{on_read} # but we still have on_read
898 ) { 1076 ) {
899 # no further data will arrive 1077 # no further data will arrive
900 # so no progress can be made 1078 # so no progress can be made
901 $self->_error (&Errno::EPIPE, 1), return 1079 $self->_error (Errno::EPIPE, 1), return
902 if $self->{_eof}; 1080 if $self->{_eof};
903 1081
904 last; # more data might arrive 1082 last; # more data might arrive
905 } 1083 }
906 } else { 1084 } else {
909 last; 1087 last;
910 } 1088 }
911 } 1089 }
912 1090
913 if ($self->{_eof}) { 1091 if ($self->{_eof}) {
914 if ($self->{on_eof}) { 1092 $self->{on_eof}
915 $self->{on_eof}($self) 1093 ? $self->{on_eof}($self)
916 } else {
917 $self->_error (0, 1, "Unexpected end-of-file"); 1094 : $self->_error (0, 1, "Unexpected end-of-file");
918 } 1095
1096 return;
1097 }
1098
1099 if (
1100 defined $self->{rbuf_max}
1101 && $self->{rbuf_max} < length $self->{rbuf}
1102 ) {
1103 $self->_error (Errno::ENOSPC, 1), return;
919 } 1104 }
920 1105
921 # may need to restart read watcher 1106 # may need to restart read watcher
922 unless ($self->{_rw}) { 1107 unless ($self->{_rw}) {
923 $self->start_read 1108 $self->start_read
935 1120
936sub on_read { 1121sub on_read {
937 my ($self, $cb) = @_; 1122 my ($self, $cb) = @_;
938 1123
939 $self->{on_read} = $cb; 1124 $self->{on_read} = $cb;
940 $self->_drain_rbuf if $cb && !$self->{_in_drain}; 1125 $self->_drain_rbuf if $cb;
941} 1126}
942 1127
943=item $handle->rbuf 1128=item $handle->rbuf
944 1129
945Returns the read buffer (as a modifiable lvalue). 1130Returns the read buffer (as a modifiable lvalue).
997 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1182 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
998 ->($self, $cb, @_); 1183 ->($self, $cb, @_);
999 } 1184 }
1000 1185
1001 push @{ $self->{_queue} }, $cb; 1186 push @{ $self->{_queue} }, $cb;
1002 $self->_drain_rbuf unless $self->{_in_drain}; 1187 $self->_drain_rbuf;
1003} 1188}
1004 1189
1005sub unshift_read { 1190sub unshift_read {
1006 my $self = shift; 1191 my $self = shift;
1007 my $cb = pop; 1192 my $cb = pop;
1013 ->($self, $cb, @_); 1198 ->($self, $cb, @_);
1014 } 1199 }
1015 1200
1016 1201
1017 unshift @{ $self->{_queue} }, $cb; 1202 unshift @{ $self->{_queue} }, $cb;
1018 $self->_drain_rbuf unless $self->{_in_drain}; 1203 $self->_drain_rbuf;
1019} 1204}
1020 1205
1021=item $handle->push_read (type => @args, $cb) 1206=item $handle->push_read (type => @args, $cb)
1022 1207
1023=item $handle->unshift_read (type => @args, $cb) 1208=item $handle->unshift_read (type => @args, $cb)
1156 return 1; 1341 return 1;
1157 } 1342 }
1158 1343
1159 # reject 1344 # reject
1160 if ($reject && $$rbuf =~ $reject) { 1345 if ($reject && $$rbuf =~ $reject) {
1161 $self->_error (&Errno::EBADMSG); 1346 $self->_error (Errno::EBADMSG);
1162 } 1347 }
1163 1348
1164 # skip 1349 # skip
1165 if ($skip && $$rbuf =~ $skip) { 1350 if ($skip && $$rbuf =~ $skip) {
1166 $data .= substr $$rbuf, 0, $+[0], ""; 1351 $data .= substr $$rbuf, 0, $+[0], "";
1182 my ($self, $cb) = @_; 1367 my ($self, $cb) = @_;
1183 1368
1184 sub { 1369 sub {
1185 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1370 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1186 if ($_[0]{rbuf} =~ /[^0-9]/) { 1371 if ($_[0]{rbuf} =~ /[^0-9]/) {
1187 $self->_error (&Errno::EBADMSG); 1372 $self->_error (Errno::EBADMSG);
1188 } 1373 }
1189 return; 1374 return;
1190 } 1375 }
1191 1376
1192 my $len = $1; 1377 my $len = $1;
1195 my $string = $_[1]; 1380 my $string = $_[1];
1196 $_[0]->unshift_read (chunk => 1, sub { 1381 $_[0]->unshift_read (chunk => 1, sub {
1197 if ($_[1] eq ",") { 1382 if ($_[1] eq ",") {
1198 $cb->($_[0], $string); 1383 $cb->($_[0], $string);
1199 } else { 1384 } else {
1200 $self->_error (&Errno::EBADMSG); 1385 $self->_error (Errno::EBADMSG);
1201 } 1386 }
1202 }); 1387 });
1203 }); 1388 });
1204 1389
1205 1 1390 1
1295 $json->incr_skip; 1480 $json->incr_skip;
1296 1481
1297 $self->{rbuf} = $json->incr_text; 1482 $self->{rbuf} = $json->incr_text;
1298 $json->incr_text = ""; 1483 $json->incr_text = "";
1299 1484
1300 $self->_error (&Errno::EBADMSG); 1485 $self->_error (Errno::EBADMSG);
1301 1486
1302 () 1487 ()
1303 } else { 1488 } else {
1304 $self->{rbuf} = ""; 1489 $self->{rbuf} = "";
1305 1490
1342 # read remaining chunk 1527 # read remaining chunk
1343 $_[0]->unshift_read (chunk => $len, sub { 1528 $_[0]->unshift_read (chunk => $len, sub {
1344 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1529 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1345 $cb->($_[0], $ref); 1530 $cb->($_[0], $ref);
1346 } else { 1531 } else {
1347 $self->_error (&Errno::EBADMSG); 1532 $self->_error (Errno::EBADMSG);
1348 } 1533 }
1349 }); 1534 });
1350 } 1535 }
1351 1536
1352 1 1537 1
1404 my ($self) = @_; 1589 my ($self) = @_;
1405 1590
1406 unless ($self->{_rw} || $self->{_eof}) { 1591 unless ($self->{_rw} || $self->{_eof}) {
1407 Scalar::Util::weaken $self; 1592 Scalar::Util::weaken $self;
1408 1593
1409 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1594 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1410 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1595 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1411 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1596 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1412 1597
1413 if ($len > 0) { 1598 if ($len > 0) {
1414 $self->{_activity} = AnyEvent->now; 1599 $self->{_activity} = $self->{_ractivity} = AE::now;
1415 1600
1416 if ($self->{tls}) { 1601 if ($self->{tls}) {
1417 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1602 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1418 1603
1419 &_dotls ($self); 1604 &_dotls ($self);
1420 } else { 1605 } else {
1421 $self->_drain_rbuf unless $self->{_in_drain}; 1606 $self->_drain_rbuf;
1422 } 1607 }
1423 1608
1424 } elsif (defined $len) { 1609 } elsif (defined $len) {
1425 delete $self->{_rw}; 1610 delete $self->{_rw};
1426 $self->{_eof} = 1; 1611 $self->{_eof} = 1;
1427 $self->_drain_rbuf unless $self->{_in_drain}; 1612 $self->_drain_rbuf;
1428 1613
1429 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 1614 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1430 return $self->_error ($!, 1); 1615 return $self->_error ($!, 1);
1431 } 1616 }
1432 }); 1617 };
1433 } 1618 }
1434} 1619}
1435 1620
1436our $ERROR_SYSCALL; 1621our $ERROR_SYSCALL;
1437our $ERROR_WANT_READ; 1622our $ERROR_WANT_READ;
1450 if ($self->{_on_starttls}) { 1635 if ($self->{_on_starttls}) {
1451 (delete $self->{_on_starttls})->($self, undef, $err); 1636 (delete $self->{_on_starttls})->($self, undef, $err);
1452 &_freetls; 1637 &_freetls;
1453 } else { 1638 } else {
1454 &_freetls; 1639 &_freetls;
1455 $self->_error (&Errno::EPROTO, 1, $err); 1640 $self->_error (Errno::EPROTO, 1, $err);
1456 } 1641 }
1457} 1642}
1458 1643
1459# poll the write BIO and send the data if applicable 1644# poll the write BIO and send the data if applicable
1460# also decode read data if possible 1645# also decode read data if possible
1492 $self->{_eof} = 1; 1677 $self->{_eof} = 1;
1493 } 1678 }
1494 } 1679 }
1495 1680
1496 $self->{_tls_rbuf} .= $tmp; 1681 $self->{_tls_rbuf} .= $tmp;
1497 $self->_drain_rbuf unless $self->{_in_drain}; 1682 $self->_drain_rbuf;
1498 $self->{tls} or return; # tls session might have gone away in callback 1683 $self->{tls} or return; # tls session might have gone away in callback
1499 } 1684 }
1500 1685
1501 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 1686 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1502 return $self->_tls_error ($tmp) 1687 return $self->_tls_error ($tmp)
1517 1702
1518Instead of starting TLS negotiation immediately when the AnyEvent::Handle 1703Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1519object is created, you can also do that at a later time by calling 1704object is created, you can also do that at a later time by calling
1520C<starttls>. 1705C<starttls>.
1521 1706
1707Starting TLS is currently an asynchronous operation - when you push some
1708write data and then call C<< ->starttls >> then TLS negotiation will start
1709immediately, after which the queued write data is then sent.
1710
1522The first argument is the same as the C<tls> constructor argument (either 1711The first argument is the same as the C<tls> constructor argument (either
1523C<"connect">, C<"accept"> or an existing Net::SSLeay object). 1712C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1524 1713
1525The second argument is the optional C<AnyEvent::TLS> object that is used 1714The second argument is the optional C<AnyEvent::TLS> object that is used
1526when AnyEvent::Handle has to create its own TLS connection object, or 1715when AnyEvent::Handle has to create its own TLS connection object, or
1530The TLS connection object will end up in C<< $handle->{tls} >>, the TLS 1719The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1531context in C<< $handle->{tls_ctx} >> after this call and can be used or 1720context in C<< $handle->{tls_ctx} >> after this call and can be used or
1532changed to your liking. Note that the handshake might have already started 1721changed to your liking. Note that the handshake might have already started
1533when this function returns. 1722when this function returns.
1534 1723
1535If it an error to start a TLS handshake more than once per 1724Due to bugs in OpenSSL, it might or might not be possible to do multiple
1536AnyEvent::Handle object (this is due to bugs in OpenSSL). 1725handshakes on the same stream. Best do not attempt to use the stream after
1726stopping TLS.
1537 1727
1538=cut 1728=cut
1539 1729
1540our %TLS_CACHE; #TODO not yet documented, should we? 1730our %TLS_CACHE; #TODO not yet documented, should we?
1541 1731
1542sub starttls { 1732sub starttls {
1543 my ($self, $ssl, $ctx) = @_; 1733 my ($self, $tls, $ctx) = @_;
1734
1735 Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1736 if $self->{tls};
1737
1738 $self->{tls} = $tls;
1739 $self->{tls_ctx} = $ctx if @_ > 2;
1740
1741 return unless $self->{fh};
1544 1742
1545 require Net::SSLeay; 1743 require Net::SSLeay;
1546
1547 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1548 if $self->{tls};
1549 1744
1550 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1745 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1551 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1746 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1552 1747
1748 $tls = $self->{tls};
1553 $ctx ||= $self->{tls_ctx}; 1749 $ctx = $self->{tls_ctx};
1750
1751 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1554 1752
1555 if ("HASH" eq ref $ctx) { 1753 if ("HASH" eq ref $ctx) {
1556 require AnyEvent::TLS; 1754 require AnyEvent::TLS;
1557
1558 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1559 1755
1560 if ($ctx->{cache}) { 1756 if ($ctx->{cache}) {
1561 my $key = $ctx+0; 1757 my $key = $ctx+0;
1562 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; 1758 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1563 } else { 1759 } else {
1564 $ctx = new AnyEvent::TLS %$ctx; 1760 $ctx = new AnyEvent::TLS %$ctx;
1565 } 1761 }
1566 } 1762 }
1567 1763
1568 $self->{tls_ctx} = $ctx || TLS_CTX (); 1764 $self->{tls_ctx} = $ctx || TLS_CTX ();
1569 $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); 1765 $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1570 1766
1571 # basically, this is deep magic (because SSL_read should have the same issues) 1767 # basically, this is deep magic (because SSL_read should have the same issues)
1572 # but the openssl maintainers basically said: "trust us, it just works". 1768 # but the openssl maintainers basically said: "trust us, it just works".
1573 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1769 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1574 # and mismaintained ssleay-module doesn't even offer them). 1770 # and mismaintained ssleay-module doesn't even offer them).
1581 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to 1777 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1582 # have identity issues in that area. 1778 # have identity issues in that area.
1583# Net::SSLeay::CTX_set_mode ($ssl, 1779# Net::SSLeay::CTX_set_mode ($ssl,
1584# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1780# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1585# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1781# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1586 Net::SSLeay::CTX_set_mode ($ssl, 1|2); 1782 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1587 1783
1588 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1784 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1589 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1785 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1590 1786
1787 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
1788
1591 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1789 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1592 1790
1593 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 1791 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1594 if $self->{on_starttls}; 1792 if $self->{on_starttls};
1595 1793
1596 &_dotls; # need to trigger the initial handshake 1794 &_dotls; # need to trigger the initial handshake
1599 1797
1600=item $handle->stoptls 1798=item $handle->stoptls
1601 1799
1602Shuts down the SSL connection - this makes a proper EOF handshake by 1800Shuts down the SSL connection - this makes a proper EOF handshake by
1603sending a close notify to the other side, but since OpenSSL doesn't 1801sending a close notify to the other side, but since OpenSSL doesn't
1604support non-blocking shut downs, it is not possible to re-use the stream 1802support non-blocking shut downs, it is not guarenteed that you can re-use
1605afterwards. 1803the stream afterwards.
1606 1804
1607=cut 1805=cut
1608 1806
1609sub stoptls { 1807sub stoptls {
1610 my ($self) = @_; 1808 my ($self) = @_;
1623sub _freetls { 1821sub _freetls {
1624 my ($self) = @_; 1822 my ($self) = @_;
1625 1823
1626 return unless $self->{tls}; 1824 return unless $self->{tls};
1627 1825
1628 $self->{tls_ctx}->_put_session (delete $self->{tls}); 1826 $self->{tls_ctx}->_put_session (delete $self->{tls})
1827 if $self->{tls} > 0;
1629 1828
1630 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 1829 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1631} 1830}
1632 1831
1633sub DESTROY { 1832sub DESTROY {
1635 1834
1636 &_freetls; 1835 &_freetls;
1637 1836
1638 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1837 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1639 1838
1640 if ($linger && length $self->{wbuf}) { 1839 if ($linger && length $self->{wbuf} && $self->{fh}) {
1641 my $fh = delete $self->{fh}; 1840 my $fh = delete $self->{fh};
1642 my $wbuf = delete $self->{wbuf}; 1841 my $wbuf = delete $self->{wbuf};
1643 1842
1644 my @linger; 1843 my @linger;
1645 1844
1646 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { 1845 push @linger, AE::io $fh, 1, sub {
1647 my $len = syswrite $fh, $wbuf, length $wbuf; 1846 my $len = syswrite $fh, $wbuf, length $wbuf;
1648 1847
1649 if ($len > 0) { 1848 if ($len > 0) {
1650 substr $wbuf, 0, $len, ""; 1849 substr $wbuf, 0, $len, "";
1651 } else { 1850 } else {
1652 @linger = (); # end 1851 @linger = (); # end
1653 } 1852 }
1654 }); 1853 };
1655 push @linger, AnyEvent->timer (after => $linger, cb => sub { 1854 push @linger, AE::timer $linger, 0, sub {
1656 @linger = (); 1855 @linger = ();
1657 }); 1856 };
1658 } 1857 }
1659} 1858}
1660 1859
1661=item $handle->destroy 1860=item $handle->destroy
1662 1861
1663Shuts down the handle object as much as possible - this call ensures that 1862Shuts down the handle object as much as possible - this call ensures that
1664no further callbacks will be invoked and as many resources as possible 1863no further callbacks will be invoked and as many resources as possible
1665will be freed. You must not call any methods on the object afterwards. 1864will be freed. Any method you will call on the handle object after
1865destroying it in this way will be silently ignored (and it will return the
1866empty list).
1666 1867
1667Normally, you can just "forget" any references to an AnyEvent::Handle 1868Normally, you can just "forget" any references to an AnyEvent::Handle
1668object and it will simply shut down. This works in fatal error and EOF 1869object and it will simply shut down. This works in fatal error and EOF
1669callbacks, as well as code outside. It does I<NOT> work in a read or write 1870callbacks, as well as code outside. It does I<NOT> work in a read or write
1670callback, so when you want to destroy the AnyEvent::Handle object from 1871callback, so when you want to destroy the AnyEvent::Handle object from
1684sub destroy { 1885sub destroy {
1685 my ($self) = @_; 1886 my ($self) = @_;
1686 1887
1687 $self->DESTROY; 1888 $self->DESTROY;
1688 %$self = (); 1889 %$self = ();
1890 bless $self, "AnyEvent::Handle::destroyed";
1891}
1892
1893sub AnyEvent::Handle::destroyed::AUTOLOAD {
1894 #nop
1689} 1895}
1690 1896
1691=item AnyEvent::Handle::TLS_CTX 1897=item AnyEvent::Handle::TLS_CTX
1692 1898
1693This function creates and returns the AnyEvent::TLS object used by default 1899This function creates and returns the AnyEvent::TLS object used by default

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines