… | |
… | |
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.1; |
19 | our $VERSION = 4.151; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
105 | C<croak>. |
105 | C<croak>. |
106 | |
106 | |
107 | =item on_read => $cb->($handle) |
107 | =item on_read => $cb->($handle) |
108 | |
108 | |
109 | 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 |
110 | 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). |
111 | |
113 | |
112 | 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 >> |
113 | method or access the C<$handle->{rbuf}> member directly. |
115 | method or access the C<$handle->{rbuf}> member directly. |
114 | |
116 | |
115 | 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 |
… | |
… | |
165 | |
167 | |
166 | 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 |
167 | 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 |
168 | considered empty. |
170 | considered empty. |
169 | |
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 | |
170 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
183 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
171 | |
184 | |
172 | 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 |
173 | will start making tls handshake and will transparently encrypt/decrypt |
186 | will start making tls handshake and will transparently encrypt/decrypt |
174 | data. |
187 | data. |
… | |
… | |
224 | if ($self->{tls}) { |
237 | if ($self->{tls}) { |
225 | require Net::SSLeay; |
238 | require Net::SSLeay; |
226 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
239 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
227 | } |
240 | } |
228 | |
241 | |
229 | # $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop |
|
|
230 | # $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop |
|
|
231 | # $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop |
|
|
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
|
|
233 | |
|
|
234 | $self->{_activity} = AnyEvent->now; |
242 | $self->{_activity} = AnyEvent->now; |
235 | $self->_timeout; |
243 | $self->_timeout; |
236 | |
244 | |
|
|
245 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
|
|
246 | |
237 | $self->start_read; |
247 | $self->start_read |
|
|
248 | if $self->{on_read}; |
238 | |
249 | |
239 | $self |
250 | $self |
240 | } |
251 | } |
241 | |
252 | |
242 | sub _shutdown { |
253 | sub _shutdown { |
… | |
… | |
339 | $self->{on_timeout}($self); |
350 | $self->{on_timeout}($self); |
340 | } else { |
351 | } else { |
341 | $self->_error (&Errno::ETIMEDOUT); |
352 | $self->_error (&Errno::ETIMEDOUT); |
342 | } |
353 | } |
343 | |
354 | |
344 | # callbakx could have changed timeout value, optimise |
355 | # callback could have changed timeout value, optimise |
345 | return unless $self->{timeout}; |
356 | return unless $self->{timeout}; |
346 | |
357 | |
347 | # calculate new after |
358 | # calculate new after |
348 | $after = $self->{timeout}; |
359 | $after = $self->{timeout}; |
349 | } |
360 | } |
350 | |
361 | |
351 | Scalar::Util::weaken $self; |
362 | Scalar::Util::weaken $self; |
|
|
363 | return unless $self; # ->error could have destroyed $self |
352 | |
364 | |
353 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
365 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
354 | delete $self->{_tw}; |
366 | delete $self->{_tw}; |
355 | $self->_timeout; |
367 | $self->_timeout; |
356 | }); |
368 | }); |
… | |
… | |
479 | my ($self, $string) = @_; |
491 | my ($self, $string) = @_; |
480 | |
492 | |
481 | sprintf "%d:%s,", (length $string), $string |
493 | sprintf "%d:%s,", (length $string), $string |
482 | }; |
494 | }; |
483 | |
495 | |
|
|
496 | =item packstring => $format, $data |
|
|
497 | |
|
|
498 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
499 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
500 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
501 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
502 | |
|
|
503 | =cut |
|
|
504 | |
|
|
505 | register_write_type packstring => sub { |
|
|
506 | my ($self, $format, $string) = @_; |
|
|
507 | |
|
|
508 | pack "$format/a*", $string |
|
|
509 | }; |
|
|
510 | |
484 | =item json => $array_or_hashref |
511 | =item json => $array_or_hashref |
485 | |
512 | |
486 | Encodes the given hash or array reference into a JSON object. Unless you |
513 | Encodes the given hash or array reference into a JSON object. Unless you |
487 | provide your own JSON object, this means it will be encoded to JSON text |
514 | provide your own JSON object, this means it will be encoded to JSON text |
488 | in UTF-8. |
515 | in UTF-8. |
… | |
… | |
520 | |
547 | |
521 | $self->{json} ? $self->{json}->encode ($ref) |
548 | $self->{json} ? $self->{json}->encode ($ref) |
522 | : JSON::encode_json ($ref) |
549 | : JSON::encode_json ($ref) |
523 | }; |
550 | }; |
524 | |
551 | |
|
|
552 | =item storable => $reference |
|
|
553 | |
|
|
554 | Freezes the given reference using L<Storable> and writes it to the |
|
|
555 | handle. Uses the C<nfreeze> format. |
|
|
556 | |
|
|
557 | =cut |
|
|
558 | |
|
|
559 | register_write_type storable => sub { |
|
|
560 | my ($self, $ref) = @_; |
|
|
561 | |
|
|
562 | require Storable; |
|
|
563 | |
|
|
564 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
565 | }; |
|
|
566 | |
525 | =back |
567 | =back |
526 | |
568 | |
527 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
569 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
528 | |
570 | |
529 | This function (not method) lets you add your own types to C<push_write>. |
571 | This function (not method) lets you add your own types to C<push_write>. |
… | |
… | |
556 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
598 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
557 | or not. |
599 | or not. |
558 | |
600 | |
559 | In the more complex case, you want to queue multiple callbacks. In this |
601 | In the more complex case, you want to queue multiple callbacks. In this |
560 | case, AnyEvent::Handle will call the first queued callback each time new |
602 | case, AnyEvent::Handle will call the first queued callback each time new |
561 | data arrives and removes it when it has done its job (see C<push_read>, |
603 | data arrives (also the first time it is queued) and removes it when it has |
562 | below). |
604 | done its job (see C<push_read>, below). |
563 | |
605 | |
564 | This way you can, for example, push three line-reads, followed by reading |
606 | This way you can, for example, push three line-reads, followed by reading |
565 | a chunk of data, and AnyEvent::Handle will execute them in order. |
607 | a chunk of data, and AnyEvent::Handle will execute them in order. |
566 | |
608 | |
567 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
609 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
619 | =cut |
661 | =cut |
620 | |
662 | |
621 | sub _drain_rbuf { |
663 | sub _drain_rbuf { |
622 | my ($self) = @_; |
664 | my ($self) = @_; |
623 | |
665 | |
|
|
666 | local $self->{_in_drain} = 1; |
|
|
667 | |
624 | if ( |
668 | if ( |
625 | defined $self->{rbuf_max} |
669 | defined $self->{rbuf_max} |
626 | && $self->{rbuf_max} < length $self->{rbuf} |
670 | && $self->{rbuf_max} < length $self->{rbuf} |
627 | ) { |
671 | ) { |
628 | return $self->_error (&Errno::ENOSPC, 1); |
672 | return $self->_error (&Errno::ENOSPC, 1); |
629 | } |
673 | } |
630 | |
674 | |
631 | return if $self->{in_drain}; |
675 | while () { |
632 | local $self->{in_drain} = 1; |
|
|
633 | |
|
|
634 | while (my $len = length $self->{rbuf}) { |
|
|
635 | no strict 'refs'; |
676 | no strict 'refs'; |
|
|
677 | |
|
|
678 | my $len = length $self->{rbuf}; |
|
|
679 | |
636 | if (my $cb = shift @{ $self->{_queue} }) { |
680 | if (my $cb = shift @{ $self->{_queue} }) { |
637 | unless ($cb->($self)) { |
681 | unless ($cb->($self)) { |
638 | if ($self->{_eof}) { |
682 | if ($self->{_eof}) { |
639 | # no progress can be made (not enough data and no data forthcoming) |
683 | # no progress can be made (not enough data and no data forthcoming) |
640 | return $self->_error (&Errno::EPIPE, 1); |
684 | $self->_error (&Errno::EPIPE, 1), last; |
641 | } |
685 | } |
642 | |
686 | |
643 | unshift @{ $self->{_queue} }, $cb; |
687 | unshift @{ $self->{_queue} }, $cb; |
644 | return; |
688 | last; |
645 | } |
689 | } |
646 | } elsif ($self->{on_read}) { |
690 | } elsif ($self->{on_read}) { |
|
|
691 | last unless $len; |
|
|
692 | |
647 | $self->{on_read}($self); |
693 | $self->{on_read}($self); |
648 | |
694 | |
649 | if ( |
695 | if ( |
650 | $self->{_eof} # if no further data will arrive |
|
|
651 | && $len == length $self->{rbuf} # and no data has been consumed |
696 | $len == length $self->{rbuf} # if no data has been consumed |
652 | && !@{ $self->{_queue} } # and the queue is still empty |
697 | && !@{ $self->{_queue} } # and the queue is still empty |
653 | && $self->{on_read} # and we still want to read data |
698 | && $self->{on_read} # but we still have on_read |
654 | ) { |
699 | ) { |
|
|
700 | # no further data will arrive |
655 | # then no progress can be made |
701 | # so no progress can be made |
656 | return $self->_error (&Errno::EPIPE, 1); |
702 | $self->_error (&Errno::EPIPE, 1), last |
|
|
703 | if $self->{_eof}; |
|
|
704 | |
|
|
705 | last; # more data might arrive |
657 | } |
706 | } |
658 | } else { |
707 | } else { |
659 | # read side becomes idle |
708 | # read side becomes idle |
660 | delete $self->{_rw}; |
709 | delete $self->{_rw}; |
661 | return; |
710 | last; |
662 | } |
711 | } |
663 | } |
712 | } |
664 | |
713 | |
665 | $self->{on_eof}($self) |
714 | $self->{on_eof}($self) |
666 | if $self->{_eof} && $self->{on_eof}; |
715 | if $self->{_eof} && $self->{on_eof}; |
|
|
716 | |
|
|
717 | # may need to restart read watcher |
|
|
718 | unless ($self->{_rw}) { |
|
|
719 | $self->start_read |
|
|
720 | if $self->{on_read} || @{ $self->{_queue} }; |
|
|
721 | } |
667 | } |
722 | } |
668 | |
723 | |
669 | =item $handle->on_read ($cb) |
724 | =item $handle->on_read ($cb) |
670 | |
725 | |
671 | This replaces the currently set C<on_read> callback, or clears it (when |
726 | This replaces the currently set C<on_read> callback, or clears it (when |
… | |
… | |
676 | |
731 | |
677 | sub on_read { |
732 | sub on_read { |
678 | my ($self, $cb) = @_; |
733 | my ($self, $cb) = @_; |
679 | |
734 | |
680 | $self->{on_read} = $cb; |
735 | $self->{on_read} = $cb; |
|
|
736 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
681 | } |
737 | } |
682 | |
738 | |
683 | =item $handle->rbuf |
739 | =item $handle->rbuf |
684 | |
740 | |
685 | Returns the read buffer (as a modifiable lvalue). |
741 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
734 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
790 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
735 | ->($self, $cb, @_); |
791 | ->($self, $cb, @_); |
736 | } |
792 | } |
737 | |
793 | |
738 | push @{ $self->{_queue} }, $cb; |
794 | push @{ $self->{_queue} }, $cb; |
739 | $self->_drain_rbuf; |
795 | $self->_drain_rbuf unless $self->{_in_drain}; |
740 | } |
796 | } |
741 | |
797 | |
742 | sub unshift_read { |
798 | sub unshift_read { |
743 | my $self = shift; |
799 | my $self = shift; |
744 | my $cb = pop; |
800 | my $cb = pop; |
… | |
… | |
750 | ->($self, $cb, @_); |
806 | ->($self, $cb, @_); |
751 | } |
807 | } |
752 | |
808 | |
753 | |
809 | |
754 | unshift @{ $self->{_queue} }, $cb; |
810 | unshift @{ $self->{_queue} }, $cb; |
755 | $self->_drain_rbuf; |
811 | $self->_drain_rbuf unless $self->{_in_drain}; |
756 | } |
812 | } |
757 | |
813 | |
758 | =item $handle->push_read (type => @args, $cb) |
814 | =item $handle->push_read (type => @args, $cb) |
759 | |
815 | |
760 | =item $handle->unshift_read (type => @args, $cb) |
816 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
845 | |
901 | |
846 | sub unshift_read_line { |
902 | sub unshift_read_line { |
847 | my $self = shift; |
903 | my $self = shift; |
848 | $self->unshift_read (line => @_); |
904 | $self->unshift_read (line => @_); |
849 | } |
905 | } |
850 | |
|
|
851 | =item netstring => $cb->($handle, $string) |
|
|
852 | |
|
|
853 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
854 | |
|
|
855 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
856 | |
|
|
857 | =cut |
|
|
858 | |
|
|
859 | register_read_type netstring => sub { |
|
|
860 | my ($self, $cb) = @_; |
|
|
861 | |
|
|
862 | sub { |
|
|
863 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
864 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
865 | $self->_error (&Errno::EBADMSG); |
|
|
866 | } |
|
|
867 | return; |
|
|
868 | } |
|
|
869 | |
|
|
870 | my $len = $1; |
|
|
871 | |
|
|
872 | $self->unshift_read (chunk => $len, sub { |
|
|
873 | my $string = $_[1]; |
|
|
874 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
875 | if ($_[1] eq ",") { |
|
|
876 | $cb->($_[0], $string); |
|
|
877 | } else { |
|
|
878 | $self->_error (&Errno::EBADMSG); |
|
|
879 | } |
|
|
880 | }); |
|
|
881 | }); |
|
|
882 | |
|
|
883 | 1 |
|
|
884 | } |
|
|
885 | }; |
|
|
886 | |
906 | |
887 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
907 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
888 | |
908 | |
889 | Makes a regex match against the regex object C<$accept> and returns |
909 | Makes a regex match against the regex object C<$accept> and returns |
890 | everything up to and including the match. |
910 | everything up to and including the match. |
… | |
… | |
952 | |
972 | |
953 | () |
973 | () |
954 | } |
974 | } |
955 | }; |
975 | }; |
956 | |
976 | |
|
|
977 | =item netstring => $cb->($handle, $string) |
|
|
978 | |
|
|
979 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
980 | |
|
|
981 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
982 | |
|
|
983 | =cut |
|
|
984 | |
|
|
985 | register_read_type netstring => sub { |
|
|
986 | my ($self, $cb) = @_; |
|
|
987 | |
|
|
988 | sub { |
|
|
989 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
990 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
991 | $self->_error (&Errno::EBADMSG); |
|
|
992 | } |
|
|
993 | return; |
|
|
994 | } |
|
|
995 | |
|
|
996 | my $len = $1; |
|
|
997 | |
|
|
998 | $self->unshift_read (chunk => $len, sub { |
|
|
999 | my $string = $_[1]; |
|
|
1000 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1001 | if ($_[1] eq ",") { |
|
|
1002 | $cb->($_[0], $string); |
|
|
1003 | } else { |
|
|
1004 | $self->_error (&Errno::EBADMSG); |
|
|
1005 | } |
|
|
1006 | }); |
|
|
1007 | }); |
|
|
1008 | |
|
|
1009 | 1 |
|
|
1010 | } |
|
|
1011 | }; |
|
|
1012 | |
|
|
1013 | =item packstring => $format, $cb->($handle, $string) |
|
|
1014 | |
|
|
1015 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1016 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1017 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1018 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1019 | |
|
|
1020 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1021 | |
|
|
1022 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1023 | format (very efficient). |
|
|
1024 | |
|
|
1025 | $handle->push_read (packstring => "w", sub { |
|
|
1026 | my ($handle, $data) = @_; |
|
|
1027 | }); |
|
|
1028 | |
|
|
1029 | =cut |
|
|
1030 | |
|
|
1031 | register_read_type packstring => sub { |
|
|
1032 | my ($self, $cb, $format) = @_; |
|
|
1033 | |
|
|
1034 | sub { |
|
|
1035 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1036 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
|
|
1037 | or return; |
|
|
1038 | |
|
|
1039 | # remove prefix |
|
|
1040 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
|
|
1041 | |
|
|
1042 | # read rest |
|
|
1043 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1044 | |
|
|
1045 | 1 |
|
|
1046 | } |
|
|
1047 | }; |
|
|
1048 | |
957 | =item json => $cb->($handle, $hash_or_arrayref) |
1049 | =item json => $cb->($handle, $hash_or_arrayref) |
958 | |
1050 | |
959 | Reads a JSON object or array, decodes it and passes it to the callback. |
1051 | Reads a JSON object or array, decodes it and passes it to the callback. |
960 | |
1052 | |
961 | If a C<json> object was passed to the constructor, then that will be used |
1053 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
971 | the C<json> write type description, above, for an actual example. |
1063 | the C<json> write type description, above, for an actual example. |
972 | |
1064 | |
973 | =cut |
1065 | =cut |
974 | |
1066 | |
975 | register_read_type json => sub { |
1067 | register_read_type json => sub { |
976 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1068 | my ($self, $cb) = @_; |
977 | |
1069 | |
978 | require JSON; |
1070 | require JSON; |
979 | |
1071 | |
980 | my $data; |
1072 | my $data; |
981 | my $rbuf = \$self->{rbuf}; |
1073 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
996 | () |
1088 | () |
997 | } |
1089 | } |
998 | } |
1090 | } |
999 | }; |
1091 | }; |
1000 | |
1092 | |
|
|
1093 | =item storable => $cb->($handle, $ref) |
|
|
1094 | |
|
|
1095 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1096 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1097 | data). |
|
|
1098 | |
|
|
1099 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1100 | |
|
|
1101 | =cut |
|
|
1102 | |
|
|
1103 | register_read_type storable => sub { |
|
|
1104 | my ($self, $cb) = @_; |
|
|
1105 | |
|
|
1106 | require Storable; |
|
|
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 "w", $_[0]->{rbuf} }) |
|
|
1111 | or return; |
|
|
1112 | |
|
|
1113 | # remove prefix |
|
|
1114 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
|
|
1115 | |
|
|
1116 | # read rest |
|
|
1117 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1118 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1119 | $cb->($_[0], $ref); |
|
|
1120 | } else { |
|
|
1121 | $self->_error (&Errno::EBADMSG); |
|
|
1122 | } |
|
|
1123 | }); |
|
|
1124 | } |
|
|
1125 | }; |
|
|
1126 | |
1001 | =back |
1127 | =back |
1002 | |
1128 | |
1003 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1129 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1004 | |
1130 | |
1005 | This function (not method) lets you add your own types to C<push_read>. |
1131 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1023 | =item $handle->stop_read |
1149 | =item $handle->stop_read |
1024 | |
1150 | |
1025 | =item $handle->start_read |
1151 | =item $handle->start_read |
1026 | |
1152 | |
1027 | In rare cases you actually do not want to read anything from the |
1153 | In rare cases you actually do not want to read anything from the |
1028 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1154 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
1029 | any queued callbacks will be executed then. To start reading again, call |
1155 | any queued callbacks will be executed then. To start reading again, call |
1030 | C<start_read>. |
1156 | C<start_read>. |
|
|
1157 | |
|
|
1158 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1159 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1160 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1161 | there are any read requests in the queue. |
1031 | |
1162 | |
1032 | =cut |
1163 | =cut |
1033 | |
1164 | |
1034 | sub stop_read { |
1165 | sub stop_read { |
1035 | my ($self) = @_; |
1166 | my ($self) = @_; |
… | |
… | |
1050 | if ($len > 0) { |
1181 | if ($len > 0) { |
1051 | $self->{_activity} = AnyEvent->now; |
1182 | $self->{_activity} = AnyEvent->now; |
1052 | |
1183 | |
1053 | $self->{filter_r} |
1184 | $self->{filter_r} |
1054 | ? $self->{filter_r}($self, $rbuf) |
1185 | ? $self->{filter_r}($self, $rbuf) |
1055 | : $self->_drain_rbuf; |
1186 | : $self->{_in_drain} || $self->_drain_rbuf; |
1056 | |
1187 | |
1057 | } elsif (defined $len) { |
1188 | } elsif (defined $len) { |
1058 | delete $self->{_rw}; |
1189 | delete $self->{_rw}; |
1059 | $self->{_eof} = 1; |
1190 | $self->{_eof} = 1; |
1060 | $self->_drain_rbuf; |
1191 | $self->_drain_rbuf unless $self->{_in_drain}; |
1061 | |
1192 | |
1062 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1193 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1063 | return $self->_error ($!, 1); |
1194 | return $self->_error ($!, 1); |
1064 | } |
1195 | } |
1065 | }); |
1196 | }); |
… | |
… | |
1067 | } |
1198 | } |
1068 | |
1199 | |
1069 | sub _dotls { |
1200 | sub _dotls { |
1070 | my ($self) = @_; |
1201 | my ($self) = @_; |
1071 | |
1202 | |
|
|
1203 | my $buf; |
|
|
1204 | |
1072 | if (length $self->{_tls_wbuf}) { |
1205 | if (length $self->{_tls_wbuf}) { |
1073 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1206 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1074 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1207 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1075 | } |
1208 | } |
1076 | } |
1209 | } |
1077 | |
1210 | |
1078 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1211 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1079 | $self->{wbuf} .= $buf; |
1212 | $self->{wbuf} .= $buf; |
1080 | $self->_drain_wbuf; |
1213 | $self->_drain_wbuf; |
1081 | } |
1214 | } |
1082 | |
1215 | |
1083 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1216 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1217 | if (length $buf) { |
1084 | $self->{rbuf} .= $buf; |
1218 | $self->{rbuf} .= $buf; |
1085 | $self->_drain_rbuf; |
1219 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1220 | } else { |
|
|
1221 | # let's treat SSL-eof as we treat normal EOF |
|
|
1222 | $self->{_eof} = 1; |
|
|
1223 | $self->_shutdown; |
|
|
1224 | return; |
|
|
1225 | } |
1086 | } |
1226 | } |
1087 | |
1227 | |
1088 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1228 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1089 | |
1229 | |
1090 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1230 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
… | |
… | |
1176 | |
1316 | |
1177 | sub DESTROY { |
1317 | sub DESTROY { |
1178 | my $self = shift; |
1318 | my $self = shift; |
1179 | |
1319 | |
1180 | $self->stoptls; |
1320 | $self->stoptls; |
|
|
1321 | |
|
|
1322 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1323 | |
|
|
1324 | if ($linger && length $self->{wbuf}) { |
|
|
1325 | my $fh = delete $self->{fh}; |
|
|
1326 | my $wbuf = delete $self->{wbuf}; |
|
|
1327 | |
|
|
1328 | my @linger; |
|
|
1329 | |
|
|
1330 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1331 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1332 | |
|
|
1333 | if ($len > 0) { |
|
|
1334 | substr $wbuf, 0, $len, ""; |
|
|
1335 | } else { |
|
|
1336 | @linger = (); # end |
|
|
1337 | } |
|
|
1338 | }); |
|
|
1339 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1340 | @linger = (); |
|
|
1341 | }); |
|
|
1342 | } |
1181 | } |
1343 | } |
1182 | |
1344 | |
1183 | =item AnyEvent::Handle::TLS_CTX |
1345 | =item AnyEvent::Handle::TLS_CTX |
1184 | |
1346 | |
1185 | This function creates and returns the Net::SSLeay::CTX object used by |
1347 | This function creates and returns the Net::SSLeay::CTX object used by |