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.22; |
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; |
… | |
… | |
79 | |
79 | |
80 | Set the callback to be called when an end-of-file condition is detected, |
80 | 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 |
81 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
82 | connection cleanly. |
83 | |
83 | |
|
|
84 | For sockets, this just means that the other side has stopped sending data, |
|
|
85 | you can still try to write data, and, in fact, one can return from the eof |
|
|
86 | callback and continue writing data, as only the read part has been shut |
|
|
87 | down. |
|
|
88 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
89 | 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 |
90 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
91 | waiting for data. |
|
|
92 | |
|
|
93 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
94 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
95 | |
88 | =item on_error => $cb->($handle, $fatal) |
96 | =item on_error => $cb->($handle, $fatal) |
89 | |
97 | |
90 | This is the error callback, which is called when, well, some error |
98 | 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 |
99 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
100 | connect or a read error. |
93 | |
101 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
102 | 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 |
103 | fatal errors the handle object will be shut down and will not be usable |
|
|
104 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
|
|
105 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
106 | (C<EPIPE>) or I/O errors. |
|
|
107 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
108 | 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 |
109 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
110 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
111 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
112 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
113 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
114 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
115 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
116 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
288 | delete $self->{_rw}; |
301 | delete $self->{_rw}; |
289 | delete $self->{_ww}; |
302 | delete $self->{_ww}; |
290 | delete $self->{fh}; |
303 | delete $self->{fh}; |
291 | |
304 | |
292 | $self->stoptls; |
305 | $self->stoptls; |
|
|
306 | |
|
|
307 | delete $self->{on_read}; |
|
|
308 | delete $self->{_queue}; |
293 | } |
309 | } |
294 | |
310 | |
295 | sub _error { |
311 | sub _error { |
296 | my ($self, $errno, $fatal) = @_; |
312 | my ($self, $errno, $fatal) = @_; |
297 | |
313 | |
… | |
… | |
726 | |
742 | |
727 | if ( |
743 | if ( |
728 | defined $self->{rbuf_max} |
744 | defined $self->{rbuf_max} |
729 | && $self->{rbuf_max} < length $self->{rbuf} |
745 | && $self->{rbuf_max} < length $self->{rbuf} |
730 | ) { |
746 | ) { |
731 | return $self->_error (&Errno::ENOSPC, 1); |
747 | $self->_error (&Errno::ENOSPC, 1), return; |
732 | } |
748 | } |
733 | |
749 | |
734 | while () { |
750 | while () { |
735 | no strict 'refs'; |
|
|
736 | |
|
|
737 | my $len = length $self->{rbuf}; |
751 | my $len = length $self->{rbuf}; |
738 | |
752 | |
739 | if (my $cb = shift @{ $self->{_queue} }) { |
753 | if (my $cb = shift @{ $self->{_queue} }) { |
740 | unless ($cb->($self)) { |
754 | unless ($cb->($self)) { |
741 | if ($self->{_eof}) { |
755 | if ($self->{_eof}) { |
742 | # no progress can be made (not enough data and no data forthcoming) |
756 | # no progress can be made (not enough data and no data forthcoming) |
743 | $self->_error (&Errno::EPIPE, 1), last; |
757 | $self->_error (&Errno::EPIPE, 1), return; |
744 | } |
758 | } |
745 | |
759 | |
746 | unshift @{ $self->{_queue} }, $cb; |
760 | unshift @{ $self->{_queue} }, $cb; |
747 | last; |
761 | last; |
748 | } |
762 | } |
… | |
… | |
756 | && !@{ $self->{_queue} } # and the queue is still empty |
770 | && !@{ $self->{_queue} } # and the queue is still empty |
757 | && $self->{on_read} # but we still have on_read |
771 | && $self->{on_read} # but we still have on_read |
758 | ) { |
772 | ) { |
759 | # no further data will arrive |
773 | # no further data will arrive |
760 | # so no progress can be made |
774 | # so no progress can be made |
761 | $self->_error (&Errno::EPIPE, 1), last |
775 | $self->_error (&Errno::EPIPE, 1), return |
762 | if $self->{_eof}; |
776 | if $self->{_eof}; |
763 | |
777 | |
764 | last; # more data might arrive |
778 | last; # more data might arrive |
765 | } |
779 | } |
766 | } else { |
780 | } else { |
… | |
… | |
768 | delete $self->{_rw}; |
782 | delete $self->{_rw}; |
769 | last; |
783 | last; |
770 | } |
784 | } |
771 | } |
785 | } |
772 | |
786 | |
|
|
787 | if ($self->{_eof}) { |
|
|
788 | if ($self->{on_eof}) { |
773 | $self->{on_eof}($self) |
789 | $self->{on_eof}($self) |
774 | if $self->{_eof} && $self->{on_eof}; |
790 | } else { |
|
|
791 | $self->_error (0, 1); |
|
|
792 | } |
|
|
793 | } |
775 | |
794 | |
776 | # may need to restart read watcher |
795 | # may need to restart read watcher |
777 | unless ($self->{_rw}) { |
796 | unless ($self->{_rw}) { |
778 | $self->start_read |
797 | $self->start_read |
779 | if $self->{on_read} || @{ $self->{_queue} }; |
798 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
904 | $len <= length $_[0]{rbuf} or return; |
923 | $len <= length $_[0]{rbuf} or return; |
905 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
924 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
906 | 1 |
925 | 1 |
907 | } |
926 | } |
908 | }; |
927 | }; |
909 | |
|
|
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 | |
928 | |
919 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
929 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
920 | |
930 | |
921 | The callback will be called only once a full line (including the end of |
931 | 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 |
932 | line marker, C<$eol>) has been read. This line (excluding the end of line |
… | |
… | |
958 | $cb->($_[0], $1, $2); |
968 | $cb->($_[0], $1, $2); |
959 | 1 |
969 | 1 |
960 | } |
970 | } |
961 | } |
971 | } |
962 | }; |
972 | }; |
963 | |
|
|
964 | # compatibility with older API |
|
|
965 | sub push_read_line { |
|
|
966 | my $self = shift; |
|
|
967 | $self->push_read (line => @_); |
|
|
968 | } |
|
|
969 | |
|
|
970 | sub unshift_read_line { |
|
|
971 | my $self = shift; |
|
|
972 | $self->unshift_read (line => @_); |
|
|
973 | } |
|
|
974 | |
973 | |
975 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
974 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
976 | |
975 | |
977 | Makes a regex match against the regex object C<$accept> and returns |
976 | Makes a regex match against the regex object C<$accept> and returns |
978 | everything up to and including the match. |
977 | everything up to and including the match. |