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 = '0.04'; |
19 | our $VERSION = 4.22; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
76 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
77 | |
77 | |
78 | =item on_eof => $cb->($handle) |
78 | =item on_eof => $cb->($handle) |
79 | |
79 | |
80 | Set the callback to be called on EOF. |
80 | 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 |
|
|
82 | connection cleanly. |
81 | |
83 | |
82 | While not mandatory, it is highly recommended to set an eof callback, |
84 | While not mandatory, it is I<highly> recommended to set an eof callback, |
83 | otherwise you might end up with a closed socket while you are still |
85 | otherwise you might end up with a closed socket while you are still |
84 | waiting for data. |
86 | waiting for data. |
85 | |
87 | |
|
|
88 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
89 | set, then a fatal error will be raised with C<$!> set to <0>. |
|
|
90 | |
86 | =item on_error => $cb->($handle) |
91 | =item on_error => $cb->($handle, $fatal) |
87 | |
92 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
93 | This is the error callback, which is called when, well, some error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
94 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
95 | connect or a read error. |
91 | |
96 | |
92 | The object will not be in a usable state when this callback has been |
97 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
98 | fatal errors the handle object will be shut down and will not be |
|
|
99 | usable. Non-fatal errors can be retried by simply returning, but it is |
|
|
100 | recommended to simply ignore this parameter and instead abondon the handle |
|
|
101 | object when this callback is invoked. |
94 | |
102 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
103 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
104 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
105 | |
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
|
|
100 | |
|
|
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
106 | While not mandatory, it is I<highly> recommended to set this callback, as |
102 | you will not be notified of errors otherwise. The default simply calls |
107 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
108 | C<croak>. |
104 | |
109 | |
105 | =item on_read => $cb->($handle) |
110 | =item on_read => $cb->($handle) |
106 | |
111 | |
107 | This sets the default read callback, which is called when data arrives |
112 | This sets the default read callback, which is called when data arrives |
108 | and no read request is in the queue. |
113 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
114 | callback will only be called when at least one octet of data is in the |
|
|
115 | read buffer). |
109 | |
116 | |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
117 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
111 | method or access the C<$handle->{rbuf}> member directly. |
118 | method or access the C<$handle->{rbuf}> member directly. |
112 | |
119 | |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
120 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
119 | |
126 | |
120 | This sets the callback that is called when the write buffer becomes empty |
127 | This sets the callback that is called when the write buffer becomes empty |
121 | (or when the callback is set and the buffer is empty already). |
128 | (or when the callback is set and the buffer is empty already). |
122 | |
129 | |
123 | To append to the write buffer, use the C<< ->push_write >> method. |
130 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
131 | |
|
|
132 | This callback is useful when you don't want to put all of your write data |
|
|
133 | into the queue at once, for example, when you want to write the contents |
|
|
134 | of some file to the socket you might not want to read the whole file into |
|
|
135 | memory and push it into the queue, but instead only read more data from |
|
|
136 | the file when the write queue becomes empty. |
124 | |
137 | |
125 | =item timeout => $fractional_seconds |
138 | =item timeout => $fractional_seconds |
126 | |
139 | |
127 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
140 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
128 | seconds pass without a successful read or write on the underlying file |
141 | seconds pass without a successful read or write on the underlying file |
… | |
… | |
152 | be configured to accept only so-and-so much data that it cannot act on |
165 | be configured to accept only so-and-so much data that it cannot act on |
153 | (for example, when expecting a line, an attacker could send an unlimited |
166 | (for example, when expecting a line, an attacker could send an unlimited |
154 | amount of data without a callback ever being called as long as the line |
167 | amount of data without a callback ever being called as long as the line |
155 | isn't finished). |
168 | isn't finished). |
156 | |
169 | |
|
|
170 | =item autocork => <boolean> |
|
|
171 | |
|
|
172 | When disabled (the default), then C<push_write> will try to immediately |
|
|
173 | write the data to the handle if possible. This avoids having to register |
|
|
174 | a write watcher and wait for the next event loop iteration, but can be |
|
|
175 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
176 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
177 | |
|
|
178 | When enabled, then writes will always be queued till the next event loop |
|
|
179 | iteration. This is efficient when you do many small writes per iteration, |
|
|
180 | but less efficient when you do a single write only. |
|
|
181 | |
|
|
182 | =item no_delay => <boolean> |
|
|
183 | |
|
|
184 | When doing small writes on sockets, your operating system kernel might |
|
|
185 | wait a bit for more data before actually sending it out. This is called |
|
|
186 | the Nagle algorithm, and usually it is beneficial. |
|
|
187 | |
|
|
188 | In some situations you want as low a delay as possible, which cna be |
|
|
189 | accomplishd by setting this option to true. |
|
|
190 | |
|
|
191 | The default is your opertaing system's default behaviour, this option |
|
|
192 | explicitly enables or disables it, if possible. |
|
|
193 | |
157 | =item read_size => <bytes> |
194 | =item read_size => <bytes> |
158 | |
195 | |
159 | The default read block size (the amount of bytes this module will try to read |
196 | The default read block size (the amount of bytes this module will try to read |
160 | during each (loop iteration). Default: C<8192>. |
197 | during each (loop iteration). Default: C<8192>. |
161 | |
198 | |
162 | =item low_water_mark => <bytes> |
199 | =item low_water_mark => <bytes> |
163 | |
200 | |
164 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
201 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
165 | buffer: If the write reaches this size or gets even samller it is |
202 | buffer: If the write reaches this size or gets even samller it is |
166 | considered empty. |
203 | considered empty. |
|
|
204 | |
|
|
205 | =item linger => <seconds> |
|
|
206 | |
|
|
207 | If non-zero (default: C<3600>), then the destructor of the |
|
|
208 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
209 | data and will install a watcher that will write out this data. No errors |
|
|
210 | will be reported (this mostly matches how the operating system treats |
|
|
211 | outstanding data at socket close time). |
|
|
212 | |
|
|
213 | This will not work for partial TLS data that could not yet been |
|
|
214 | encoded. This data will be lost. |
167 | |
215 | |
168 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
216 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
169 | |
217 | |
170 | When this parameter is given, it enables TLS (SSL) mode, that means it |
218 | When this parameter is given, it enables TLS (SSL) mode, that means it |
171 | will start making tls handshake and will transparently encrypt/decrypt |
219 | will start making tls handshake and will transparently encrypt/decrypt |
… | |
… | |
180 | You can also provide your own TLS connection object, but you have |
228 | You can also provide your own TLS connection object, but you have |
181 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
229 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
182 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
230 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
183 | AnyEvent::Handle. |
231 | AnyEvent::Handle. |
184 | |
232 | |
185 | See the C<starttls> method if you need to start TLs negotiation later. |
233 | See the C<starttls> method if you need to start TLS negotiation later. |
186 | |
234 | |
187 | =item tls_ctx => $ssl_ctx |
235 | =item tls_ctx => $ssl_ctx |
188 | |
236 | |
189 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
237 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
190 | (unless a connection object was specified directly). If this parameter is |
238 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
222 | if ($self->{tls}) { |
270 | if ($self->{tls}) { |
223 | require Net::SSLeay; |
271 | require Net::SSLeay; |
224 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
272 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
225 | } |
273 | } |
226 | |
274 | |
227 | # $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop |
|
|
228 | # $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop |
|
|
229 | # $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop |
|
|
230 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
|
|
231 | |
|
|
232 | $self->{_activity} = AnyEvent->now; |
275 | $self->{_activity} = AnyEvent->now; |
233 | $self->_timeout; |
276 | $self->_timeout; |
234 | |
277 | |
|
|
278 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
279 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
280 | |
235 | $self->start_read; |
281 | $self->start_read |
|
|
282 | if $self->{on_read}; |
236 | |
283 | |
237 | $self |
284 | $self |
238 | } |
285 | } |
239 | |
286 | |
240 | sub _shutdown { |
287 | sub _shutdown { |
… | |
… | |
242 | |
289 | |
243 | delete $self->{_tw}; |
290 | delete $self->{_tw}; |
244 | delete $self->{_rw}; |
291 | delete $self->{_rw}; |
245 | delete $self->{_ww}; |
292 | delete $self->{_ww}; |
246 | delete $self->{fh}; |
293 | delete $self->{fh}; |
247 | } |
|
|
248 | |
294 | |
|
|
295 | $self->stoptls; |
|
|
296 | } |
|
|
297 | |
249 | sub error { |
298 | sub _error { |
250 | my ($self) = @_; |
299 | my ($self, $errno, $fatal) = @_; |
251 | |
300 | |
252 | { |
|
|
253 | local $!; |
|
|
254 | $self->_shutdown; |
301 | $self->_shutdown |
255 | } |
302 | if $fatal; |
256 | |
303 | |
257 | $self->{on_error}($self) |
304 | $! = $errno; |
|
|
305 | |
258 | if $self->{on_error}; |
306 | if ($self->{on_error}) { |
259 | |
307 | $self->{on_error}($self, $fatal); |
|
|
308 | } else { |
260 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
309 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
|
|
310 | } |
261 | } |
311 | } |
262 | |
312 | |
263 | =item $fh = $handle->fh |
313 | =item $fh = $handle->fh |
264 | |
314 | |
265 | This method returns the file handle of the L<AnyEvent::Handle> object. |
315 | This method returns the file handle of the L<AnyEvent::Handle> object. |
… | |
… | |
296 | |
346 | |
297 | =cut |
347 | =cut |
298 | |
348 | |
299 | sub on_timeout { |
349 | sub on_timeout { |
300 | $_[0]{on_timeout} = $_[1]; |
350 | $_[0]{on_timeout} = $_[1]; |
|
|
351 | } |
|
|
352 | |
|
|
353 | =item $handle->autocork ($boolean) |
|
|
354 | |
|
|
355 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
356 | constructor argument). |
|
|
357 | |
|
|
358 | =cut |
|
|
359 | |
|
|
360 | =item $handle->no_delay ($boolean) |
|
|
361 | |
|
|
362 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
363 | the same name for details). |
|
|
364 | |
|
|
365 | =cut |
|
|
366 | |
|
|
367 | sub no_delay { |
|
|
368 | $_[0]{no_delay} = $_[1]; |
|
|
369 | |
|
|
370 | eval { |
|
|
371 | local $SIG{__DIE__}; |
|
|
372 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
373 | }; |
301 | } |
374 | } |
302 | |
375 | |
303 | ############################################################################# |
376 | ############################################################################# |
304 | |
377 | |
305 | =item $handle->timeout ($seconds) |
378 | =item $handle->timeout ($seconds) |
… | |
… | |
329 | # now or in the past already? |
402 | # now or in the past already? |
330 | if ($after <= 0) { |
403 | if ($after <= 0) { |
331 | $self->{_activity} = $NOW; |
404 | $self->{_activity} = $NOW; |
332 | |
405 | |
333 | if ($self->{on_timeout}) { |
406 | if ($self->{on_timeout}) { |
334 | $self->{on_timeout}->($self); |
407 | $self->{on_timeout}($self); |
335 | } else { |
408 | } else { |
336 | $! = Errno::ETIMEDOUT; |
409 | $self->_error (&Errno::ETIMEDOUT); |
337 | $self->error; |
|
|
338 | } |
410 | } |
339 | |
411 | |
340 | # callbakx could have changed timeout value, optimise |
412 | # callback could have changed timeout value, optimise |
341 | return unless $self->{timeout}; |
413 | return unless $self->{timeout}; |
342 | |
414 | |
343 | # calculate new after |
415 | # calculate new after |
344 | $after = $self->{timeout}; |
416 | $after = $self->{timeout}; |
345 | } |
417 | } |
346 | |
418 | |
347 | Scalar::Util::weaken $self; |
419 | Scalar::Util::weaken $self; |
|
|
420 | return unless $self; # ->error could have destroyed $self |
348 | |
421 | |
349 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
422 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
350 | delete $self->{_tw}; |
423 | delete $self->{_tw}; |
351 | $self->_timeout; |
424 | $self->_timeout; |
352 | }); |
425 | }); |
… | |
… | |
415 | if $self->{low_water_mark} >= length $self->{wbuf} |
488 | if $self->{low_water_mark} >= length $self->{wbuf} |
416 | && $self->{on_drain}; |
489 | && $self->{on_drain}; |
417 | |
490 | |
418 | delete $self->{_ww} unless length $self->{wbuf}; |
491 | delete $self->{_ww} unless length $self->{wbuf}; |
419 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
492 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
420 | $self->error; |
493 | $self->_error ($!, 1); |
421 | } |
494 | } |
422 | }; |
495 | }; |
423 | |
496 | |
424 | # try to write data immediately |
497 | # try to write data immediately |
425 | $cb->(); |
498 | $cb->() unless $self->{autocork}; |
426 | |
499 | |
427 | # if still data left in wbuf, we need to poll |
500 | # if still data left in wbuf, we need to poll |
428 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
501 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
429 | if length $self->{wbuf}; |
502 | if length $self->{wbuf}; |
430 | }; |
503 | }; |
… | |
… | |
445 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
518 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
446 | ->($self, @_); |
519 | ->($self, @_); |
447 | } |
520 | } |
448 | |
521 | |
449 | if ($self->{filter_w}) { |
522 | if ($self->{filter_w}) { |
450 | $self->{filter_w}->($self, \$_[0]); |
523 | $self->{filter_w}($self, \$_[0]); |
451 | } else { |
524 | } else { |
452 | $self->{wbuf} .= $_[0]; |
525 | $self->{wbuf} .= $_[0]; |
453 | $self->_drain_wbuf; |
526 | $self->_drain_wbuf; |
454 | } |
527 | } |
455 | } |
528 | } |
456 | |
529 | |
457 | =item $handle->push_write (type => @args) |
530 | =item $handle->push_write (type => @args) |
458 | |
531 | |
459 | =item $handle->unshift_write (type => @args) |
|
|
460 | |
|
|
461 | Instead of formatting your data yourself, you can also let this module do |
532 | Instead of formatting your data yourself, you can also let this module do |
462 | the job by specifying a type and type-specific arguments. |
533 | the job by specifying a type and type-specific arguments. |
463 | |
534 | |
464 | Predefined types are (if you have ideas for additional types, feel free to |
535 | Predefined types are (if you have ideas for additional types, feel free to |
465 | drop by and tell us): |
536 | drop by and tell us): |
… | |
… | |
469 | =item netstring => $string |
540 | =item netstring => $string |
470 | |
541 | |
471 | Formats the given value as netstring |
542 | Formats the given value as netstring |
472 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
543 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
473 | |
544 | |
474 | =back |
|
|
475 | |
|
|
476 | =cut |
545 | =cut |
477 | |
546 | |
478 | register_write_type netstring => sub { |
547 | register_write_type netstring => sub { |
479 | my ($self, $string) = @_; |
548 | my ($self, $string) = @_; |
480 | |
549 | |
481 | sprintf "%d:%s,", (length $string), $string |
550 | sprintf "%d:%s,", (length $string), $string |
|
|
551 | }; |
|
|
552 | |
|
|
553 | =item packstring => $format, $data |
|
|
554 | |
|
|
555 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
556 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
557 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
558 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
559 | |
|
|
560 | =cut |
|
|
561 | |
|
|
562 | register_write_type packstring => sub { |
|
|
563 | my ($self, $format, $string) = @_; |
|
|
564 | |
|
|
565 | pack "$format/a*", $string |
482 | }; |
566 | }; |
483 | |
567 | |
484 | =item json => $array_or_hashref |
568 | =item json => $array_or_hashref |
485 | |
569 | |
486 | Encodes the given hash or array reference into a JSON object. Unless you |
570 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
520 | |
604 | |
521 | $self->{json} ? $self->{json}->encode ($ref) |
605 | $self->{json} ? $self->{json}->encode ($ref) |
522 | : JSON::encode_json ($ref) |
606 | : JSON::encode_json ($ref) |
523 | }; |
607 | }; |
524 | |
608 | |
|
|
609 | =item storable => $reference |
|
|
610 | |
|
|
611 | Freezes the given reference using L<Storable> and writes it to the |
|
|
612 | handle. Uses the C<nfreeze> format. |
|
|
613 | |
|
|
614 | =cut |
|
|
615 | |
|
|
616 | register_write_type storable => sub { |
|
|
617 | my ($self, $ref) = @_; |
|
|
618 | |
|
|
619 | require Storable; |
|
|
620 | |
|
|
621 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
622 | }; |
|
|
623 | |
|
|
624 | =back |
|
|
625 | |
525 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
626 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
526 | |
627 | |
527 | This function (not method) lets you add your own types to C<push_write>. |
628 | This function (not method) lets you add your own types to C<push_write>. |
528 | Whenever the given C<type> is used, C<push_write> will invoke the code |
629 | Whenever the given C<type> is used, C<push_write> will invoke the code |
529 | reference with the handle object and the remaining arguments. |
630 | reference with the handle object and the remaining arguments. |
… | |
… | |
549 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
650 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
550 | a queue. |
651 | a queue. |
551 | |
652 | |
552 | In the simple case, you just install an C<on_read> callback and whenever |
653 | In the simple case, you just install an C<on_read> callback and whenever |
553 | new data arrives, it will be called. You can then remove some data (if |
654 | new data arrives, it will be called. You can then remove some data (if |
554 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
655 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
555 | or not. |
656 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
657 | partial message has been received so far). |
556 | |
658 | |
557 | In the more complex case, you want to queue multiple callbacks. In this |
659 | In the more complex case, you want to queue multiple callbacks. In this |
558 | case, AnyEvent::Handle will call the first queued callback each time new |
660 | case, AnyEvent::Handle will call the first queued callback each time new |
559 | data arrives and removes it when it has done its job (see C<push_read>, |
661 | data arrives (also the first time it is queued) and removes it when it has |
560 | below). |
662 | done its job (see C<push_read>, below). |
561 | |
663 | |
562 | This way you can, for example, push three line-reads, followed by reading |
664 | This way you can, for example, push three line-reads, followed by reading |
563 | a chunk of data, and AnyEvent::Handle will execute them in order. |
665 | a chunk of data, and AnyEvent::Handle will execute them in order. |
564 | |
666 | |
565 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
667 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
566 | the specified number of bytes which give an XML datagram. |
668 | the specified number of bytes which give an XML datagram. |
567 | |
669 | |
568 | # in the default state, expect some header bytes |
670 | # in the default state, expect some header bytes |
569 | $handle->on_read (sub { |
671 | $handle->on_read (sub { |
570 | # some data is here, now queue the length-header-read (4 octets) |
672 | # some data is here, now queue the length-header-read (4 octets) |
571 | shift->unshift_read_chunk (4, sub { |
673 | shift->unshift_read (chunk => 4, sub { |
572 | # header arrived, decode |
674 | # header arrived, decode |
573 | my $len = unpack "N", $_[1]; |
675 | my $len = unpack "N", $_[1]; |
574 | |
676 | |
575 | # now read the payload |
677 | # now read the payload |
576 | shift->unshift_read_chunk ($len, sub { |
678 | shift->unshift_read (chunk => $len, sub { |
577 | my $xml = $_[1]; |
679 | my $xml = $_[1]; |
578 | # handle xml |
680 | # handle xml |
579 | }); |
681 | }); |
580 | }); |
682 | }); |
581 | }); |
683 | }); |
582 | |
684 | |
583 | Example 2: Implement a client for a protocol that replies either with |
685 | Example 2: Implement a client for a protocol that replies either with "OK" |
584 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
686 | and another line or "ERROR" for the first request that is sent, and 64 |
585 | second request. Due tot he availability of a full queue, we can just |
687 | bytes for the second request. Due to the availability of a queue, we can |
586 | pipeline sending both requests and manipulate the queue as necessary in |
688 | just pipeline sending both requests and manipulate the queue as necessary |
587 | the callbacks: |
689 | in the callbacks. |
588 | |
690 | |
589 | # request one |
691 | When the first callback is called and sees an "OK" response, it will |
|
|
692 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
693 | 64-byte chunk callback. |
|
|
694 | |
|
|
695 | # request one, returns either "OK + extra line" or "ERROR" |
590 | $handle->push_write ("request 1\015\012"); |
696 | $handle->push_write ("request 1\015\012"); |
591 | |
697 | |
592 | # we expect "ERROR" or "OK" as response, so push a line read |
698 | # we expect "ERROR" or "OK" as response, so push a line read |
593 | $handle->push_read_line (sub { |
699 | $handle->push_read (line => sub { |
594 | # if we got an "OK", we have to _prepend_ another line, |
700 | # if we got an "OK", we have to _prepend_ another line, |
595 | # so it will be read before the second request reads its 64 bytes |
701 | # so it will be read before the second request reads its 64 bytes |
596 | # which are already in the queue when this callback is called |
702 | # which are already in the queue when this callback is called |
597 | # we don't do this in case we got an error |
703 | # we don't do this in case we got an error |
598 | if ($_[1] eq "OK") { |
704 | if ($_[1] eq "OK") { |
599 | $_[0]->unshift_read_line (sub { |
705 | $_[0]->unshift_read (line => sub { |
600 | my $response = $_[1]; |
706 | my $response = $_[1]; |
601 | ... |
707 | ... |
602 | }); |
708 | }); |
603 | } |
709 | } |
604 | }); |
710 | }); |
605 | |
711 | |
606 | # request two |
712 | # request two, simply returns 64 octets |
607 | $handle->push_write ("request 2\015\012"); |
713 | $handle->push_write ("request 2\015\012"); |
608 | |
714 | |
609 | # simply read 64 bytes, always |
715 | # simply read 64 bytes, always |
610 | $handle->push_read_chunk (64, sub { |
716 | $handle->push_read (chunk => 64, sub { |
611 | my $response = $_[1]; |
717 | my $response = $_[1]; |
612 | ... |
718 | ... |
613 | }); |
719 | }); |
614 | |
720 | |
615 | =over 4 |
721 | =over 4 |
616 | |
722 | |
617 | =cut |
723 | =cut |
618 | |
724 | |
619 | sub _drain_rbuf { |
725 | sub _drain_rbuf { |
620 | my ($self) = @_; |
726 | my ($self) = @_; |
|
|
727 | |
|
|
728 | local $self->{_in_drain} = 1; |
621 | |
729 | |
622 | if ( |
730 | if ( |
623 | defined $self->{rbuf_max} |
731 | defined $self->{rbuf_max} |
624 | && $self->{rbuf_max} < length $self->{rbuf} |
732 | && $self->{rbuf_max} < length $self->{rbuf} |
625 | ) { |
733 | ) { |
626 | $! = &Errno::ENOSPC; |
734 | return $self->_error (&Errno::ENOSPC, 1); |
627 | $self->error; |
|
|
628 | } |
735 | } |
629 | |
736 | |
630 | return if $self->{in_drain}; |
737 | while () { |
631 | local $self->{in_drain} = 1; |
|
|
632 | |
|
|
633 | while (my $len = length $self->{rbuf}) { |
738 | my $len = length $self->{rbuf}; |
634 | no strict 'refs'; |
739 | |
635 | if (my $cb = shift @{ $self->{_queue} }) { |
740 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | unless ($cb->($self)) { |
741 | unless ($cb->($self)) { |
637 | if ($self->{_eof}) { |
742 | if ($self->{_eof}) { |
638 | # no progress can be made (not enough data and no data forthcoming) |
743 | # no progress can be made (not enough data and no data forthcoming) |
639 | $! = &Errno::EPIPE; |
744 | $self->_error (&Errno::EPIPE, 1), last; |
640 | $self->error; |
|
|
641 | } |
745 | } |
642 | |
746 | |
643 | unshift @{ $self->{_queue} }, $cb; |
747 | unshift @{ $self->{_queue} }, $cb; |
644 | return; |
748 | last; |
645 | } |
749 | } |
646 | } elsif ($self->{on_read}) { |
750 | } elsif ($self->{on_read}) { |
|
|
751 | last unless $len; |
|
|
752 | |
647 | $self->{on_read}($self); |
753 | $self->{on_read}($self); |
648 | |
754 | |
649 | if ( |
755 | if ( |
650 | $self->{_eof} # if no further data will arrive |
|
|
651 | && $len == length $self->{rbuf} # and no data has been consumed |
756 | $len == length $self->{rbuf} # if no data has been consumed |
652 | && !@{ $self->{_queue} } # and the queue is still empty |
757 | && !@{ $self->{_queue} } # and the queue is still empty |
653 | && $self->{on_read} # and we still want to read data |
758 | && $self->{on_read} # but we still have on_read |
654 | ) { |
759 | ) { |
|
|
760 | # no further data will arrive |
655 | # then no progress can be made |
761 | # so no progress can be made |
656 | $! = &Errno::EPIPE; |
762 | $self->_error (&Errno::EPIPE, 1), last |
657 | $self->error; |
763 | if $self->{_eof}; |
|
|
764 | |
|
|
765 | last; # more data might arrive |
658 | } |
766 | } |
659 | } else { |
767 | } else { |
660 | # read side becomes idle |
768 | # read side becomes idle |
661 | delete $self->{_rw}; |
769 | delete $self->{_rw}; |
662 | return; |
770 | last; |
663 | } |
771 | } |
664 | } |
772 | } |
665 | |
773 | |
666 | if ($self->{_eof}) { |
774 | if ($self->{_eof}) { |
667 | $self->_shutdown; |
775 | if ($self->{on_eof}) { |
668 | $self->{on_eof}($self) |
776 | $self->{on_eof}($self) |
669 | if $self->{on_eof}; |
777 | } else { |
|
|
778 | $self->_error (0, 1); |
|
|
779 | } |
|
|
780 | } |
|
|
781 | |
|
|
782 | # may need to restart read watcher |
|
|
783 | unless ($self->{_rw}) { |
|
|
784 | $self->start_read |
|
|
785 | if $self->{on_read} || @{ $self->{_queue} }; |
670 | } |
786 | } |
671 | } |
787 | } |
672 | |
788 | |
673 | =item $handle->on_read ($cb) |
789 | =item $handle->on_read ($cb) |
674 | |
790 | |
… | |
… | |
680 | |
796 | |
681 | sub on_read { |
797 | sub on_read { |
682 | my ($self, $cb) = @_; |
798 | my ($self, $cb) = @_; |
683 | |
799 | |
684 | $self->{on_read} = $cb; |
800 | $self->{on_read} = $cb; |
|
|
801 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
685 | } |
802 | } |
686 | |
803 | |
687 | =item $handle->rbuf |
804 | =item $handle->rbuf |
688 | |
805 | |
689 | Returns the read buffer (as a modifiable lvalue). |
806 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
738 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
855 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
739 | ->($self, $cb, @_); |
856 | ->($self, $cb, @_); |
740 | } |
857 | } |
741 | |
858 | |
742 | push @{ $self->{_queue} }, $cb; |
859 | push @{ $self->{_queue} }, $cb; |
743 | $self->_drain_rbuf; |
860 | $self->_drain_rbuf unless $self->{_in_drain}; |
744 | } |
861 | } |
745 | |
862 | |
746 | sub unshift_read { |
863 | sub unshift_read { |
747 | my $self = shift; |
864 | my $self = shift; |
748 | my $cb = pop; |
865 | my $cb = pop; |
… | |
… | |
754 | ->($self, $cb, @_); |
871 | ->($self, $cb, @_); |
755 | } |
872 | } |
756 | |
873 | |
757 | |
874 | |
758 | unshift @{ $self->{_queue} }, $cb; |
875 | unshift @{ $self->{_queue} }, $cb; |
759 | $self->_drain_rbuf; |
876 | $self->_drain_rbuf unless $self->{_in_drain}; |
760 | } |
877 | } |
761 | |
878 | |
762 | =item $handle->push_read (type => @args, $cb) |
879 | =item $handle->push_read (type => @args, $cb) |
763 | |
880 | |
764 | =item $handle->unshift_read (type => @args, $cb) |
881 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
794 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
911 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
795 | 1 |
912 | 1 |
796 | } |
913 | } |
797 | }; |
914 | }; |
798 | |
915 | |
799 | # compatibility with older API |
|
|
800 | sub push_read_chunk { |
|
|
801 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
802 | } |
|
|
803 | |
|
|
804 | sub unshift_read_chunk { |
|
|
805 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
806 | } |
|
|
807 | |
|
|
808 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
916 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
809 | |
917 | |
810 | The callback will be called only once a full line (including the end of |
918 | The callback will be called only once a full line (including the end of |
811 | line marker, C<$eol>) has been read. This line (excluding the end of line |
919 | line marker, C<$eol>) has been read. This line (excluding the end of line |
812 | marker) will be passed to the callback as second argument (C<$line>), and |
920 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
827 | =cut |
935 | =cut |
828 | |
936 | |
829 | register_read_type line => sub { |
937 | register_read_type line => sub { |
830 | my ($self, $cb, $eol) = @_; |
938 | my ($self, $cb, $eol) = @_; |
831 | |
939 | |
832 | $eol = qr|(\015?\012)| if @_ < 3; |
940 | if (@_ < 3) { |
|
|
941 | # this is more than twice as fast as the generic code below |
|
|
942 | sub { |
|
|
943 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
944 | |
|
|
945 | $cb->($_[0], $1, $2); |
|
|
946 | 1 |
|
|
947 | } |
|
|
948 | } else { |
833 | $eol = quotemeta $eol unless ref $eol; |
949 | $eol = quotemeta $eol unless ref $eol; |
834 | $eol = qr|^(.*?)($eol)|s; |
950 | $eol = qr|^(.*?)($eol)|s; |
835 | |
951 | |
836 | sub { |
952 | sub { |
837 | $_[0]{rbuf} =~ s/$eol// or return; |
953 | $_[0]{rbuf} =~ s/$eol// or return; |
838 | |
954 | |
839 | $cb->($_[0], $1, $2); |
955 | $cb->($_[0], $1, $2); |
840 | 1 |
|
|
841 | } |
|
|
842 | }; |
|
|
843 | |
|
|
844 | # compatibility with older API |
|
|
845 | sub push_read_line { |
|
|
846 | my $self = shift; |
|
|
847 | $self->push_read (line => @_); |
|
|
848 | } |
|
|
849 | |
|
|
850 | sub unshift_read_line { |
|
|
851 | my $self = shift; |
|
|
852 | $self->unshift_read (line => @_); |
|
|
853 | } |
|
|
854 | |
|
|
855 | =item netstring => $cb->($handle, $string) |
|
|
856 | |
|
|
857 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
858 | |
|
|
859 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
860 | |
|
|
861 | =cut |
|
|
862 | |
|
|
863 | register_read_type netstring => sub { |
|
|
864 | my ($self, $cb) = @_; |
|
|
865 | |
|
|
866 | sub { |
|
|
867 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
868 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
869 | $! = &Errno::EBADMSG; |
|
|
870 | $self->error; |
|
|
871 | } |
956 | 1 |
872 | return; |
|
|
873 | } |
|
|
874 | |
|
|
875 | my $len = $1; |
|
|
876 | |
|
|
877 | $self->unshift_read (chunk => $len, sub { |
|
|
878 | my $string = $_[1]; |
|
|
879 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
880 | if ($_[1] eq ",") { |
|
|
881 | $cb->($_[0], $string); |
|
|
882 | } else { |
|
|
883 | $! = &Errno::EBADMSG; |
|
|
884 | $self->error; |
|
|
885 | } |
|
|
886 | }); |
|
|
887 | }); |
957 | } |
888 | |
|
|
889 | 1 |
|
|
890 | } |
958 | } |
891 | }; |
959 | }; |
892 | |
960 | |
893 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
961 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
894 | |
962 | |
… | |
… | |
946 | return 1; |
1014 | return 1; |
947 | } |
1015 | } |
948 | |
1016 | |
949 | # reject |
1017 | # reject |
950 | if ($reject && $$rbuf =~ $reject) { |
1018 | if ($reject && $$rbuf =~ $reject) { |
951 | $! = &Errno::EBADMSG; |
1019 | $self->_error (&Errno::EBADMSG); |
952 | $self->error; |
|
|
953 | } |
1020 | } |
954 | |
1021 | |
955 | # skip |
1022 | # skip |
956 | if ($skip && $$rbuf =~ $skip) { |
1023 | if ($skip && $$rbuf =~ $skip) { |
957 | $data .= substr $$rbuf, 0, $+[0], ""; |
1024 | $data .= substr $$rbuf, 0, $+[0], ""; |
958 | } |
1025 | } |
959 | |
1026 | |
960 | () |
1027 | () |
|
|
1028 | } |
|
|
1029 | }; |
|
|
1030 | |
|
|
1031 | =item netstring => $cb->($handle, $string) |
|
|
1032 | |
|
|
1033 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1034 | |
|
|
1035 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1036 | |
|
|
1037 | =cut |
|
|
1038 | |
|
|
1039 | register_read_type netstring => sub { |
|
|
1040 | my ($self, $cb) = @_; |
|
|
1041 | |
|
|
1042 | sub { |
|
|
1043 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1044 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1045 | $self->_error (&Errno::EBADMSG); |
|
|
1046 | } |
|
|
1047 | return; |
|
|
1048 | } |
|
|
1049 | |
|
|
1050 | my $len = $1; |
|
|
1051 | |
|
|
1052 | $self->unshift_read (chunk => $len, sub { |
|
|
1053 | my $string = $_[1]; |
|
|
1054 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1055 | if ($_[1] eq ",") { |
|
|
1056 | $cb->($_[0], $string); |
|
|
1057 | } else { |
|
|
1058 | $self->_error (&Errno::EBADMSG); |
|
|
1059 | } |
|
|
1060 | }); |
|
|
1061 | }); |
|
|
1062 | |
|
|
1063 | 1 |
|
|
1064 | } |
|
|
1065 | }; |
|
|
1066 | |
|
|
1067 | =item packstring => $format, $cb->($handle, $string) |
|
|
1068 | |
|
|
1069 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1070 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1071 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1072 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1073 | |
|
|
1074 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1075 | |
|
|
1076 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1077 | format (very efficient). |
|
|
1078 | |
|
|
1079 | $handle->push_read (packstring => "w", sub { |
|
|
1080 | my ($handle, $data) = @_; |
|
|
1081 | }); |
|
|
1082 | |
|
|
1083 | =cut |
|
|
1084 | |
|
|
1085 | register_read_type packstring => sub { |
|
|
1086 | my ($self, $cb, $format) = @_; |
|
|
1087 | |
|
|
1088 | sub { |
|
|
1089 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1090 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1091 | or return; |
|
|
1092 | |
|
|
1093 | $format = length pack $format, $len; |
|
|
1094 | |
|
|
1095 | # bypass unshift if we already have the remaining chunk |
|
|
1096 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1097 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1098 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1099 | $cb->($_[0], $data); |
|
|
1100 | } else { |
|
|
1101 | # remove prefix |
|
|
1102 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1103 | |
|
|
1104 | # read remaining chunk |
|
|
1105 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1106 | } |
|
|
1107 | |
|
|
1108 | 1 |
961 | } |
1109 | } |
962 | }; |
1110 | }; |
963 | |
1111 | |
964 | =item json => $cb->($handle, $hash_or_arrayref) |
1112 | =item json => $cb->($handle, $hash_or_arrayref) |
965 | |
1113 | |
… | |
… | |
978 | the C<json> write type description, above, for an actual example. |
1126 | the C<json> write type description, above, for an actual example. |
979 | |
1127 | |
980 | =cut |
1128 | =cut |
981 | |
1129 | |
982 | register_read_type json => sub { |
1130 | register_read_type json => sub { |
983 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1131 | my ($self, $cb) = @_; |
984 | |
1132 | |
985 | require JSON; |
1133 | require JSON; |
986 | |
1134 | |
987 | my $data; |
1135 | my $data; |
988 | my $rbuf = \$self->{rbuf}; |
1136 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1003 | () |
1151 | () |
1004 | } |
1152 | } |
1005 | } |
1153 | } |
1006 | }; |
1154 | }; |
1007 | |
1155 | |
|
|
1156 | =item storable => $cb->($handle, $ref) |
|
|
1157 | |
|
|
1158 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1159 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1160 | data). |
|
|
1161 | |
|
|
1162 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1163 | |
|
|
1164 | =cut |
|
|
1165 | |
|
|
1166 | register_read_type storable => sub { |
|
|
1167 | my ($self, $cb) = @_; |
|
|
1168 | |
|
|
1169 | require Storable; |
|
|
1170 | |
|
|
1171 | sub { |
|
|
1172 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1173 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1174 | or return; |
|
|
1175 | |
|
|
1176 | my $format = length pack "w", $len; |
|
|
1177 | |
|
|
1178 | # bypass unshift if we already have the remaining chunk |
|
|
1179 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1180 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1181 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1182 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1183 | } else { |
|
|
1184 | # remove prefix |
|
|
1185 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1186 | |
|
|
1187 | # read remaining chunk |
|
|
1188 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1189 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1190 | $cb->($_[0], $ref); |
|
|
1191 | } else { |
|
|
1192 | $self->_error (&Errno::EBADMSG); |
|
|
1193 | } |
|
|
1194 | }); |
|
|
1195 | } |
|
|
1196 | |
|
|
1197 | 1 |
|
|
1198 | } |
|
|
1199 | }; |
|
|
1200 | |
1008 | =back |
1201 | =back |
1009 | |
1202 | |
1010 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1203 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1011 | |
1204 | |
1012 | This function (not method) lets you add your own types to C<push_read>. |
1205 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1030 | =item $handle->stop_read |
1223 | =item $handle->stop_read |
1031 | |
1224 | |
1032 | =item $handle->start_read |
1225 | =item $handle->start_read |
1033 | |
1226 | |
1034 | In rare cases you actually do not want to read anything from the |
1227 | In rare cases you actually do not want to read anything from the |
1035 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1228 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
1036 | any queued callbacks will be executed then. To start reading again, call |
1229 | any queued callbacks will be executed then. To start reading again, call |
1037 | C<start_read>. |
1230 | C<start_read>. |
|
|
1231 | |
|
|
1232 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1233 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1234 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1235 | there are any read requests in the queue. |
1038 | |
1236 | |
1039 | =cut |
1237 | =cut |
1040 | |
1238 | |
1041 | sub stop_read { |
1239 | sub stop_read { |
1042 | my ($self) = @_; |
1240 | my ($self) = @_; |
… | |
… | |
1056 | |
1254 | |
1057 | if ($len > 0) { |
1255 | if ($len > 0) { |
1058 | $self->{_activity} = AnyEvent->now; |
1256 | $self->{_activity} = AnyEvent->now; |
1059 | |
1257 | |
1060 | $self->{filter_r} |
1258 | $self->{filter_r} |
1061 | ? $self->{filter_r}->($self, $rbuf) |
1259 | ? $self->{filter_r}($self, $rbuf) |
1062 | : $self->_drain_rbuf; |
1260 | : $self->{_in_drain} || $self->_drain_rbuf; |
1063 | |
1261 | |
1064 | } elsif (defined $len) { |
1262 | } elsif (defined $len) { |
1065 | delete $self->{_rw}; |
1263 | delete $self->{_rw}; |
1066 | $self->{_eof} = 1; |
1264 | $self->{_eof} = 1; |
1067 | $self->_drain_rbuf; |
1265 | $self->_drain_rbuf unless $self->{_in_drain}; |
1068 | |
1266 | |
1069 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1267 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1070 | return $self->error; |
1268 | return $self->_error ($!, 1); |
1071 | } |
1269 | } |
1072 | }); |
1270 | }); |
1073 | } |
1271 | } |
1074 | } |
1272 | } |
1075 | |
1273 | |
1076 | sub _dotls { |
1274 | sub _dotls { |
1077 | my ($self) = @_; |
1275 | my ($self) = @_; |
|
|
1276 | |
|
|
1277 | my $buf; |
1078 | |
1278 | |
1079 | if (length $self->{_tls_wbuf}) { |
1279 | if (length $self->{_tls_wbuf}) { |
1080 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1280 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1081 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1281 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1082 | } |
1282 | } |
1083 | } |
1283 | } |
1084 | |
1284 | |
1085 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1285 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1086 | $self->{wbuf} .= $buf; |
1286 | $self->{wbuf} .= $buf; |
1087 | $self->_drain_wbuf; |
1287 | $self->_drain_wbuf; |
1088 | } |
1288 | } |
1089 | |
1289 | |
1090 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1290 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1291 | if (length $buf) { |
1091 | $self->{rbuf} .= $buf; |
1292 | $self->{rbuf} .= $buf; |
1092 | $self->_drain_rbuf; |
1293 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1294 | } else { |
|
|
1295 | # let's treat SSL-eof as we treat normal EOF |
|
|
1296 | $self->{_eof} = 1; |
|
|
1297 | $self->_shutdown; |
|
|
1298 | return; |
|
|
1299 | } |
1093 | } |
1300 | } |
1094 | |
1301 | |
1095 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1302 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1096 | |
1303 | |
1097 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1304 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1098 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1305 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1099 | $self->error; |
1306 | return $self->_error ($!, 1); |
1100 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1307 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1101 | $! = &Errno::EIO; |
1308 | return $self->_error (&Errno::EIO, 1); |
1102 | $self->error; |
|
|
1103 | } |
1309 | } |
1104 | |
1310 | |
1105 | # all others are fine for our purposes |
1311 | # all others are fine for our purposes |
1106 | } |
1312 | } |
1107 | } |
1313 | } |
… | |
… | |
1122 | call and can be used or changed to your liking. Note that the handshake |
1328 | call and can be used or changed to your liking. Note that the handshake |
1123 | might have already started when this function returns. |
1329 | might have already started when this function returns. |
1124 | |
1330 | |
1125 | =cut |
1331 | =cut |
1126 | |
1332 | |
1127 | # TODO: maybe document... |
|
|
1128 | sub starttls { |
1333 | sub starttls { |
1129 | my ($self, $ssl, $ctx) = @_; |
1334 | my ($self, $ssl, $ctx) = @_; |
1130 | |
1335 | |
1131 | $self->stoptls; |
1336 | $self->stoptls; |
1132 | |
1337 | |
… | |
… | |
1185 | |
1390 | |
1186 | sub DESTROY { |
1391 | sub DESTROY { |
1187 | my $self = shift; |
1392 | my $self = shift; |
1188 | |
1393 | |
1189 | $self->stoptls; |
1394 | $self->stoptls; |
|
|
1395 | |
|
|
1396 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1397 | |
|
|
1398 | if ($linger && length $self->{wbuf}) { |
|
|
1399 | my $fh = delete $self->{fh}; |
|
|
1400 | my $wbuf = delete $self->{wbuf}; |
|
|
1401 | |
|
|
1402 | my @linger; |
|
|
1403 | |
|
|
1404 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1405 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1406 | |
|
|
1407 | if ($len > 0) { |
|
|
1408 | substr $wbuf, 0, $len, ""; |
|
|
1409 | } else { |
|
|
1410 | @linger = (); # end |
|
|
1411 | } |
|
|
1412 | }); |
|
|
1413 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1414 | @linger = (); |
|
|
1415 | }); |
|
|
1416 | } |
1190 | } |
1417 | } |
1191 | |
1418 | |
1192 | =item AnyEvent::Handle::TLS_CTX |
1419 | =item AnyEvent::Handle::TLS_CTX |
1193 | |
1420 | |
1194 | This function creates and returns the Net::SSLeay::CTX object used by |
1421 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1236 | =over 4 |
1463 | =over 4 |
1237 | |
1464 | |
1238 | =item * all constructor arguments become object members. |
1465 | =item * all constructor arguments become object members. |
1239 | |
1466 | |
1240 | At least initially, when you pass a C<tls>-argument to the constructor it |
1467 | At least initially, when you pass a C<tls>-argument to the constructor it |
1241 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1468 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1242 | mutated later on (for example C<tls> will hold the TLS connection object). |
1469 | mutated later on (for example C<tls> will hold the TLS connection object). |
1243 | |
1470 | |
1244 | =item * other object member names are prefixed with an C<_>. |
1471 | =item * other object member names are prefixed with an C<_>. |
1245 | |
1472 | |
1246 | All object members not explicitly documented (internal use) are prefixed |
1473 | All object members not explicitly documented (internal use) are prefixed |