1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
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.13; |
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 detcted, |
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 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. |
|
|
96 | |
|
|
97 | 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>. |
87 | |
99 | |
88 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal) |
89 | |
101 | |
90 | 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 |
91 | 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 |
92 | connect or a read error. |
104 | connect or a read error. |
93 | |
105 | |
94 | 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 |
95 | 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 | |
96 | 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 |
97 | recommended to simply ignore this parameter and instead abondon the handle |
113 | to simply ignore this parameter and instead abondon the handle object |
98 | 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>). |
99 | |
116 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
119 | |
103 | 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 |
… | |
… | |
105 | C<croak>. |
122 | C<croak>. |
106 | |
123 | |
107 | =item on_read => $cb->($handle) |
124 | =item on_read => $cb->($handle) |
108 | |
125 | |
109 | This sets the default read callback, which is called when data arrives |
126 | This sets the default read callback, which is called when data arrives |
110 | and no read request is in the queue. |
127 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
128 | callback will only be called when at least one octet of data is in the |
|
|
129 | read buffer). |
111 | |
130 | |
112 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
131 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
113 | method or access the C<$handle->{rbuf}> member directly. |
132 | method or access the C<$handle->{rbuf}> member directly. |
114 | |
133 | |
115 | When an EOF condition is detected then AnyEvent::Handle will first try to |
134 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
121 | |
140 | |
122 | This sets the callback that is called when the write buffer becomes empty |
141 | This sets the callback that is called when the write buffer becomes empty |
123 | (or when the callback is set and the buffer is empty already). |
142 | (or when the callback is set and the buffer is empty already). |
124 | |
143 | |
125 | To append to the write buffer, use the C<< ->push_write >> method. |
144 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
145 | |
|
|
146 | This callback is useful when you don't want to put all of your write data |
|
|
147 | into the queue at once, for example, when you want to write the contents |
|
|
148 | of some file to the socket you might not want to read the whole file into |
|
|
149 | memory and push it into the queue, but instead only read more data from |
|
|
150 | the file when the write queue becomes empty. |
126 | |
151 | |
127 | =item timeout => $fractional_seconds |
152 | =item timeout => $fractional_seconds |
128 | |
153 | |
129 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
154 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
130 | seconds pass without a successful read or write on the underlying file |
155 | seconds pass without a successful read or write on the underlying file |
… | |
… | |
154 | be configured to accept only so-and-so much data that it cannot act on |
179 | be configured to accept only so-and-so much data that it cannot act on |
155 | (for example, when expecting a line, an attacker could send an unlimited |
180 | (for example, when expecting a line, an attacker could send an unlimited |
156 | amount of data without a callback ever being called as long as the line |
181 | amount of data without a callback ever being called as long as the line |
157 | isn't finished). |
182 | isn't finished). |
158 | |
183 | |
|
|
184 | =item autocork => <boolean> |
|
|
185 | |
|
|
186 | When disabled (the default), then C<push_write> will try to immediately |
|
|
187 | write the data to the handle if possible. This avoids having to register |
|
|
188 | a write watcher and wait for the next event loop iteration, but can be |
|
|
189 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
190 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
191 | |
|
|
192 | When enabled, then writes will always be queued till the next event loop |
|
|
193 | iteration. This is efficient when you do many small writes per iteration, |
|
|
194 | but less efficient when you do a single write only. |
|
|
195 | |
|
|
196 | =item no_delay => <boolean> |
|
|
197 | |
|
|
198 | When doing small writes on sockets, your operating system kernel might |
|
|
199 | wait a bit for more data before actually sending it out. This is called |
|
|
200 | the Nagle algorithm, and usually it is beneficial. |
|
|
201 | |
|
|
202 | In some situations you want as low a delay as possible, which cna be |
|
|
203 | accomplishd by setting this option to true. |
|
|
204 | |
|
|
205 | The default is your opertaing system's default behaviour, this option |
|
|
206 | explicitly enables or disables it, if possible. |
|
|
207 | |
159 | =item read_size => <bytes> |
208 | =item read_size => <bytes> |
160 | |
209 | |
161 | The default read block size (the amount of bytes this module will try to read |
210 | The default read block size (the amount of bytes this module will try to read |
162 | during each (loop iteration). Default: C<8192>. |
211 | during each (loop iteration). Default: C<8192>. |
163 | |
212 | |
… | |
… | |
165 | |
214 | |
166 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
215 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
167 | buffer: If the write reaches this size or gets even samller it is |
216 | buffer: If the write reaches this size or gets even samller it is |
168 | considered empty. |
217 | considered empty. |
169 | |
218 | |
|
|
219 | =item linger => <seconds> |
|
|
220 | |
|
|
221 | If non-zero (default: C<3600>), then the destructor of the |
|
|
222 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
223 | data and will install a watcher that will write out this data. No errors |
|
|
224 | will be reported (this mostly matches how the operating system treats |
|
|
225 | outstanding data at socket close time). |
|
|
226 | |
|
|
227 | This will not work for partial TLS data that could not yet been |
|
|
228 | encoded. This data will be lost. |
|
|
229 | |
170 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
230 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
171 | |
231 | |
172 | 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 |
173 | will start making tls handshake and will transparently encrypt/decrypt |
233 | AnyEvent will start a TLS handshake and will transparently encrypt/decrypt |
174 | data. |
234 | data. |
175 | |
235 | |
176 | 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 |
177 | automatically when you try to create a TLS handle). |
237 | automatically when you try to create a TLS handle). |
178 | |
238 | |
179 | 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 |
180 | connection, use C<connect> mode. |
240 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
241 | mode. |
181 | |
242 | |
182 | 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 |
183 | 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> |
184 | 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 |
185 | AnyEvent::Handle. |
246 | AnyEvent::Handle. |
186 | |
247 | |
187 | 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. |
188 | |
249 | |
189 | =item tls_ctx => $ssl_ctx |
250 | =item tls_ctx => $ssl_ctx |
190 | |
251 | |
191 | 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 |
192 | (unless a connection object was specified directly). If this parameter is |
253 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
195 | =item json => JSON or JSON::XS object |
256 | =item json => JSON or JSON::XS object |
196 | |
257 | |
197 | 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. |
198 | |
259 | |
199 | 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 |
200 | 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. |
201 | |
263 | |
202 | 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 |
203 | use this functionality, as AnyEvent does not have a dependency itself. |
265 | use this functionality, as AnyEvent does not have a dependency itself. |
204 | |
266 | |
205 | =item filter_r => $cb |
267 | =item filter_r => $cb |
206 | |
268 | |
207 | =item filter_w => $cb |
269 | =item filter_w => $cb |
208 | |
270 | |
209 | 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). |
210 | |
273 | |
211 | =back |
274 | =back |
212 | |
275 | |
213 | =cut |
276 | =cut |
214 | |
277 | |
… | |
… | |
227 | } |
290 | } |
228 | |
291 | |
229 | $self->{_activity} = AnyEvent->now; |
292 | $self->{_activity} = AnyEvent->now; |
230 | $self->_timeout; |
293 | $self->_timeout; |
231 | |
294 | |
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
295 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
233 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
296 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
297 | |
|
|
298 | $self->start_read |
|
|
299 | if $self->{on_read}; |
234 | |
300 | |
235 | $self |
301 | $self |
236 | } |
302 | } |
237 | |
303 | |
238 | sub _shutdown { |
304 | sub _shutdown { |
… | |
… | |
242 | delete $self->{_rw}; |
308 | delete $self->{_rw}; |
243 | delete $self->{_ww}; |
309 | delete $self->{_ww}; |
244 | delete $self->{fh}; |
310 | delete $self->{fh}; |
245 | |
311 | |
246 | $self->stoptls; |
312 | $self->stoptls; |
|
|
313 | |
|
|
314 | delete $self->{on_read}; |
|
|
315 | delete $self->{_queue}; |
247 | } |
316 | } |
248 | |
317 | |
249 | sub _error { |
318 | sub _error { |
250 | my ($self, $errno, $fatal) = @_; |
319 | my ($self, $errno, $fatal) = @_; |
251 | |
320 | |
… | |
… | |
297 | |
366 | |
298 | =cut |
367 | =cut |
299 | |
368 | |
300 | sub on_timeout { |
369 | sub on_timeout { |
301 | $_[0]{on_timeout} = $_[1]; |
370 | $_[0]{on_timeout} = $_[1]; |
|
|
371 | } |
|
|
372 | |
|
|
373 | =item $handle->autocork ($boolean) |
|
|
374 | |
|
|
375 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
376 | constructor argument). |
|
|
377 | |
|
|
378 | =cut |
|
|
379 | |
|
|
380 | =item $handle->no_delay ($boolean) |
|
|
381 | |
|
|
382 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
383 | the same name for details). |
|
|
384 | |
|
|
385 | =cut |
|
|
386 | |
|
|
387 | sub no_delay { |
|
|
388 | $_[0]{no_delay} = $_[1]; |
|
|
389 | |
|
|
390 | eval { |
|
|
391 | local $SIG{__DIE__}; |
|
|
392 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
393 | }; |
302 | } |
394 | } |
303 | |
395 | |
304 | ############################################################################# |
396 | ############################################################################# |
305 | |
397 | |
306 | =item $handle->timeout ($seconds) |
398 | =item $handle->timeout ($seconds) |
… | |
… | |
421 | $self->_error ($!, 1); |
513 | $self->_error ($!, 1); |
422 | } |
514 | } |
423 | }; |
515 | }; |
424 | |
516 | |
425 | # try to write data immediately |
517 | # try to write data immediately |
426 | $cb->(); |
518 | $cb->() unless $self->{autocork}; |
427 | |
519 | |
428 | # if still data left in wbuf, we need to poll |
520 | # if still data left in wbuf, we need to poll |
429 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
521 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
430 | if length $self->{wbuf}; |
522 | if length $self->{wbuf}; |
431 | }; |
523 | }; |
… | |
… | |
476 | my ($self, $string) = @_; |
568 | my ($self, $string) = @_; |
477 | |
569 | |
478 | sprintf "%d:%s,", (length $string), $string |
570 | sprintf "%d:%s,", (length $string), $string |
479 | }; |
571 | }; |
480 | |
572 | |
|
|
573 | =item packstring => $format, $data |
|
|
574 | |
|
|
575 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
576 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
577 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
578 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
579 | |
|
|
580 | =cut |
|
|
581 | |
|
|
582 | register_write_type packstring => sub { |
|
|
583 | my ($self, $format, $string) = @_; |
|
|
584 | |
|
|
585 | pack "$format/a*", $string |
|
|
586 | }; |
|
|
587 | |
481 | =item json => $array_or_hashref |
588 | =item json => $array_or_hashref |
482 | |
589 | |
483 | Encodes the given hash or array reference into a JSON object. Unless you |
590 | Encodes the given hash or array reference into a JSON object. Unless you |
484 | provide your own JSON object, this means it will be encoded to JSON text |
591 | provide your own JSON object, this means it will be encoded to JSON text |
485 | in UTF-8. |
592 | in UTF-8. |
… | |
… | |
517 | |
624 | |
518 | $self->{json} ? $self->{json}->encode ($ref) |
625 | $self->{json} ? $self->{json}->encode ($ref) |
519 | : JSON::encode_json ($ref) |
626 | : JSON::encode_json ($ref) |
520 | }; |
627 | }; |
521 | |
628 | |
|
|
629 | =item storable => $reference |
|
|
630 | |
|
|
631 | Freezes the given reference using L<Storable> and writes it to the |
|
|
632 | handle. Uses the C<nfreeze> format. |
|
|
633 | |
|
|
634 | =cut |
|
|
635 | |
|
|
636 | register_write_type storable => sub { |
|
|
637 | my ($self, $ref) = @_; |
|
|
638 | |
|
|
639 | require Storable; |
|
|
640 | |
|
|
641 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
642 | }; |
|
|
643 | |
522 | =back |
644 | =back |
523 | |
645 | |
524 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
646 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
525 | |
647 | |
526 | This function (not method) lets you add your own types to C<push_write>. |
648 | This function (not method) lets you add your own types to C<push_write>. |
… | |
… | |
548 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
670 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
549 | a queue. |
671 | a queue. |
550 | |
672 | |
551 | In the simple case, you just install an C<on_read> callback and whenever |
673 | In the simple case, you just install an C<on_read> callback and whenever |
552 | new data arrives, it will be called. You can then remove some data (if |
674 | new data arrives, it will be called. You can then remove some data (if |
553 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
675 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
554 | or not. |
676 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
677 | partial message has been received so far). |
555 | |
678 | |
556 | In the more complex case, you want to queue multiple callbacks. In this |
679 | In the more complex case, you want to queue multiple callbacks. In this |
557 | case, AnyEvent::Handle will call the first queued callback each time new |
680 | case, AnyEvent::Handle will call the first queued callback each time new |
558 | data arrives and removes it when it has done its job (see C<push_read>, |
681 | data arrives (also the first time it is queued) and removes it when it has |
559 | below). |
682 | done its job (see C<push_read>, below). |
560 | |
683 | |
561 | This way you can, for example, push three line-reads, followed by reading |
684 | This way you can, for example, push three line-reads, followed by reading |
562 | a chunk of data, and AnyEvent::Handle will execute them in order. |
685 | a chunk of data, and AnyEvent::Handle will execute them in order. |
563 | |
686 | |
564 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
687 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
577 | # handle xml |
700 | # handle xml |
578 | }); |
701 | }); |
579 | }); |
702 | }); |
580 | }); |
703 | }); |
581 | |
704 | |
582 | Example 2: Implement a client for a protocol that replies either with |
705 | Example 2: Implement a client for a protocol that replies either with "OK" |
583 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
706 | and another line or "ERROR" for the first request that is sent, and 64 |
584 | second request. Due tot he availability of a full queue, we can just |
707 | bytes for the second request. Due to the availability of a queue, we can |
585 | pipeline sending both requests and manipulate the queue as necessary in |
708 | just pipeline sending both requests and manipulate the queue as necessary |
586 | the callbacks: |
709 | in the callbacks. |
587 | |
710 | |
588 | # request one |
711 | When the first callback is called and sees an "OK" response, it will |
|
|
712 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
713 | 64-byte chunk callback. |
|
|
714 | |
|
|
715 | # request one, returns either "OK + extra line" or "ERROR" |
589 | $handle->push_write ("request 1\015\012"); |
716 | $handle->push_write ("request 1\015\012"); |
590 | |
717 | |
591 | # we expect "ERROR" or "OK" as response, so push a line read |
718 | # we expect "ERROR" or "OK" as response, so push a line read |
592 | $handle->push_read (line => sub { |
719 | $handle->push_read (line => sub { |
593 | # if we got an "OK", we have to _prepend_ another line, |
720 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
600 | ... |
727 | ... |
601 | }); |
728 | }); |
602 | } |
729 | } |
603 | }); |
730 | }); |
604 | |
731 | |
605 | # request two |
732 | # request two, simply returns 64 octets |
606 | $handle->push_write ("request 2\015\012"); |
733 | $handle->push_write ("request 2\015\012"); |
607 | |
734 | |
608 | # simply read 64 bytes, always |
735 | # simply read 64 bytes, always |
609 | $handle->push_read (chunk => 64, sub { |
736 | $handle->push_read (chunk => 64, sub { |
610 | my $response = $_[1]; |
737 | my $response = $_[1]; |
… | |
… | |
622 | |
749 | |
623 | if ( |
750 | if ( |
624 | defined $self->{rbuf_max} |
751 | defined $self->{rbuf_max} |
625 | && $self->{rbuf_max} < length $self->{rbuf} |
752 | && $self->{rbuf_max} < length $self->{rbuf} |
626 | ) { |
753 | ) { |
627 | return $self->_error (&Errno::ENOSPC, 1); |
754 | $self->_error (&Errno::ENOSPC, 1), return; |
628 | } |
755 | } |
629 | |
756 | |
630 | while () { |
757 | while () { |
631 | no strict 'refs'; |
|
|
632 | |
|
|
633 | my $len = length $self->{rbuf}; |
758 | my $len = length $self->{rbuf}; |
634 | |
759 | |
635 | if (my $cb = shift @{ $self->{_queue} }) { |
760 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | unless ($cb->($self)) { |
761 | unless ($cb->($self)) { |
637 | if ($self->{_eof}) { |
762 | if ($self->{_eof}) { |
638 | # 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) |
639 | return $self->_error (&Errno::EPIPE, 1); |
764 | $self->_error (&Errno::EPIPE, 1), return; |
640 | } |
765 | } |
641 | |
766 | |
642 | unshift @{ $self->{_queue} }, $cb; |
767 | unshift @{ $self->{_queue} }, $cb; |
643 | last; |
768 | last; |
644 | } |
769 | } |
645 | } elsif ($self->{on_read}) { |
770 | } elsif ($self->{on_read}) { |
|
|
771 | last unless $len; |
|
|
772 | |
646 | $self->{on_read}($self); |
773 | $self->{on_read}($self); |
647 | |
774 | |
648 | if ( |
775 | if ( |
649 | $len == length $self->{rbuf} # if no data has been consumed |
776 | $len == length $self->{rbuf} # if no data has been consumed |
650 | && !@{ $self->{_queue} } # and the queue is still empty |
777 | && !@{ $self->{_queue} } # and the queue is still empty |
651 | && $self->{on_read} # but we still have on_read |
778 | && $self->{on_read} # but we still have on_read |
652 | ) { |
779 | ) { |
653 | # no further data will arrive |
780 | # no further data will arrive |
654 | # so no progress can be made |
781 | # so no progress can be made |
655 | return $self->_error (&Errno::EPIPE, 1) |
782 | $self->_error (&Errno::EPIPE, 1), return |
656 | if $self->{_eof}; |
783 | if $self->{_eof}; |
657 | |
784 | |
658 | last; # more data might arrive |
785 | last; # more data might arrive |
659 | } |
786 | } |
660 | } else { |
787 | } else { |
… | |
… | |
662 | delete $self->{_rw}; |
789 | delete $self->{_rw}; |
663 | last; |
790 | last; |
664 | } |
791 | } |
665 | } |
792 | } |
666 | |
793 | |
|
|
794 | if ($self->{_eof}) { |
|
|
795 | if ($self->{on_eof}) { |
667 | $self->{on_eof}($self) |
796 | $self->{on_eof}($self) |
668 | if $self->{_eof} && $self->{on_eof}; |
797 | } else { |
|
|
798 | $self->_error (0, 1); |
|
|
799 | } |
|
|
800 | } |
669 | |
801 | |
670 | # may need to restart read watcher |
802 | # may need to restart read watcher |
671 | unless ($self->{_rw}) { |
803 | unless ($self->{_rw}) { |
672 | $self->start_read |
804 | $self->start_read |
673 | if $self->{on_read} || @{ $self->{_queue} }; |
805 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
799 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
931 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
800 | 1 |
932 | 1 |
801 | } |
933 | } |
802 | }; |
934 | }; |
803 | |
935 | |
804 | # compatibility with older API |
|
|
805 | sub push_read_chunk { |
|
|
806 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
807 | } |
|
|
808 | |
|
|
809 | sub unshift_read_chunk { |
|
|
810 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
811 | } |
|
|
812 | |
|
|
813 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
936 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
814 | |
937 | |
815 | The callback will be called only once a full line (including the end of |
938 | The callback will be called only once a full line (including the end of |
816 | line marker, C<$eol>) has been read. This line (excluding the end of line |
939 | line marker, C<$eol>) has been read. This line (excluding the end of line |
817 | marker) will be passed to the callback as second argument (C<$line>), and |
940 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
832 | =cut |
955 | =cut |
833 | |
956 | |
834 | register_read_type line => sub { |
957 | register_read_type line => sub { |
835 | my ($self, $cb, $eol) = @_; |
958 | my ($self, $cb, $eol) = @_; |
836 | |
959 | |
837 | $eol = qr|(\015?\012)| if @_ < 3; |
960 | if (@_ < 3) { |
838 | $eol = quotemeta $eol unless ref $eol; |
961 | # this is more than twice as fast as the generic code below |
839 | $eol = qr|^(.*?)($eol)|s; |
|
|
840 | |
|
|
841 | sub { |
962 | sub { |
842 | $_[0]{rbuf} =~ s/$eol// or return; |
963 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
843 | |
964 | |
844 | $cb->($_[0], $1, $2); |
965 | $cb->($_[0], $1, $2); |
845 | 1 |
|
|
846 | } |
|
|
847 | }; |
|
|
848 | |
|
|
849 | # compatibility with older API |
|
|
850 | sub push_read_line { |
|
|
851 | my $self = shift; |
|
|
852 | $self->push_read (line => @_); |
|
|
853 | } |
|
|
854 | |
|
|
855 | sub unshift_read_line { |
|
|
856 | my $self = shift; |
|
|
857 | $self->unshift_read (line => @_); |
|
|
858 | } |
|
|
859 | |
|
|
860 | =item netstring => $cb->($handle, $string) |
|
|
861 | |
|
|
862 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
863 | |
|
|
864 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
865 | |
|
|
866 | =cut |
|
|
867 | |
|
|
868 | register_read_type netstring => sub { |
|
|
869 | my ($self, $cb) = @_; |
|
|
870 | |
|
|
871 | sub { |
|
|
872 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
873 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
874 | $self->_error (&Errno::EBADMSG); |
|
|
875 | } |
966 | 1 |
876 | return; |
|
|
877 | } |
967 | } |
|
|
968 | } else { |
|
|
969 | $eol = quotemeta $eol unless ref $eol; |
|
|
970 | $eol = qr|^(.*?)($eol)|s; |
878 | |
971 | |
879 | my $len = $1; |
972 | sub { |
|
|
973 | $_[0]{rbuf} =~ s/$eol// or return; |
880 | |
974 | |
881 | $self->unshift_read (chunk => $len, sub { |
975 | $cb->($_[0], $1, $2); |
882 | my $string = $_[1]; |
|
|
883 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
884 | if ($_[1] eq ",") { |
|
|
885 | $cb->($_[0], $string); |
|
|
886 | } else { |
|
|
887 | $self->_error (&Errno::EBADMSG); |
|
|
888 | } |
|
|
889 | }); |
976 | 1 |
890 | }); |
977 | } |
891 | |
|
|
892 | 1 |
|
|
893 | } |
978 | } |
894 | }; |
979 | }; |
895 | |
980 | |
896 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
981 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
897 | |
982 | |
… | |
… | |
961 | |
1046 | |
962 | () |
1047 | () |
963 | } |
1048 | } |
964 | }; |
1049 | }; |
965 | |
1050 | |
|
|
1051 | =item netstring => $cb->($handle, $string) |
|
|
1052 | |
|
|
1053 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1054 | |
|
|
1055 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1056 | |
|
|
1057 | =cut |
|
|
1058 | |
|
|
1059 | register_read_type netstring => sub { |
|
|
1060 | my ($self, $cb) = @_; |
|
|
1061 | |
|
|
1062 | sub { |
|
|
1063 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1064 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1065 | $self->_error (&Errno::EBADMSG); |
|
|
1066 | } |
|
|
1067 | return; |
|
|
1068 | } |
|
|
1069 | |
|
|
1070 | my $len = $1; |
|
|
1071 | |
|
|
1072 | $self->unshift_read (chunk => $len, sub { |
|
|
1073 | my $string = $_[1]; |
|
|
1074 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1075 | if ($_[1] eq ",") { |
|
|
1076 | $cb->($_[0], $string); |
|
|
1077 | } else { |
|
|
1078 | $self->_error (&Errno::EBADMSG); |
|
|
1079 | } |
|
|
1080 | }); |
|
|
1081 | }); |
|
|
1082 | |
|
|
1083 | 1 |
|
|
1084 | } |
|
|
1085 | }; |
|
|
1086 | |
|
|
1087 | =item packstring => $format, $cb->($handle, $string) |
|
|
1088 | |
|
|
1089 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1090 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1091 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1092 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1093 | |
|
|
1094 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1095 | |
|
|
1096 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1097 | format (very efficient). |
|
|
1098 | |
|
|
1099 | $handle->push_read (packstring => "w", sub { |
|
|
1100 | my ($handle, $data) = @_; |
|
|
1101 | }); |
|
|
1102 | |
|
|
1103 | =cut |
|
|
1104 | |
|
|
1105 | register_read_type packstring => sub { |
|
|
1106 | my ($self, $cb, $format) = @_; |
|
|
1107 | |
|
|
1108 | sub { |
|
|
1109 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1110 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1111 | or return; |
|
|
1112 | |
|
|
1113 | $format = length pack $format, $len; |
|
|
1114 | |
|
|
1115 | # bypass unshift if we already have the remaining chunk |
|
|
1116 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1117 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1118 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1119 | $cb->($_[0], $data); |
|
|
1120 | } else { |
|
|
1121 | # remove prefix |
|
|
1122 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1123 | |
|
|
1124 | # read remaining chunk |
|
|
1125 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1126 | } |
|
|
1127 | |
|
|
1128 | 1 |
|
|
1129 | } |
|
|
1130 | }; |
|
|
1131 | |
966 | =item json => $cb->($handle, $hash_or_arrayref) |
1132 | =item json => $cb->($handle, $hash_or_arrayref) |
967 | |
1133 | |
968 | Reads a JSON object or array, decodes it and passes it to the callback. |
1134 | Reads a JSON object or array, decodes it and passes it to the callback. |
969 | |
1135 | |
970 | If a C<json> object was passed to the constructor, then that will be used |
1136 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
980 | the C<json> write type description, above, for an actual example. |
1146 | the C<json> write type description, above, for an actual example. |
981 | |
1147 | |
982 | =cut |
1148 | =cut |
983 | |
1149 | |
984 | register_read_type json => sub { |
1150 | register_read_type json => sub { |
985 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1151 | my ($self, $cb) = @_; |
986 | |
1152 | |
987 | require JSON; |
1153 | require JSON; |
988 | |
1154 | |
989 | my $data; |
1155 | my $data; |
990 | my $rbuf = \$self->{rbuf}; |
1156 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1002 | 1 |
1168 | 1 |
1003 | } else { |
1169 | } else { |
1004 | $self->{rbuf} = ""; |
1170 | $self->{rbuf} = ""; |
1005 | () |
1171 | () |
1006 | } |
1172 | } |
|
|
1173 | } |
|
|
1174 | }; |
|
|
1175 | |
|
|
1176 | =item storable => $cb->($handle, $ref) |
|
|
1177 | |
|
|
1178 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1179 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1180 | data). |
|
|
1181 | |
|
|
1182 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1183 | |
|
|
1184 | =cut |
|
|
1185 | |
|
|
1186 | register_read_type storable => sub { |
|
|
1187 | my ($self, $cb) = @_; |
|
|
1188 | |
|
|
1189 | require Storable; |
|
|
1190 | |
|
|
1191 | sub { |
|
|
1192 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1193 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1194 | or return; |
|
|
1195 | |
|
|
1196 | my $format = length pack "w", $len; |
|
|
1197 | |
|
|
1198 | # bypass unshift if we already have the remaining chunk |
|
|
1199 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1200 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1201 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1202 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1203 | } else { |
|
|
1204 | # remove prefix |
|
|
1205 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1206 | |
|
|
1207 | # read remaining chunk |
|
|
1208 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1209 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1210 | $cb->($_[0], $ref); |
|
|
1211 | } else { |
|
|
1212 | $self->_error (&Errno::EBADMSG); |
|
|
1213 | } |
|
|
1214 | }); |
|
|
1215 | } |
|
|
1216 | |
|
|
1217 | 1 |
1007 | } |
1218 | } |
1008 | }; |
1219 | }; |
1009 | |
1220 | |
1010 | =back |
1221 | =back |
1011 | |
1222 | |
… | |
… | |
1157 | # 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) |
1158 | # but the openssl maintainers basically said: "trust us, it just works". |
1369 | # but the openssl maintainers basically said: "trust us, it just works". |
1159 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1370 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1160 | # and mismaintained ssleay-module doesn't even offer them). |
1371 | # and mismaintained ssleay-module doesn't even offer them). |
1161 | # 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. |
1162 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1379 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1163 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1380 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1164 | | (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)); |
1165 | |
1382 | |
1166 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1383 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
… | |
… | |
1199 | |
1416 | |
1200 | sub DESTROY { |
1417 | sub DESTROY { |
1201 | my $self = shift; |
1418 | my $self = shift; |
1202 | |
1419 | |
1203 | $self->stoptls; |
1420 | $self->stoptls; |
|
|
1421 | |
|
|
1422 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1423 | |
|
|
1424 | if ($linger && length $self->{wbuf}) { |
|
|
1425 | my $fh = delete $self->{fh}; |
|
|
1426 | my $wbuf = delete $self->{wbuf}; |
|
|
1427 | |
|
|
1428 | my @linger; |
|
|
1429 | |
|
|
1430 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1431 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1432 | |
|
|
1433 | if ($len > 0) { |
|
|
1434 | substr $wbuf, 0, $len, ""; |
|
|
1435 | } else { |
|
|
1436 | @linger = (); # end |
|
|
1437 | } |
|
|
1438 | }); |
|
|
1439 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1440 | @linger = (); |
|
|
1441 | }); |
|
|
1442 | } |
1204 | } |
1443 | } |
1205 | |
1444 | |
1206 | =item AnyEvent::Handle::TLS_CTX |
1445 | =item AnyEvent::Handle::TLS_CTX |
1207 | |
1446 | |
1208 | This function creates and returns the Net::SSLeay::CTX object used by |
1447 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1250 | =over 4 |
1489 | =over 4 |
1251 | |
1490 | |
1252 | =item * all constructor arguments become object members. |
1491 | =item * all constructor arguments become object members. |
1253 | |
1492 | |
1254 | At least initially, when you pass a C<tls>-argument to the constructor it |
1493 | At least initially, when you pass a C<tls>-argument to the constructor it |
1255 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1494 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1256 | mutated later on (for example C<tls> will hold the TLS connection object). |
1495 | mutated later on (for example C<tls> will hold the TLS connection object). |
1257 | |
1496 | |
1258 | =item * other object member names are prefixed with an C<_>. |
1497 | =item * other object member names are prefixed with an C<_>. |
1259 | |
1498 | |
1260 | All object members not explicitly documented (internal use) are prefixed |
1499 | All object members not explicitly documented (internal use) are prefixed |