… | |
… | |
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 I<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. |
87 | |
92 | |
88 | If an EOF condition has been detected but no C<on_eof> callback has been |
93 | If an EOF condition has been detected but no C<on_eof> callback has been |
… | |
… | |
93 | 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 |
94 | 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 |
95 | connect or a read error. |
100 | connect or a read error. |
96 | |
101 | |
97 | 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 |
98 | 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 | |
99 | 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 |
100 | recommended to simply ignore this parameter and instead abondon the handle |
109 | to simply ignore this parameter and instead abondon the handle object |
101 | 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>). |
102 | |
112 | |
103 | On callback entrance, the value of C<$!> contains the operating system |
113 | On callback entrance, the value of C<$!> contains the operating system |
104 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
114 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
105 | |
115 | |
106 | 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 |
… | |
… | |
291 | delete $self->{_rw}; |
301 | delete $self->{_rw}; |
292 | delete $self->{_ww}; |
302 | delete $self->{_ww}; |
293 | delete $self->{fh}; |
303 | delete $self->{fh}; |
294 | |
304 | |
295 | $self->stoptls; |
305 | $self->stoptls; |
|
|
306 | |
|
|
307 | delete $self->{on_read}; |
|
|
308 | delete $self->{_queue}; |
296 | } |
309 | } |
297 | |
310 | |
298 | sub _error { |
311 | sub _error { |
299 | my ($self, $errno, $fatal) = @_; |
312 | my ($self, $errno, $fatal) = @_; |
300 | |
313 | |
… | |
… | |
729 | |
742 | |
730 | if ( |
743 | if ( |
731 | defined $self->{rbuf_max} |
744 | defined $self->{rbuf_max} |
732 | && $self->{rbuf_max} < length $self->{rbuf} |
745 | && $self->{rbuf_max} < length $self->{rbuf} |
733 | ) { |
746 | ) { |
734 | return $self->_error (&Errno::ENOSPC, 1); |
747 | $self->_error (&Errno::ENOSPC, 1), return; |
735 | } |
748 | } |
736 | |
749 | |
737 | while () { |
750 | while () { |
738 | my $len = length $self->{rbuf}; |
751 | my $len = length $self->{rbuf}; |
739 | |
752 | |
740 | if (my $cb = shift @{ $self->{_queue} }) { |
753 | if (my $cb = shift @{ $self->{_queue} }) { |
741 | unless ($cb->($self)) { |
754 | unless ($cb->($self)) { |
742 | if ($self->{_eof}) { |
755 | if ($self->{_eof}) { |
743 | # 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) |
744 | $self->_error (&Errno::EPIPE, 1), last; |
757 | $self->_error (&Errno::EPIPE, 1), return; |
745 | } |
758 | } |
746 | |
759 | |
747 | unshift @{ $self->{_queue} }, $cb; |
760 | unshift @{ $self->{_queue} }, $cb; |
748 | last; |
761 | last; |
749 | } |
762 | } |
… | |
… | |
757 | && !@{ $self->{_queue} } # and the queue is still empty |
770 | && !@{ $self->{_queue} } # and the queue is still empty |
758 | && $self->{on_read} # but we still have on_read |
771 | && $self->{on_read} # but we still have on_read |
759 | ) { |
772 | ) { |
760 | # no further data will arrive |
773 | # no further data will arrive |
761 | # so no progress can be made |
774 | # so no progress can be made |
762 | $self->_error (&Errno::EPIPE, 1), last |
775 | $self->_error (&Errno::EPIPE, 1), return |
763 | if $self->{_eof}; |
776 | if $self->{_eof}; |
764 | |
777 | |
765 | last; # more data might arrive |
778 | last; # more data might arrive |
766 | } |
779 | } |
767 | } else { |
780 | } else { |