… | |
… | |
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.12; |
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; |
… | |
… | |
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 | |
237 | $self->start_read; |
245 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
238 | |
246 | |
239 | $self |
247 | $self |
240 | } |
248 | } |
241 | |
249 | |
242 | sub _shutdown { |
250 | sub _shutdown { |
… | |
… | |
480 | my ($self, $string) = @_; |
488 | my ($self, $string) = @_; |
481 | |
489 | |
482 | sprintf "%d:%s,", (length $string), $string |
490 | sprintf "%d:%s,", (length $string), $string |
483 | }; |
491 | }; |
484 | |
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 |
|
|
506 | }; |
|
|
507 | |
485 | =item json => $array_or_hashref |
508 | =item json => $array_or_hashref |
486 | |
509 | |
487 | 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 |
488 | provide your own JSON object, this means it will be encoded to JSON text |
511 | provide your own JSON object, this means it will be encoded to JSON text |
489 | in UTF-8. |
512 | in UTF-8. |
… | |
… | |
557 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
580 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
558 | or not. |
581 | or not. |
559 | |
582 | |
560 | In the more complex case, you want to queue multiple callbacks. In this |
583 | In the more complex case, you want to queue multiple callbacks. In this |
561 | case, AnyEvent::Handle will call the first queued callback each time new |
584 | case, AnyEvent::Handle will call the first queued callback each time new |
562 | data arrives and removes it when it has done its job (see C<push_read>, |
585 | data arrives (also the first time it is queued) and removes it when it has |
563 | below). |
586 | done its job (see C<push_read>, below). |
564 | |
587 | |
565 | This way you can, for example, push three line-reads, followed by reading |
588 | This way you can, for example, push three line-reads, followed by reading |
566 | a chunk of data, and AnyEvent::Handle will execute them in order. |
589 | a chunk of data, and AnyEvent::Handle will execute them in order. |
567 | |
590 | |
568 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
591 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
620 | =cut |
643 | =cut |
621 | |
644 | |
622 | sub _drain_rbuf { |
645 | sub _drain_rbuf { |
623 | my ($self) = @_; |
646 | my ($self) = @_; |
624 | |
647 | |
|
|
648 | local $self->{_in_drain} = 1; |
|
|
649 | |
625 | if ( |
650 | if ( |
626 | defined $self->{rbuf_max} |
651 | defined $self->{rbuf_max} |
627 | && $self->{rbuf_max} < length $self->{rbuf} |
652 | && $self->{rbuf_max} < length $self->{rbuf} |
628 | ) { |
653 | ) { |
629 | return $self->_error (&Errno::ENOSPC, 1); |
654 | return $self->_error (&Errno::ENOSPC, 1); |
630 | } |
655 | } |
631 | |
656 | |
632 | return if $self->{in_drain}; |
657 | while () { |
633 | local $self->{in_drain} = 1; |
|
|
634 | |
|
|
635 | while (my $len = length $self->{rbuf}) { |
|
|
636 | no strict 'refs'; |
658 | no strict 'refs'; |
|
|
659 | |
|
|
660 | my $len = length $self->{rbuf}; |
|
|
661 | |
637 | if (my $cb = shift @{ $self->{_queue} }) { |
662 | if (my $cb = shift @{ $self->{_queue} }) { |
638 | unless ($cb->($self)) { |
663 | unless ($cb->($self)) { |
639 | if ($self->{_eof}) { |
664 | if ($self->{_eof}) { |
640 | # no progress can be made (not enough data and no data forthcoming) |
665 | # no progress can be made (not enough data and no data forthcoming) |
641 | return $self->_error (&Errno::EPIPE, 1); |
666 | $self->_error (&Errno::EPIPE, 1), last; |
642 | } |
667 | } |
643 | |
668 | |
644 | unshift @{ $self->{_queue} }, $cb; |
669 | unshift @{ $self->{_queue} }, $cb; |
645 | last; |
670 | last; |
646 | } |
671 | } |
647 | } elsif ($self->{on_read}) { |
672 | } elsif ($self->{on_read}) { |
|
|
673 | last unless $len; |
|
|
674 | |
648 | $self->{on_read}($self); |
675 | $self->{on_read}($self); |
649 | |
676 | |
650 | if ( |
677 | if ( |
651 | $len == length $self->{rbuf} # if no data has been consumed |
678 | $len == length $self->{rbuf} # if no data has been consumed |
652 | && !@{ $self->{_queue} } # and the queue is still empty |
679 | && !@{ $self->{_queue} } # and the queue is still empty |
653 | && $self->{on_read} # but we still have on_read |
680 | && $self->{on_read} # but we still have on_read |
654 | ) { |
681 | ) { |
655 | # no further data will arrive |
682 | # no further data will arrive |
656 | # so no progress can be made |
683 | # so no progress can be made |
657 | return $self->_error (&Errno::EPIPE, 1) |
684 | $self->_error (&Errno::EPIPE, 1), last |
658 | if $self->{_eof}; |
685 | if $self->{_eof}; |
659 | |
686 | |
660 | last; # more data might arrive |
687 | last; # more data might arrive |
661 | } |
688 | } |
662 | } else { |
689 | } else { |
… | |
… | |
686 | |
713 | |
687 | sub on_read { |
714 | sub on_read { |
688 | my ($self, $cb) = @_; |
715 | my ($self, $cb) = @_; |
689 | |
716 | |
690 | $self->{on_read} = $cb; |
717 | $self->{on_read} = $cb; |
|
|
718 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
691 | } |
719 | } |
692 | |
720 | |
693 | =item $handle->rbuf |
721 | =item $handle->rbuf |
694 | |
722 | |
695 | Returns the read buffer (as a modifiable lvalue). |
723 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
744 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
772 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
745 | ->($self, $cb, @_); |
773 | ->($self, $cb, @_); |
746 | } |
774 | } |
747 | |
775 | |
748 | push @{ $self->{_queue} }, $cb; |
776 | push @{ $self->{_queue} }, $cb; |
749 | $self->_drain_rbuf; |
777 | $self->_drain_rbuf unless $self->{_in_drain}; |
750 | } |
778 | } |
751 | |
779 | |
752 | sub unshift_read { |
780 | sub unshift_read { |
753 | my $self = shift; |
781 | my $self = shift; |
754 | my $cb = pop; |
782 | my $cb = pop; |
… | |
… | |
760 | ->($self, $cb, @_); |
788 | ->($self, $cb, @_); |
761 | } |
789 | } |
762 | |
790 | |
763 | |
791 | |
764 | unshift @{ $self->{_queue} }, $cb; |
792 | unshift @{ $self->{_queue} }, $cb; |
765 | $self->_drain_rbuf; |
793 | $self->_drain_rbuf unless $self->{_in_drain}; |
766 | } |
794 | } |
767 | |
795 | |
768 | =item $handle->push_read (type => @args, $cb) |
796 | =item $handle->push_read (type => @args, $cb) |
769 | |
797 | |
770 | =item $handle->unshift_read (type => @args, $cb) |
798 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
855 | |
883 | |
856 | sub unshift_read_line { |
884 | sub unshift_read_line { |
857 | my $self = shift; |
885 | my $self = shift; |
858 | $self->unshift_read (line => @_); |
886 | $self->unshift_read (line => @_); |
859 | } |
887 | } |
860 | |
|
|
861 | =item netstring => $cb->($handle, $string) |
|
|
862 | |
|
|
863 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
864 | |
|
|
865 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
866 | |
|
|
867 | =cut |
|
|
868 | |
|
|
869 | register_read_type netstring => sub { |
|
|
870 | my ($self, $cb) = @_; |
|
|
871 | |
|
|
872 | sub { |
|
|
873 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
874 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
875 | $self->_error (&Errno::EBADMSG); |
|
|
876 | } |
|
|
877 | return; |
|
|
878 | } |
|
|
879 | |
|
|
880 | my $len = $1; |
|
|
881 | |
|
|
882 | $self->unshift_read (chunk => $len, sub { |
|
|
883 | my $string = $_[1]; |
|
|
884 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
885 | if ($_[1] eq ",") { |
|
|
886 | $cb->($_[0], $string); |
|
|
887 | } else { |
|
|
888 | $self->_error (&Errno::EBADMSG); |
|
|
889 | } |
|
|
890 | }); |
|
|
891 | }); |
|
|
892 | |
|
|
893 | 1 |
|
|
894 | } |
|
|
895 | }; |
|
|
896 | |
888 | |
897 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
889 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
898 | |
890 | |
899 | Makes a regex match against the regex object C<$accept> and returns |
891 | Makes a regex match against the regex object C<$accept> and returns |
900 | everything up to and including the match. |
892 | everything up to and including the match. |
… | |
… | |
962 | |
954 | |
963 | () |
955 | () |
964 | } |
956 | } |
965 | }; |
957 | }; |
966 | |
958 | |
|
|
959 | =item netstring => $cb->($handle, $string) |
|
|
960 | |
|
|
961 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
962 | |
|
|
963 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
964 | |
|
|
965 | =cut |
|
|
966 | |
|
|
967 | register_read_type netstring => sub { |
|
|
968 | my ($self, $cb) = @_; |
|
|
969 | |
|
|
970 | sub { |
|
|
971 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
972 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
973 | $self->_error (&Errno::EBADMSG); |
|
|
974 | } |
|
|
975 | return; |
|
|
976 | } |
|
|
977 | |
|
|
978 | my $len = $1; |
|
|
979 | |
|
|
980 | $self->unshift_read (chunk => $len, sub { |
|
|
981 | my $string = $_[1]; |
|
|
982 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
983 | if ($_[1] eq ",") { |
|
|
984 | $cb->($_[0], $string); |
|
|
985 | } else { |
|
|
986 | $self->_error (&Errno::EBADMSG); |
|
|
987 | } |
|
|
988 | }); |
|
|
989 | }); |
|
|
990 | |
|
|
991 | 1 |
|
|
992 | } |
|
|
993 | }; |
|
|
994 | |
|
|
995 | =item packstring => $format, $cb->($handle, $string) |
|
|
996 | |
|
|
997 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
998 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
999 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1000 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1001 | |
|
|
1002 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1003 | |
|
|
1004 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1005 | format (very efficient). |
|
|
1006 | |
|
|
1007 | $handle->push_read (packstring => "w", sub { |
|
|
1008 | my ($handle, $data) = @_; |
|
|
1009 | }); |
|
|
1010 | |
|
|
1011 | =cut |
|
|
1012 | |
|
|
1013 | register_read_type packstring => sub { |
|
|
1014 | my ($self, $cb, $format) = @_; |
|
|
1015 | |
|
|
1016 | sub { |
|
|
1017 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1018 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
|
|
1019 | or return; |
|
|
1020 | |
|
|
1021 | # remove prefix |
|
|
1022 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
|
|
1023 | |
|
|
1024 | # read rest |
|
|
1025 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1026 | |
|
|
1027 | 1 |
|
|
1028 | } |
|
|
1029 | }; |
|
|
1030 | |
967 | =item json => $cb->($handle, $hash_or_arrayref) |
1031 | =item json => $cb->($handle, $hash_or_arrayref) |
968 | |
1032 | |
969 | Reads a JSON object or array, decodes it and passes it to the callback. |
1033 | Reads a JSON object or array, decodes it and passes it to the callback. |
970 | |
1034 | |
971 | If a C<json> object was passed to the constructor, then that will be used |
1035 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
1033 | =item $handle->stop_read |
1097 | =item $handle->stop_read |
1034 | |
1098 | |
1035 | =item $handle->start_read |
1099 | =item $handle->start_read |
1036 | |
1100 | |
1037 | In rare cases you actually do not want to read anything from the |
1101 | In rare cases you actually do not want to read anything from the |
1038 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1102 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
1039 | any queued callbacks will be executed then. To start reading again, call |
1103 | any queued callbacks will be executed then. To start reading again, call |
1040 | C<start_read>. |
1104 | C<start_read>. |
1041 | |
1105 | |
1042 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1106 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1043 | you change the C<on_read> callback or push/unshift a read callback, and it |
1107 | you change the C<on_read> callback or push/unshift a read callback, and it |
… | |
… | |
1065 | if ($len > 0) { |
1129 | if ($len > 0) { |
1066 | $self->{_activity} = AnyEvent->now; |
1130 | $self->{_activity} = AnyEvent->now; |
1067 | |
1131 | |
1068 | $self->{filter_r} |
1132 | $self->{filter_r} |
1069 | ? $self->{filter_r}($self, $rbuf) |
1133 | ? $self->{filter_r}($self, $rbuf) |
1070 | : $self->_drain_rbuf; |
1134 | : $self->{_in_drain} || $self->_drain_rbuf; |
1071 | |
1135 | |
1072 | } elsif (defined $len) { |
1136 | } elsif (defined $len) { |
1073 | delete $self->{_rw}; |
1137 | delete $self->{_rw}; |
1074 | $self->{_eof} = 1; |
1138 | $self->{_eof} = 1; |
1075 | $self->_drain_rbuf; |
1139 | $self->_drain_rbuf unless $self->{_in_drain}; |
1076 | |
1140 | |
1077 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1141 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1078 | return $self->_error ($!, 1); |
1142 | return $self->_error ($!, 1); |
1079 | } |
1143 | } |
1080 | }); |
1144 | }); |
… | |
… | |
1098 | } |
1162 | } |
1099 | |
1163 | |
1100 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1164 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1101 | if (length $buf) { |
1165 | if (length $buf) { |
1102 | $self->{rbuf} .= $buf; |
1166 | $self->{rbuf} .= $buf; |
1103 | $self->_drain_rbuf; |
1167 | $self->_drain_rbuf unless $self->{_in_drain}; |
1104 | } else { |
1168 | } else { |
1105 | # let's treat SSL-eof as we treat normal EOF |
1169 | # let's treat SSL-eof as we treat normal EOF |
1106 | $self->{_eof} = 1; |
1170 | $self->{_eof} = 1; |
1107 | $self->_shutdown; |
1171 | $self->_shutdown; |
1108 | return; |
1172 | return; |
… | |
… | |
1200 | |
1264 | |
1201 | sub DESTROY { |
1265 | sub DESTROY { |
1202 | my $self = shift; |
1266 | my $self = shift; |
1203 | |
1267 | |
1204 | $self->stoptls; |
1268 | $self->stoptls; |
|
|
1269 | |
|
|
1270 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1271 | |
|
|
1272 | if ($linger && length $self->{wbuf}) { |
|
|
1273 | my $fh = delete $self->{fh}; |
|
|
1274 | my $wbuf = delete $self->{wbuf}; |
|
|
1275 | |
|
|
1276 | my @linger; |
|
|
1277 | |
|
|
1278 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1279 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1280 | |
|
|
1281 | if ($len > 0) { |
|
|
1282 | substr $wbuf, 0, $len, ""; |
|
|
1283 | } else { |
|
|
1284 | @linger = (); # end |
|
|
1285 | } |
|
|
1286 | }); |
|
|
1287 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1288 | @linger = (); |
|
|
1289 | }); |
|
|
1290 | } |
1205 | } |
1291 | } |
1206 | |
1292 | |
1207 | =item AnyEvent::Handle::TLS_CTX |
1293 | =item AnyEvent::Handle::TLS_CTX |
1208 | |
1294 | |
1209 | This function creates and returns the Net::SSLeay::CTX object used by |
1295 | This function creates and returns the Net::SSLeay::CTX object used by |