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.102 by root, Wed Oct 29 14:32:02 2008 UTC vs.
Revision 1.122 by root, Sat Apr 11 05:56:36 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.3; 19our $VERSION = 4.351;
20 20
21=head1 SYNOPSIS 21=head1 SYNOPSIS
22 22
23 use AnyEvent; 23 use AnyEvent;
24 use AnyEvent::Handle; 24 use AnyEvent::Handle;
27 27
28 my $handle = 28 my $handle =
29 AnyEvent::Handle->new ( 29 AnyEvent::Handle->new (
30 fh => \*STDIN, 30 fh => \*STDIN,
31 on_eof => sub { 31 on_eof => sub {
32 $cv->broadcast; 32 $cv->send;
33 }, 33 },
34 ); 34 );
35 35
36 # send some request line 36 # send some request line
37 $handle->push_write ("getinfo\015\012"); 37 $handle->push_write ("getinfo\015\012");
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>).
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.
259 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.
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
264Use the given C<Net::SSLeay::CTX> object to create the new TLS connection 271Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
374} 381}
375 382
376=item $handle->autocork ($boolean) 383=item $handle->autocork ($boolean)
377 384
378Enables or disables the current autocork behaviour (see C<autocork> 385Enables or disables the current autocork behaviour (see C<autocork>
379constructor argument). 386constructor argument). Changes will only take effect on the next write.
380 387
381=cut 388=cut
389
390sub autocork {
391 $_[0]{autocork} = $_[1];
392}
382 393
383=item $handle->no_delay ($boolean) 394=item $handle->no_delay ($boolean)
384 395
385Enables or disables the C<no_delay> setting (see constructor argument of 396Enables or disables the C<no_delay> setting (see constructor argument of
386the same name for details). 397the same name for details).
758 ) { 769 ) {
759 $self->_error (&Errno::ENOSPC, 1), return; 770 $self->_error (&Errno::ENOSPC, 1), return;
760 } 771 }
761 772
762 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
763 my $len = length $self->{rbuf}; 778 my $len = length $self->{rbuf};
764 779
765 if (my $cb = shift @{ $self->{_queue} }) { 780 if (my $cb = shift @{ $self->{_queue} }) {
766 unless ($cb->($self)) { 781 unless ($cb->($self)) {
767 if ($self->{_eof}) { 782 if ($self->{_eof}) {
828 843
829=item $handle->rbuf 844=item $handle->rbuf
830 845
831Returns the read buffer (as a modifiable lvalue). 846Returns the read buffer (as a modifiable lvalue).
832 847
833You can access the read buffer directly as the C<< ->{rbuf} >> member, if 848You can access the read buffer directly as the C<< ->{rbuf} >>
834you 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.
835 853
836NOTE: 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>,
837C<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
838automatically manage the read buffer. 856automatically manage the read buffer.
839 857
1135 } 1153 }
1136}; 1154};
1137 1155
1138=item json => $cb->($handle, $hash_or_arrayref) 1156=item json => $cb->($handle, $hash_or_arrayref)
1139 1157
1140Reads 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.
1141 1160
1142If 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
1143for 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.
1144 1163
1145This read type uses the incremental parser available with JSON version 1164This read type uses the incremental parser available with JSON version
1162 my $rbuf = \$self->{rbuf}; 1181 my $rbuf = \$self->{rbuf};
1163 1182
1164 my $json = $self->{json} ||= JSON->new->utf8; 1183 my $json = $self->{json} ||= JSON->new->utf8;
1165 1184
1166 sub { 1185 sub {
1167 my $ref = $json->incr_parse ($self->{rbuf}); 1186 my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1168 1187
1169 if ($ref) { 1188 if ($ref) {
1170 $self->{rbuf} = $json->incr_text; 1189 $self->{rbuf} = $json->incr_text;
1171 $json->incr_text = ""; 1190 $json->incr_text = "";
1172 $cb->($self, $ref); 1191 $cb->($self, $ref);
1173 1192
1174 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 ()
1175 } else { 1204 } else {
1176 $self->{rbuf} = ""; 1205 $self->{rbuf} = "";
1206
1177 () 1207 ()
1178 } 1208 }
1179 } 1209 }
1180}; 1210};
1181 1211
1322 delete $self->{_rw}; 1352 delete $self->{_rw};
1323 $self->{_eof} = 1; 1353 $self->{_eof} = 1;
1324 &_freetls; 1354 &_freetls;
1325 } 1355 }
1326 1356
1327 $self->{rbuf} .= $tmp; 1357 $self->{_tls_rbuf} .= $tmp;
1328 $self->_drain_rbuf unless $self->{_in_drain}; 1358 $self->_drain_rbuf unless $self->{_in_drain};
1329 $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
1330 } 1360 }
1331 1361
1332 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 1362 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1333 1363
1334 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { 1364 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1335 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { 1365 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1336 return $self->_error ($!, 1); 1366 return $self->_error ($!, 1);
1337 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { 1367 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1338 return $self->_error (&Errno::EIO, 1); 1368 return $self->_error (&Errno::EIO, 1);
1339 } 1369 }
1340 1370
1341 # all other errors are fine for our purposes 1371 # all other errors are fine for our purposes
1342 } 1372 }
1443 1473
1444 delete @$self{qw(_rbio _wbio _tls_wbuf)}; 1474 delete @$self{qw(_rbio _wbio _tls_wbuf)};
1445} 1475}
1446 1476
1447sub DESTROY { 1477sub DESTROY {
1448 my $self = shift; 1478 my ($self) = @_;
1449 1479
1450 &_freetls; 1480 &_freetls;
1451 1481
1452 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1482 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1453 1483

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines