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.108 by root, Tue Jan 6 20:08:05 2009 UTC vs.
Revision 1.123 by root, Mon Apr 20 14:34:18 2009 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.331; 19our $VERSION = 4.352;
20 20
21=head1 SYNOPSIS 21=head1 SYNOPSIS
22 22
23 use AnyEvent; 23 use AnyEvent;
24 use AnyEvent::Handle; 24 use AnyEvent::Handle;
127and no read request is in the queue (unlike read queue callbacks, this 127and no read request is in the queue (unlike read queue callbacks, this
128callback will only be called when at least one octet of data is in the 128callback will only be called when at least one octet of data is in the
129read buffer). 129read buffer).
130 130
131To access (and remove data from) the read buffer, use the C<< ->rbuf >> 131To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132method or access the C<$handle->{rbuf}> member directly. 132method or access the C<$handle->{rbuf}> member directly. Note that you
133must not enlarge or modify the read buffer, you can only remove data at
134the beginning from it.
133 135
134When an EOF condition is detected then AnyEvent::Handle will first try to 136When an EOF condition is detected then AnyEvent::Handle will first try to
135feed all the remaining data to the queued callbacks and C<on_read> before 137feed all the remaining data to the queued callbacks and C<on_read> before
136calling the C<on_eof> callback. If no progress can be made, then a fatal 138calling the C<on_eof> callback. If no progress can be made, then a fatal
137error will be raised (with C<$!> set to C<EPIPE>). 139error will be raised (with C<$!> set to C<EPIPE>).
254 256
255You can also provide your own TLS connection object, but you have 257You can also provide your own TLS connection object, but you have
256to make sure that you call either C<Net::SSLeay::set_connect_state> 258to make sure that you call either C<Net::SSLeay::set_connect_state>
257or C<Net::SSLeay::set_accept_state> on it before you pass it to 259or C<Net::SSLeay::set_accept_state> on it before you pass it to
258AnyEvent::Handle. 260AnyEvent::Handle.
261
262B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263passing in the wrong integer will lead to certain crash. This most often
264happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265segmentation fault.
259 266
260See the C<< ->starttls >> method for when need to start TLS negotiation later. 267See the C<< ->starttls >> method for when need to start TLS negotiation later.
261 268
262=item tls_ctx => $ssl_ctx 269=item tls_ctx => $ssl_ctx
263 270
762 ) { 769 ) {
763 $self->_error (&Errno::ENOSPC, 1), return; 770 $self->_error (&Errno::ENOSPC, 1), return;
764 } 771 }
765 772
766 while () { 773 while () {
774 # we need to use a separate tls read buffer, as we must not receive data while
775 # we are draining the buffer, and this can only happen with TLS.
776 $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
777
767 my $len = length $self->{rbuf}; 778 my $len = length $self->{rbuf};
768 779
769 if (my $cb = shift @{ $self->{_queue} }) { 780 if (my $cb = shift @{ $self->{_queue} }) {
770 unless ($cb->($self)) { 781 unless ($cb->($self)) {
771 if ($self->{_eof}) { 782 if ($self->{_eof}) {
832 843
833=item $handle->rbuf 844=item $handle->rbuf
834 845
835Returns the read buffer (as a modifiable lvalue). 846Returns the read buffer (as a modifiable lvalue).
836 847
837You can access the read buffer directly as the C<< ->{rbuf} >> member, if 848You can access the read buffer directly as the C<< ->{rbuf} >>
838you want. 849member, if you want. However, the only operation allowed on the
850read buffer (apart from looking at it) is removing data from its
851beginning. Otherwise modifying or appending to it is not allowed and will
852lead to hard-to-track-down bugs.
839 853
840NOTE: The read buffer should only be used or modified if the C<on_read>, 854NOTE: The read buffer should only be used or modified if the C<on_read>,
841C<push_read> or C<unshift_read> methods are used. The other read methods 855C<push_read> or C<unshift_read> methods are used. The other read methods
842automatically manage the read buffer. 856automatically manage the read buffer.
843 857
1139 } 1153 }
1140}; 1154};
1141 1155
1142=item json => $cb->($handle, $hash_or_arrayref) 1156=item json => $cb->($handle, $hash_or_arrayref)
1143 1157
1144Reads a JSON object or array, decodes it and passes it to the callback. 1158Reads a JSON object or array, decodes it and passes it to the
1159callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1145 1160
1146If a C<json> object was passed to the constructor, then that will be used 1161If a C<json> object was passed to the constructor, then that will be used
1147for the final decode, otherwise it will create a JSON coder expecting UTF-8. 1162for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1148 1163
1149This read type uses the incremental parser available with JSON version 1164This read type uses the incremental parser available with JSON version
1166 my $rbuf = \$self->{rbuf}; 1181 my $rbuf = \$self->{rbuf};
1167 1182
1168 my $json = $self->{json} ||= JSON->new->utf8; 1183 my $json = $self->{json} ||= JSON->new->utf8;
1169 1184
1170 sub { 1185 sub {
1171 my $ref = $json->incr_parse ($self->{rbuf}); 1186 my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1172 1187
1173 if ($ref) { 1188 if ($ref) {
1174 $self->{rbuf} = $json->incr_text; 1189 $self->{rbuf} = $json->incr_text;
1175 $json->incr_text = ""; 1190 $json->incr_text = "";
1176 $cb->($self, $ref); 1191 $cb->($self, $ref);
1177 1192
1178 1 1193 1
1194 } elsif ($@) {
1195 # error case
1196 $json->incr_skip;
1197
1198 $self->{rbuf} = $json->incr_text;
1199 $json->incr_text = "";
1200
1201 $self->_error (&Errno::EBADMSG);
1202
1203 ()
1179 } else { 1204 } else {
1180 $self->{rbuf} = ""; 1205 $self->{rbuf} = "";
1206
1181 () 1207 ()
1182 } 1208 }
1183 } 1209 }
1184}; 1210};
1185 1211
1326 delete $self->{_rw}; 1352 delete $self->{_rw};
1327 $self->{_eof} = 1; 1353 $self->{_eof} = 1;
1328 &_freetls; 1354 &_freetls;
1329 } 1355 }
1330 1356
1331 $self->{rbuf} .= $tmp; 1357 $self->{_tls_rbuf} .= $tmp;
1332 $self->_drain_rbuf unless $self->{_in_drain}; 1358 $self->_drain_rbuf unless $self->{_in_drain};
1333 $self->{tls} or return; # tls session might have gone away in callback 1359 $self->{tls} or return; # tls session might have gone away in callback
1334 } 1360 }
1335 1361
1336 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 1362 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1337 1363
1338 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { 1364 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1339 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { 1365 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1340 return $self->_error ($!, 1); 1366 return $self->_error ($!, 1);
1341 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { 1367 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1342 return $self->_error (&Errno::EIO, 1); 1368 return $self->_error (&Errno::EIO, 1);
1343 } 1369 }
1344 1370
1345 # all other errors are fine for our purposes 1371 # all other errors are fine for our purposes
1346 } 1372 }
1447 1473
1448 delete @$self{qw(_rbio _wbio _tls_wbuf)}; 1474 delete @$self{qw(_rbio _wbio _tls_wbuf)};
1449} 1475}
1450 1476
1451sub DESTROY { 1477sub DESTROY {
1452 my $self = shift; 1478 my ($self) = @_;
1453 1479
1454 &_freetls; 1480 &_freetls;
1455 1481
1456 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1482 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1457 1483

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines