| … | |
… | |
| 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.8; |
19 | our $VERSION = 4.82; |
| 20 | |
20 | |
| 21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
| 22 | |
22 | |
| 23 | use AnyEvent; |
23 | use AnyEvent; |
| 24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
| 25 | |
25 | |
| 26 | my $cv = AnyEvent->condvar; |
26 | my $cv = AnyEvent->condvar; |
| 27 | |
27 | |
| 28 | my $handle = |
28 | my $hdl; $hdl = new AnyEvent::Handle |
| 29 | AnyEvent::Handle->new ( |
|
|
| 30 | fh => \*STDIN, |
29 | fh => \*STDIN, |
| 31 | on_eof => sub { |
30 | on_error => sub { |
|
|
31 | warn "got error $_[2]\n"; |
| 32 | $cv->send; |
32 | $cv->send; |
| 33 | }, |
|
|
| 34 | ); |
33 | ); |
| 35 | |
34 | |
| 36 | # send some request line |
35 | # send some request line |
| 37 | $handle->push_write ("getinfo\015\012"); |
36 | $hdl->push_write ("getinfo\015\012"); |
| 38 | |
37 | |
| 39 | # read the response line |
38 | # read the response line |
| 40 | $handle->push_read (line => sub { |
39 | $hdl->push_read (line => sub { |
| 41 | my ($handle, $line) = @_; |
40 | my ($hdl, $line) = @_; |
| 42 | warn "read line <$line>\n"; |
41 | warn "got line <$line>\n"; |
| 43 | $cv->send; |
42 | $cv->send; |
| 44 | }); |
43 | }); |
| 45 | |
44 | |
| 46 | $cv->recv; |
45 | $cv->recv; |
| 47 | |
46 | |
| … | |
… | |
| 81 | |
80 | |
| 82 | =item on_eof => $cb->($handle) |
81 | =item on_eof => $cb->($handle) |
| 83 | |
82 | |
| 84 | Set the callback to be called when an end-of-file condition is detected, |
83 | Set the callback to be called when an end-of-file condition is detected, |
| 85 | i.e. in the case of a socket, when the other side has closed the |
84 | i.e. in the case of a socket, when the other side has closed the |
| 86 | connection cleanly. |
85 | connection cleanly, and there are no outstanding read requests in the |
|
|
86 | queue (if there are read requests, then an EOF counts as an unexpected |
|
|
87 | connection close and will be flagged as an error). |
| 87 | |
88 | |
| 88 | For sockets, this just means that the other side has stopped sending data, |
89 | 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 | 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 | callback and continue writing data, as only the read part has been shut |
| 91 | down. |
92 | down. |
| 92 | |
93 | |
| 93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
|
|
| 94 | otherwise you might end up with a closed socket while you are still |
|
|
| 95 | waiting for data. |
|
|
| 96 | |
|
|
| 97 | If an EOF condition has been detected but no C<on_eof> callback has been |
94 | 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>. |
95 | set, then a fatal error will be raised with C<$!> set to <0>. |
| 99 | |
96 | |
| 100 | =item on_error => $cb->($handle, $fatal, $message) |
97 | =item on_error => $cb->($handle, $fatal, $message) |
| 101 | |
98 | |
| 102 | This is the error callback, which is called when, well, some error |
99 | This is the error callback, which is called when, well, some error |
| 103 | occured, such as not being able to resolve the hostname, failure to |
100 | occured, such as not being able to resolve the hostname, failure to |
| 104 | connect or a read error. |
101 | connect or a read error. |
| 105 | |
102 | |
| 106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
103 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
| 107 | fatal errors the handle object will be shut down and will not be usable |
104 | fatal errors the handle object will be destroyed (by a call to C<< -> |
| 108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
105 | destroy >>) after invoking the error callback (which means you are free to |
| 109 | errors are an EOF condition with active (but unsatisifable) read watchers |
106 | examine the handle object). Examples of fatal errors are an EOF condition |
| 110 | (C<EPIPE>) or I/O errors. |
107 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. |
| 111 | |
108 | |
| 112 | AnyEvent::Handle tries to find an appropriate error code for you to check |
109 | AnyEvent::Handle tries to find an appropriate error code for you to check |
| 113 | against, but in some cases (TLS errors), this does not work well. It is |
110 | against, but in some cases (TLS errors), this does not work well. It is |
| 114 | recommended to always output the C<$message> argument in human-readable |
111 | recommended to always output the C<$message> argument in human-readable |
| 115 | error messages (it's usually the same as C<"$!">). |
112 | error messages (it's usually the same as C<"$!">). |
| … | |
… | |
| 141 | |
138 | |
| 142 | When an EOF condition is detected then AnyEvent::Handle will first try to |
139 | When an EOF condition is detected then AnyEvent::Handle will first try to |
| 143 | feed all the remaining data to the queued callbacks and C<on_read> before |
140 | feed all the remaining data to the queued callbacks and C<on_read> before |
| 144 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
141 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
| 145 | error will be raised (with C<$!> set to C<EPIPE>). |
142 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
143 | |
|
|
144 | Note that, unlike requests in the read queue, an C<on_read> callback |
|
|
145 | doesn't mean you I<require> some data: if there is an EOF and there |
|
|
146 | are outstanding read requests then an error will be flagged. With an |
|
|
147 | C<on_read> callback, the C<on_eof> callback will be invoked. |
| 146 | |
148 | |
| 147 | =item on_drain => $cb->($handle) |
149 | =item on_drain => $cb->($handle) |
| 148 | |
150 | |
| 149 | This sets the callback that is called when the write buffer becomes empty |
151 | This sets the callback that is called when the write buffer becomes empty |
| 150 | (or when the callback is set and the buffer is empty already). |
152 | (or when the callback is set and the buffer is empty already). |
| … | |
… | |
| 369 | if $self->{on_read}; |
371 | if $self->{on_read}; |
| 370 | |
372 | |
| 371 | $self->{fh} && $self |
373 | $self->{fh} && $self |
| 372 | } |
374 | } |
| 373 | |
375 | |
| 374 | sub _shutdown { |
376 | #sub _shutdown { |
| 375 | my ($self) = @_; |
377 | # my ($self) = @_; |
| 376 | |
378 | # |
| 377 | delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
379 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
| 378 | $self->{_eof} = 1; # tell starttls et. al to stop trying |
380 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
| 379 | |
381 | # |
| 380 | &_freetls; |
382 | # &_freetls; |
| 381 | } |
383 | #} |
| 382 | |
384 | |
| 383 | sub _error { |
385 | sub _error { |
| 384 | my ($self, $errno, $fatal, $message) = @_; |
386 | my ($self, $errno, $fatal, $message) = @_; |
| 385 | |
387 | |
| 386 | $self->_shutdown |
|
|
| 387 | if $fatal; |
|
|
| 388 | |
|
|
| 389 | $! = $errno; |
388 | $! = $errno; |
| 390 | $message ||= "$!"; |
389 | $message ||= "$!"; |
| 391 | |
390 | |
| 392 | if ($self->{on_error}) { |
391 | if ($self->{on_error}) { |
| 393 | $self->{on_error}($self, $fatal, $message); |
392 | $self->{on_error}($self, $fatal, $message); |
|
|
393 | $self->destroy; |
| 394 | } elsif ($self->{fh}) { |
394 | } elsif ($self->{fh}) { |
|
|
395 | $self->destroy; |
| 395 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
396 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
| 396 | } |
397 | } |
| 397 | } |
398 | } |
| 398 | |
399 | |
| 399 | =item $fh = $handle->fh |
400 | =item $fh = $handle->fh |
| … | |
… | |
| 514 | $self->{_activity} = $NOW; |
515 | $self->{_activity} = $NOW; |
| 515 | |
516 | |
| 516 | if ($self->{on_timeout}) { |
517 | if ($self->{on_timeout}) { |
| 517 | $self->{on_timeout}($self); |
518 | $self->{on_timeout}($self); |
| 518 | } else { |
519 | } else { |
| 519 | $self->_error (&Errno::ETIMEDOUT); |
520 | $self->_error (Errno::ETIMEDOUT); |
| 520 | } |
521 | } |
| 521 | |
522 | |
| 522 | # callback could have changed timeout value, optimise |
523 | # callback could have changed timeout value, optimise |
| 523 | return unless $self->{timeout}; |
524 | return unless $self->{timeout}; |
| 524 | |
525 | |
| … | |
… | |
| 587 | Scalar::Util::weaken $self; |
588 | Scalar::Util::weaken $self; |
| 588 | |
589 | |
| 589 | my $cb = sub { |
590 | my $cb = sub { |
| 590 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
591 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
| 591 | |
592 | |
| 592 | if ($len >= 0) { |
593 | if (defined $len) { |
| 593 | substr $self->{wbuf}, 0, $len, ""; |
594 | substr $self->{wbuf}, 0, $len, ""; |
| 594 | |
595 | |
| 595 | $self->{_activity} = AnyEvent->now; |
596 | $self->{_activity} = AnyEvent->now; |
| 596 | |
597 | |
| 597 | $self->{on_drain}($self) |
598 | $self->{on_drain}($self) |
| … | |
… | |
| 866 | |
867 | |
| 867 | if ( |
868 | if ( |
| 868 | defined $self->{rbuf_max} |
869 | defined $self->{rbuf_max} |
| 869 | && $self->{rbuf_max} < length $self->{rbuf} |
870 | && $self->{rbuf_max} < length $self->{rbuf} |
| 870 | ) { |
871 | ) { |
| 871 | $self->_error (&Errno::ENOSPC, 1), return; |
872 | $self->_error (Errno::ENOSPC, 1), return; |
| 872 | } |
873 | } |
| 873 | |
874 | |
| 874 | while () { |
875 | while () { |
| 875 | # we need to use a separate tls read buffer, as we must not receive data while |
876 | # we need to use a separate tls read buffer, as we must not receive data while |
| 876 | # we are draining the buffer, and this can only happen with TLS. |
877 | # we are draining the buffer, and this can only happen with TLS. |
| … | |
… | |
| 880 | |
881 | |
| 881 | if (my $cb = shift @{ $self->{_queue} }) { |
882 | if (my $cb = shift @{ $self->{_queue} }) { |
| 882 | unless ($cb->($self)) { |
883 | unless ($cb->($self)) { |
| 883 | if ($self->{_eof}) { |
884 | if ($self->{_eof}) { |
| 884 | # no progress can be made (not enough data and no data forthcoming) |
885 | # no progress can be made (not enough data and no data forthcoming) |
| 885 | $self->_error (&Errno::EPIPE, 1), return; |
886 | $self->_error (Errno::EPIPE, 1), return; |
| 886 | } |
887 | } |
| 887 | |
888 | |
| 888 | unshift @{ $self->{_queue} }, $cb; |
889 | unshift @{ $self->{_queue} }, $cb; |
| 889 | last; |
890 | last; |
| 890 | } |
891 | } |
| … | |
… | |
| 898 | && !@{ $self->{_queue} } # and the queue is still empty |
899 | && !@{ $self->{_queue} } # and the queue is still empty |
| 899 | && $self->{on_read} # but we still have on_read |
900 | && $self->{on_read} # but we still have on_read |
| 900 | ) { |
901 | ) { |
| 901 | # no further data will arrive |
902 | # no further data will arrive |
| 902 | # so no progress can be made |
903 | # so no progress can be made |
| 903 | $self->_error (&Errno::EPIPE, 1), return |
904 | $self->_error (Errno::EPIPE, 1), return |
| 904 | if $self->{_eof}; |
905 | if $self->{_eof}; |
| 905 | |
906 | |
| 906 | last; # more data might arrive |
907 | last; # more data might arrive |
| 907 | } |
908 | } |
| 908 | } else { |
909 | } else { |
| … | |
… | |
| 1158 | return 1; |
1159 | return 1; |
| 1159 | } |
1160 | } |
| 1160 | |
1161 | |
| 1161 | # reject |
1162 | # reject |
| 1162 | if ($reject && $$rbuf =~ $reject) { |
1163 | if ($reject && $$rbuf =~ $reject) { |
| 1163 | $self->_error (&Errno::EBADMSG); |
1164 | $self->_error (Errno::EBADMSG); |
| 1164 | } |
1165 | } |
| 1165 | |
1166 | |
| 1166 | # skip |
1167 | # skip |
| 1167 | if ($skip && $$rbuf =~ $skip) { |
1168 | if ($skip && $$rbuf =~ $skip) { |
| 1168 | $data .= substr $$rbuf, 0, $+[0], ""; |
1169 | $data .= substr $$rbuf, 0, $+[0], ""; |
| … | |
… | |
| 1184 | my ($self, $cb) = @_; |
1185 | my ($self, $cb) = @_; |
| 1185 | |
1186 | |
| 1186 | sub { |
1187 | sub { |
| 1187 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1188 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
| 1188 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1189 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
| 1189 | $self->_error (&Errno::EBADMSG); |
1190 | $self->_error (Errno::EBADMSG); |
| 1190 | } |
1191 | } |
| 1191 | return; |
1192 | return; |
| 1192 | } |
1193 | } |
| 1193 | |
1194 | |
| 1194 | my $len = $1; |
1195 | my $len = $1; |
| … | |
… | |
| 1197 | my $string = $_[1]; |
1198 | my $string = $_[1]; |
| 1198 | $_[0]->unshift_read (chunk => 1, sub { |
1199 | $_[0]->unshift_read (chunk => 1, sub { |
| 1199 | if ($_[1] eq ",") { |
1200 | if ($_[1] eq ",") { |
| 1200 | $cb->($_[0], $string); |
1201 | $cb->($_[0], $string); |
| 1201 | } else { |
1202 | } else { |
| 1202 | $self->_error (&Errno::EBADMSG); |
1203 | $self->_error (Errno::EBADMSG); |
| 1203 | } |
1204 | } |
| 1204 | }); |
1205 | }); |
| 1205 | }); |
1206 | }); |
| 1206 | |
1207 | |
| 1207 | 1 |
1208 | 1 |
| … | |
… | |
| 1297 | $json->incr_skip; |
1298 | $json->incr_skip; |
| 1298 | |
1299 | |
| 1299 | $self->{rbuf} = $json->incr_text; |
1300 | $self->{rbuf} = $json->incr_text; |
| 1300 | $json->incr_text = ""; |
1301 | $json->incr_text = ""; |
| 1301 | |
1302 | |
| 1302 | $self->_error (&Errno::EBADMSG); |
1303 | $self->_error (Errno::EBADMSG); |
| 1303 | |
1304 | |
| 1304 | () |
1305 | () |
| 1305 | } else { |
1306 | } else { |
| 1306 | $self->{rbuf} = ""; |
1307 | $self->{rbuf} = ""; |
| 1307 | |
1308 | |
| … | |
… | |
| 1344 | # read remaining chunk |
1345 | # read remaining chunk |
| 1345 | $_[0]->unshift_read (chunk => $len, sub { |
1346 | $_[0]->unshift_read (chunk => $len, sub { |
| 1346 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1347 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
| 1347 | $cb->($_[0], $ref); |
1348 | $cb->($_[0], $ref); |
| 1348 | } else { |
1349 | } else { |
| 1349 | $self->_error (&Errno::EBADMSG); |
1350 | $self->_error (Errno::EBADMSG); |
| 1350 | } |
1351 | } |
| 1351 | }); |
1352 | }); |
| 1352 | } |
1353 | } |
| 1353 | |
1354 | |
| 1354 | 1 |
1355 | 1 |
| … | |
… | |
| 1452 | if ($self->{_on_starttls}) { |
1453 | if ($self->{_on_starttls}) { |
| 1453 | (delete $self->{_on_starttls})->($self, undef, $err); |
1454 | (delete $self->{_on_starttls})->($self, undef, $err); |
| 1454 | &_freetls; |
1455 | &_freetls; |
| 1455 | } else { |
1456 | } else { |
| 1456 | &_freetls; |
1457 | &_freetls; |
| 1457 | $self->_error (&Errno::EPROTO, 1, $err); |
1458 | $self->_error (Errno::EPROTO, 1, $err); |
| 1458 | } |
1459 | } |
| 1459 | } |
1460 | } |
| 1460 | |
1461 | |
| 1461 | # poll the write BIO and send the data if applicable |
1462 | # poll the write BIO and send the data if applicable |
| 1462 | # also decode read data if possible |
1463 | # also decode read data if possible |
| … | |
… | |
| 1671 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1672 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
| 1672 | callback, so when you want to destroy the AnyEvent::Handle object from |
1673 | callback, so when you want to destroy the AnyEvent::Handle object from |
| 1673 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
1674 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
| 1674 | that case. |
1675 | that case. |
| 1675 | |
1676 | |
|
|
1677 | Destroying the handle object in this way has the advantage that callbacks |
|
|
1678 | will be removed as well, so if those are the only reference holders (as |
|
|
1679 | is common), then one doesn't need to do anything special to break any |
|
|
1680 | reference cycles. |
|
|
1681 | |
| 1676 | The handle might still linger in the background and write out remaining |
1682 | The handle might still linger in the background and write out remaining |
| 1677 | data, as specified by the C<linger> option, however. |
1683 | data, as specified by the C<linger> option, however. |
| 1678 | |
1684 | |
| 1679 | =cut |
1685 | =cut |
| 1680 | |
1686 | |
| … | |
… | |
| 1747 | |
1753 | |
| 1748 | $handle->on_read (sub { }); |
1754 | $handle->on_read (sub { }); |
| 1749 | $handle->on_eof (undef); |
1755 | $handle->on_eof (undef); |
| 1750 | $handle->on_error (sub { |
1756 | $handle->on_error (sub { |
| 1751 | my $data = delete $_[0]{rbuf}; |
1757 | my $data = delete $_[0]{rbuf}; |
| 1752 | undef $handle; |
|
|
| 1753 | }); |
1758 | }); |
| 1754 | |
1759 | |
| 1755 | The reason to use C<on_error> is that TCP connections, due to latencies |
1760 | The reason to use C<on_error> is that TCP connections, due to latencies |
| 1756 | and packets loss, might get closed quite violently with an error, when in |
1761 | and packets loss, might get closed quite violently with an error, when in |
| 1757 | fact, all data has been received. |
1762 | fact, all data has been received. |
