… | |
… | |
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.15; |
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 |
… | |
… | |
124 | This sets the callback that is called when the write buffer becomes empty |
124 | This sets the callback that is called when the write buffer becomes empty |
125 | (or when the callback is set and the buffer is empty already). |
125 | (or when the callback is set and the buffer is empty already). |
126 | |
126 | |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
128 | |
128 | |
|
|
129 | This callback is useful when you don't want to put all of your write data |
|
|
130 | into the queue at once, for example, when you want to write the contents |
|
|
131 | of some file to the socket you might not want to read the whole file into |
|
|
132 | memory and push it into the queue, but instead only read more data from |
|
|
133 | the file when the write queue becomes empty. |
|
|
134 | |
129 | =item timeout => $fractional_seconds |
135 | =item timeout => $fractional_seconds |
130 | |
136 | |
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
137 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
132 | seconds pass without a successful read or write on the underlying file |
138 | seconds pass without a successful read or write on the underlying file |
133 | handle, the C<on_timeout> callback will be invoked (and if that one is |
139 | handle, the C<on_timeout> callback will be invoked (and if that one is |
… | |
… | |
156 | 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 |
157 | (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 |
158 | 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 |
159 | isn't finished). |
165 | isn't finished). |
160 | |
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 | |
161 | =item read_size => <bytes> |
191 | =item read_size => <bytes> |
162 | |
192 | |
163 | 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 |
164 | during each (loop iteration). Default: C<8192>. |
194 | during each (loop iteration). Default: C<8192>. |
165 | |
195 | |
… | |
… | |
195 | 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 |
196 | 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> |
197 | 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 |
198 | AnyEvent::Handle. |
228 | AnyEvent::Handle. |
199 | |
229 | |
200 | 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. |
201 | |
231 | |
202 | =item tls_ctx => $ssl_ctx |
232 | =item tls_ctx => $ssl_ctx |
203 | |
233 | |
204 | 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 |
205 | (unless a connection object was specified directly). If this parameter is |
235 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
240 | } |
270 | } |
241 | |
271 | |
242 | $self->{_activity} = AnyEvent->now; |
272 | $self->{_activity} = AnyEvent->now; |
243 | $self->_timeout; |
273 | $self->_timeout; |
244 | |
274 | |
245 | $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}; |
|
|
277 | |
|
|
278 | $self->start_read |
|
|
279 | if $self->{on_read}; |
246 | |
280 | |
247 | $self |
281 | $self |
248 | } |
282 | } |
249 | |
283 | |
250 | sub _shutdown { |
284 | sub _shutdown { |
… | |
… | |
309 | |
343 | |
310 | =cut |
344 | =cut |
311 | |
345 | |
312 | sub on_timeout { |
346 | sub on_timeout { |
313 | $_[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 | }; |
314 | } |
371 | } |
315 | |
372 | |
316 | ############################################################################# |
373 | ############################################################################# |
317 | |
374 | |
318 | =item $handle->timeout ($seconds) |
375 | =item $handle->timeout ($seconds) |
… | |
… | |
433 | $self->_error ($!, 1); |
490 | $self->_error ($!, 1); |
434 | } |
491 | } |
435 | }; |
492 | }; |
436 | |
493 | |
437 | # try to write data immediately |
494 | # try to write data immediately |
438 | $cb->(); |
495 | $cb->() unless $self->{autocork}; |
439 | |
496 | |
440 | # if still data left in wbuf, we need to poll |
497 | # if still data left in wbuf, we need to poll |
441 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
498 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
442 | if length $self->{wbuf}; |
499 | if length $self->{wbuf}; |
443 | }; |
500 | }; |
… | |
… | |
500 | =cut |
557 | =cut |
501 | |
558 | |
502 | register_write_type packstring => sub { |
559 | register_write_type packstring => sub { |
503 | my ($self, $format, $string) = @_; |
560 | my ($self, $format, $string) = @_; |
504 | |
561 | |
505 | pack "$format/a", $string |
562 | pack "$format/a*", $string |
506 | }; |
563 | }; |
507 | |
564 | |
508 | =item json => $array_or_hashref |
565 | =item json => $array_or_hashref |
509 | |
566 | |
510 | Encodes the given hash or array reference into a JSON object. Unless you |
567 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
556 | register_write_type storable => sub { |
613 | register_write_type storable => sub { |
557 | my ($self, $ref) = @_; |
614 | my ($self, $ref) = @_; |
558 | |
615 | |
559 | require Storable; |
616 | require Storable; |
560 | |
617 | |
561 | pack "w/a", Storable::nfreeze ($ref) |
618 | pack "w/a*", Storable::nfreeze ($ref) |
562 | }; |
619 | }; |
563 | |
620 | |
564 | =back |
621 | =back |
565 | |
622 | |
566 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
623 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
… | |
… | |
590 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
647 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
591 | a queue. |
648 | a queue. |
592 | |
649 | |
593 | In the simple case, you just install an C<on_read> callback and whenever |
650 | In the simple case, you just install an C<on_read> callback and whenever |
594 | new data arrives, it will be called. You can then remove some data (if |
651 | new data arrives, it will be called. You can then remove some data (if |
595 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
652 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
596 | or not. |
653 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
654 | partial message has been received so far). |
597 | |
655 | |
598 | In the more complex case, you want to queue multiple callbacks. In this |
656 | In the more complex case, you want to queue multiple callbacks. In this |
599 | case, AnyEvent::Handle will call the first queued callback each time new |
657 | case, AnyEvent::Handle will call the first queued callback each time new |
600 | data arrives (also the first time it is queued) and removes it when it has |
658 | data arrives (also the first time it is queued) and removes it when it has |
601 | done its job (see C<push_read>, below). |
659 | done its job (see C<push_read>, below). |
… | |
… | |
619 | # handle xml |
677 | # handle xml |
620 | }); |
678 | }); |
621 | }); |
679 | }); |
622 | }); |
680 | }); |
623 | |
681 | |
624 | Example 2: Implement a client for a protocol that replies either with |
682 | Example 2: Implement a client for a protocol that replies either with "OK" |
625 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
683 | and another line or "ERROR" for the first request that is sent, and 64 |
626 | second request. Due tot he availability of a full queue, we can just |
684 | bytes for the second request. Due to the availability of a queue, we can |
627 | pipeline sending both requests and manipulate the queue as necessary in |
685 | just pipeline sending both requests and manipulate the queue as necessary |
628 | the callbacks: |
686 | in the callbacks. |
629 | |
687 | |
630 | # request one |
688 | When the first callback is called and sees an "OK" response, it will |
|
|
689 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
690 | 64-byte chunk callback. |
|
|
691 | |
|
|
692 | # request one, returns either "OK + extra line" or "ERROR" |
631 | $handle->push_write ("request 1\015\012"); |
693 | $handle->push_write ("request 1\015\012"); |
632 | |
694 | |
633 | # we expect "ERROR" or "OK" as response, so push a line read |
695 | # we expect "ERROR" or "OK" as response, so push a line read |
634 | $handle->push_read (line => sub { |
696 | $handle->push_read (line => sub { |
635 | # if we got an "OK", we have to _prepend_ another line, |
697 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
642 | ... |
704 | ... |
643 | }); |
705 | }); |
644 | } |
706 | } |
645 | }); |
707 | }); |
646 | |
708 | |
647 | # request two |
709 | # request two, simply returns 64 octets |
648 | $handle->push_write ("request 2\015\012"); |
710 | $handle->push_write ("request 2\015\012"); |
649 | |
711 | |
650 | # simply read 64 bytes, always |
712 | # simply read 64 bytes, always |
651 | $handle->push_read (chunk => 64, sub { |
713 | $handle->push_read (chunk => 64, sub { |
652 | my $response = $_[1]; |
714 | my $response = $_[1]; |
… | |
… | |
876 | =cut |
938 | =cut |
877 | |
939 | |
878 | register_read_type line => sub { |
940 | register_read_type line => sub { |
879 | my ($self, $cb, $eol) = @_; |
941 | my ($self, $cb, $eol) = @_; |
880 | |
942 | |
881 | $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 { |
882 | $eol = quotemeta $eol unless ref $eol; |
952 | $eol = quotemeta $eol unless ref $eol; |
883 | $eol = qr|^(.*?)($eol)|s; |
953 | $eol = qr|^(.*?)($eol)|s; |
884 | |
954 | |
885 | sub { |
955 | sub { |
886 | $_[0]{rbuf} =~ s/$eol// or return; |
956 | $_[0]{rbuf} =~ s/$eol// or return; |
887 | |
957 | |
888 | $cb->($_[0], $1, $2); |
958 | $cb->($_[0], $1, $2); |
|
|
959 | 1 |
889 | 1 |
960 | } |
890 | } |
961 | } |
891 | }; |
962 | }; |
892 | |
963 | |
893 | # compatibility with older API |
964 | # compatibility with older API |
894 | sub push_read_line { |
965 | sub push_read_line { |
… | |
… | |
1028 | register_read_type packstring => sub { |
1099 | register_read_type packstring => sub { |
1029 | my ($self, $cb, $format) = @_; |
1100 | my ($self, $cb, $format) = @_; |
1030 | |
1101 | |
1031 | sub { |
1102 | sub { |
1032 | # 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 |
1033 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1104 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1034 | or return; |
1105 | or return; |
1035 | |
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 { |
1036 | # remove prefix |
1115 | # remove prefix |
1037 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1116 | substr $_[0]{rbuf}, 0, $format, ""; |
1038 | |
1117 | |
1039 | # read rest |
1118 | # read remaining chunk |
1040 | $_[0]->unshift_read (chunk => $len, $cb); |
1119 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1120 | } |
1041 | |
1121 | |
1042 | 1 |
1122 | 1 |
1043 | } |
1123 | } |
1044 | }; |
1124 | }; |
1045 | |
1125 | |
… | |
… | |
1102 | |
1182 | |
1103 | require Storable; |
1183 | require Storable; |
1104 | |
1184 | |
1105 | sub { |
1185 | sub { |
1106 | # 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 |
1107 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
1187 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1108 | or return; |
1188 | or return; |
1109 | |
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 { |
1110 | # remove prefix |
1198 | # remove prefix |
1111 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1199 | substr $_[0]{rbuf}, 0, $format, ""; |
1112 | |
1200 | |
1113 | # read rest |
1201 | # read remaining chunk |
1114 | $_[0]->unshift_read (chunk => $len, sub { |
1202 | $_[0]->unshift_read (chunk => $len, sub { |
1115 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1203 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1116 | $cb->($_[0], $ref); |
1204 | $cb->($_[0], $ref); |
1117 | } else { |
1205 | } else { |
1118 | $self->_error (&Errno::EBADMSG); |
1206 | $self->_error (&Errno::EBADMSG); |
|
|
1207 | } |
1119 | } |
1208 | }); |
1120 | }); |
1209 | } |
|
|
1210 | |
|
|
1211 | 1 |
1121 | } |
1212 | } |
1122 | }; |
1213 | }; |
1123 | |
1214 | |
1124 | =back |
1215 | =back |
1125 | |
1216 | |
… | |
… | |
1386 | =over 4 |
1477 | =over 4 |
1387 | |
1478 | |
1388 | =item * all constructor arguments become object members. |
1479 | =item * all constructor arguments become object members. |
1389 | |
1480 | |
1390 | 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 |
1391 | 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 |
1392 | 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). |
1393 | |
1484 | |
1394 | =item * other object member names are prefixed with an C<_>. |
1485 | =item * other object member names are prefixed with an C<_>. |
1395 | |
1486 | |
1396 | All object members not explicitly documented (internal use) are prefixed |
1487 | All object members not explicitly documented (internal use) are prefixed |