1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = 4.160; |
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 when an end-of-file condition is detcted, |
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 |
81 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
82 | connection cleanly. |
83 | |
83 | |
84 | 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, |
85 | 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 |
… | |
… | |
225 | You can also provide your own TLS connection object, but you have |
225 | You can also provide your own TLS connection object, but you have |
226 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
226 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
227 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
227 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
228 | AnyEvent::Handle. |
228 | AnyEvent::Handle. |
229 | |
229 | |
230 | See the C<starttls> method if you need to start TLs negotiation later. |
230 | See the C<starttls> method if you need to start TLS negotiation later. |
231 | |
231 | |
232 | =item tls_ctx => $ssl_ctx |
232 | =item tls_ctx => $ssl_ctx |
233 | |
233 | |
234 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
234 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
235 | (unless a connection object was specified directly). If this parameter is |
235 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
730 | ) { |
730 | ) { |
731 | return $self->_error (&Errno::ENOSPC, 1); |
731 | return $self->_error (&Errno::ENOSPC, 1); |
732 | } |
732 | } |
733 | |
733 | |
734 | while () { |
734 | while () { |
735 | no strict 'refs'; |
|
|
736 | |
|
|
737 | my $len = length $self->{rbuf}; |
735 | my $len = length $self->{rbuf}; |
738 | |
736 | |
739 | if (my $cb = shift @{ $self->{_queue} }) { |
737 | if (my $cb = shift @{ $self->{_queue} }) { |
740 | unless ($cb->($self)) { |
738 | unless ($cb->($self)) { |
741 | if ($self->{_eof}) { |
739 | if ($self->{_eof}) { |
… | |
… | |
905 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
903 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
906 | 1 |
904 | 1 |
907 | } |
905 | } |
908 | }; |
906 | }; |
909 | |
907 | |
910 | # compatibility with older API |
|
|
911 | sub push_read_chunk { |
|
|
912 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
913 | } |
|
|
914 | |
|
|
915 | sub unshift_read_chunk { |
|
|
916 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
917 | } |
|
|
918 | |
|
|
919 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
908 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
920 | |
909 | |
921 | The callback will be called only once a full line (including the end of |
910 | The callback will be called only once a full line (including the end of |
922 | line marker, C<$eol>) has been read. This line (excluding the end of line |
911 | line marker, C<$eol>) has been read. This line (excluding the end of line |
923 | marker) will be passed to the callback as second argument (C<$line>), and |
912 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
938 | =cut |
927 | =cut |
939 | |
928 | |
940 | register_read_type line => sub { |
929 | register_read_type line => sub { |
941 | my ($self, $cb, $eol) = @_; |
930 | my ($self, $cb, $eol) = @_; |
942 | |
931 | |
943 | $eol = qr|(\015?\012)| if @_ < 3; |
932 | if (@_ < 3) { |
|
|
933 | # this is more than twice as fast as the generic code below |
|
|
934 | sub { |
|
|
935 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
936 | |
|
|
937 | $cb->($_[0], $1, $2); |
|
|
938 | 1 |
|
|
939 | } |
|
|
940 | } else { |
944 | $eol = quotemeta $eol unless ref $eol; |
941 | $eol = quotemeta $eol unless ref $eol; |
945 | $eol = qr|^(.*?)($eol)|s; |
942 | $eol = qr|^(.*?)($eol)|s; |
946 | |
943 | |
947 | sub { |
944 | sub { |
948 | $_[0]{rbuf} =~ s/$eol// or return; |
945 | $_[0]{rbuf} =~ s/$eol// or return; |
949 | |
946 | |
950 | $cb->($_[0], $1, $2); |
947 | $cb->($_[0], $1, $2); |
|
|
948 | 1 |
951 | 1 |
949 | } |
952 | } |
950 | } |
953 | }; |
951 | }; |
954 | |
|
|
955 | # compatibility with older API |
|
|
956 | sub push_read_line { |
|
|
957 | my $self = shift; |
|
|
958 | $self->push_read (line => @_); |
|
|
959 | } |
|
|
960 | |
|
|
961 | sub unshift_read_line { |
|
|
962 | my $self = shift; |
|
|
963 | $self->unshift_read (line => @_); |
|
|
964 | } |
|
|
965 | |
952 | |
966 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
953 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
967 | |
954 | |
968 | Makes a regex match against the regex object C<$accept> and returns |
955 | Makes a regex match against the regex object C<$accept> and returns |
969 | everything up to and including the match. |
956 | everything up to and including the match. |
… | |
… | |
1090 | register_read_type packstring => sub { |
1077 | register_read_type packstring => sub { |
1091 | my ($self, $cb, $format) = @_; |
1078 | my ($self, $cb, $format) = @_; |
1092 | |
1079 | |
1093 | sub { |
1080 | sub { |
1094 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1081 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1095 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1082 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1096 | or return; |
1083 | or return; |
1097 | |
1084 | |
|
|
1085 | $format = length pack $format, $len; |
|
|
1086 | |
|
|
1087 | # bypass unshift if we already have the remaining chunk |
|
|
1088 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1089 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1090 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1091 | $cb->($_[0], $data); |
|
|
1092 | } else { |
1098 | # remove prefix |
1093 | # remove prefix |
1099 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1094 | substr $_[0]{rbuf}, 0, $format, ""; |
1100 | |
1095 | |
1101 | # read rest |
1096 | # read remaining chunk |
1102 | $_[0]->unshift_read (chunk => $len, $cb); |
1097 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1098 | } |
1103 | |
1099 | |
1104 | 1 |
1100 | 1 |
1105 | } |
1101 | } |
1106 | }; |
1102 | }; |
1107 | |
1103 | |
… | |
… | |
1164 | |
1160 | |
1165 | require Storable; |
1161 | require Storable; |
1166 | |
1162 | |
1167 | sub { |
1163 | sub { |
1168 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1164 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1169 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
1165 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1170 | or return; |
1166 | or return; |
1171 | |
1167 | |
|
|
1168 | my $format = length pack "w", $len; |
|
|
1169 | |
|
|
1170 | # bypass unshift if we already have the remaining chunk |
|
|
1171 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1172 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1173 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1174 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1175 | } else { |
1172 | # remove prefix |
1176 | # remove prefix |
1173 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1177 | substr $_[0]{rbuf}, 0, $format, ""; |
1174 | |
1178 | |
1175 | # read rest |
1179 | # read remaining chunk |
1176 | $_[0]->unshift_read (chunk => $len, sub { |
1180 | $_[0]->unshift_read (chunk => $len, sub { |
1177 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1181 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1178 | $cb->($_[0], $ref); |
1182 | $cb->($_[0], $ref); |
1179 | } else { |
1183 | } else { |
1180 | $self->_error (&Errno::EBADMSG); |
1184 | $self->_error (&Errno::EBADMSG); |
|
|
1185 | } |
1181 | } |
1186 | }); |
1182 | }); |
1187 | } |
|
|
1188 | |
|
|
1189 | 1 |
1183 | } |
1190 | } |
1184 | }; |
1191 | }; |
1185 | |
1192 | |
1186 | =back |
1193 | =back |
1187 | |
1194 | |
… | |
… | |
1448 | =over 4 |
1455 | =over 4 |
1449 | |
1456 | |
1450 | =item * all constructor arguments become object members. |
1457 | =item * all constructor arguments become object members. |
1451 | |
1458 | |
1452 | At least initially, when you pass a C<tls>-argument to the constructor it |
1459 | At least initially, when you pass a C<tls>-argument to the constructor it |
1453 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1460 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1454 | mutated later on (for example C<tls> will hold the TLS connection object). |
1461 | mutated later on (for example C<tls> will hold the TLS connection object). |
1455 | |
1462 | |
1456 | =item * other object member names are prefixed with an C<_>. |
1463 | =item * other object member names are prefixed with an C<_>. |
1457 | |
1464 | |
1458 | All object members not explicitly documented (internal use) are prefixed |
1465 | All object members not explicitly documented (internal use) are prefixed |