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 |
… | |
… | |
124 | This sets the callback that is called when the write buffer becomes empty |
127 | 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). |
128 | (or when the callback is set and the buffer is empty already). |
126 | |
129 | |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
130 | To append to the write buffer, use the C<< ->push_write >> method. |
128 | |
131 | |
|
|
132 | This callback is useful when you don't want to put all of your write data |
|
|
133 | into the queue at once, for example, when you want to write the contents |
|
|
134 | of some file to the socket you might not want to read the whole file into |
|
|
135 | memory and push it into the queue, but instead only read more data from |
|
|
136 | the file when the write queue becomes empty. |
|
|
137 | |
129 | =item timeout => $fractional_seconds |
138 | =item timeout => $fractional_seconds |
130 | |
139 | |
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
140 | 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 |
141 | 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 |
142 | 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 |
165 | 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 |
166 | (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 |
167 | amount of data without a callback ever being called as long as the line |
159 | isn't finished). |
168 | isn't finished). |
160 | |
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 | |
161 | =item read_size => <bytes> |
194 | =item read_size => <bytes> |
162 | |
195 | |
163 | 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 |
164 | during each (loop iteration). Default: C<8192>. |
197 | during each (loop iteration). Default: C<8192>. |
165 | |
198 | |
… | |
… | |
195 | 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 |
196 | 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> |
197 | 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 |
198 | AnyEvent::Handle. |
231 | AnyEvent::Handle. |
199 | |
232 | |
200 | 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. |
201 | |
234 | |
202 | =item tls_ctx => $ssl_ctx |
235 | =item tls_ctx => $ssl_ctx |
203 | |
236 | |
204 | 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 |
205 | (unless a connection object was specified directly). If this parameter is |
238 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
240 | } |
273 | } |
241 | |
274 | |
242 | $self->{_activity} = AnyEvent->now; |
275 | $self->{_activity} = AnyEvent->now; |
243 | $self->_timeout; |
276 | $self->_timeout; |
244 | |
277 | |
245 | $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}; |
246 | |
280 | |
247 | $self->start_read |
281 | $self->start_read |
248 | if $self->{on_read}; |
282 | if $self->{on_read}; |
249 | |
283 | |
250 | $self |
284 | $self |
… | |
… | |
312 | |
346 | |
313 | =cut |
347 | =cut |
314 | |
348 | |
315 | sub on_timeout { |
349 | sub on_timeout { |
316 | $_[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 | }; |
317 | } |
374 | } |
318 | |
375 | |
319 | ############################################################################# |
376 | ############################################################################# |
320 | |
377 | |
321 | =item $handle->timeout ($seconds) |
378 | =item $handle->timeout ($seconds) |
… | |
… | |
436 | $self->_error ($!, 1); |
493 | $self->_error ($!, 1); |
437 | } |
494 | } |
438 | }; |
495 | }; |
439 | |
496 | |
440 | # try to write data immediately |
497 | # try to write data immediately |
441 | $cb->(); |
498 | $cb->() unless $self->{autocork}; |
442 | |
499 | |
443 | # if still data left in wbuf, we need to poll |
500 | # if still data left in wbuf, we need to poll |
444 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
501 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
445 | if length $self->{wbuf}; |
502 | if length $self->{wbuf}; |
446 | }; |
503 | }; |
… | |
… | |
593 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
650 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
594 | a queue. |
651 | a queue. |
595 | |
652 | |
596 | In the simple case, you just install an C<on_read> callback and whenever |
653 | In the simple case, you just install an C<on_read> callback and whenever |
597 | new data arrives, it will be called. You can then remove some data (if |
654 | new data arrives, it will be called. You can then remove some data (if |
598 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
655 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
599 | or not. |
656 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
657 | partial message has been received so far). |
600 | |
658 | |
601 | In the more complex case, you want to queue multiple callbacks. In this |
659 | In the more complex case, you want to queue multiple callbacks. In this |
602 | case, AnyEvent::Handle will call the first queued callback each time new |
660 | case, AnyEvent::Handle will call the first queued callback each time new |
603 | data arrives (also the first time it is queued) and removes it when it has |
661 | data arrives (also the first time it is queued) and removes it when it has |
604 | done its job (see C<push_read>, below). |
662 | done its job (see C<push_read>, below). |
… | |
… | |
622 | # handle xml |
680 | # handle xml |
623 | }); |
681 | }); |
624 | }); |
682 | }); |
625 | }); |
683 | }); |
626 | |
684 | |
627 | Example 2: Implement a client for a protocol that replies either with |
685 | Example 2: Implement a client for a protocol that replies either with "OK" |
628 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
686 | and another line or "ERROR" for the first request that is sent, and 64 |
629 | second request. Due tot he availability of a full queue, we can just |
687 | bytes for the second request. Due to the availability of a queue, we can |
630 | pipeline sending both requests and manipulate the queue as necessary in |
688 | just pipeline sending both requests and manipulate the queue as necessary |
631 | the callbacks: |
689 | in the callbacks. |
632 | |
690 | |
633 | # request one |
691 | When the first callback is called and sees an "OK" response, it will |
|
|
692 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
693 | 64-byte chunk callback. |
|
|
694 | |
|
|
695 | # request one, returns either "OK + extra line" or "ERROR" |
634 | $handle->push_write ("request 1\015\012"); |
696 | $handle->push_write ("request 1\015\012"); |
635 | |
697 | |
636 | # we expect "ERROR" or "OK" as response, so push a line read |
698 | # we expect "ERROR" or "OK" as response, so push a line read |
637 | $handle->push_read (line => sub { |
699 | $handle->push_read (line => sub { |
638 | # if we got an "OK", we have to _prepend_ another line, |
700 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
645 | ... |
707 | ... |
646 | }); |
708 | }); |
647 | } |
709 | } |
648 | }); |
710 | }); |
649 | |
711 | |
650 | # request two |
712 | # request two, simply returns 64 octets |
651 | $handle->push_write ("request 2\015\012"); |
713 | $handle->push_write ("request 2\015\012"); |
652 | |
714 | |
653 | # simply read 64 bytes, always |
715 | # simply read 64 bytes, always |
654 | $handle->push_read (chunk => 64, sub { |
716 | $handle->push_read (chunk => 64, sub { |
655 | my $response = $_[1]; |
717 | my $response = $_[1]; |
… | |
… | |
671 | ) { |
733 | ) { |
672 | return $self->_error (&Errno::ENOSPC, 1); |
734 | return $self->_error (&Errno::ENOSPC, 1); |
673 | } |
735 | } |
674 | |
736 | |
675 | while () { |
737 | while () { |
676 | no strict 'refs'; |
|
|
677 | |
|
|
678 | my $len = length $self->{rbuf}; |
738 | my $len = length $self->{rbuf}; |
679 | |
739 | |
680 | if (my $cb = shift @{ $self->{_queue} }) { |
740 | if (my $cb = shift @{ $self->{_queue} }) { |
681 | unless ($cb->($self)) { |
741 | unless ($cb->($self)) { |
682 | if ($self->{_eof}) { |
742 | if ($self->{_eof}) { |
… | |
… | |
709 | delete $self->{_rw}; |
769 | delete $self->{_rw}; |
710 | last; |
770 | last; |
711 | } |
771 | } |
712 | } |
772 | } |
713 | |
773 | |
|
|
774 | if ($self->{_eof}) { |
|
|
775 | if ($self->{on_eof}) { |
714 | $self->{on_eof}($self) |
776 | $self->{on_eof}($self) |
715 | if $self->{_eof} && $self->{on_eof}; |
777 | } else { |
|
|
778 | $self->_error (0, 1); |
|
|
779 | } |
|
|
780 | } |
716 | |
781 | |
717 | # may need to restart read watcher |
782 | # may need to restart read watcher |
718 | unless ($self->{_rw}) { |
783 | unless ($self->{_rw}) { |
719 | $self->start_read |
784 | $self->start_read |
720 | if $self->{on_read} || @{ $self->{_queue} }; |
785 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
846 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
911 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
847 | 1 |
912 | 1 |
848 | } |
913 | } |
849 | }; |
914 | }; |
850 | |
915 | |
851 | # compatibility with older API |
|
|
852 | sub push_read_chunk { |
|
|
853 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
854 | } |
|
|
855 | |
|
|
856 | sub unshift_read_chunk { |
|
|
857 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
858 | } |
|
|
859 | |
|
|
860 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
916 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
861 | |
917 | |
862 | 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 |
863 | 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 |
864 | 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 |
… | |
… | |
879 | =cut |
935 | =cut |
880 | |
936 | |
881 | register_read_type line => sub { |
937 | register_read_type line => sub { |
882 | my ($self, $cb, $eol) = @_; |
938 | my ($self, $cb, $eol) = @_; |
883 | |
939 | |
884 | $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 { |
885 | $eol = quotemeta $eol unless ref $eol; |
949 | $eol = quotemeta $eol unless ref $eol; |
886 | $eol = qr|^(.*?)($eol)|s; |
950 | $eol = qr|^(.*?)($eol)|s; |
887 | |
951 | |
888 | sub { |
952 | sub { |
889 | $_[0]{rbuf} =~ s/$eol// or return; |
953 | $_[0]{rbuf} =~ s/$eol// or return; |
890 | |
954 | |
891 | $cb->($_[0], $1, $2); |
955 | $cb->($_[0], $1, $2); |
|
|
956 | 1 |
892 | 1 |
957 | } |
893 | } |
958 | } |
894 | }; |
959 | }; |
895 | |
|
|
896 | # compatibility with older API |
|
|
897 | sub push_read_line { |
|
|
898 | my $self = shift; |
|
|
899 | $self->push_read (line => @_); |
|
|
900 | } |
|
|
901 | |
|
|
902 | sub unshift_read_line { |
|
|
903 | my $self = shift; |
|
|
904 | $self->unshift_read (line => @_); |
|
|
905 | } |
|
|
906 | |
960 | |
907 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
961 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
908 | |
962 | |
909 | 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 |
910 | everything up to and including the match. |
964 | everything up to and including the match. |
… | |
… | |
1031 | register_read_type packstring => sub { |
1085 | register_read_type packstring => sub { |
1032 | my ($self, $cb, $format) = @_; |
1086 | my ($self, $cb, $format) = @_; |
1033 | |
1087 | |
1034 | sub { |
1088 | sub { |
1035 | # 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 |
1036 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1090 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1037 | or return; |
1091 | or return; |
1038 | |
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 { |
1039 | # remove prefix |
1101 | # remove prefix |
1040 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1102 | substr $_[0]{rbuf}, 0, $format, ""; |
1041 | |
1103 | |
1042 | # read rest |
1104 | # read remaining chunk |
1043 | $_[0]->unshift_read (chunk => $len, $cb); |
1105 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1106 | } |
1044 | |
1107 | |
1045 | 1 |
1108 | 1 |
1046 | } |
1109 | } |
1047 | }; |
1110 | }; |
1048 | |
1111 | |
… | |
… | |
1105 | |
1168 | |
1106 | require Storable; |
1169 | require Storable; |
1107 | |
1170 | |
1108 | sub { |
1171 | sub { |
1109 | # 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 |
1110 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
1173 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1111 | or return; |
1174 | or return; |
1112 | |
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 { |
1113 | # remove prefix |
1184 | # remove prefix |
1114 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1185 | substr $_[0]{rbuf}, 0, $format, ""; |
1115 | |
1186 | |
1116 | # read rest |
1187 | # read remaining chunk |
1117 | $_[0]->unshift_read (chunk => $len, sub { |
1188 | $_[0]->unshift_read (chunk => $len, sub { |
1118 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1189 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1119 | $cb->($_[0], $ref); |
1190 | $cb->($_[0], $ref); |
1120 | } else { |
1191 | } else { |
1121 | $self->_error (&Errno::EBADMSG); |
1192 | $self->_error (&Errno::EBADMSG); |
|
|
1193 | } |
1122 | } |
1194 | }); |
1123 | }); |
1195 | } |
|
|
1196 | |
|
|
1197 | 1 |
1124 | } |
1198 | } |
1125 | }; |
1199 | }; |
1126 | |
1200 | |
1127 | =back |
1201 | =back |
1128 | |
1202 | |
… | |
… | |
1389 | =over 4 |
1463 | =over 4 |
1390 | |
1464 | |
1391 | =item * all constructor arguments become object members. |
1465 | =item * all constructor arguments become object members. |
1392 | |
1466 | |
1393 | 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 |
1394 | 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 |
1395 | 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). |
1396 | |
1470 | |
1397 | =item * other object member names are prefixed with an C<_>. |
1471 | =item * other object member names are prefixed with an C<_>. |
1398 | |
1472 | |
1399 | All object members not explicitly documented (internal use) are prefixed |
1473 | All object members not explicitly documented (internal use) are prefixed |