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.51 by root, Sat May 31 13:38:01 2008 UTC vs.
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 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.1; 19our $VERSION = 4.12;
20 20
21=head1 SYNOPSIS 21=head1 SYNOPSIS
22 22
23 use AnyEvent; 23 use AnyEvent;
24 use AnyEvent::Handle; 24 use AnyEvent::Handle;
… …
75NOTE: The filehandle will be set to non-blocking (using 75NOTE: The filehandle will be set to non-blocking (using
76AnyEvent::Util::fh_nonblocking). 76AnyEvent::Util::fh_nonblocking).
77 77
78=item on_eof => $cb->($handle) 78=item on_eof => $cb->($handle)
79 79
80Set the callback to be called on EOF. 80Set the callback to be called when an end-of-file condition is detcted,
81i.e. in the case of a socket, when the other side has closed the
82connection cleanly.
81 83
82While not mandatory, it is highly recommended to set an eof callback, 84While not mandatory, it is highly recommended to set an eof callback,
83otherwise you might end up with a closed socket while you are still 85otherwise you might end up with a closed socket while you are still
84waiting for data. 86waiting for data.
85 87
86=item on_error => $cb->($handle) 88=item on_error => $cb->($handle, $fatal)
87 89
88This is the fatal error callback, that is called when, well, a fatal error 90This is the error callback, which is called when, well, some error
89occurs, such as not being able to resolve the hostname, failure to connect 91occured, such as not being able to resolve the hostname, failure to
90or a read error. 92connect or a read error.
91 93
92The object will not be in a usable state when this callback has been 94Some errors are fatal (which is indicated by C<$fatal> being true). On
93called. 95fatal errors the handle object will be shut down and will not be
96usable. Non-fatal errors can be retried by simply returning, but it is
97recommended to simply ignore this parameter and instead abondon the handle
98object when this callback is invoked.
94 99
95On callback entrance, the value of C<$!> contains the operating system 100On callback entrance, the value of C<$!> contains the operating system
96error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 101error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97 102
98The callback should throw an exception. If it returns, then
99AnyEvent::Handle will C<croak> for you.
100
101While not mandatory, it is I<highly> recommended to set this callback, as 103While not mandatory, it is I<highly> recommended to set this callback, as
102you will not be notified of errors otherwise. The default simply calls 104you will not be notified of errors otherwise. The default simply calls
103die. 105C<croak>.
104 106
105=item on_read => $cb->($handle) 107=item on_read => $cb->($handle)
106 108
107This sets the default read callback, which is called when data arrives 109This sets the default read callback, which is called when data arrives
108and no read request is in the queue. 110and no read request is in the queue.
… …
242 244
243 delete $self->{_tw}; 245 delete $self->{_tw};
244 delete $self->{_rw}; 246 delete $self->{_rw};
245 delete $self->{_ww}; 247 delete $self->{_ww};
246 delete $self->{fh}; 248 delete $self->{fh};
247}
248 249
250 $self->stoptls;
251}
252
249sub error { 253sub _error {
250 my ($self) = @_; 254 my ($self, $errno, $fatal) = @_;
251 255
252 {
253 local $!;
254 $self->_shutdown; 256 $self->_shutdown
255 } 257 if $fatal;
256 258
257 $self->{on_error}($self) 259 $! = $errno;
260
258 if $self->{on_error}; 261 if ($self->{on_error}) {
259 262 $self->{on_error}($self, $fatal);
263 } else {
260 Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; 264 Carp::croak "AnyEvent::Handle uncaught error: $!";
265 }
261} 266}
262 267
263=item $fh = $handle->fh 268=item $fh = $handle->fh
264 269
265This method returns the file handle of the L<AnyEvent::Handle> object. 270This method returns the file handle of the L<AnyEvent::Handle> object.
… …
331 $self->{_activity} = $NOW; 336 $self->{_activity} = $NOW;
332 337
333 if ($self->{on_timeout}) { 338 if ($self->{on_timeout}) {
334 $self->{on_timeout}($self); 339 $self->{on_timeout}($self);
335 } else { 340 } else {
336 $! = Errno::ETIMEDOUT; 341 $self->_error (&Errno::ETIMEDOUT);
337 $self->error;
338 } 342 }
339 343
340 # callbakx could have changed timeout value, optimise 344 # callback could have changed timeout value, optimise
341 return unless $self->{timeout}; 345 return unless $self->{timeout};
342 346
343 # calculate new after 347 # calculate new after
344 $after = $self->{timeout}; 348 $after = $self->{timeout};
345 } 349 }
346 350
347 Scalar::Util::weaken $self; 351 Scalar::Util::weaken $self;
352 return unless $self; # ->error could have destroyed $self
348 353
349 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { 354 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
350 delete $self->{_tw}; 355 delete $self->{_tw};
351 $self->_timeout; 356 $self->_timeout;
352 }); 357 });
… …
415 if $self->{low_water_mark} >= length $self->{wbuf} 420 if $self->{low_water_mark} >= length $self->{wbuf}
416 && $self->{on_drain}; 421 && $self->{on_drain};
417 422
418 delete $self->{_ww} unless length $self->{wbuf}; 423 delete $self->{_ww} unless length $self->{wbuf};
419 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 424 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420 $self->error; 425 $self->_error ($!, 1);
421 } 426 }
422 }; 427 };
423 428
424 # try to write data immediately 429 # try to write data immediately
425 $cb->(); 430 $cb->();
… …
454 } 459 }
455} 460}
456 461
457=item $handle->push_write (type => @args) 462=item $handle->push_write (type => @args)
458 463
459=item $handle->unshift_write (type => @args)
460
461Instead of formatting your data yourself, you can also let this module do 464Instead of formatting your data yourself, you can also let this module do
462the job by specifying a type and type-specific arguments. 465the job by specifying a type and type-specific arguments.
463 466
464Predefined types are (if you have ideas for additional types, feel free to 467Predefined types are (if you have ideas for additional types, feel free to
465drop by and tell us): 468drop by and tell us):
… …
468 471
469=item netstring => $string 472=item netstring => $string
470 473
471Formats the given value as netstring 474Formats the given value as netstring
472(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). 475(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473
474=back
475 476
476=cut 477=cut
477 478
478register_write_type netstring => sub { 479register_write_type netstring => sub {
479 my ($self, $string) = @_; 480 my ($self, $string) = @_;
… …
520 521
521 $self->{json} ? $self->{json}->encode ($ref) 522 $self->{json} ? $self->{json}->encode ($ref)
522 : JSON::encode_json ($ref) 523 : JSON::encode_json ($ref)
523}; 524};
524 525
526=back
527
525=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 528=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526 529
527This function (not method) lets you add your own types to C<push_write>. 530This function (not method) lets you add your own types to C<push_write>.
528Whenever the given C<type> is used, C<push_write> will invoke the code 531Whenever the given C<type> is used, C<push_write> will invoke the code
529reference with the handle object and the remaining arguments. 532reference with the handle object and the remaining arguments.
… …
566the specified number of bytes which give an XML datagram. 569the specified number of bytes which give an XML datagram.
567 570
568 # in the default state, expect some header bytes 571 # in the default state, expect some header bytes
569 $handle->on_read (sub { 572 $handle->on_read (sub {
570 # some data is here, now queue the length-header-read (4 octets) 573 # some data is here, now queue the length-header-read (4 octets)
571 shift->unshift_read_chunk (4, sub { 574 shift->unshift_read (chunk => 4, sub {
572 # header arrived, decode 575 # header arrived, decode
573 my $len = unpack "N", $_[1]; 576 my $len = unpack "N", $_[1];
574 577
575 # now read the payload 578 # now read the payload
576 shift->unshift_read_chunk ($len, sub { 579 shift->unshift_read (chunk => $len, sub {
577 my $xml = $_[1]; 580 my $xml = $_[1];
578 # handle xml 581 # handle xml
579 }); 582 });
580 }); 583 });
581 }); 584 });
… …
588 591
589 # request one 592 # request one
590 $handle->push_write ("request 1\015\012"); 593 $handle->push_write ("request 1\015\012");
591 594
592 # we expect "ERROR" or "OK" as response, so push a line read 595 # we expect "ERROR" or "OK" as response, so push a line read
593 $handle->push_read_line (sub { 596 $handle->push_read (line => sub {
594 # if we got an "OK", we have to _prepend_ another line, 597 # if we got an "OK", we have to _prepend_ another line,
595 # so it will be read before the second request reads its 64 bytes 598 # so it will be read before the second request reads its 64 bytes
596 # which are already in the queue when this callback is called 599 # which are already in the queue when this callback is called
597 # we don't do this in case we got an error 600 # we don't do this in case we got an error
598 if ($_[1] eq "OK") { 601 if ($_[1] eq "OK") {
599 $_[0]->unshift_read_line (sub { 602 $_[0]->unshift_read (line => sub {
600 my $response = $_[1]; 603 my $response = $_[1];
601 ... 604 ...
602 }); 605 });
603 } 606 }
604 }); 607 });
605 608
606 # request two 609 # request two
607 $handle->push_write ("request 2\015\012"); 610 $handle->push_write ("request 2\015\012");
608 611
609 # simply read 64 bytes, always 612 # simply read 64 bytes, always
610 $handle->push_read_chunk (64, sub { 613 $handle->push_read (chunk => 64, sub {
611 my $response = $_[1]; 614 my $response = $_[1];
612 ... 615 ...
613 }); 616 });
614 617
615=over 4 618=over 4
… …
621 624
622 if ( 625 if (
623 defined $self->{rbuf_max} 626 defined $self->{rbuf_max}
624 && $self->{rbuf_max} < length $self->{rbuf} 627 && $self->{rbuf_max} < length $self->{rbuf}
625 ) { 628 ) {
626 $! = &Errno::ENOSPC; 629 return $self->_error (&Errno::ENOSPC, 1);
627 $self->error;
628 } 630 }
629 631
630 return if $self->{in_drain}; 632 return if $self->{in_drain};
631 local $self->{in_drain} = 1; 633 local $self->{in_drain} = 1;
632 634
… …
634 no strict 'refs'; 636 no strict 'refs';
635 if (my $cb = shift @{ $self->{_queue} }) { 637 if (my $cb = shift @{ $self->{_queue} }) {
636 unless ($cb->($self)) { 638 unless ($cb->($self)) {
637 if ($self->{_eof}) { 639 if ($self->{_eof}) {
638 # no progress can be made (not enough data and no data forthcoming) 640 # no progress can be made (not enough data and no data forthcoming)
639 $! = &Errno::EPIPE; 641 return $self->_error (&Errno::EPIPE, 1);
640 $self->error;
641 } 642 }
642 643
643 unshift @{ $self->{_queue} }, $cb; 644 unshift @{ $self->{_queue} }, $cb;
644 return; 645 last;
645 } 646 }
646 } elsif ($self->{on_read}) { 647 } elsif ($self->{on_read}) {
647 $self->{on_read}($self); 648 $self->{on_read}($self);
648 649
649 if ( 650 if (
650 $self->{_eof} # if no further data will arrive
651 && $len == length $self->{rbuf} # and no data has been consumed 651 $len == length $self->{rbuf} # if no data has been consumed
652 && !@{ $self->{_queue} } # and the queue is still empty 652 && !@{ $self->{_queue} } # and the queue is still empty
653 && $self->{on_read} # and we still want to read data 653 && $self->{on_read} # but we still have on_read
654 ) { 654 ) {
655 # no further data will arrive
655 # then no progress can be made 656 # so no progress can be made
656 $! = &Errno::EPIPE; 657 return $self->_error (&Errno::EPIPE, 1)
657 $self->error; 658 if $self->{_eof};
659
660 last; # more data might arrive
658 } 661 }
659 } else { 662 } else {
660 # read side becomes idle 663 # read side becomes idle
661 delete $self->{_rw}; 664 delete $self->{_rw};
662 return; 665 last;
663 } 666 }
664 } 667 }
665 668
666 $self->{on_eof}($self) 669 $self->{on_eof}($self)
667 if $self->{_eof} && $self->{on_eof}; 670 if $self->{_eof} && $self->{on_eof};
671
672 # may need to restart read watcher
673 unless ($self->{_rw}) {
674 $self->start_read
675 if $self->{on_read} || @{ $self->{_queue} };
676 }
668} 677}
669 678
670=item $handle->on_read ($cb) 679=item $handle->on_read ($cb)
671 680
672This replaces the currently set C<on_read> callback, or clears it (when 681This replaces the currently set C<on_read> callback, or clears it (when
… …
861 my ($self, $cb) = @_; 870 my ($self, $cb) = @_;
862 871
863 sub { 872 sub {
864 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 873 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
865 if ($_[0]{rbuf} =~ /[^0-9]/) { 874 if ($_[0]{rbuf} =~ /[^0-9]/) {
866 $! = &Errno::EBADMSG; 875 $self->_error (&Errno::EBADMSG);
867 $self->error;
868 } 876 }
869 return; 877 return;
870 } 878 }
871 879
872 my $len = $1; 880 my $len = $1;
… …
875 my $string = $_[1]; 883 my $string = $_[1];
876 $_[0]->unshift_read (chunk => 1, sub { 884 $_[0]->unshift_read (chunk => 1, sub {
877 if ($_[1] eq ",") { 885 if ($_[1] eq ",") {
878 $cb->($_[0], $string); 886 $cb->($_[0], $string);
879 } else { 887 } else {
880 $! = &Errno::EBADMSG; 888 $self->_error (&Errno::EBADMSG);
881 $self->error;
882 } 889 }
883 }); 890 });
884 }); 891 });
885 892
886 1 893 1
… …
943 return 1; 950 return 1;
944 } 951 }
945 952
946 # reject 953 # reject
947 if ($reject && $$rbuf =~ $reject) { 954 if ($reject && $$rbuf =~ $reject) {
948 $! = &Errno::EBADMSG; 955 $self->_error (&Errno::EBADMSG);
949 $self->error;
950 } 956 }
951 957
952 # skip 958 # skip
953 if ($skip && $$rbuf =~ $skip) { 959 if ($skip && $$rbuf =~ $skip) {
954 $data .= substr $$rbuf, 0, $+[0], ""; 960 $data .= substr $$rbuf, 0, $+[0], "";
… …
1031In rare cases you actually do not want to read anything from the 1037In rare cases you actually do not want to read anything from the
1032socket. In this case you can call C<stop_read>. Neither C<on_read> no 1038socket. In this case you can call C<stop_read>. Neither C<on_read> no
1033any queued callbacks will be executed then. To start reading again, call 1039any queued callbacks will be executed then. To start reading again, call
1034C<start_read>. 1040C<start_read>.
1035 1041
1042Note that AnyEvent::Handle will automatically C<start_read> for you when
1043you change the C<on_read> callback or push/unshift a read callback, and it
1044will automatically C<stop_read> for you when neither C<on_read> is set nor
1045there are any read requests in the queue.
1046
1036=cut 1047=cut
1037 1048
1038sub stop_read { 1049sub stop_read {
1039 my ($self) = @_; 1050 my ($self) = @_;
1040 1051
… …
1062 delete $self->{_rw}; 1073 delete $self->{_rw};
1063 $self->{_eof} = 1; 1074 $self->{_eof} = 1;
1064 $self->_drain_rbuf; 1075 $self->_drain_rbuf;
1065 1076
1066 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 1077 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1067 return $self->error; 1078 return $self->_error ($!, 1);
1068 } 1079 }
1069 }); 1080 });
1070 } 1081 }
1071} 1082}
1072 1083
1073sub _dotls { 1084sub _dotls {
1074 my ($self) = @_; 1085 my ($self) = @_;
1086
1087 my $buf;
1075 1088
1076 if (length $self->{_tls_wbuf}) { 1089 if (length $self->{_tls_wbuf}) {
1077 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1090 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1078 substr $self->{_tls_wbuf}, 0, $len, ""; 1091 substr $self->{_tls_wbuf}, 0, $len, "";
1079 } 1092 }
1080 } 1093 }
1081 1094
1082 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1095 if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1083 $self->{wbuf} .= $buf; 1096 $self->{wbuf} .= $buf;
1084 $self->_drain_wbuf; 1097 $self->_drain_wbuf;
1085 } 1098 }
1086 1099
1087 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { 1100 while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1101 if (length $buf) {
1088 $self->{rbuf} .= $buf; 1102 $self->{rbuf} .= $buf;
1089 $self->_drain_rbuf; 1103 $self->_drain_rbuf;
1104 } else {
1105 # let's treat SSL-eof as we treat normal EOF
1106 $self->{_eof} = 1;
1107 $self->_shutdown;
1108 return;
1109 }
1090 } 1110 }
1091 1111
1092 my $err = Net::SSLeay::get_error ($self->{tls}, -1); 1112 my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1093 1113
1094 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { 1114 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1095 if ($err == Net::SSLeay::ERROR_SYSCALL ()) { 1115 if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1096 $self->error; 1116 return $self->_error ($!, 1);
1097 } elsif ($err == Net::SSLeay::ERROR_SSL ()) { 1117 } elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1098 $! = &Errno::EIO; 1118 return $self->_error (&Errno::EIO, 1);
1099 $self->error;
1100 } 1119 }
1101 1120
1102 # all others are fine for our purposes 1121 # all others are fine for our purposes
1103 } 1122 }
1104} 1123}

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines