… | |
… | |
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 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 |
… | |
… | |
162 | be configured to accept only so-and-so much data that it cannot act on |
162 | 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 |
163 | (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 |
164 | amount of data without a callback ever being called as long as the line |
165 | isn't finished). |
165 | isn't finished). |
166 | |
166 | |
|
|
167 | =item autocork => <boolean> |
|
|
168 | |
|
|
169 | When disabled (the default), then C<push_write> will try to immediately |
|
|
170 | write the data to the handle if possible. This avoids having to register |
|
|
171 | a write watcher and wait for the next event loop iteration, but can be |
|
|
172 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
173 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
174 | |
|
|
175 | When enabled, then writes will always be queued till the next event loop |
|
|
176 | iteration. This is efficient when you do many small writes per iteration, |
|
|
177 | but less efficient when you do a single write only. |
|
|
178 | |
|
|
179 | =item no_delay => <boolean> |
|
|
180 | |
|
|
181 | When doing small writes on sockets, your operating system kernel might |
|
|
182 | wait a bit for more data before actually sending it out. This is called |
|
|
183 | the Nagle algorithm, and usually it is beneficial. |
|
|
184 | |
|
|
185 | In some situations you want as low a delay as possible, which cna be |
|
|
186 | accomplishd by setting this option to true. |
|
|
187 | |
|
|
188 | The default is your opertaing system's default behaviour, this option |
|
|
189 | explicitly enables or disables it, if possible. |
|
|
190 | |
167 | =item read_size => <bytes> |
191 | =item read_size => <bytes> |
168 | |
192 | |
169 | The default read block size (the amount of bytes this module will try to read |
193 | The default read block size (the amount of bytes this module will try to read |
170 | during each (loop iteration). Default: C<8192>. |
194 | during each (loop iteration). Default: C<8192>. |
171 | |
195 | |
… | |
… | |
201 | 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 |
202 | 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> |
203 | 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 |
204 | AnyEvent::Handle. |
228 | AnyEvent::Handle. |
205 | |
229 | |
206 | 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. |
207 | |
231 | |
208 | =item tls_ctx => $ssl_ctx |
232 | =item tls_ctx => $ssl_ctx |
209 | |
233 | |
210 | 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 |
211 | (unless a connection object was specified directly). If this parameter is |
235 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
246 | } |
270 | } |
247 | |
271 | |
248 | $self->{_activity} = AnyEvent->now; |
272 | $self->{_activity} = AnyEvent->now; |
249 | $self->_timeout; |
273 | $self->_timeout; |
250 | |
274 | |
251 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
275 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
276 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
252 | |
277 | |
253 | $self->start_read |
278 | $self->start_read |
254 | if $self->{on_read}; |
279 | if $self->{on_read}; |
255 | |
280 | |
256 | $self |
281 | $self |
… | |
… | |
318 | |
343 | |
319 | =cut |
344 | =cut |
320 | |
345 | |
321 | sub on_timeout { |
346 | sub on_timeout { |
322 | $_[0]{on_timeout} = $_[1]; |
347 | $_[0]{on_timeout} = $_[1]; |
|
|
348 | } |
|
|
349 | |
|
|
350 | =item $handle->autocork ($boolean) |
|
|
351 | |
|
|
352 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
353 | constructor argument). |
|
|
354 | |
|
|
355 | =cut |
|
|
356 | |
|
|
357 | =item $handle->no_delay ($boolean) |
|
|
358 | |
|
|
359 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
360 | the same name for details). |
|
|
361 | |
|
|
362 | =cut |
|
|
363 | |
|
|
364 | sub no_delay { |
|
|
365 | $_[0]{no_delay} = $_[1]; |
|
|
366 | |
|
|
367 | eval { |
|
|
368 | local $SIG{__DIE__}; |
|
|
369 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
370 | }; |
323 | } |
371 | } |
324 | |
372 | |
325 | ############################################################################# |
373 | ############################################################################# |
326 | |
374 | |
327 | =item $handle->timeout ($seconds) |
375 | =item $handle->timeout ($seconds) |
… | |
… | |
442 | $self->_error ($!, 1); |
490 | $self->_error ($!, 1); |
443 | } |
491 | } |
444 | }; |
492 | }; |
445 | |
493 | |
446 | # try to write data immediately |
494 | # try to write data immediately |
447 | $cb->(); |
495 | $cb->() unless $self->{autocork}; |
448 | |
496 | |
449 | # if still data left in wbuf, we need to poll |
497 | # if still data left in wbuf, we need to poll |
450 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
498 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
451 | if length $self->{wbuf}; |
499 | if length $self->{wbuf}; |
452 | }; |
500 | }; |
… | |
… | |
890 | =cut |
938 | =cut |
891 | |
939 | |
892 | register_read_type line => sub { |
940 | register_read_type line => sub { |
893 | my ($self, $cb, $eol) = @_; |
941 | my ($self, $cb, $eol) = @_; |
894 | |
942 | |
895 | $eol = qr|(\015?\012)| if @_ < 3; |
943 | if (@_ < 3) { |
|
|
944 | # this is more than twice as fast as the generic code below |
|
|
945 | sub { |
|
|
946 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
947 | |
|
|
948 | $cb->($_[0], $1, $2); |
|
|
949 | 1 |
|
|
950 | } |
|
|
951 | } else { |
896 | $eol = quotemeta $eol unless ref $eol; |
952 | $eol = quotemeta $eol unless ref $eol; |
897 | $eol = qr|^(.*?)($eol)|s; |
953 | $eol = qr|^(.*?)($eol)|s; |
898 | |
954 | |
899 | sub { |
955 | sub { |
900 | $_[0]{rbuf} =~ s/$eol// or return; |
956 | $_[0]{rbuf} =~ s/$eol// or return; |
901 | |
957 | |
902 | $cb->($_[0], $1, $2); |
958 | $cb->($_[0], $1, $2); |
|
|
959 | 1 |
903 | 1 |
960 | } |
904 | } |
961 | } |
905 | }; |
962 | }; |
906 | |
963 | |
907 | # compatibility with older API |
964 | # compatibility with older API |
908 | sub push_read_line { |
965 | sub push_read_line { |
… | |
… | |
1042 | register_read_type packstring => sub { |
1099 | register_read_type packstring => sub { |
1043 | my ($self, $cb, $format) = @_; |
1100 | my ($self, $cb, $format) = @_; |
1044 | |
1101 | |
1045 | sub { |
1102 | sub { |
1046 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1103 | # 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} }) |
1104 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1048 | or return; |
1105 | or return; |
1049 | |
1106 | |
|
|
1107 | $format = length pack $format, $len; |
|
|
1108 | |
|
|
1109 | # bypass unshift if we already have the remaining chunk |
|
|
1110 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1111 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1112 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1113 | $cb->($_[0], $data); |
|
|
1114 | } else { |
1050 | # remove prefix |
1115 | # remove prefix |
1051 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1116 | substr $_[0]{rbuf}, 0, $format, ""; |
1052 | |
1117 | |
1053 | # read rest |
1118 | # read remaining chunk |
1054 | $_[0]->unshift_read (chunk => $len, $cb); |
1119 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1120 | } |
1055 | |
1121 | |
1056 | 1 |
1122 | 1 |
1057 | } |
1123 | } |
1058 | }; |
1124 | }; |
1059 | |
1125 | |
… | |
… | |
1116 | |
1182 | |
1117 | require Storable; |
1183 | require Storable; |
1118 | |
1184 | |
1119 | sub { |
1185 | sub { |
1120 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1186 | # 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} }) |
1187 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1122 | or return; |
1188 | or return; |
1123 | |
1189 | |
|
|
1190 | my $format = length pack "w", $len; |
|
|
1191 | |
|
|
1192 | # bypass unshift if we already have the remaining chunk |
|
|
1193 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1194 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1195 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1196 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1197 | } else { |
1124 | # remove prefix |
1198 | # remove prefix |
1125 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1199 | substr $_[0]{rbuf}, 0, $format, ""; |
1126 | |
1200 | |
1127 | # read rest |
1201 | # read remaining chunk |
1128 | $_[0]->unshift_read (chunk => $len, sub { |
1202 | $_[0]->unshift_read (chunk => $len, sub { |
1129 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1203 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1130 | $cb->($_[0], $ref); |
1204 | $cb->($_[0], $ref); |
1131 | } else { |
1205 | } else { |
1132 | $self->_error (&Errno::EBADMSG); |
1206 | $self->_error (&Errno::EBADMSG); |
|
|
1207 | } |
1133 | } |
1208 | }); |
1134 | }); |
1209 | } |
|
|
1210 | |
|
|
1211 | 1 |
1135 | } |
1212 | } |
1136 | }; |
1213 | }; |
1137 | |
1214 | |
1138 | =back |
1215 | =back |
1139 | |
1216 | |
… | |
… | |
1400 | =over 4 |
1477 | =over 4 |
1401 | |
1478 | |
1402 | =item * all constructor arguments become object members. |
1479 | =item * all constructor arguments become object members. |
1403 | |
1480 | |
1404 | At least initially, when you pass a C<tls>-argument to the constructor it |
1481 | 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 |
1482 | 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). |
1483 | mutated later on (for example C<tls> will hold the TLS connection object). |
1407 | |
1484 | |
1408 | =item * other object member names are prefixed with an C<_>. |
1485 | =item * other object member names are prefixed with an C<_>. |
1409 | |
1486 | |
1410 | All object members not explicitly documented (internal use) are prefixed |
1487 | All object members not explicitly documented (internal use) are prefixed |