ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.71 by root, Thu Jul 3 02:03:33 2008 UTC vs.
Revision 1.78 by root, Sun Jul 27 07:34:07 2008 UTC

14 14
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 16
17=cut 17=cut
18 18
19our $VERSION = 4.160; 19our $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;
75NOTE: The filehandle will be set to non-blocking (using 75NOTE: The filehandle will be set to non-blocking (using
76AnyEvent::Util::fh_nonblocking). 76AnyEvent::Util::fh_nonblocking).
77 77
78=item on_eof => $cb->($handle) 78=item on_eof => $cb->($handle)
79 79
80Set the callback to be called when an end-of-file condition is detcted, 80Set the callback to be called when an end-of-file condition is detected,
81i.e. in the case of a socket, when the other side has closed the 81i.e. in the case of a socket, when the other side has closed the
82connection cleanly. 82connection cleanly.
83 83
84While not mandatory, it is highly recommended to set an eof callback, 84While not mandatory, it is highly recommended to set an eof callback,
85otherwise you might end up with a closed socket while you are still 85otherwise you might end up with a closed socket while you are still
225You can also provide your own TLS connection object, but you have 225You can also provide your own TLS connection object, but you have
226to make sure that you call either C<Net::SSLeay::set_connect_state> 226to make sure that you call either C<Net::SSLeay::set_connect_state>
227or C<Net::SSLeay::set_accept_state> on it before you pass it to 227or C<Net::SSLeay::set_accept_state> on it before you pass it to
228AnyEvent::Handle. 228AnyEvent::Handle.
229 229
230See the C<starttls> method if you need to start TLs negotiation later. 230See the C<starttls> method if you need to start TLS negotiation later.
231 231
232=item tls_ctx => $ssl_ctx 232=item tls_ctx => $ssl_ctx
233 233
234Use the given Net::SSLeay::CTX object to create the new TLS connection 234Use the given Net::SSLeay::CTX object to create the new TLS connection
235(unless a connection object was specified directly). If this parameter is 235(unless a connection object was specified directly). If this parameter is
905 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); 905 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
906 1 906 1
907 } 907 }
908}; 908};
909 909
910# compatibility with older API
911sub push_read_chunk {
912 $_[0]->push_read (chunk => $_[1], $_[2]);
913}
914
915sub unshift_read_chunk {
916 $_[0]->unshift_read (chunk => $_[1], $_[2]);
917}
918
919=item line => [$eol, ]$cb->($handle, $line, $eol) 910=item line => [$eol, ]$cb->($handle, $line, $eol)
920 911
921The callback will be called only once a full line (including the end of 912The callback will be called only once a full line (including the end of
922line marker, C<$eol>) has been read. This line (excluding the end of line 913line marker, C<$eol>) has been read. This line (excluding the end of line
923marker) will be passed to the callback as second argument (C<$line>), and 914marker) will be passed to the callback as second argument (C<$line>), and
938=cut 929=cut
939 930
940register_read_type line => sub { 931register_read_type line => sub {
941 my ($self, $cb, $eol) = @_; 932 my ($self, $cb, $eol) = @_;
942 933
943 $eol = qr|(\015?\012)| if @_ < 3; 934 if (@_ < 3) {
935 # this is more than twice as fast as the generic code below
936 sub {
937 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
938
939 $cb->($_[0], $1, $2);
940 1
941 }
942 } else {
944 $eol = quotemeta $eol unless ref $eol; 943 $eol = quotemeta $eol unless ref $eol;
945 $eol = qr|^(.*?)($eol)|s; 944 $eol = qr|^(.*?)($eol)|s;
946 945
947 sub { 946 sub {
948 $_[0]{rbuf} =~ s/$eol// or return; 947 $_[0]{rbuf} =~ s/$eol// or return;
949 948
950 $cb->($_[0], $1, $2); 949 $cb->($_[0], $1, $2);
950 1
951 1 951 }
952 } 952 }
953}; 953};
954
955# compatibility with older API
956sub push_read_line {
957 my $self = shift;
958 $self->push_read (line => @_);
959}
960
961sub unshift_read_line {
962 my $self = shift;
963 $self->unshift_read (line => @_);
964}
965 954
966=item regex => $accept[, $reject[, $skip], $cb->($handle, $data) 955=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
967 956
968Makes a regex match against the regex object C<$accept> and returns 957Makes a regex match against the regex object C<$accept> and returns
969everything up to and including the match. 958everything up to and including the match.
1090register_read_type packstring => sub { 1079register_read_type packstring => sub {
1091 my ($self, $cb, $format) = @_; 1080 my ($self, $cb, $format) = @_;
1092 1081
1093 sub { 1082 sub {
1094 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1083 # 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} }) 1084 defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1096 or return; 1085 or return;
1097 1086
1087 $format = length pack $format, $len;
1088
1089 # bypass unshift if we already have the remaining chunk
1090 if ($format + $len <= length $_[0]{rbuf}) {
1091 my $data = substr $_[0]{rbuf}, $format, $len;
1092 substr $_[0]{rbuf}, 0, $format + $len, "";
1093 $cb->($_[0], $data);
1094 } else {
1098 # remove prefix 1095 # remove prefix
1099 substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; 1096 substr $_[0]{rbuf}, 0, $format, "";
1100 1097
1101 # read rest 1098 # read remaining chunk
1102 $_[0]->unshift_read (chunk => $len, $cb); 1099 $_[0]->unshift_read (chunk => $len, $cb);
1100 }
1103 1101
1104 1 1102 1
1105 } 1103 }
1106}; 1104};
1107 1105
1164 1162
1165 require Storable; 1163 require Storable;
1166 1164
1167 sub { 1165 sub {
1168 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1166 # 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} }) 1167 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1170 or return; 1168 or return;
1171 1169
1170 my $format = length pack "w", $len;
1171
1172 # bypass unshift if we already have the remaining chunk
1173 if ($format + $len <= length $_[0]{rbuf}) {
1174 my $data = substr $_[0]{rbuf}, $format, $len;
1175 substr $_[0]{rbuf}, 0, $format + $len, "";
1176 $cb->($_[0], Storable::thaw ($data));
1177 } else {
1172 # remove prefix 1178 # remove prefix
1173 substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; 1179 substr $_[0]{rbuf}, 0, $format, "";
1174 1180
1175 # read rest 1181 # read remaining chunk
1176 $_[0]->unshift_read (chunk => $len, sub { 1182 $_[0]->unshift_read (chunk => $len, sub {
1177 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1183 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1178 $cb->($_[0], $ref); 1184 $cb->($_[0], $ref);
1179 } else { 1185 } else {
1180 $self->_error (&Errno::EBADMSG); 1186 $self->_error (&Errno::EBADMSG);
1187 }
1181 } 1188 });
1182 }); 1189 }
1190
1191 1
1183 } 1192 }
1184}; 1193};
1185 1194
1186=back 1195=back
1187 1196
1448=over 4 1457=over 4
1449 1458
1450=item * all constructor arguments become object members. 1459=item * all constructor arguments become object members.
1451 1460
1452At least initially, when you pass a C<tls>-argument to the constructor it 1461At least initially, when you pass a C<tls>-argument to the constructor it
1453will end up in C<< $handle->{tls} >>. Those members might be changes or 1462will end up in C<< $handle->{tls} >>. Those members might be changed or
1454mutated later on (for example C<tls> will hold the TLS connection object). 1463mutated later on (for example C<tls> will hold the TLS connection object).
1455 1464
1456=item * other object member names are prefixed with an C<_>. 1465=item * other object member names are prefixed with an C<_>.
1457 1466
1458All object members not explicitly documented (internal use) are prefixed 1467All object members not explicitly documented (internal use) are prefixed

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines