1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
|
|
4 | use strict qw(subs vars); |
|
|
5 | |
|
|
6 | use AnyEvent (); |
|
|
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
8 | use Scalar::Util (); |
3 | use Scalar::Util (); |
9 | use Carp (); |
4 | use Carp (); |
10 | use Fcntl (); |
|
|
11 | use Errno qw(EAGAIN EINTR); |
5 | use Errno qw(EAGAIN EINTR); |
12 | |
6 | |
|
|
7 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
8 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
9 | |
13 | =head1 NAME |
10 | =head1 NAME |
14 | |
11 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
12 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
13 | |
17 | =cut |
14 | =cut |
18 | |
15 | |
19 | our $VERSION = 4.8; |
16 | our $VERSION = 4.87; |
20 | |
17 | |
21 | =head1 SYNOPSIS |
18 | =head1 SYNOPSIS |
22 | |
19 | |
23 | use AnyEvent; |
20 | use AnyEvent; |
24 | use AnyEvent::Handle; |
21 | use AnyEvent::Handle; |
25 | |
22 | |
26 | my $cv = AnyEvent->condvar; |
23 | my $cv = AnyEvent->condvar; |
27 | |
24 | |
28 | my $handle = |
25 | my $hdl; $hdl = new AnyEvent::Handle |
29 | AnyEvent::Handle->new ( |
|
|
30 | fh => \*STDIN, |
26 | fh => \*STDIN, |
31 | on_eof => sub { |
27 | on_error => sub { |
|
|
28 | my ($hdl, $fatal, $msg) = @_; |
|
|
29 | warn "got error $msg\n"; |
|
|
30 | $hdl->destroy; |
32 | $cv->send; |
31 | $cv->send; |
33 | }, |
|
|
34 | ); |
32 | ); |
35 | |
33 | |
36 | # send some request line |
34 | # send some request line |
37 | $handle->push_write ("getinfo\015\012"); |
35 | $hdl->push_write ("getinfo\015\012"); |
38 | |
36 | |
39 | # read the response line |
37 | # read the response line |
40 | $handle->push_read (line => sub { |
38 | $hdl->push_read (line => sub { |
41 | my ($handle, $line) = @_; |
39 | my ($hdl, $line) = @_; |
42 | warn "read line <$line>\n"; |
40 | warn "got line <$line>\n"; |
43 | $cv->send; |
41 | $cv->send; |
44 | }); |
42 | }); |
45 | |
43 | |
46 | $cv->recv; |
44 | $cv->recv; |
47 | |
45 | |
48 | =head1 DESCRIPTION |
46 | =head1 DESCRIPTION |
49 | |
47 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
48 | This module is a helper module to make it easier to do event-based I/O on |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
49 | filehandles. |
52 | on sockets see L<AnyEvent::Util>. |
|
|
53 | |
50 | |
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
51 | The L<AnyEvent::Intro> tutorial contains some well-documented |
55 | AnyEvent::Handle examples. |
52 | AnyEvent::Handle examples. |
56 | |
53 | |
57 | In the following, when the documentation refers to of "bytes" then this |
54 | In the following, when the documentation refers to of "bytes" then this |
58 | means characters. As sysread and syswrite are used for all I/O, their |
55 | means characters. As sysread and syswrite are used for all I/O, their |
59 | treatment of characters applies to this module as well. |
56 | treatment of characters applies to this module as well. |
60 | |
57 | |
|
|
58 | At the very minimum, you should specify C<fh> or C<connect>, and the |
|
|
59 | C<on_error> callback. |
|
|
60 | |
61 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
62 | argument. |
62 | argument. |
63 | |
63 | |
64 | =head1 METHODS |
64 | =head1 METHODS |
65 | |
65 | |
… | |
… | |
69 | |
69 | |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
71 | |
71 | |
72 | =over 4 |
72 | =over 4 |
73 | |
73 | |
74 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [C<fh> or C<connect> MANDATORY] |
75 | |
75 | |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
77 | |
|
|
78 | NOTE: The filehandle will be set to non-blocking mode (using |
77 | NOTE: The filehandle will be set to non-blocking mode (using |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
78 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
80 | that mode. |
79 | that mode. |
81 | |
80 | |
|
|
81 | =item connect => [$host, $service] [C<fh> or C<connect> MANDATORY] |
|
|
82 | |
|
|
83 | Try to connect to the specified host and service (port), using |
|
|
84 | C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the |
|
|
85 | default C<peername>. |
|
|
86 | |
|
|
87 | You have to specify either this parameter, or C<fh>, above. |
|
|
88 | |
|
|
89 | It is possible to push requests on the read and write queues, and modify |
|
|
90 | properties of the stream, even while AnyEvent::Handle is connecting. |
|
|
91 | |
|
|
92 | When this parameter is specified, then the C<on_prepare>, |
|
|
93 | C<on_connect_error> and C<on_connect> callbacks will be called under the |
|
|
94 | appropriate circumstances: |
|
|
95 | |
|
|
96 | =over 4 |
|
|
97 | |
|
|
98 | =item on_prepare => $cb->($handle) |
|
|
99 | |
|
|
100 | This (rarely used) callback is called before a new connection is |
|
|
101 | attempted, but after the file handle has been created. It could be used to |
|
|
102 | prepare the file handle with parameters required for the actual connect |
|
|
103 | (as opposed to settings that can be changed when the connection is already |
|
|
104 | established). |
|
|
105 | |
|
|
106 | The return value of this callback should be the connect timeout value in |
|
|
107 | seconds (or C<0>, or C<undef>, or the empty list, to indicate the default |
|
|
108 | timeout is to be used). |
|
|
109 | |
|
|
110 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
|
|
111 | |
|
|
112 | This callback is called when a connection has been successfully established. |
|
|
113 | |
|
|
114 | The actual numeric host and port (the socket peername) are passed as |
|
|
115 | parameters, together with a retry callback. |
|
|
116 | |
|
|
117 | When, for some reason, the handle is not acceptable, then calling |
|
|
118 | C<$retry> will continue with the next conenction target (in case of |
|
|
119 | multi-homed hosts or SRV records there can be multiple connection |
|
|
120 | endpoints). When it is called then the read and write queues, eof status, |
|
|
121 | tls status and similar properties of the handle are being reset. |
|
|
122 | |
|
|
123 | In most cases, ignoring the C<$retry> parameter is the way to go. |
|
|
124 | |
|
|
125 | =item on_connect_error => $cb->($handle, $message) |
|
|
126 | |
|
|
127 | This callback is called when the conenction could not be |
|
|
128 | established. C<$!> will contain the relevant error code, and C<$message> a |
|
|
129 | message describing it (usually the same as C<"$!">). |
|
|
130 | |
|
|
131 | If this callback isn't specified, then C<on_error> will be called with a |
|
|
132 | fatal error instead. |
|
|
133 | |
|
|
134 | =back |
|
|
135 | |
|
|
136 | =item on_error => $cb->($handle, $fatal, $message) |
|
|
137 | |
|
|
138 | This is the error callback, which is called when, well, some error |
|
|
139 | occured, such as not being able to resolve the hostname, failure to |
|
|
140 | connect or a read error. |
|
|
141 | |
|
|
142 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
|
|
143 | fatal errors the handle object will be destroyed (by a call to C<< -> |
|
|
144 | destroy >>) after invoking the error callback (which means you are free to |
|
|
145 | examine the handle object). Examples of fatal errors are an EOF condition |
|
|
146 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
|
|
147 | cases where the other side can close the connection at their will it is |
|
|
148 | often easiest to not report C<EPIPE> errors in this callback. |
|
|
149 | |
|
|
150 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
151 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
152 | recommended to always output the C<$message> argument in human-readable |
|
|
153 | error messages (it's usually the same as C<"$!">). |
|
|
154 | |
|
|
155 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
156 | to simply ignore this parameter and instead abondon the handle object |
|
|
157 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
158 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
159 | |
|
|
160 | On callback entrance, the value of C<$!> contains the operating system |
|
|
161 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
162 | C<EPROTO>). |
|
|
163 | |
|
|
164 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
165 | you will not be notified of errors otherwise. The default simply calls |
|
|
166 | C<croak>. |
|
|
167 | |
|
|
168 | =item on_read => $cb->($handle) |
|
|
169 | |
|
|
170 | This sets the default read callback, which is called when data arrives |
|
|
171 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
172 | callback will only be called when at least one octet of data is in the |
|
|
173 | read buffer). |
|
|
174 | |
|
|
175 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
176 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
177 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
178 | the beginning from it. |
|
|
179 | |
|
|
180 | When an EOF condition is detected then AnyEvent::Handle will first try to |
|
|
181 | feed all the remaining data to the queued callbacks and C<on_read> before |
|
|
182 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
|
|
183 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
184 | |
|
|
185 | Note that, unlike requests in the read queue, an C<on_read> callback |
|
|
186 | doesn't mean you I<require> some data: if there is an EOF and there |
|
|
187 | are outstanding read requests then an error will be flagged. With an |
|
|
188 | C<on_read> callback, the C<on_eof> callback will be invoked. |
|
|
189 | |
82 | =item on_eof => $cb->($handle) |
190 | =item on_eof => $cb->($handle) |
83 | |
191 | |
84 | Set the callback to be called when an end-of-file condition is detected, |
192 | Set the callback to be called when an end-of-file condition is detected, |
85 | i.e. in the case of a socket, when the other side has closed the |
193 | i.e. in the case of a socket, when the other side has closed the |
86 | connection cleanly. |
194 | connection cleanly, and there are no outstanding read requests in the |
|
|
195 | queue (if there are read requests, then an EOF counts as an unexpected |
|
|
196 | connection close and will be flagged as an error). |
87 | |
197 | |
88 | For sockets, this just means that the other side has stopped sending data, |
198 | For sockets, this just means that the other side has stopped sending data, |
89 | you can still try to write data, and, in fact, one can return from the EOF |
199 | you can still try to write data, and, in fact, one can return from the EOF |
90 | callback and continue writing data, as only the read part has been shut |
200 | callback and continue writing data, as only the read part has been shut |
91 | down. |
201 | down. |
92 | |
202 | |
93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
|
|
94 | otherwise you might end up with a closed socket while you are still |
|
|
95 | waiting for data. |
|
|
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
203 | If an EOF condition has been detected but no C<on_eof> callback has been |
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
204 | set, then a fatal error will be raised with C<$!> set to <0>. |
99 | |
|
|
100 | =item on_error => $cb->($handle, $fatal, $message) |
|
|
101 | |
|
|
102 | This is the error callback, which is called when, well, some error |
|
|
103 | occured, such as not being able to resolve the hostname, failure to |
|
|
104 | connect or a read error. |
|
|
105 | |
|
|
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
|
|
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
|
|
112 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
113 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
114 | recommended to always output the C<$message> argument in human-readable |
|
|
115 | error messages (it's usually the same as C<"$!">). |
|
|
116 | |
|
|
117 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
118 | to simply ignore this parameter and instead abondon the handle object |
|
|
119 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
120 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
121 | |
|
|
122 | On callback entrance, the value of C<$!> contains the operating system |
|
|
123 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
124 | C<EPROTO>). |
|
|
125 | |
|
|
126 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
127 | you will not be notified of errors otherwise. The default simply calls |
|
|
128 | C<croak>. |
|
|
129 | |
|
|
130 | =item on_read => $cb->($handle) |
|
|
131 | |
|
|
132 | This sets the default read callback, which is called when data arrives |
|
|
133 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
134 | callback will only be called when at least one octet of data is in the |
|
|
135 | read buffer). |
|
|
136 | |
|
|
137 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
138 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
139 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
140 | the beginning from it. |
|
|
141 | |
|
|
142 | When an EOF condition is detected then AnyEvent::Handle will first try to |
|
|
143 | feed all the remaining data to the queued callbacks and C<on_read> before |
|
|
144 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
|
|
145 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
146 | |
205 | |
147 | =item on_drain => $cb->($handle) |
206 | =item on_drain => $cb->($handle) |
148 | |
207 | |
149 | This sets the callback that is called when the write buffer becomes empty |
208 | This sets the callback that is called when the write buffer becomes empty |
150 | (or when the callback is set and the buffer is empty already). |
209 | (or when the callback is set and the buffer is empty already). |
… | |
… | |
349 | |
408 | |
350 | sub new { |
409 | sub new { |
351 | my $class = shift; |
410 | my $class = shift; |
352 | my $self = bless { @_ }, $class; |
411 | my $self = bless { @_ }, $class; |
353 | |
412 | |
354 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
413 | if ($self->{fh}) { |
|
|
414 | $self->_start; |
|
|
415 | return unless $self->{fh}; # could be gone by now |
|
|
416 | |
|
|
417 | } elsif ($self->{connect}) { |
|
|
418 | require AnyEvent::Socket; |
|
|
419 | |
|
|
420 | $self->{peername} = $self->{connect}[0] |
|
|
421 | unless exists $self->{peername}; |
|
|
422 | |
|
|
423 | $self->{_skip_drain_rbuf} = 1; |
|
|
424 | |
|
|
425 | { |
|
|
426 | Scalar::Util::weaken (my $self = $self); |
|
|
427 | |
|
|
428 | $self->{_connect} = |
|
|
429 | AnyEvent::Socket::tcp_connect ( |
|
|
430 | $self->{connect}[0], |
|
|
431 | $self->{connect}[1], |
|
|
432 | sub { |
|
|
433 | my ($fh, $host, $port, $retry) = @_; |
|
|
434 | |
|
|
435 | if ($fh) { |
|
|
436 | $self->{fh} = $fh; |
|
|
437 | |
|
|
438 | delete $self->{_skip_drain_rbuf}; |
|
|
439 | $self->_start; |
|
|
440 | |
|
|
441 | $self->{on_connect} |
|
|
442 | and $self->{on_connect}($self, $host, $port, sub { |
|
|
443 | delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
|
|
444 | $self->{_skip_drain_rbuf} = 1; |
|
|
445 | &$retry; |
|
|
446 | }); |
|
|
447 | |
|
|
448 | } else { |
|
|
449 | if ($self->{on_connect_error}) { |
|
|
450 | $self->{on_connect_error}($self, "$!"); |
|
|
451 | $self->destroy; |
|
|
452 | } else { |
|
|
453 | $self->_error ($!, 1); |
|
|
454 | } |
|
|
455 | } |
|
|
456 | }, |
|
|
457 | sub { |
|
|
458 | local $self->{fh} = $_[0]; |
|
|
459 | |
|
|
460 | $self->{on_prepare} |
|
|
461 | ? $self->{on_prepare}->($self) |
|
|
462 | : () |
|
|
463 | } |
|
|
464 | ); |
|
|
465 | } |
|
|
466 | |
|
|
467 | } else { |
|
|
468 | Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified"; |
|
|
469 | } |
|
|
470 | |
|
|
471 | $self |
|
|
472 | } |
|
|
473 | |
|
|
474 | sub _start { |
|
|
475 | my ($self) = @_; |
355 | |
476 | |
356 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
477 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
357 | |
478 | |
358 | $self->{_activity} = AnyEvent->now; |
479 | $self->{_activity} = AnyEvent->now; |
359 | $self->_timeout; |
480 | $self->_timeout; |
… | |
… | |
364 | if $self->{tls}; |
485 | if $self->{tls}; |
365 | |
486 | |
366 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
487 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
367 | |
488 | |
368 | $self->start_read |
489 | $self->start_read |
369 | if $self->{on_read}; |
490 | if $self->{on_read} || @{ $self->{_queue} }; |
370 | |
491 | |
371 | $self->{fh} && $self |
492 | $self->_drain_wbuf; |
372 | } |
493 | } |
373 | |
494 | |
374 | sub _shutdown { |
495 | #sub _shutdown { |
375 | my ($self) = @_; |
496 | # my ($self) = @_; |
376 | |
497 | # |
377 | delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
498 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
378 | $self->{_eof} = 1; # tell starttls et. al to stop trying |
499 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
379 | |
500 | # |
380 | &_freetls; |
501 | # &_freetls; |
381 | } |
502 | #} |
382 | |
503 | |
383 | sub _error { |
504 | sub _error { |
384 | my ($self, $errno, $fatal, $message) = @_; |
505 | my ($self, $errno, $fatal, $message) = @_; |
385 | |
506 | |
386 | $self->_shutdown |
|
|
387 | if $fatal; |
|
|
388 | |
|
|
389 | $! = $errno; |
507 | $! = $errno; |
390 | $message ||= "$!"; |
508 | $message ||= "$!"; |
391 | |
509 | |
392 | if ($self->{on_error}) { |
510 | if ($self->{on_error}) { |
393 | $self->{on_error}($self, $fatal, $message); |
511 | $self->{on_error}($self, $fatal, $message); |
|
|
512 | $self->destroy if $fatal; |
394 | } elsif ($self->{fh}) { |
513 | } elsif ($self->{fh}) { |
|
|
514 | $self->destroy; |
395 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
515 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
396 | } |
516 | } |
397 | } |
517 | } |
398 | |
518 | |
399 | =item $fh = $handle->fh |
519 | =item $fh = $handle->fh |
… | |
… | |
457 | sub no_delay { |
577 | sub no_delay { |
458 | $_[0]{no_delay} = $_[1]; |
578 | $_[0]{no_delay} = $_[1]; |
459 | |
579 | |
460 | eval { |
580 | eval { |
461 | local $SIG{__DIE__}; |
581 | local $SIG{__DIE__}; |
462 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
582 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] |
|
|
583 | if $_[0]{fh}; |
463 | }; |
584 | }; |
464 | } |
585 | } |
465 | |
586 | |
466 | =item $handle->on_starttls ($cb) |
587 | =item $handle->on_starttls ($cb) |
467 | |
588 | |
… | |
… | |
501 | # reset the timeout watcher, as neccessary |
622 | # reset the timeout watcher, as neccessary |
502 | # also check for time-outs |
623 | # also check for time-outs |
503 | sub _timeout { |
624 | sub _timeout { |
504 | my ($self) = @_; |
625 | my ($self) = @_; |
505 | |
626 | |
506 | if ($self->{timeout}) { |
627 | if ($self->{timeout} && $self->{fh}) { |
507 | my $NOW = AnyEvent->now; |
628 | my $NOW = AnyEvent->now; |
508 | |
629 | |
509 | # when would the timeout trigger? |
630 | # when would the timeout trigger? |
510 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
631 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
511 | |
632 | |
… | |
… | |
514 | $self->{_activity} = $NOW; |
635 | $self->{_activity} = $NOW; |
515 | |
636 | |
516 | if ($self->{on_timeout}) { |
637 | if ($self->{on_timeout}) { |
517 | $self->{on_timeout}($self); |
638 | $self->{on_timeout}($self); |
518 | } else { |
639 | } else { |
519 | $self->_error (&Errno::ETIMEDOUT); |
640 | $self->_error (Errno::ETIMEDOUT); |
520 | } |
641 | } |
521 | |
642 | |
522 | # callback could have changed timeout value, optimise |
643 | # callback could have changed timeout value, optimise |
523 | return unless $self->{timeout}; |
644 | return unless $self->{timeout}; |
524 | |
645 | |
… | |
… | |
587 | Scalar::Util::weaken $self; |
708 | Scalar::Util::weaken $self; |
588 | |
709 | |
589 | my $cb = sub { |
710 | my $cb = sub { |
590 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
711 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
591 | |
712 | |
592 | if ($len >= 0) { |
713 | if (defined $len) { |
593 | substr $self->{wbuf}, 0, $len, ""; |
714 | substr $self->{wbuf}, 0, $len, ""; |
594 | |
715 | |
595 | $self->{_activity} = AnyEvent->now; |
716 | $self->{_activity} = AnyEvent->now; |
596 | |
717 | |
597 | $self->{on_drain}($self) |
718 | $self->{on_drain}($self) |
… | |
… | |
629 | ->($self, @_); |
750 | ->($self, @_); |
630 | } |
751 | } |
631 | |
752 | |
632 | if ($self->{tls}) { |
753 | if ($self->{tls}) { |
633 | $self->{_tls_wbuf} .= $_[0]; |
754 | $self->{_tls_wbuf} .= $_[0]; |
634 | |
755 | &_dotls ($self) if $self->{fh}; |
635 | &_dotls ($self); |
|
|
636 | } else { |
756 | } else { |
637 | $self->{wbuf} .= $_[0]; |
757 | $self->{wbuf} .= $_[0]; |
638 | $self->_drain_wbuf; |
758 | $self->_drain_wbuf if $self->{fh}; |
639 | } |
759 | } |
640 | } |
760 | } |
641 | |
761 | |
642 | =item $handle->push_write (type => @args) |
762 | =item $handle->push_write (type => @args) |
643 | |
763 | |
… | |
… | |
860 | =cut |
980 | =cut |
861 | |
981 | |
862 | sub _drain_rbuf { |
982 | sub _drain_rbuf { |
863 | my ($self) = @_; |
983 | my ($self) = @_; |
864 | |
984 | |
|
|
985 | # avoid recursion |
|
|
986 | return if exists $self->{_skip_drain_rbuf}; |
865 | local $self->{_in_drain} = 1; |
987 | local $self->{_skip_drain_rbuf} = 1; |
866 | |
988 | |
867 | if ( |
989 | if ( |
868 | defined $self->{rbuf_max} |
990 | defined $self->{rbuf_max} |
869 | && $self->{rbuf_max} < length $self->{rbuf} |
991 | && $self->{rbuf_max} < length $self->{rbuf} |
870 | ) { |
992 | ) { |
871 | $self->_error (&Errno::ENOSPC, 1), return; |
993 | $self->_error (Errno::ENOSPC, 1), return; |
872 | } |
994 | } |
873 | |
995 | |
874 | while () { |
996 | while () { |
875 | # we need to use a separate tls read buffer, as we must not receive data while |
997 | # 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. |
998 | # we are draining the buffer, and this can only happen with TLS. |
877 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
999 | $self->{rbuf} .= delete $self->{_tls_rbuf} |
|
|
1000 | if exists $self->{_tls_rbuf}; |
878 | |
1001 | |
879 | my $len = length $self->{rbuf}; |
1002 | my $len = length $self->{rbuf}; |
880 | |
1003 | |
881 | if (my $cb = shift @{ $self->{_queue} }) { |
1004 | if (my $cb = shift @{ $self->{_queue} }) { |
882 | unless ($cb->($self)) { |
1005 | unless ($cb->($self)) { |
883 | if ($self->{_eof}) { |
1006 | # no progress can be made |
884 | # no progress can be made (not enough data and no data forthcoming) |
1007 | # (not enough data and no data forthcoming) |
885 | $self->_error (&Errno::EPIPE, 1), return; |
1008 | $self->_error (Errno::EPIPE, 1), return |
886 | } |
1009 | if $self->{_eof}; |
887 | |
1010 | |
888 | unshift @{ $self->{_queue} }, $cb; |
1011 | unshift @{ $self->{_queue} }, $cb; |
889 | last; |
1012 | last; |
890 | } |
1013 | } |
891 | } elsif ($self->{on_read}) { |
1014 | } elsif ($self->{on_read}) { |
… | |
… | |
898 | && !@{ $self->{_queue} } # and the queue is still empty |
1021 | && !@{ $self->{_queue} } # and the queue is still empty |
899 | && $self->{on_read} # but we still have on_read |
1022 | && $self->{on_read} # but we still have on_read |
900 | ) { |
1023 | ) { |
901 | # no further data will arrive |
1024 | # no further data will arrive |
902 | # so no progress can be made |
1025 | # so no progress can be made |
903 | $self->_error (&Errno::EPIPE, 1), return |
1026 | $self->_error (Errno::EPIPE, 1), return |
904 | if $self->{_eof}; |
1027 | if $self->{_eof}; |
905 | |
1028 | |
906 | last; # more data might arrive |
1029 | last; # more data might arrive |
907 | } |
1030 | } |
908 | } else { |
1031 | } else { |
… | |
… | |
911 | last; |
1034 | last; |
912 | } |
1035 | } |
913 | } |
1036 | } |
914 | |
1037 | |
915 | if ($self->{_eof}) { |
1038 | if ($self->{_eof}) { |
916 | if ($self->{on_eof}) { |
1039 | $self->{on_eof} |
917 | $self->{on_eof}($self) |
1040 | ? $self->{on_eof}($self) |
918 | } else { |
|
|
919 | $self->_error (0, 1, "Unexpected end-of-file"); |
1041 | : $self->_error (0, 1, "Unexpected end-of-file"); |
920 | } |
1042 | |
|
|
1043 | return; |
921 | } |
1044 | } |
922 | |
1045 | |
923 | # may need to restart read watcher |
1046 | # may need to restart read watcher |
924 | unless ($self->{_rw}) { |
1047 | unless ($self->{_rw}) { |
925 | $self->start_read |
1048 | $self->start_read |
… | |
… | |
937 | |
1060 | |
938 | sub on_read { |
1061 | sub on_read { |
939 | my ($self, $cb) = @_; |
1062 | my ($self, $cb) = @_; |
940 | |
1063 | |
941 | $self->{on_read} = $cb; |
1064 | $self->{on_read} = $cb; |
942 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
1065 | $self->_drain_rbuf if $cb; |
943 | } |
1066 | } |
944 | |
1067 | |
945 | =item $handle->rbuf |
1068 | =item $handle->rbuf |
946 | |
1069 | |
947 | Returns the read buffer (as a modifiable lvalue). |
1070 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
999 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1122 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1000 | ->($self, $cb, @_); |
1123 | ->($self, $cb, @_); |
1001 | } |
1124 | } |
1002 | |
1125 | |
1003 | push @{ $self->{_queue} }, $cb; |
1126 | push @{ $self->{_queue} }, $cb; |
1004 | $self->_drain_rbuf unless $self->{_in_drain}; |
1127 | $self->_drain_rbuf; |
1005 | } |
1128 | } |
1006 | |
1129 | |
1007 | sub unshift_read { |
1130 | sub unshift_read { |
1008 | my $self = shift; |
1131 | my $self = shift; |
1009 | my $cb = pop; |
1132 | my $cb = pop; |
… | |
… | |
1015 | ->($self, $cb, @_); |
1138 | ->($self, $cb, @_); |
1016 | } |
1139 | } |
1017 | |
1140 | |
1018 | |
1141 | |
1019 | unshift @{ $self->{_queue} }, $cb; |
1142 | unshift @{ $self->{_queue} }, $cb; |
1020 | $self->_drain_rbuf unless $self->{_in_drain}; |
1143 | $self->_drain_rbuf; |
1021 | } |
1144 | } |
1022 | |
1145 | |
1023 | =item $handle->push_read (type => @args, $cb) |
1146 | =item $handle->push_read (type => @args, $cb) |
1024 | |
1147 | |
1025 | =item $handle->unshift_read (type => @args, $cb) |
1148 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
1158 | return 1; |
1281 | return 1; |
1159 | } |
1282 | } |
1160 | |
1283 | |
1161 | # reject |
1284 | # reject |
1162 | if ($reject && $$rbuf =~ $reject) { |
1285 | if ($reject && $$rbuf =~ $reject) { |
1163 | $self->_error (&Errno::EBADMSG); |
1286 | $self->_error (Errno::EBADMSG); |
1164 | } |
1287 | } |
1165 | |
1288 | |
1166 | # skip |
1289 | # skip |
1167 | if ($skip && $$rbuf =~ $skip) { |
1290 | if ($skip && $$rbuf =~ $skip) { |
1168 | $data .= substr $$rbuf, 0, $+[0], ""; |
1291 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1184 | my ($self, $cb) = @_; |
1307 | my ($self, $cb) = @_; |
1185 | |
1308 | |
1186 | sub { |
1309 | sub { |
1187 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1310 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1188 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1311 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1189 | $self->_error (&Errno::EBADMSG); |
1312 | $self->_error (Errno::EBADMSG); |
1190 | } |
1313 | } |
1191 | return; |
1314 | return; |
1192 | } |
1315 | } |
1193 | |
1316 | |
1194 | my $len = $1; |
1317 | my $len = $1; |
… | |
… | |
1197 | my $string = $_[1]; |
1320 | my $string = $_[1]; |
1198 | $_[0]->unshift_read (chunk => 1, sub { |
1321 | $_[0]->unshift_read (chunk => 1, sub { |
1199 | if ($_[1] eq ",") { |
1322 | if ($_[1] eq ",") { |
1200 | $cb->($_[0], $string); |
1323 | $cb->($_[0], $string); |
1201 | } else { |
1324 | } else { |
1202 | $self->_error (&Errno::EBADMSG); |
1325 | $self->_error (Errno::EBADMSG); |
1203 | } |
1326 | } |
1204 | }); |
1327 | }); |
1205 | }); |
1328 | }); |
1206 | |
1329 | |
1207 | 1 |
1330 | 1 |
… | |
… | |
1297 | $json->incr_skip; |
1420 | $json->incr_skip; |
1298 | |
1421 | |
1299 | $self->{rbuf} = $json->incr_text; |
1422 | $self->{rbuf} = $json->incr_text; |
1300 | $json->incr_text = ""; |
1423 | $json->incr_text = ""; |
1301 | |
1424 | |
1302 | $self->_error (&Errno::EBADMSG); |
1425 | $self->_error (Errno::EBADMSG); |
1303 | |
1426 | |
1304 | () |
1427 | () |
1305 | } else { |
1428 | } else { |
1306 | $self->{rbuf} = ""; |
1429 | $self->{rbuf} = ""; |
1307 | |
1430 | |
… | |
… | |
1344 | # read remaining chunk |
1467 | # read remaining chunk |
1345 | $_[0]->unshift_read (chunk => $len, sub { |
1468 | $_[0]->unshift_read (chunk => $len, sub { |
1346 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1469 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1347 | $cb->($_[0], $ref); |
1470 | $cb->($_[0], $ref); |
1348 | } else { |
1471 | } else { |
1349 | $self->_error (&Errno::EBADMSG); |
1472 | $self->_error (Errno::EBADMSG); |
1350 | } |
1473 | } |
1351 | }); |
1474 | }); |
1352 | } |
1475 | } |
1353 | |
1476 | |
1354 | 1 |
1477 | 1 |
… | |
… | |
1418 | if ($self->{tls}) { |
1541 | if ($self->{tls}) { |
1419 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1542 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1420 | |
1543 | |
1421 | &_dotls ($self); |
1544 | &_dotls ($self); |
1422 | } else { |
1545 | } else { |
1423 | $self->_drain_rbuf unless $self->{_in_drain}; |
1546 | $self->_drain_rbuf; |
1424 | } |
1547 | } |
1425 | |
1548 | |
1426 | } elsif (defined $len) { |
1549 | } elsif (defined $len) { |
1427 | delete $self->{_rw}; |
1550 | delete $self->{_rw}; |
1428 | $self->{_eof} = 1; |
1551 | $self->{_eof} = 1; |
1429 | $self->_drain_rbuf unless $self->{_in_drain}; |
1552 | $self->_drain_rbuf; |
1430 | |
1553 | |
1431 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1554 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1432 | return $self->_error ($!, 1); |
1555 | return $self->_error ($!, 1); |
1433 | } |
1556 | } |
1434 | }); |
1557 | }); |
… | |
… | |
1452 | if ($self->{_on_starttls}) { |
1575 | if ($self->{_on_starttls}) { |
1453 | (delete $self->{_on_starttls})->($self, undef, $err); |
1576 | (delete $self->{_on_starttls})->($self, undef, $err); |
1454 | &_freetls; |
1577 | &_freetls; |
1455 | } else { |
1578 | } else { |
1456 | &_freetls; |
1579 | &_freetls; |
1457 | $self->_error (&Errno::EPROTO, 1, $err); |
1580 | $self->_error (Errno::EPROTO, 1, $err); |
1458 | } |
1581 | } |
1459 | } |
1582 | } |
1460 | |
1583 | |
1461 | # poll the write BIO and send the data if applicable |
1584 | # poll the write BIO and send the data if applicable |
1462 | # also decode read data if possible |
1585 | # also decode read data if possible |
… | |
… | |
1494 | $self->{_eof} = 1; |
1617 | $self->{_eof} = 1; |
1495 | } |
1618 | } |
1496 | } |
1619 | } |
1497 | |
1620 | |
1498 | $self->{_tls_rbuf} .= $tmp; |
1621 | $self->{_tls_rbuf} .= $tmp; |
1499 | $self->_drain_rbuf unless $self->{_in_drain}; |
1622 | $self->_drain_rbuf; |
1500 | $self->{tls} or return; # tls session might have gone away in callback |
1623 | $self->{tls} or return; # tls session might have gone away in callback |
1501 | } |
1624 | } |
1502 | |
1625 | |
1503 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1626 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1504 | return $self->_tls_error ($tmp) |
1627 | return $self->_tls_error ($tmp) |
… | |
… | |
1519 | |
1642 | |
1520 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1643 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1521 | object is created, you can also do that at a later time by calling |
1644 | object is created, you can also do that at a later time by calling |
1522 | C<starttls>. |
1645 | C<starttls>. |
1523 | |
1646 | |
|
|
1647 | Starting TLS is currently an asynchronous operation - when you push some |
|
|
1648 | write data and then call C<< ->starttls >> then TLS negotiation will start |
|
|
1649 | immediately, after which the queued write data is then sent. |
|
|
1650 | |
1524 | The first argument is the same as the C<tls> constructor argument (either |
1651 | The first argument is the same as the C<tls> constructor argument (either |
1525 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1652 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1526 | |
1653 | |
1527 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1654 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1528 | when AnyEvent::Handle has to create its own TLS connection object, or |
1655 | when AnyEvent::Handle has to create its own TLS connection object, or |
… | |
… | |
1532 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1659 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1533 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1660 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1534 | changed to your liking. Note that the handshake might have already started |
1661 | changed to your liking. Note that the handshake might have already started |
1535 | when this function returns. |
1662 | when this function returns. |
1536 | |
1663 | |
1537 | If it an error to start a TLS handshake more than once per |
1664 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1538 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1665 | handshakes on the same stream. Best do not attempt to use the stream after |
|
|
1666 | stopping TLS. |
1539 | |
1667 | |
1540 | =cut |
1668 | =cut |
1541 | |
1669 | |
1542 | our %TLS_CACHE; #TODO not yet documented, should we? |
1670 | our %TLS_CACHE; #TODO not yet documented, should we? |
1543 | |
1671 | |
1544 | sub starttls { |
1672 | sub starttls { |
1545 | my ($self, $ssl, $ctx) = @_; |
1673 | my ($self, $tls, $ctx) = @_; |
|
|
1674 | |
|
|
1675 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
|
|
1676 | if $self->{tls}; |
|
|
1677 | |
|
|
1678 | $self->{tls} = $tls; |
|
|
1679 | $self->{tls_ctx} = $ctx if @_ > 2; |
|
|
1680 | |
|
|
1681 | return unless $self->{fh}; |
1546 | |
1682 | |
1547 | require Net::SSLeay; |
1683 | require Net::SSLeay; |
1548 | |
|
|
1549 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
|
|
1550 | if $self->{tls}; |
|
|
1551 | |
1684 | |
1552 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1685 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1553 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1686 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1554 | |
1687 | |
|
|
1688 | $tls = $self->{tls}; |
1555 | $ctx ||= $self->{tls_ctx}; |
1689 | $ctx = $self->{tls_ctx}; |
|
|
1690 | |
|
|
1691 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1556 | |
1692 | |
1557 | if ("HASH" eq ref $ctx) { |
1693 | if ("HASH" eq ref $ctx) { |
1558 | require AnyEvent::TLS; |
1694 | require AnyEvent::TLS; |
1559 | |
|
|
1560 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context |
|
|
1561 | |
1695 | |
1562 | if ($ctx->{cache}) { |
1696 | if ($ctx->{cache}) { |
1563 | my $key = $ctx+0; |
1697 | my $key = $ctx+0; |
1564 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1698 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1565 | } else { |
1699 | } else { |
1566 | $ctx = new AnyEvent::TLS %$ctx; |
1700 | $ctx = new AnyEvent::TLS %$ctx; |
1567 | } |
1701 | } |
1568 | } |
1702 | } |
1569 | |
1703 | |
1570 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1704 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1571 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
1705 | $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername}); |
1572 | |
1706 | |
1573 | # basically, this is deep magic (because SSL_read should have the same issues) |
1707 | # basically, this is deep magic (because SSL_read should have the same issues) |
1574 | # but the openssl maintainers basically said: "trust us, it just works". |
1708 | # but the openssl maintainers basically said: "trust us, it just works". |
1575 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1709 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1576 | # and mismaintained ssleay-module doesn't even offer them). |
1710 | # and mismaintained ssleay-module doesn't even offer them). |
… | |
… | |
1583 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1717 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1584 | # have identity issues in that area. |
1718 | # have identity issues in that area. |
1585 | # Net::SSLeay::CTX_set_mode ($ssl, |
1719 | # Net::SSLeay::CTX_set_mode ($ssl, |
1586 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1720 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1587 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1721 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1588 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
1722 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1589 | |
1723 | |
1590 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1724 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1591 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1725 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1592 | |
1726 | |
1593 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1727 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1594 | |
1728 | |
1595 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1729 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1596 | if $self->{on_starttls}; |
1730 | if $self->{on_starttls}; |
1597 | |
1731 | |
1598 | &_dotls; # need to trigger the initial handshake |
1732 | &_dotls; # need to trigger the initial handshake |
… | |
… | |
1601 | |
1735 | |
1602 | =item $handle->stoptls |
1736 | =item $handle->stoptls |
1603 | |
1737 | |
1604 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1738 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1605 | sending a close notify to the other side, but since OpenSSL doesn't |
1739 | sending a close notify to the other side, but since OpenSSL doesn't |
1606 | support non-blocking shut downs, it is not possible to re-use the stream |
1740 | support non-blocking shut downs, it is not guarenteed that you can re-use |
1607 | afterwards. |
1741 | the stream afterwards. |
1608 | |
1742 | |
1609 | =cut |
1743 | =cut |
1610 | |
1744 | |
1611 | sub stoptls { |
1745 | sub stoptls { |
1612 | my ($self) = @_; |
1746 | my ($self) = @_; |
… | |
… | |
1625 | sub _freetls { |
1759 | sub _freetls { |
1626 | my ($self) = @_; |
1760 | my ($self) = @_; |
1627 | |
1761 | |
1628 | return unless $self->{tls}; |
1762 | return unless $self->{tls}; |
1629 | |
1763 | |
1630 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
1764 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
|
|
1765 | if ref $self->{tls}; |
1631 | |
1766 | |
1632 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1767 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1633 | } |
1768 | } |
1634 | |
1769 | |
1635 | sub DESTROY { |
1770 | sub DESTROY { |
… | |
… | |
1637 | |
1772 | |
1638 | &_freetls; |
1773 | &_freetls; |
1639 | |
1774 | |
1640 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1775 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1641 | |
1776 | |
1642 | if ($linger && length $self->{wbuf}) { |
1777 | if ($linger && length $self->{wbuf} && $self->{fh}) { |
1643 | my $fh = delete $self->{fh}; |
1778 | my $fh = delete $self->{fh}; |
1644 | my $wbuf = delete $self->{wbuf}; |
1779 | my $wbuf = delete $self->{wbuf}; |
1645 | |
1780 | |
1646 | my @linger; |
1781 | my @linger; |
1647 | |
1782 | |
… | |
… | |
1671 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1806 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1672 | callback, so when you want to destroy the AnyEvent::Handle object from |
1807 | callback, so when you want to destroy the AnyEvent::Handle object from |
1673 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
1808 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
1674 | that case. |
1809 | that case. |
1675 | |
1810 | |
|
|
1811 | Destroying the handle object in this way has the advantage that callbacks |
|
|
1812 | will be removed as well, so if those are the only reference holders (as |
|
|
1813 | is common), then one doesn't need to do anything special to break any |
|
|
1814 | reference cycles. |
|
|
1815 | |
1676 | The handle might still linger in the background and write out remaining |
1816 | The handle might still linger in the background and write out remaining |
1677 | data, as specified by the C<linger> option, however. |
1817 | data, as specified by the C<linger> option, however. |
1678 | |
1818 | |
1679 | =cut |
1819 | =cut |
1680 | |
1820 | |
1681 | sub destroy { |
1821 | sub destroy { |
1682 | my ($self) = @_; |
1822 | my ($self) = @_; |
1683 | |
1823 | |
1684 | $self->DESTROY; |
1824 | $self->DESTROY; |
1685 | %$self = (); |
1825 | %$self = (); |
|
|
1826 | bless $self, "AnyEvent::Handle::destroyed"; |
|
|
1827 | } |
|
|
1828 | |
|
|
1829 | { |
|
|
1830 | package AnyEvent::Handle::destroyed; |
|
|
1831 | |
|
|
1832 | sub AUTOLOAD { |
|
|
1833 | #nop |
|
|
1834 | } |
1686 | } |
1835 | } |
1687 | |
1836 | |
1688 | =item AnyEvent::Handle::TLS_CTX |
1837 | =item AnyEvent::Handle::TLS_CTX |
1689 | |
1838 | |
1690 | This function creates and returns the AnyEvent::TLS object used by default |
1839 | This function creates and returns the AnyEvent::TLS object used by default |
… | |
… | |
1747 | |
1896 | |
1748 | $handle->on_read (sub { }); |
1897 | $handle->on_read (sub { }); |
1749 | $handle->on_eof (undef); |
1898 | $handle->on_eof (undef); |
1750 | $handle->on_error (sub { |
1899 | $handle->on_error (sub { |
1751 | my $data = delete $_[0]{rbuf}; |
1900 | my $data = delete $_[0]{rbuf}; |
1752 | undef $handle; |
|
|
1753 | }); |
1901 | }); |
1754 | |
1902 | |
1755 | The reason to use C<on_error> is that TCP connections, due to latencies |
1903 | The reason to use C<on_error> is that TCP connections, due to latencies |
1756 | and packets loss, might get closed quite violently with an error, when in |
1904 | and packets loss, might get closed quite violently with an error, when in |
1757 | fact, all data has been received. |
1905 | fact, all data has been received. |