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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines