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.151; |
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 I<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 |
86 | waiting for data. |
86 | waiting for data. |
|
|
87 | |
|
|
88 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
89 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
90 | |
88 | =item on_error => $cb->($handle, $fatal) |
91 | =item on_error => $cb->($handle, $fatal) |
89 | |
92 | |
90 | This is the error callback, which is called when, well, some error |
93 | This is the error callback, which is called when, well, some error |
91 | occured, such as not being able to resolve the hostname, failure to |
94 | occured, such as not being able to resolve the hostname, failure to |
… | |
… | |
162 | be configured to accept only so-and-so much data that it cannot act on |
165 | be configured to accept only so-and-so much data that it cannot act on |
163 | (for example, when expecting a line, an attacker could send an unlimited |
166 | (for example, when expecting a line, an attacker could send an unlimited |
164 | amount of data without a callback ever being called as long as the line |
167 | amount of data without a callback ever being called as long as the line |
165 | isn't finished). |
168 | isn't finished). |
166 | |
169 | |
|
|
170 | =item autocork => <boolean> |
|
|
171 | |
|
|
172 | When disabled (the default), then C<push_write> will try to immediately |
|
|
173 | write the data to the handle if possible. This avoids having to register |
|
|
174 | a write watcher and wait for the next event loop iteration, but can be |
|
|
175 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
176 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
177 | |
|
|
178 | When enabled, then writes will always be queued till the next event loop |
|
|
179 | iteration. This is efficient when you do many small writes per iteration, |
|
|
180 | but less efficient when you do a single write only. |
|
|
181 | |
|
|
182 | =item no_delay => <boolean> |
|
|
183 | |
|
|
184 | When doing small writes on sockets, your operating system kernel might |
|
|
185 | wait a bit for more data before actually sending it out. This is called |
|
|
186 | the Nagle algorithm, and usually it is beneficial. |
|
|
187 | |
|
|
188 | In some situations you want as low a delay as possible, which cna be |
|
|
189 | accomplishd by setting this option to true. |
|
|
190 | |
|
|
191 | The default is your opertaing system's default behaviour, this option |
|
|
192 | explicitly enables or disables it, if possible. |
|
|
193 | |
167 | =item read_size => <bytes> |
194 | =item read_size => <bytes> |
168 | |
195 | |
169 | The default read block size (the amount of bytes this module will try to read |
196 | The default read block size (the amount of bytes this module will try to read |
170 | during each (loop iteration). Default: C<8192>. |
197 | during each (loop iteration). Default: C<8192>. |
171 | |
198 | |
… | |
… | |
201 | You can also provide your own TLS connection object, but you have |
228 | You can also provide your own TLS connection object, but you have |
202 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
229 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
203 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
230 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
204 | AnyEvent::Handle. |
231 | AnyEvent::Handle. |
205 | |
232 | |
206 | See the C<starttls> method if you need to start TLs negotiation later. |
233 | See the C<starttls> method if you need to start TLS negotiation later. |
207 | |
234 | |
208 | =item tls_ctx => $ssl_ctx |
235 | =item tls_ctx => $ssl_ctx |
209 | |
236 | |
210 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
237 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
211 | (unless a connection object was specified directly). If this parameter is |
238 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
246 | } |
273 | } |
247 | |
274 | |
248 | $self->{_activity} = AnyEvent->now; |
275 | $self->{_activity} = AnyEvent->now; |
249 | $self->_timeout; |
276 | $self->_timeout; |
250 | |
277 | |
251 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
278 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
279 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
252 | |
280 | |
253 | $self->start_read |
281 | $self->start_read |
254 | if $self->{on_read}; |
282 | if $self->{on_read}; |
255 | |
283 | |
256 | $self |
284 | $self |
… | |
… | |
318 | |
346 | |
319 | =cut |
347 | =cut |
320 | |
348 | |
321 | sub on_timeout { |
349 | sub on_timeout { |
322 | $_[0]{on_timeout} = $_[1]; |
350 | $_[0]{on_timeout} = $_[1]; |
|
|
351 | } |
|
|
352 | |
|
|
353 | =item $handle->autocork ($boolean) |
|
|
354 | |
|
|
355 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
356 | constructor argument). |
|
|
357 | |
|
|
358 | =cut |
|
|
359 | |
|
|
360 | =item $handle->no_delay ($boolean) |
|
|
361 | |
|
|
362 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
363 | the same name for details). |
|
|
364 | |
|
|
365 | =cut |
|
|
366 | |
|
|
367 | sub no_delay { |
|
|
368 | $_[0]{no_delay} = $_[1]; |
|
|
369 | |
|
|
370 | eval { |
|
|
371 | local $SIG{__DIE__}; |
|
|
372 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
373 | }; |
323 | } |
374 | } |
324 | |
375 | |
325 | ############################################################################# |
376 | ############################################################################# |
326 | |
377 | |
327 | =item $handle->timeout ($seconds) |
378 | =item $handle->timeout ($seconds) |
… | |
… | |
442 | $self->_error ($!, 1); |
493 | $self->_error ($!, 1); |
443 | } |
494 | } |
444 | }; |
495 | }; |
445 | |
496 | |
446 | # try to write data immediately |
497 | # try to write data immediately |
447 | $cb->(); |
498 | $cb->() unless $self->{autocork}; |
448 | |
499 | |
449 | # if still data left in wbuf, we need to poll |
500 | # if still data left in wbuf, we need to poll |
450 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
501 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
451 | if length $self->{wbuf}; |
502 | if length $self->{wbuf}; |
452 | }; |
503 | }; |
… | |
… | |
682 | ) { |
733 | ) { |
683 | return $self->_error (&Errno::ENOSPC, 1); |
734 | return $self->_error (&Errno::ENOSPC, 1); |
684 | } |
735 | } |
685 | |
736 | |
686 | while () { |
737 | while () { |
687 | no strict 'refs'; |
|
|
688 | |
|
|
689 | my $len = length $self->{rbuf}; |
738 | my $len = length $self->{rbuf}; |
690 | |
739 | |
691 | if (my $cb = shift @{ $self->{_queue} }) { |
740 | if (my $cb = shift @{ $self->{_queue} }) { |
692 | unless ($cb->($self)) { |
741 | unless ($cb->($self)) { |
693 | if ($self->{_eof}) { |
742 | if ($self->{_eof}) { |
… | |
… | |
720 | delete $self->{_rw}; |
769 | delete $self->{_rw}; |
721 | last; |
770 | last; |
722 | } |
771 | } |
723 | } |
772 | } |
724 | |
773 | |
|
|
774 | if ($self->{_eof}) { |
|
|
775 | if ($self->{on_eof}) { |
725 | $self->{on_eof}($self) |
776 | $self->{on_eof}($self) |
726 | if $self->{_eof} && $self->{on_eof}; |
777 | } else { |
|
|
778 | $self->_error (0, 1); |
|
|
779 | } |
|
|
780 | } |
727 | |
781 | |
728 | # may need to restart read watcher |
782 | # may need to restart read watcher |
729 | unless ($self->{_rw}) { |
783 | unless ($self->{_rw}) { |
730 | $self->start_read |
784 | $self->start_read |
731 | if $self->{on_read} || @{ $self->{_queue} }; |
785 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
857 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
911 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
858 | 1 |
912 | 1 |
859 | } |
913 | } |
860 | }; |
914 | }; |
861 | |
915 | |
862 | # compatibility with older API |
|
|
863 | sub push_read_chunk { |
|
|
864 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
865 | } |
|
|
866 | |
|
|
867 | sub unshift_read_chunk { |
|
|
868 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
869 | } |
|
|
870 | |
|
|
871 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
916 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
872 | |
917 | |
873 | The callback will be called only once a full line (including the end of |
918 | The callback will be called only once a full line (including the end of |
874 | line marker, C<$eol>) has been read. This line (excluding the end of line |
919 | line marker, C<$eol>) has been read. This line (excluding the end of line |
875 | marker) will be passed to the callback as second argument (C<$line>), and |
920 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
890 | =cut |
935 | =cut |
891 | |
936 | |
892 | register_read_type line => sub { |
937 | register_read_type line => sub { |
893 | my ($self, $cb, $eol) = @_; |
938 | my ($self, $cb, $eol) = @_; |
894 | |
939 | |
895 | $eol = qr|(\015?\012)| if @_ < 3; |
940 | if (@_ < 3) { |
|
|
941 | # this is more than twice as fast as the generic code below |
|
|
942 | sub { |
|
|
943 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
944 | |
|
|
945 | $cb->($_[0], $1, $2); |
|
|
946 | 1 |
|
|
947 | } |
|
|
948 | } else { |
896 | $eol = quotemeta $eol unless ref $eol; |
949 | $eol = quotemeta $eol unless ref $eol; |
897 | $eol = qr|^(.*?)($eol)|s; |
950 | $eol = qr|^(.*?)($eol)|s; |
898 | |
951 | |
899 | sub { |
952 | sub { |
900 | $_[0]{rbuf} =~ s/$eol// or return; |
953 | $_[0]{rbuf} =~ s/$eol// or return; |
901 | |
954 | |
902 | $cb->($_[0], $1, $2); |
955 | $cb->($_[0], $1, $2); |
|
|
956 | 1 |
903 | 1 |
957 | } |
904 | } |
958 | } |
905 | }; |
959 | }; |
906 | |
|
|
907 | # compatibility with older API |
|
|
908 | sub push_read_line { |
|
|
909 | my $self = shift; |
|
|
910 | $self->push_read (line => @_); |
|
|
911 | } |
|
|
912 | |
|
|
913 | sub unshift_read_line { |
|
|
914 | my $self = shift; |
|
|
915 | $self->unshift_read (line => @_); |
|
|
916 | } |
|
|
917 | |
960 | |
918 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
961 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
919 | |
962 | |
920 | Makes a regex match against the regex object C<$accept> and returns |
963 | Makes a regex match against the regex object C<$accept> and returns |
921 | everything up to and including the match. |
964 | everything up to and including the match. |
… | |
… | |
1042 | register_read_type packstring => sub { |
1085 | register_read_type packstring => sub { |
1043 | my ($self, $cb, $format) = @_; |
1086 | my ($self, $cb, $format) = @_; |
1044 | |
1087 | |
1045 | sub { |
1088 | sub { |
1046 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1089 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1047 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1090 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1048 | or return; |
1091 | or return; |
1049 | |
1092 | |
|
|
1093 | $format = length pack $format, $len; |
|
|
1094 | |
|
|
1095 | # bypass unshift if we already have the remaining chunk |
|
|
1096 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1097 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1098 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1099 | $cb->($_[0], $data); |
|
|
1100 | } else { |
1050 | # remove prefix |
1101 | # remove prefix |
1051 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1102 | substr $_[0]{rbuf}, 0, $format, ""; |
1052 | |
1103 | |
1053 | # read rest |
1104 | # read remaining chunk |
1054 | $_[0]->unshift_read (chunk => $len, $cb); |
1105 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1106 | } |
1055 | |
1107 | |
1056 | 1 |
1108 | 1 |
1057 | } |
1109 | } |
1058 | }; |
1110 | }; |
1059 | |
1111 | |
… | |
… | |
1116 | |
1168 | |
1117 | require Storable; |
1169 | require Storable; |
1118 | |
1170 | |
1119 | sub { |
1171 | sub { |
1120 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1172 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1121 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
1173 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1122 | or return; |
1174 | or return; |
1123 | |
1175 | |
|
|
1176 | my $format = length pack "w", $len; |
|
|
1177 | |
|
|
1178 | # bypass unshift if we already have the remaining chunk |
|
|
1179 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1180 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1181 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1182 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1183 | } else { |
1124 | # remove prefix |
1184 | # remove prefix |
1125 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1185 | substr $_[0]{rbuf}, 0, $format, ""; |
1126 | |
1186 | |
1127 | # read rest |
1187 | # read remaining chunk |
1128 | $_[0]->unshift_read (chunk => $len, sub { |
1188 | $_[0]->unshift_read (chunk => $len, sub { |
1129 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1189 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1130 | $cb->($_[0], $ref); |
1190 | $cb->($_[0], $ref); |
1131 | } else { |
1191 | } else { |
1132 | $self->_error (&Errno::EBADMSG); |
1192 | $self->_error (&Errno::EBADMSG); |
|
|
1193 | } |
1133 | } |
1194 | }); |
1134 | }); |
1195 | } |
|
|
1196 | |
|
|
1197 | 1 |
1135 | } |
1198 | } |
1136 | }; |
1199 | }; |
1137 | |
1200 | |
1138 | =back |
1201 | =back |
1139 | |
1202 | |
… | |
… | |
1400 | =over 4 |
1463 | =over 4 |
1401 | |
1464 | |
1402 | =item * all constructor arguments become object members. |
1465 | =item * all constructor arguments become object members. |
1403 | |
1466 | |
1404 | At least initially, when you pass a C<tls>-argument to the constructor it |
1467 | At least initially, when you pass a C<tls>-argument to the constructor it |
1405 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1468 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1406 | mutated later on (for example C<tls> will hold the TLS connection object). |
1469 | mutated later on (for example C<tls> will hold the TLS connection object). |
1407 | |
1470 | |
1408 | =item * other object member names are prefixed with an C<_>. |
1471 | =item * other object member names are prefixed with an C<_>. |
1409 | |
1472 | |
1410 | All object members not explicitly documented (internal use) are prefixed |
1473 | All object members not explicitly documented (internal use) are prefixed |