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.232; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
49 | |
49 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
84 | 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 |
85 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
86 | connection cleanly. |
83 | |
87 | |
|
|
88 | For sockets, this just means that the other side has stopped sending data, |
|
|
89 | you can still try to write data, and, in fact, one can return from the eof |
|
|
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
|
|
92 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
93 | 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 |
94 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
95 | waiting for data. |
|
|
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
99 | |
88 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal) |
89 | |
101 | |
90 | This is the error callback, which is called when, well, some error |
102 | 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 |
103 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
104 | connect or a read error. |
93 | |
105 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
95 | fatal errors the handle object will be shut down and will not be |
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
97 | recommended to simply ignore this parameter and instead abondon the handle |
113 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
116 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
119 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
210 | This will not work for partial TLS data that could not yet been |
227 | This will not work for partial TLS data that could not yet been |
211 | encoded. This data will be lost. |
228 | encoded. This data will be lost. |
212 | |
229 | |
213 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
230 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
214 | |
231 | |
215 | When this parameter is given, it enables TLS (SSL) mode, that means it |
232 | When this parameter is given, it enables TLS (SSL) mode, that means |
216 | will start making tls handshake and will transparently encrypt/decrypt |
233 | AnyEvent will start a TLS handshake and will transparently encrypt/decrypt |
217 | data. |
234 | data. |
218 | |
235 | |
219 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
236 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
220 | automatically when you try to create a TLS handle). |
237 | automatically when you try to create a TLS handle). |
221 | |
238 | |
222 | For the TLS server side, use C<accept>, and for the TLS client side of a |
239 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
223 | connection, use C<connect> mode. |
240 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
241 | mode. |
224 | |
242 | |
225 | You can also provide your own TLS connection object, but you have |
243 | 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> |
244 | 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 |
245 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
228 | AnyEvent::Handle. |
246 | AnyEvent::Handle. |
229 | |
247 | |
230 | See the C<starttls> method if you need to start TLs negotiation later. |
248 | See the C<starttls> method for when need to start TLS negotiation later. |
231 | |
249 | |
232 | =item tls_ctx => $ssl_ctx |
250 | =item tls_ctx => $ssl_ctx |
233 | |
251 | |
234 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
252 | 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 |
253 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
288 | delete $self->{_rw}; |
306 | delete $self->{_rw}; |
289 | delete $self->{_ww}; |
307 | delete $self->{_ww}; |
290 | delete $self->{fh}; |
308 | delete $self->{fh}; |
291 | |
309 | |
292 | $self->stoptls; |
310 | $self->stoptls; |
|
|
311 | |
|
|
312 | delete $self->{on_read}; |
|
|
313 | delete $self->{_queue}; |
293 | } |
314 | } |
294 | |
315 | |
295 | sub _error { |
316 | sub _error { |
296 | my ($self, $errno, $fatal) = @_; |
317 | my ($self, $errno, $fatal) = @_; |
297 | |
318 | |
… | |
… | |
726 | |
747 | |
727 | if ( |
748 | if ( |
728 | defined $self->{rbuf_max} |
749 | defined $self->{rbuf_max} |
729 | && $self->{rbuf_max} < length $self->{rbuf} |
750 | && $self->{rbuf_max} < length $self->{rbuf} |
730 | ) { |
751 | ) { |
731 | return $self->_error (&Errno::ENOSPC, 1); |
752 | $self->_error (&Errno::ENOSPC, 1), return; |
732 | } |
753 | } |
733 | |
754 | |
734 | while () { |
755 | while () { |
735 | no strict 'refs'; |
|
|
736 | |
|
|
737 | my $len = length $self->{rbuf}; |
756 | my $len = length $self->{rbuf}; |
738 | |
757 | |
739 | if (my $cb = shift @{ $self->{_queue} }) { |
758 | if (my $cb = shift @{ $self->{_queue} }) { |
740 | unless ($cb->($self)) { |
759 | unless ($cb->($self)) { |
741 | if ($self->{_eof}) { |
760 | if ($self->{_eof}) { |
742 | # no progress can be made (not enough data and no data forthcoming) |
761 | # no progress can be made (not enough data and no data forthcoming) |
743 | $self->_error (&Errno::EPIPE, 1), last; |
762 | $self->_error (&Errno::EPIPE, 1), return; |
744 | } |
763 | } |
745 | |
764 | |
746 | unshift @{ $self->{_queue} }, $cb; |
765 | unshift @{ $self->{_queue} }, $cb; |
747 | last; |
766 | last; |
748 | } |
767 | } |
… | |
… | |
756 | && !@{ $self->{_queue} } # and the queue is still empty |
775 | && !@{ $self->{_queue} } # and the queue is still empty |
757 | && $self->{on_read} # but we still have on_read |
776 | && $self->{on_read} # but we still have on_read |
758 | ) { |
777 | ) { |
759 | # no further data will arrive |
778 | # no further data will arrive |
760 | # so no progress can be made |
779 | # so no progress can be made |
761 | $self->_error (&Errno::EPIPE, 1), last |
780 | $self->_error (&Errno::EPIPE, 1), return |
762 | if $self->{_eof}; |
781 | if $self->{_eof}; |
763 | |
782 | |
764 | last; # more data might arrive |
783 | last; # more data might arrive |
765 | } |
784 | } |
766 | } else { |
785 | } else { |
… | |
… | |
768 | delete $self->{_rw}; |
787 | delete $self->{_rw}; |
769 | last; |
788 | last; |
770 | } |
789 | } |
771 | } |
790 | } |
772 | |
791 | |
|
|
792 | if ($self->{_eof}) { |
|
|
793 | if ($self->{on_eof}) { |
773 | $self->{on_eof}($self) |
794 | $self->{on_eof}($self) |
774 | if $self->{_eof} && $self->{on_eof}; |
795 | } else { |
|
|
796 | $self->_error (0, 1); |
|
|
797 | } |
|
|
798 | } |
775 | |
799 | |
776 | # may need to restart read watcher |
800 | # may need to restart read watcher |
777 | unless ($self->{_rw}) { |
801 | unless ($self->{_rw}) { |
778 | $self->start_read |
802 | $self->start_read |
779 | if $self->{on_read} || @{ $self->{_queue} }; |
803 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
905 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
929 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
906 | 1 |
930 | 1 |
907 | } |
931 | } |
908 | }; |
932 | }; |
909 | |
933 | |
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) |
934 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
920 | |
935 | |
921 | The callback will be called only once a full line (including the end of |
936 | 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 |
937 | 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 |
938 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
938 | =cut |
953 | =cut |
939 | |
954 | |
940 | register_read_type line => sub { |
955 | register_read_type line => sub { |
941 | my ($self, $cb, $eol) = @_; |
956 | my ($self, $cb, $eol) = @_; |
942 | |
957 | |
943 | $eol = qr|(\015?\012)| if @_ < 3; |
958 | if (@_ < 3) { |
|
|
959 | # this is more than twice as fast as the generic code below |
|
|
960 | sub { |
|
|
961 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
962 | |
|
|
963 | $cb->($_[0], $1, $2); |
|
|
964 | 1 |
|
|
965 | } |
|
|
966 | } else { |
944 | $eol = quotemeta $eol unless ref $eol; |
967 | $eol = quotemeta $eol unless ref $eol; |
945 | $eol = qr|^(.*?)($eol)|s; |
968 | $eol = qr|^(.*?)($eol)|s; |
946 | |
969 | |
947 | sub { |
970 | sub { |
948 | $_[0]{rbuf} =~ s/$eol// or return; |
971 | $_[0]{rbuf} =~ s/$eol// or return; |
949 | |
972 | |
950 | $cb->($_[0], $1, $2); |
973 | $cb->($_[0], $1, $2); |
|
|
974 | 1 |
951 | 1 |
975 | } |
952 | } |
976 | } |
953 | }; |
977 | }; |
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 | |
978 | |
966 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
979 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
967 | |
980 | |
968 | Makes a regex match against the regex object C<$accept> and returns |
981 | Makes a regex match against the regex object C<$accept> and returns |
969 | everything up to and including the match. |
982 | everything up to and including the match. |
… | |
… | |
1090 | register_read_type packstring => sub { |
1103 | register_read_type packstring => sub { |
1091 | my ($self, $cb, $format) = @_; |
1104 | my ($self, $cb, $format) = @_; |
1092 | |
1105 | |
1093 | sub { |
1106 | sub { |
1094 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1107 | # 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} }) |
1108 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1096 | or return; |
1109 | or return; |
1097 | |
1110 | |
|
|
1111 | $format = length pack $format, $len; |
|
|
1112 | |
|
|
1113 | # bypass unshift if we already have the remaining chunk |
|
|
1114 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1115 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1116 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1117 | $cb->($_[0], $data); |
|
|
1118 | } else { |
1098 | # remove prefix |
1119 | # remove prefix |
1099 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1120 | substr $_[0]{rbuf}, 0, $format, ""; |
1100 | |
1121 | |
1101 | # read rest |
1122 | # read remaining chunk |
1102 | $_[0]->unshift_read (chunk => $len, $cb); |
1123 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1124 | } |
1103 | |
1125 | |
1104 | 1 |
1126 | 1 |
1105 | } |
1127 | } |
1106 | }; |
1128 | }; |
1107 | |
1129 | |
… | |
… | |
1164 | |
1186 | |
1165 | require Storable; |
1187 | require Storable; |
1166 | |
1188 | |
1167 | sub { |
1189 | sub { |
1168 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1190 | # 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} }) |
1191 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1170 | or return; |
1192 | or return; |
1171 | |
1193 | |
|
|
1194 | my $format = length pack "w", $len; |
|
|
1195 | |
|
|
1196 | # bypass unshift if we already have the remaining chunk |
|
|
1197 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1198 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1199 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1200 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1201 | } else { |
1172 | # remove prefix |
1202 | # remove prefix |
1173 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1203 | substr $_[0]{rbuf}, 0, $format, ""; |
1174 | |
1204 | |
1175 | # read rest |
1205 | # read remaining chunk |
1176 | $_[0]->unshift_read (chunk => $len, sub { |
1206 | $_[0]->unshift_read (chunk => $len, sub { |
1177 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1207 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1178 | $cb->($_[0], $ref); |
1208 | $cb->($_[0], $ref); |
1179 | } else { |
1209 | } else { |
1180 | $self->_error (&Errno::EBADMSG); |
1210 | $self->_error (&Errno::EBADMSG); |
|
|
1211 | } |
1181 | } |
1212 | }); |
1182 | }); |
1213 | } |
|
|
1214 | |
|
|
1215 | 1 |
1183 | } |
1216 | } |
1184 | }; |
1217 | }; |
1185 | |
1218 | |
1186 | =back |
1219 | =back |
1187 | |
1220 | |
… | |
… | |
1448 | =over 4 |
1481 | =over 4 |
1449 | |
1482 | |
1450 | =item * all constructor arguments become object members. |
1483 | =item * all constructor arguments become object members. |
1451 | |
1484 | |
1452 | At least initially, when you pass a C<tls>-argument to the constructor it |
1485 | 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 |
1486 | 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). |
1487 | mutated later on (for example C<tls> will hold the TLS connection object). |
1455 | |
1488 | |
1456 | =item * other object member names are prefixed with an C<_>. |
1489 | =item * other object member names are prefixed with an C<_>. |
1457 | |
1490 | |
1458 | All object members not explicitly documented (internal use) are prefixed |
1491 | All object members not explicitly documented (internal use) are prefixed |