… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = 4.22; |
19 | our $VERSION = 4.232; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
49 | |
49 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | 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 |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | 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 |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called when an end-of-file condition is detected, |
84 | Set the callback to be called when an end-of-file condition is detected, |
81 | i.e. in the case of a socket, when the other side has closed the |
85 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
86 | connection cleanly. |
83 | |
87 | |
|
|
88 | 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 |
|
|
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
|
|
92 | |
84 | While not mandatory, it is I<highly> recommended to set an eof callback, |
93 | While not mandatory, it is I<highly> recommended to set an eof callback, |
85 | otherwise you might end up with a closed socket while you are still |
94 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
95 | waiting for data. |
87 | |
96 | |
88 | If an EOF condition has been detected but no C<on_eof> callback has been |
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
… | |
… | |
93 | This is the error callback, which is called when, well, some error |
102 | This is the error callback, which is called when, well, some error |
94 | occured, such as not being able to resolve the hostname, failure to |
103 | occured, such as not being able to resolve the hostname, failure to |
95 | connect or a read error. |
104 | connect or a read error. |
96 | |
105 | |
97 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
98 | fatal errors the handle object will be shut down and will not be |
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 | |
99 | usable. Non-fatal errors can be retried by simply returning, but it is |
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
100 | recommended to simply ignore this parameter and instead abondon the handle |
113 | to simply ignore this parameter and instead abondon the handle object |
101 | object when this callback is invoked. |
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
102 | |
116 | |
103 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
104 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
105 | |
119 | |
106 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
213 | This will not work for partial TLS data that could not yet been |
227 | This will not work for partial TLS data that could not yet been |
214 | encoded. This data will be lost. |
228 | encoded. This data will be lost. |
215 | |
229 | |
216 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
230 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
217 | |
231 | |
218 | When this parameter is given, it enables TLS (SSL) mode, that means it |
232 | When this parameter is given, it enables TLS (SSL) mode, that means |
219 | will start making tls handshake and will transparently encrypt/decrypt |
233 | AnyEvent will start a TLS handshake and will transparently encrypt/decrypt |
220 | data. |
234 | data. |
221 | |
235 | |
222 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
236 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
223 | automatically when you try to create a TLS handle). |
237 | automatically when you try to create a TLS handle). |
224 | |
238 | |
225 | For the TLS server side, use C<accept>, and for the TLS client side of a |
239 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
226 | connection, use C<connect> mode. |
240 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
241 | mode. |
227 | |
242 | |
228 | You can also provide your own TLS connection object, but you have |
243 | You can also provide your own TLS connection object, but you have |
229 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
244 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
230 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
245 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
231 | AnyEvent::Handle. |
246 | AnyEvent::Handle. |
232 | |
247 | |
233 | See the C<starttls> method if you need to start TLS negotiation later. |
248 | See the C<starttls> method for when need to start TLS negotiation later. |
234 | |
249 | |
235 | =item tls_ctx => $ssl_ctx |
250 | =item tls_ctx => $ssl_ctx |
236 | |
251 | |
237 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
252 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
238 | (unless a connection object was specified directly). If this parameter is |
253 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
241 | =item json => JSON or JSON::XS object |
256 | =item json => JSON or JSON::XS object |
242 | |
257 | |
243 | This is the json coder object used by the C<json> read and write types. |
258 | This is the json coder object used by the C<json> read and write types. |
244 | |
259 | |
245 | If you don't supply it, then AnyEvent::Handle will create and use a |
260 | If you don't supply it, then AnyEvent::Handle will create and use a |
246 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
261 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
262 | texts. |
247 | |
263 | |
248 | Note that you are responsible to depend on the JSON module if you want to |
264 | Note that you are responsible to depend on the JSON module if you want to |
249 | use this functionality, as AnyEvent does not have a dependency itself. |
265 | use this functionality, as AnyEvent does not have a dependency itself. |
250 | |
266 | |
251 | =item filter_r => $cb |
267 | =item filter_r => $cb |
252 | |
268 | |
253 | =item filter_w => $cb |
269 | =item filter_w => $cb |
254 | |
270 | |
255 | These exist, but are undocumented at this time. |
271 | These exist, but are undocumented at this time. (They are used internally |
|
|
272 | by the TLS code). |
256 | |
273 | |
257 | =back |
274 | =back |
258 | |
275 | |
259 | =cut |
276 | =cut |
260 | |
277 | |
… | |
… | |
291 | delete $self->{_rw}; |
308 | delete $self->{_rw}; |
292 | delete $self->{_ww}; |
309 | delete $self->{_ww}; |
293 | delete $self->{fh}; |
310 | delete $self->{fh}; |
294 | |
311 | |
295 | $self->stoptls; |
312 | $self->stoptls; |
|
|
313 | |
|
|
314 | delete $self->{on_read}; |
|
|
315 | delete $self->{_queue}; |
296 | } |
316 | } |
297 | |
317 | |
298 | sub _error { |
318 | sub _error { |
299 | my ($self, $errno, $fatal) = @_; |
319 | my ($self, $errno, $fatal) = @_; |
300 | |
320 | |
… | |
… | |
729 | |
749 | |
730 | if ( |
750 | if ( |
731 | defined $self->{rbuf_max} |
751 | defined $self->{rbuf_max} |
732 | && $self->{rbuf_max} < length $self->{rbuf} |
752 | && $self->{rbuf_max} < length $self->{rbuf} |
733 | ) { |
753 | ) { |
734 | return $self->_error (&Errno::ENOSPC, 1); |
754 | $self->_error (&Errno::ENOSPC, 1), return; |
735 | } |
755 | } |
736 | |
756 | |
737 | while () { |
757 | while () { |
738 | my $len = length $self->{rbuf}; |
758 | my $len = length $self->{rbuf}; |
739 | |
759 | |
740 | if (my $cb = shift @{ $self->{_queue} }) { |
760 | if (my $cb = shift @{ $self->{_queue} }) { |
741 | unless ($cb->($self)) { |
761 | unless ($cb->($self)) { |
742 | if ($self->{_eof}) { |
762 | if ($self->{_eof}) { |
743 | # no progress can be made (not enough data and no data forthcoming) |
763 | # no progress can be made (not enough data and no data forthcoming) |
744 | $self->_error (&Errno::EPIPE, 1), last; |
764 | $self->_error (&Errno::EPIPE, 1), return; |
745 | } |
765 | } |
746 | |
766 | |
747 | unshift @{ $self->{_queue} }, $cb; |
767 | unshift @{ $self->{_queue} }, $cb; |
748 | last; |
768 | last; |
749 | } |
769 | } |
… | |
… | |
757 | && !@{ $self->{_queue} } # and the queue is still empty |
777 | && !@{ $self->{_queue} } # and the queue is still empty |
758 | && $self->{on_read} # but we still have on_read |
778 | && $self->{on_read} # but we still have on_read |
759 | ) { |
779 | ) { |
760 | # no further data will arrive |
780 | # no further data will arrive |
761 | # so no progress can be made |
781 | # so no progress can be made |
762 | $self->_error (&Errno::EPIPE, 1), last |
782 | $self->_error (&Errno::EPIPE, 1), return |
763 | if $self->{_eof}; |
783 | if $self->{_eof}; |
764 | |
784 | |
765 | last; # more data might arrive |
785 | last; # more data might arrive |
766 | } |
786 | } |
767 | } else { |
787 | } else { |
… | |
… | |
1348 | # basically, this is deep magic (because SSL_read should have the same issues) |
1368 | # basically, this is deep magic (because SSL_read should have the same issues) |
1349 | # but the openssl maintainers basically said: "trust us, it just works". |
1369 | # but the openssl maintainers basically said: "trust us, it just works". |
1350 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1370 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1351 | # and mismaintained ssleay-module doesn't even offer them). |
1371 | # and mismaintained ssleay-module doesn't even offer them). |
1352 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1372 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1373 | # |
|
|
1374 | # in short: this is a mess. |
|
|
1375 | # |
|
|
1376 | # note that we do not try to kepe the length constant between writes as we are required to do. |
|
|
1377 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1378 | # and we drive openssl fully in blocking mode here. |
1353 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1379 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1354 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1380 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1355 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1381 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1356 | |
1382 | |
1357 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1383 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |