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.76 by root, Sun Jul 27 03:28:36 2008 UTC vs.
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC

1package AnyEvent::Handle; 1package AnyEvent::Handle;
2 2
3no warnings; 3no warnings;
4use strict; 4use strict qw(subs vars);
5 5
6use AnyEvent (); 6use AnyEvent ();
7use AnyEvent::Util qw(WSAEWOULDBLOCK); 7use AnyEvent::Util qw(WSAEWOULDBLOCK);
8use Scalar::Util (); 8use Scalar::Util ();
9use Carp (); 9use Carp ();
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.22; 19our $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
80Set the callback to be called when an end-of-file condition is detected, 80Set the callback to be called when an end-of-file condition is detected,
81i.e. in the case of a socket, when the other side has closed the 81i.e. in the case of a socket, when the other side has closed the
82connection cleanly. 82connection cleanly.
83 83
84For sockets, this just means that the other side has stopped sending data,
85you can still try to write data, and, in fact, one can return from the eof
86callback and continue writing data, as only the read part has been shut
87down.
88
84While not mandatory, it is highly recommended to set an eof callback, 89While not mandatory, it is I<highly> recommended to set an eof callback,
85otherwise you might end up with a closed socket while you are still 90otherwise you might end up with a closed socket while you are still
86waiting for data. 91waiting for data.
92
93If an EOF condition has been detected but no C<on_eof> callback has been
94set, 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
90This is the error callback, which is called when, well, some error 98This is the error callback, which is called when, well, some error
91occured, such as not being able to resolve the hostname, failure to 99occured, such as not being able to resolve the hostname, failure to
92connect or a read error. 100connect or a read error.
93 101
94Some errors are fatal (which is indicated by C<$fatal> being true). On 102Some errors are fatal (which is indicated by C<$fatal> being true). On
95fatal errors the handle object will be shut down and will not be 103fatal 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
105errors are an EOF condition with active (but unsatisifable) read watchers
106(C<EPIPE>) or I/O errors.
107
96usable. Non-fatal errors can be retried by simply returning, but it is 108Non-fatal errors can be retried by simply returning, but it is recommended
97recommended to simply ignore this parameter and instead abondon the handle 109to simply ignore this parameter and instead abondon the handle object
98object when this callback is invoked. 110when this callback is invoked. Examples of non-fatal errors are timeouts
111C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99 112
100On callback entrance, the value of C<$!> contains the operating system 113On callback entrance, the value of C<$!> contains the operating system
101error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 114error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102 115
103While not mandatory, it is I<highly> recommended to set this callback, as 116While 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
295sub _error { 311sub _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
911sub push_read_chunk {
912 $_[0]->push_read (chunk => $_[1], $_[2]);
913}
914
915sub 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
921The callback will be called only once a full line (including the end of 931The callback will be called only once a full line (including the end of
922line marker, C<$eol>) has been read. This line (excluding the end of line 932line 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
965sub push_read_line {
966 my $self = shift;
967 $self->push_read (line => @_);
968}
969
970sub 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
977Makes a regex match against the regex object C<$accept> and returns 976Makes a regex match against the regex object C<$accept> and returns
978everything up to and including the match. 977everything up to and including the match.
1102 sub { 1101 sub {
1103 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1102 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1104 defined (my $len = eval { unpack $format, $_[0]{rbuf} }) 1103 defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1105 or return; 1104 or return;
1106 1105
1106 $format = length pack $format, $len;
1107
1108 # bypass unshift if we already have the remaining chunk
1109 if ($format + $len <= length $_[0]{rbuf}) {
1110 my $data = substr $_[0]{rbuf}, $format, $len;
1111 substr $_[0]{rbuf}, 0, $format + $len, "";
1112 $cb->($_[0], $data);
1113 } else {
1107 # remove prefix 1114 # remove prefix
1108 substr $_[0]{rbuf}, 0, (length pack $format, $len), ""; 1115 substr $_[0]{rbuf}, 0, $format, "";
1109 1116
1110 # read rest 1117 # read remaining chunk
1111 $_[0]->unshift_read (chunk => $len, $cb); 1118 $_[0]->unshift_read (chunk => $len, $cb);
1119 }
1112 1120
1113 1 1121 1
1114 } 1122 }
1115}; 1123};
1116 1124
1176 sub { 1184 sub {
1177 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1185 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1178 defined (my $len = eval { unpack "w", $_[0]{rbuf} }) 1186 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1179 or return; 1187 or return;
1180 1188
1189 my $format = length pack "w", $len;
1190
1191 # bypass unshift if we already have the remaining chunk
1192 if ($format + $len <= length $_[0]{rbuf}) {
1193 my $data = substr $_[0]{rbuf}, $format, $len;
1194 substr $_[0]{rbuf}, 0, $format + $len, "";
1195 $cb->($_[0], Storable::thaw ($data));
1196 } else {
1181 # remove prefix 1197 # remove prefix
1182 substr $_[0]{rbuf}, 0, (length pack "w", $len), ""; 1198 substr $_[0]{rbuf}, 0, $format, "";
1183 1199
1184 # read rest 1200 # read remaining chunk
1185 $_[0]->unshift_read (chunk => $len, sub { 1201 $_[0]->unshift_read (chunk => $len, sub {
1186 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1202 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1187 $cb->($_[0], $ref); 1203 $cb->($_[0], $ref);
1188 } else { 1204 } else {
1189 $self->_error (&Errno::EBADMSG); 1205 $self->_error (&Errno::EBADMSG);
1206 }
1190 } 1207 });
1191 }); 1208 }
1209
1210 1
1192 } 1211 }
1193}; 1212};
1194 1213
1195=back 1214=back
1196 1215

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines