… | |
… | |
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 = '1.0'; |
19 | our $VERSION = 4.14; |
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 detcted, |
|
|
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 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 | |
86 | =item on_error => $cb->($handle) |
88 | =item on_error => $cb->($handle, $fatal) |
87 | |
89 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
90 | 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 |
91 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
92 | connect or a read error. |
91 | |
93 | |
92 | The object will not be in a usable state when this callback has been |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
95 | fatal errors the handle object will be shut down and will not be |
|
|
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
|
|
97 | recommended to simply ignore this parameter and instead abondon the handle |
|
|
98 | object when this callback is invoked. |
94 | |
99 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
100 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
102 | |
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 |
103 | 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 |
104 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
105 | C<croak>. |
104 | |
106 | |
105 | =item on_read => $cb->($handle) |
107 | =item on_read => $cb->($handle) |
106 | |
108 | |
107 | This sets the default read callback, which is called when data arrives |
109 | This sets the default read callback, which is called when data arrives |
108 | and no read request is in the queue. |
110 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
111 | callback will only be called when at least one octet of data is in the |
|
|
112 | read buffer). |
109 | |
113 | |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
114 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
111 | method or access the C<$handle->{rbuf}> member directly. |
115 | method or access the C<$handle->{rbuf}> member directly. |
112 | |
116 | |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
117 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
163 | |
167 | |
164 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
168 | 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 |
169 | buffer: If the write reaches this size or gets even samller it is |
166 | considered empty. |
170 | considered empty. |
167 | |
171 | |
|
|
172 | =item linger => <seconds> |
|
|
173 | |
|
|
174 | If non-zero (default: C<3600>), then the destructor of the |
|
|
175 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
176 | data and will install a watcher that will write out this data. No errors |
|
|
177 | will be reported (this mostly matches how the operating system treats |
|
|
178 | outstanding data at socket close time). |
|
|
179 | |
|
|
180 | This will not work for partial TLS data that could not yet been |
|
|
181 | encoded. This data will be lost. |
|
|
182 | |
168 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
183 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
169 | |
184 | |
170 | When this parameter is given, it enables TLS (SSL) mode, that means it |
185 | When this parameter is given, it enables TLS (SSL) mode, that means it |
171 | will start making tls handshake and will transparently encrypt/decrypt |
186 | will start making tls handshake and will transparently encrypt/decrypt |
172 | data. |
187 | data. |
… | |
… | |
222 | if ($self->{tls}) { |
237 | if ($self->{tls}) { |
223 | require Net::SSLeay; |
238 | require Net::SSLeay; |
224 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
239 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
225 | } |
240 | } |
226 | |
241 | |
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; |
242 | $self->{_activity} = AnyEvent->now; |
233 | $self->_timeout; |
243 | $self->_timeout; |
234 | |
244 | |
235 | $self->start_read; |
245 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
236 | |
246 | |
237 | $self |
247 | $self |
238 | } |
248 | } |
239 | |
249 | |
240 | sub _shutdown { |
250 | sub _shutdown { |
… | |
… | |
242 | |
252 | |
243 | delete $self->{_tw}; |
253 | delete $self->{_tw}; |
244 | delete $self->{_rw}; |
254 | delete $self->{_rw}; |
245 | delete $self->{_ww}; |
255 | delete $self->{_ww}; |
246 | delete $self->{fh}; |
256 | delete $self->{fh}; |
247 | } |
|
|
248 | |
257 | |
|
|
258 | $self->stoptls; |
|
|
259 | } |
|
|
260 | |
249 | sub error { |
261 | sub _error { |
250 | my ($self) = @_; |
262 | my ($self, $errno, $fatal) = @_; |
251 | |
263 | |
252 | { |
|
|
253 | local $!; |
|
|
254 | $self->_shutdown; |
264 | $self->_shutdown |
255 | } |
265 | if $fatal; |
256 | |
266 | |
257 | $self->{on_error}($self) |
267 | $! = $errno; |
|
|
268 | |
258 | if $self->{on_error}; |
269 | if ($self->{on_error}) { |
259 | |
270 | $self->{on_error}($self, $fatal); |
|
|
271 | } else { |
260 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
272 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
|
|
273 | } |
261 | } |
274 | } |
262 | |
275 | |
263 | =item $fh = $handle->fh |
276 | =item $fh = $handle->fh |
264 | |
277 | |
265 | This method returns the file handle of the L<AnyEvent::Handle> object. |
278 | This method returns the file handle of the L<AnyEvent::Handle> object. |
… | |
… | |
331 | $self->{_activity} = $NOW; |
344 | $self->{_activity} = $NOW; |
332 | |
345 | |
333 | if ($self->{on_timeout}) { |
346 | if ($self->{on_timeout}) { |
334 | $self->{on_timeout}($self); |
347 | $self->{on_timeout}($self); |
335 | } else { |
348 | } else { |
336 | $! = Errno::ETIMEDOUT; |
349 | $self->_error (&Errno::ETIMEDOUT); |
337 | $self->error; |
|
|
338 | } |
350 | } |
339 | |
351 | |
340 | # callbakx could have changed timeout value, optimise |
352 | # callback could have changed timeout value, optimise |
341 | return unless $self->{timeout}; |
353 | return unless $self->{timeout}; |
342 | |
354 | |
343 | # calculate new after |
355 | # calculate new after |
344 | $after = $self->{timeout}; |
356 | $after = $self->{timeout}; |
345 | } |
357 | } |
346 | |
358 | |
347 | Scalar::Util::weaken $self; |
359 | Scalar::Util::weaken $self; |
|
|
360 | return unless $self; # ->error could have destroyed $self |
348 | |
361 | |
349 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
362 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
350 | delete $self->{_tw}; |
363 | delete $self->{_tw}; |
351 | $self->_timeout; |
364 | $self->_timeout; |
352 | }); |
365 | }); |
… | |
… | |
415 | if $self->{low_water_mark} >= length $self->{wbuf} |
428 | if $self->{low_water_mark} >= length $self->{wbuf} |
416 | && $self->{on_drain}; |
429 | && $self->{on_drain}; |
417 | |
430 | |
418 | delete $self->{_ww} unless length $self->{wbuf}; |
431 | delete $self->{_ww} unless length $self->{wbuf}; |
419 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
432 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
420 | $self->error; |
433 | $self->_error ($!, 1); |
421 | } |
434 | } |
422 | }; |
435 | }; |
423 | |
436 | |
424 | # try to write data immediately |
437 | # try to write data immediately |
425 | $cb->(); |
438 | $cb->(); |
… | |
… | |
454 | } |
467 | } |
455 | } |
468 | } |
456 | |
469 | |
457 | =item $handle->push_write (type => @args) |
470 | =item $handle->push_write (type => @args) |
458 | |
471 | |
459 | =item $handle->unshift_write (type => @args) |
|
|
460 | |
|
|
461 | Instead of formatting your data yourself, you can also let this module do |
472 | Instead of formatting your data yourself, you can also let this module do |
462 | the job by specifying a type and type-specific arguments. |
473 | the job by specifying a type and type-specific arguments. |
463 | |
474 | |
464 | Predefined types are (if you have ideas for additional types, feel free to |
475 | Predefined types are (if you have ideas for additional types, feel free to |
465 | drop by and tell us): |
476 | drop by and tell us): |
… | |
… | |
469 | =item netstring => $string |
480 | =item netstring => $string |
470 | |
481 | |
471 | Formats the given value as netstring |
482 | Formats the given value as netstring |
472 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
483 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
473 | |
484 | |
474 | =back |
|
|
475 | |
|
|
476 | =cut |
485 | =cut |
477 | |
486 | |
478 | register_write_type netstring => sub { |
487 | register_write_type netstring => sub { |
479 | my ($self, $string) = @_; |
488 | my ($self, $string) = @_; |
480 | |
489 | |
481 | sprintf "%d:%s,", (length $string), $string |
490 | sprintf "%d:%s,", (length $string), $string |
|
|
491 | }; |
|
|
492 | |
|
|
493 | =item packstring => $format, $data |
|
|
494 | |
|
|
495 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
496 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
497 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
498 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
499 | |
|
|
500 | =cut |
|
|
501 | |
|
|
502 | register_write_type packstring => sub { |
|
|
503 | my ($self, $format, $string) = @_; |
|
|
504 | |
|
|
505 | pack "$format/a", $string |
482 | }; |
506 | }; |
483 | |
507 | |
484 | =item json => $array_or_hashref |
508 | =item json => $array_or_hashref |
485 | |
509 | |
486 | Encodes the given hash or array reference into a JSON object. Unless you |
510 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
520 | |
544 | |
521 | $self->{json} ? $self->{json}->encode ($ref) |
545 | $self->{json} ? $self->{json}->encode ($ref) |
522 | : JSON::encode_json ($ref) |
546 | : JSON::encode_json ($ref) |
523 | }; |
547 | }; |
524 | |
548 | |
|
|
549 | =item storable => $reference |
|
|
550 | |
|
|
551 | Freezes the given reference using L<Storable> and writes it to the |
|
|
552 | handle. Uses the C<nfreeze> format. |
|
|
553 | |
|
|
554 | =cut |
|
|
555 | |
|
|
556 | register_write_type storable => sub { |
|
|
557 | my ($self, $ref) = @_; |
|
|
558 | |
|
|
559 | require Storable; |
|
|
560 | |
|
|
561 | pack "w/a", Storable::nfreeze ($ref) |
|
|
562 | }; |
|
|
563 | |
|
|
564 | =back |
|
|
565 | |
525 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
566 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
526 | |
567 | |
527 | This function (not method) lets you add your own types to C<push_write>. |
568 | 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 |
569 | Whenever the given C<type> is used, C<push_write> will invoke the code |
529 | reference with the handle object and the remaining arguments. |
570 | reference with the handle object and the remaining arguments. |
… | |
… | |
554 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
595 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
555 | or not. |
596 | or not. |
556 | |
597 | |
557 | In the more complex case, you want to queue multiple callbacks. In this |
598 | 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 |
599 | 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>, |
600 | data arrives (also the first time it is queued) and removes it when it has |
560 | below). |
601 | done its job (see C<push_read>, below). |
561 | |
602 | |
562 | This way you can, for example, push three line-reads, followed by reading |
603 | 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. |
604 | a chunk of data, and AnyEvent::Handle will execute them in order. |
564 | |
605 | |
565 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
606 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
566 | the specified number of bytes which give an XML datagram. |
607 | the specified number of bytes which give an XML datagram. |
567 | |
608 | |
568 | # in the default state, expect some header bytes |
609 | # in the default state, expect some header bytes |
569 | $handle->on_read (sub { |
610 | $handle->on_read (sub { |
570 | # some data is here, now queue the length-header-read (4 octets) |
611 | # some data is here, now queue the length-header-read (4 octets) |
571 | shift->unshift_read_chunk (4, sub { |
612 | shift->unshift_read (chunk => 4, sub { |
572 | # header arrived, decode |
613 | # header arrived, decode |
573 | my $len = unpack "N", $_[1]; |
614 | my $len = unpack "N", $_[1]; |
574 | |
615 | |
575 | # now read the payload |
616 | # now read the payload |
576 | shift->unshift_read_chunk ($len, sub { |
617 | shift->unshift_read (chunk => $len, sub { |
577 | my $xml = $_[1]; |
618 | my $xml = $_[1]; |
578 | # handle xml |
619 | # handle xml |
579 | }); |
620 | }); |
580 | }); |
621 | }); |
581 | }); |
622 | }); |
… | |
… | |
588 | |
629 | |
589 | # request one |
630 | # request one |
590 | $handle->push_write ("request 1\015\012"); |
631 | $handle->push_write ("request 1\015\012"); |
591 | |
632 | |
592 | # we expect "ERROR" or "OK" as response, so push a line read |
633 | # we expect "ERROR" or "OK" as response, so push a line read |
593 | $handle->push_read_line (sub { |
634 | $handle->push_read (line => sub { |
594 | # if we got an "OK", we have to _prepend_ another line, |
635 | # 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 |
636 | # 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 |
637 | # which are already in the queue when this callback is called |
597 | # we don't do this in case we got an error |
638 | # we don't do this in case we got an error |
598 | if ($_[1] eq "OK") { |
639 | if ($_[1] eq "OK") { |
599 | $_[0]->unshift_read_line (sub { |
640 | $_[0]->unshift_read (line => sub { |
600 | my $response = $_[1]; |
641 | my $response = $_[1]; |
601 | ... |
642 | ... |
602 | }); |
643 | }); |
603 | } |
644 | } |
604 | }); |
645 | }); |
605 | |
646 | |
606 | # request two |
647 | # request two |
607 | $handle->push_write ("request 2\015\012"); |
648 | $handle->push_write ("request 2\015\012"); |
608 | |
649 | |
609 | # simply read 64 bytes, always |
650 | # simply read 64 bytes, always |
610 | $handle->push_read_chunk (64, sub { |
651 | $handle->push_read (chunk => 64, sub { |
611 | my $response = $_[1]; |
652 | my $response = $_[1]; |
612 | ... |
653 | ... |
613 | }); |
654 | }); |
614 | |
655 | |
615 | =over 4 |
656 | =over 4 |
616 | |
657 | |
617 | =cut |
658 | =cut |
618 | |
659 | |
619 | sub _drain_rbuf { |
660 | sub _drain_rbuf { |
620 | my ($self) = @_; |
661 | my ($self) = @_; |
|
|
662 | |
|
|
663 | local $self->{_in_drain} = 1; |
621 | |
664 | |
622 | if ( |
665 | if ( |
623 | defined $self->{rbuf_max} |
666 | defined $self->{rbuf_max} |
624 | && $self->{rbuf_max} < length $self->{rbuf} |
667 | && $self->{rbuf_max} < length $self->{rbuf} |
625 | ) { |
668 | ) { |
626 | $! = &Errno::ENOSPC; |
669 | return $self->_error (&Errno::ENOSPC, 1); |
627 | $self->error; |
|
|
628 | } |
670 | } |
629 | |
671 | |
630 | return if $self->{in_drain}; |
672 | while () { |
631 | local $self->{in_drain} = 1; |
|
|
632 | |
|
|
633 | while (my $len = length $self->{rbuf}) { |
|
|
634 | no strict 'refs'; |
673 | no strict 'refs'; |
|
|
674 | |
|
|
675 | my $len = length $self->{rbuf}; |
|
|
676 | |
635 | if (my $cb = shift @{ $self->{_queue} }) { |
677 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | unless ($cb->($self)) { |
678 | unless ($cb->($self)) { |
637 | if ($self->{_eof}) { |
679 | if ($self->{_eof}) { |
638 | # no progress can be made (not enough data and no data forthcoming) |
680 | # no progress can be made (not enough data and no data forthcoming) |
639 | $! = &Errno::EPIPE; |
681 | $self->_error (&Errno::EPIPE, 1), last; |
640 | $self->error; |
|
|
641 | } |
682 | } |
642 | |
683 | |
643 | unshift @{ $self->{_queue} }, $cb; |
684 | unshift @{ $self->{_queue} }, $cb; |
644 | return; |
685 | last; |
645 | } |
686 | } |
646 | } elsif ($self->{on_read}) { |
687 | } elsif ($self->{on_read}) { |
|
|
688 | last unless $len; |
|
|
689 | |
647 | $self->{on_read}($self); |
690 | $self->{on_read}($self); |
648 | |
691 | |
649 | if ( |
692 | if ( |
650 | $self->{_eof} # if no further data will arrive |
|
|
651 | && $len == length $self->{rbuf} # and no data has been consumed |
693 | $len == length $self->{rbuf} # if no data has been consumed |
652 | && !@{ $self->{_queue} } # and the queue is still empty |
694 | && !@{ $self->{_queue} } # and the queue is still empty |
653 | && $self->{on_read} # and we still want to read data |
695 | && $self->{on_read} # but we still have on_read |
654 | ) { |
696 | ) { |
|
|
697 | # no further data will arrive |
655 | # then no progress can be made |
698 | # so no progress can be made |
656 | $! = &Errno::EPIPE; |
699 | $self->_error (&Errno::EPIPE, 1), last |
657 | $self->error; |
700 | if $self->{_eof}; |
|
|
701 | |
|
|
702 | last; # more data might arrive |
658 | } |
703 | } |
659 | } else { |
704 | } else { |
660 | # read side becomes idle |
705 | # read side becomes idle |
661 | delete $self->{_rw}; |
706 | delete $self->{_rw}; |
662 | return; |
707 | last; |
663 | } |
708 | } |
664 | } |
709 | } |
665 | |
710 | |
666 | $self->{on_eof}($self) |
711 | $self->{on_eof}($self) |
667 | if $self->{_eof} && $self->{on_eof}; |
712 | if $self->{_eof} && $self->{on_eof}; |
|
|
713 | |
|
|
714 | # may need to restart read watcher |
|
|
715 | unless ($self->{_rw}) { |
|
|
716 | $self->start_read |
|
|
717 | if $self->{on_read} || @{ $self->{_queue} }; |
|
|
718 | } |
668 | } |
719 | } |
669 | |
720 | |
670 | =item $handle->on_read ($cb) |
721 | =item $handle->on_read ($cb) |
671 | |
722 | |
672 | This replaces the currently set C<on_read> callback, or clears it (when |
723 | This replaces the currently set C<on_read> callback, or clears it (when |
… | |
… | |
677 | |
728 | |
678 | sub on_read { |
729 | sub on_read { |
679 | my ($self, $cb) = @_; |
730 | my ($self, $cb) = @_; |
680 | |
731 | |
681 | $self->{on_read} = $cb; |
732 | $self->{on_read} = $cb; |
|
|
733 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
682 | } |
734 | } |
683 | |
735 | |
684 | =item $handle->rbuf |
736 | =item $handle->rbuf |
685 | |
737 | |
686 | Returns the read buffer (as a modifiable lvalue). |
738 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
735 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
787 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
736 | ->($self, $cb, @_); |
788 | ->($self, $cb, @_); |
737 | } |
789 | } |
738 | |
790 | |
739 | push @{ $self->{_queue} }, $cb; |
791 | push @{ $self->{_queue} }, $cb; |
740 | $self->_drain_rbuf; |
792 | $self->_drain_rbuf unless $self->{_in_drain}; |
741 | } |
793 | } |
742 | |
794 | |
743 | sub unshift_read { |
795 | sub unshift_read { |
744 | my $self = shift; |
796 | my $self = shift; |
745 | my $cb = pop; |
797 | my $cb = pop; |
… | |
… | |
751 | ->($self, $cb, @_); |
803 | ->($self, $cb, @_); |
752 | } |
804 | } |
753 | |
805 | |
754 | |
806 | |
755 | unshift @{ $self->{_queue} }, $cb; |
807 | unshift @{ $self->{_queue} }, $cb; |
756 | $self->_drain_rbuf; |
808 | $self->_drain_rbuf unless $self->{_in_drain}; |
757 | } |
809 | } |
758 | |
810 | |
759 | =item $handle->push_read (type => @args, $cb) |
811 | =item $handle->push_read (type => @args, $cb) |
760 | |
812 | |
761 | =item $handle->unshift_read (type => @args, $cb) |
813 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
846 | |
898 | |
847 | sub unshift_read_line { |
899 | sub unshift_read_line { |
848 | my $self = shift; |
900 | my $self = shift; |
849 | $self->unshift_read (line => @_); |
901 | $self->unshift_read (line => @_); |
850 | } |
902 | } |
851 | |
|
|
852 | =item netstring => $cb->($handle, $string) |
|
|
853 | |
|
|
854 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
855 | |
|
|
856 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
857 | |
|
|
858 | =cut |
|
|
859 | |
|
|
860 | register_read_type netstring => sub { |
|
|
861 | my ($self, $cb) = @_; |
|
|
862 | |
|
|
863 | sub { |
|
|
864 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
865 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
866 | $! = &Errno::EBADMSG; |
|
|
867 | $self->error; |
|
|
868 | } |
|
|
869 | return; |
|
|
870 | } |
|
|
871 | |
|
|
872 | my $len = $1; |
|
|
873 | |
|
|
874 | $self->unshift_read (chunk => $len, sub { |
|
|
875 | my $string = $_[1]; |
|
|
876 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
877 | if ($_[1] eq ",") { |
|
|
878 | $cb->($_[0], $string); |
|
|
879 | } else { |
|
|
880 | $! = &Errno::EBADMSG; |
|
|
881 | $self->error; |
|
|
882 | } |
|
|
883 | }); |
|
|
884 | }); |
|
|
885 | |
|
|
886 | 1 |
|
|
887 | } |
|
|
888 | }; |
|
|
889 | |
903 | |
890 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
904 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
891 | |
905 | |
892 | Makes a regex match against the regex object C<$accept> and returns |
906 | Makes a regex match against the regex object C<$accept> and returns |
893 | everything up to and including the match. |
907 | everything up to and including the match. |
… | |
… | |
943 | return 1; |
957 | return 1; |
944 | } |
958 | } |
945 | |
959 | |
946 | # reject |
960 | # reject |
947 | if ($reject && $$rbuf =~ $reject) { |
961 | if ($reject && $$rbuf =~ $reject) { |
948 | $! = &Errno::EBADMSG; |
962 | $self->_error (&Errno::EBADMSG); |
949 | $self->error; |
|
|
950 | } |
963 | } |
951 | |
964 | |
952 | # skip |
965 | # skip |
953 | if ($skip && $$rbuf =~ $skip) { |
966 | if ($skip && $$rbuf =~ $skip) { |
954 | $data .= substr $$rbuf, 0, $+[0], ""; |
967 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
956 | |
969 | |
957 | () |
970 | () |
958 | } |
971 | } |
959 | }; |
972 | }; |
960 | |
973 | |
|
|
974 | =item netstring => $cb->($handle, $string) |
|
|
975 | |
|
|
976 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
977 | |
|
|
978 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
979 | |
|
|
980 | =cut |
|
|
981 | |
|
|
982 | register_read_type netstring => sub { |
|
|
983 | my ($self, $cb) = @_; |
|
|
984 | |
|
|
985 | sub { |
|
|
986 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
987 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
988 | $self->_error (&Errno::EBADMSG); |
|
|
989 | } |
|
|
990 | return; |
|
|
991 | } |
|
|
992 | |
|
|
993 | my $len = $1; |
|
|
994 | |
|
|
995 | $self->unshift_read (chunk => $len, sub { |
|
|
996 | my $string = $_[1]; |
|
|
997 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
998 | if ($_[1] eq ",") { |
|
|
999 | $cb->($_[0], $string); |
|
|
1000 | } else { |
|
|
1001 | $self->_error (&Errno::EBADMSG); |
|
|
1002 | } |
|
|
1003 | }); |
|
|
1004 | }); |
|
|
1005 | |
|
|
1006 | 1 |
|
|
1007 | } |
|
|
1008 | }; |
|
|
1009 | |
|
|
1010 | =item packstring => $format, $cb->($handle, $string) |
|
|
1011 | |
|
|
1012 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1013 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1014 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1015 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1016 | |
|
|
1017 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1018 | |
|
|
1019 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1020 | format (very efficient). |
|
|
1021 | |
|
|
1022 | $handle->push_read (packstring => "w", sub { |
|
|
1023 | my ($handle, $data) = @_; |
|
|
1024 | }); |
|
|
1025 | |
|
|
1026 | =cut |
|
|
1027 | |
|
|
1028 | register_read_type packstring => sub { |
|
|
1029 | my ($self, $cb, $format) = @_; |
|
|
1030 | |
|
|
1031 | sub { |
|
|
1032 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1033 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
|
|
1034 | or return; |
|
|
1035 | |
|
|
1036 | # remove prefix |
|
|
1037 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
|
|
1038 | |
|
|
1039 | # read rest |
|
|
1040 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1041 | |
|
|
1042 | 1 |
|
|
1043 | } |
|
|
1044 | }; |
|
|
1045 | |
961 | =item json => $cb->($handle, $hash_or_arrayref) |
1046 | =item json => $cb->($handle, $hash_or_arrayref) |
962 | |
1047 | |
963 | Reads a JSON object or array, decodes it and passes it to the callback. |
1048 | Reads a JSON object or array, decodes it and passes it to the callback. |
964 | |
1049 | |
965 | If a C<json> object was passed to the constructor, then that will be used |
1050 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
975 | the C<json> write type description, above, for an actual example. |
1060 | the C<json> write type description, above, for an actual example. |
976 | |
1061 | |
977 | =cut |
1062 | =cut |
978 | |
1063 | |
979 | register_read_type json => sub { |
1064 | register_read_type json => sub { |
980 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1065 | my ($self, $cb) = @_; |
981 | |
1066 | |
982 | require JSON; |
1067 | require JSON; |
983 | |
1068 | |
984 | my $data; |
1069 | my $data; |
985 | my $rbuf = \$self->{rbuf}; |
1070 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1000 | () |
1085 | () |
1001 | } |
1086 | } |
1002 | } |
1087 | } |
1003 | }; |
1088 | }; |
1004 | |
1089 | |
|
|
1090 | =item storable => $cb->($handle, $ref) |
|
|
1091 | |
|
|
1092 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1093 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1094 | data). |
|
|
1095 | |
|
|
1096 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1097 | |
|
|
1098 | =cut |
|
|
1099 | |
|
|
1100 | register_read_type storable => sub { |
|
|
1101 | my ($self, $cb) = @_; |
|
|
1102 | |
|
|
1103 | require Storable; |
|
|
1104 | |
|
|
1105 | sub { |
|
|
1106 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1107 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
|
|
1108 | or return; |
|
|
1109 | |
|
|
1110 | # remove prefix |
|
|
1111 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
|
|
1112 | |
|
|
1113 | # read rest |
|
|
1114 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1115 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1116 | $cb->($_[0], $ref); |
|
|
1117 | } else { |
|
|
1118 | $self->_error (&Errno::EBADMSG); |
|
|
1119 | } |
|
|
1120 | }); |
|
|
1121 | } |
|
|
1122 | }; |
|
|
1123 | |
1005 | =back |
1124 | =back |
1006 | |
1125 | |
1007 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1126 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1008 | |
1127 | |
1009 | This function (not method) lets you add your own types to C<push_read>. |
1128 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1027 | =item $handle->stop_read |
1146 | =item $handle->stop_read |
1028 | |
1147 | |
1029 | =item $handle->start_read |
1148 | =item $handle->start_read |
1030 | |
1149 | |
1031 | In rare cases you actually do not want to read anything from the |
1150 | In rare cases you actually do not want to read anything from the |
1032 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1151 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
1033 | any queued callbacks will be executed then. To start reading again, call |
1152 | any queued callbacks will be executed then. To start reading again, call |
1034 | C<start_read>. |
1153 | C<start_read>. |
|
|
1154 | |
|
|
1155 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1156 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1157 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1158 | there are any read requests in the queue. |
1035 | |
1159 | |
1036 | =cut |
1160 | =cut |
1037 | |
1161 | |
1038 | sub stop_read { |
1162 | sub stop_read { |
1039 | my ($self) = @_; |
1163 | my ($self) = @_; |
… | |
… | |
1054 | if ($len > 0) { |
1178 | if ($len > 0) { |
1055 | $self->{_activity} = AnyEvent->now; |
1179 | $self->{_activity} = AnyEvent->now; |
1056 | |
1180 | |
1057 | $self->{filter_r} |
1181 | $self->{filter_r} |
1058 | ? $self->{filter_r}($self, $rbuf) |
1182 | ? $self->{filter_r}($self, $rbuf) |
1059 | : $self->_drain_rbuf; |
1183 | : $self->{_in_drain} || $self->_drain_rbuf; |
1060 | |
1184 | |
1061 | } elsif (defined $len) { |
1185 | } elsif (defined $len) { |
1062 | delete $self->{_rw}; |
1186 | delete $self->{_rw}; |
1063 | $self->{_eof} = 1; |
1187 | $self->{_eof} = 1; |
1064 | $self->_drain_rbuf; |
1188 | $self->_drain_rbuf unless $self->{_in_drain}; |
1065 | |
1189 | |
1066 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1190 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1067 | return $self->error; |
1191 | return $self->_error ($!, 1); |
1068 | } |
1192 | } |
1069 | }); |
1193 | }); |
1070 | } |
1194 | } |
1071 | } |
1195 | } |
1072 | |
1196 | |
1073 | sub _dotls { |
1197 | sub _dotls { |
1074 | my ($self) = @_; |
1198 | my ($self) = @_; |
|
|
1199 | |
|
|
1200 | my $buf; |
1075 | |
1201 | |
1076 | if (length $self->{_tls_wbuf}) { |
1202 | if (length $self->{_tls_wbuf}) { |
1077 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1203 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1078 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1204 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1079 | } |
1205 | } |
1080 | } |
1206 | } |
1081 | |
1207 | |
1082 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1208 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1083 | $self->{wbuf} .= $buf; |
1209 | $self->{wbuf} .= $buf; |
1084 | $self->_drain_wbuf; |
1210 | $self->_drain_wbuf; |
1085 | } |
1211 | } |
1086 | |
1212 | |
1087 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1213 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1214 | if (length $buf) { |
1088 | $self->{rbuf} .= $buf; |
1215 | $self->{rbuf} .= $buf; |
1089 | $self->_drain_rbuf; |
1216 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1217 | } else { |
|
|
1218 | # let's treat SSL-eof as we treat normal EOF |
|
|
1219 | $self->{_eof} = 1; |
|
|
1220 | $self->_shutdown; |
|
|
1221 | return; |
|
|
1222 | } |
1090 | } |
1223 | } |
1091 | |
1224 | |
1092 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1225 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1093 | |
1226 | |
1094 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1227 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1095 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1228 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1096 | $self->error; |
1229 | return $self->_error ($!, 1); |
1097 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1230 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1098 | $! = &Errno::EIO; |
1231 | return $self->_error (&Errno::EIO, 1); |
1099 | $self->error; |
|
|
1100 | } |
1232 | } |
1101 | |
1233 | |
1102 | # all others are fine for our purposes |
1234 | # all others are fine for our purposes |
1103 | } |
1235 | } |
1104 | } |
1236 | } |
… | |
… | |
1119 | call and can be used or changed to your liking. Note that the handshake |
1251 | call and can be used or changed to your liking. Note that the handshake |
1120 | might have already started when this function returns. |
1252 | might have already started when this function returns. |
1121 | |
1253 | |
1122 | =cut |
1254 | =cut |
1123 | |
1255 | |
1124 | # TODO: maybe document... |
|
|
1125 | sub starttls { |
1256 | sub starttls { |
1126 | my ($self, $ssl, $ctx) = @_; |
1257 | my ($self, $ssl, $ctx) = @_; |
1127 | |
1258 | |
1128 | $self->stoptls; |
1259 | $self->stoptls; |
1129 | |
1260 | |
… | |
… | |
1182 | |
1313 | |
1183 | sub DESTROY { |
1314 | sub DESTROY { |
1184 | my $self = shift; |
1315 | my $self = shift; |
1185 | |
1316 | |
1186 | $self->stoptls; |
1317 | $self->stoptls; |
|
|
1318 | |
|
|
1319 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1320 | |
|
|
1321 | if ($linger && length $self->{wbuf}) { |
|
|
1322 | my $fh = delete $self->{fh}; |
|
|
1323 | my $wbuf = delete $self->{wbuf}; |
|
|
1324 | |
|
|
1325 | my @linger; |
|
|
1326 | |
|
|
1327 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1328 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1329 | |
|
|
1330 | if ($len > 0) { |
|
|
1331 | substr $wbuf, 0, $len, ""; |
|
|
1332 | } else { |
|
|
1333 | @linger = (); # end |
|
|
1334 | } |
|
|
1335 | }); |
|
|
1336 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1337 | @linger = (); |
|
|
1338 | }); |
|
|
1339 | } |
1187 | } |
1340 | } |
1188 | |
1341 | |
1189 | =item AnyEvent::Handle::TLS_CTX |
1342 | =item AnyEvent::Handle::TLS_CTX |
1190 | |
1343 | |
1191 | This function creates and returns the Net::SSLeay::CTX object used by |
1344 | This function creates and returns the Net::SSLeay::CTX object used by |