… | |
… | |
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 = '0.04'; |
19 | our $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; |
… | |
… | |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
76 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
77 | |
77 | |
78 | =item on_eof => $cb->($handle) |
78 | =item on_eof => $cb->($handle) |
79 | |
79 | |
80 | Set the callback to be called on EOF. |
80 | Set the callback to be called when an end-of-file condition is detcted, |
|
|
81 | i.e. in the case of a socket, when the other side has closed the |
|
|
82 | connection cleanly. |
81 | |
83 | |
82 | While not mandatory, it is highly recommended to set an eof callback, |
84 | While not mandatory, it is highly recommended to set an eof callback, |
83 | otherwise you might end up with a closed socket while you are still |
85 | otherwise you might end up with a closed socket while you are still |
84 | waiting for data. |
86 | waiting for data. |
85 | |
87 | |
86 | =item on_error => $cb->($handle) |
88 | =item on_error => $cb->($handle, $fatal) |
87 | |
89 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
90 | This is the error callback, which is called when, well, some error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
91 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
92 | connect or a read error. |
91 | |
93 | |
92 | The object will not be in a usable state when this callback has been |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
95 | fatal errors the handle object will be shut down and will not be |
|
|
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
|
|
97 | recommended to simply ignore this parameter and instead abondon the handle |
|
|
98 | object when this callback is invoked. |
94 | |
99 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
100 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
102 | |
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
|
|
100 | |
|
|
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
102 | you will not be notified of errors otherwise. The default simply calls |
104 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
105 | C<croak>. |
104 | |
106 | |
105 | =item on_read => $cb->($handle) |
107 | =item on_read => $cb->($handle) |
106 | |
108 | |
107 | This sets the default read callback, which is called when data arrives |
109 | This sets the default read callback, which is called when data arrives |
108 | and no read request is in the queue. |
110 | and no read request is in the queue. |
… | |
… | |
155 | isn't finished). |
157 | isn't finished). |
156 | |
158 | |
157 | =item read_size => <bytes> |
159 | =item read_size => <bytes> |
158 | |
160 | |
159 | The default read block size (the amount of bytes this module will try to read |
161 | The default read block size (the amount of bytes this module will try to read |
160 | on each [loop iteration). Default: C<4096>. |
162 | during each (loop iteration). Default: C<8192>. |
161 | |
163 | |
162 | =item low_water_mark => <bytes> |
164 | =item low_water_mark => <bytes> |
163 | |
165 | |
164 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
166 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
165 | buffer: If the write reaches this size or gets even samller it is |
167 | buffer: If the write reaches this size or gets even samller it is |
… | |
… | |
238 | } |
240 | } |
239 | |
241 | |
240 | sub _shutdown { |
242 | sub _shutdown { |
241 | my ($self) = @_; |
243 | my ($self) = @_; |
242 | |
244 | |
|
|
245 | delete $self->{_tw}; |
243 | delete $self->{_rw}; |
246 | delete $self->{_rw}; |
244 | delete $self->{_ww}; |
247 | delete $self->{_ww}; |
245 | delete $self->{fh}; |
248 | delete $self->{fh}; |
246 | } |
|
|
247 | |
249 | |
|
|
250 | $self->stoptls; |
|
|
251 | } |
|
|
252 | |
248 | sub error { |
253 | sub _error { |
249 | my ($self) = @_; |
254 | my ($self, $errno, $fatal) = @_; |
250 | |
255 | |
251 | { |
|
|
252 | local $!; |
|
|
253 | $self->_shutdown; |
256 | $self->_shutdown |
254 | } |
257 | if $fatal; |
255 | |
258 | |
256 | $self->{on_error}($self) |
259 | $! = $errno; |
|
|
260 | |
257 | if $self->{on_error}; |
261 | if ($self->{on_error}) { |
258 | |
262 | $self->{on_error}($self, $fatal); |
|
|
263 | } else { |
259 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
264 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
|
|
265 | } |
260 | } |
266 | } |
261 | |
267 | |
262 | =item $fh = $handle->fh |
268 | =item $fh = $handle->fh |
263 | |
269 | |
264 | This method returns the file handle of the L<AnyEvent::Handle> object. |
270 | This method returns the file handle of the L<AnyEvent::Handle> object. |
… | |
… | |
328 | # now or in the past already? |
334 | # now or in the past already? |
329 | if ($after <= 0) { |
335 | if ($after <= 0) { |
330 | $self->{_activity} = $NOW; |
336 | $self->{_activity} = $NOW; |
331 | |
337 | |
332 | if ($self->{on_timeout}) { |
338 | if ($self->{on_timeout}) { |
333 | $self->{on_timeout}->($self); |
339 | $self->{on_timeout}($self); |
334 | } else { |
340 | } else { |
335 | $! = Errno::ETIMEDOUT; |
341 | $self->_error (&Errno::ETIMEDOUT); |
336 | $self->error; |
|
|
337 | } |
342 | } |
338 | |
343 | |
339 | # callbakx could have changed timeout value, optimise |
344 | # callbakx could have changed timeout value, optimise |
340 | return unless $self->{timeout}; |
345 | return unless $self->{timeout}; |
341 | |
346 | |
… | |
… | |
414 | if $self->{low_water_mark} >= length $self->{wbuf} |
419 | if $self->{low_water_mark} >= length $self->{wbuf} |
415 | && $self->{on_drain}; |
420 | && $self->{on_drain}; |
416 | |
421 | |
417 | delete $self->{_ww} unless length $self->{wbuf}; |
422 | delete $self->{_ww} unless length $self->{wbuf}; |
418 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
423 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
419 | $self->error; |
424 | $self->_error ($!, 1); |
420 | } |
425 | } |
421 | }; |
426 | }; |
422 | |
427 | |
423 | # try to write data immediately |
428 | # try to write data immediately |
424 | $cb->(); |
429 | $cb->(); |
… | |
… | |
444 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
449 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
445 | ->($self, @_); |
450 | ->($self, @_); |
446 | } |
451 | } |
447 | |
452 | |
448 | if ($self->{filter_w}) { |
453 | if ($self->{filter_w}) { |
449 | $self->{filter_w}->($self, \$_[0]); |
454 | $self->{filter_w}($self, \$_[0]); |
450 | } else { |
455 | } else { |
451 | $self->{wbuf} .= $_[0]; |
456 | $self->{wbuf} .= $_[0]; |
452 | $self->_drain_wbuf; |
457 | $self->_drain_wbuf; |
453 | } |
458 | } |
454 | } |
459 | } |
455 | |
460 | |
456 | =item $handle->push_write (type => @args) |
461 | =item $handle->push_write (type => @args) |
457 | |
462 | |
458 | =item $handle->unshift_write (type => @args) |
|
|
459 | |
|
|
460 | Instead of formatting your data yourself, you can also let this module do |
463 | Instead of formatting your data yourself, you can also let this module do |
461 | the job by specifying a type and type-specific arguments. |
464 | the job by specifying a type and type-specific arguments. |
462 | |
465 | |
463 | Predefined types are (if you have ideas for additional types, feel free to |
466 | Predefined types are (if you have ideas for additional types, feel free to |
464 | drop by and tell us): |
467 | drop by and tell us): |
… | |
… | |
467 | |
470 | |
468 | =item netstring => $string |
471 | =item netstring => $string |
469 | |
472 | |
470 | Formats the given value as netstring |
473 | Formats the given value as netstring |
471 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
474 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
472 | |
|
|
473 | =back |
|
|
474 | |
475 | |
475 | =cut |
476 | =cut |
476 | |
477 | |
477 | register_write_type netstring => sub { |
478 | register_write_type netstring => sub { |
478 | my ($self, $string) = @_; |
479 | my ($self, $string) = @_; |
… | |
… | |
519 | |
520 | |
520 | $self->{json} ? $self->{json}->encode ($ref) |
521 | $self->{json} ? $self->{json}->encode ($ref) |
521 | : JSON::encode_json ($ref) |
522 | : JSON::encode_json ($ref) |
522 | }; |
523 | }; |
523 | |
524 | |
|
|
525 | =back |
|
|
526 | |
524 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
527 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
525 | |
528 | |
526 | This function (not method) lets you add your own types to C<push_write>. |
529 | This function (not method) lets you add your own types to C<push_write>. |
527 | Whenever the given C<type> is used, C<push_write> will invoke the code |
530 | Whenever the given C<type> is used, C<push_write> will invoke the code |
528 | reference with the handle object and the remaining arguments. |
531 | reference with the handle object and the remaining arguments. |
… | |
… | |
565 | the specified number of bytes which give an XML datagram. |
568 | the specified number of bytes which give an XML datagram. |
566 | |
569 | |
567 | # in the default state, expect some header bytes |
570 | # in the default state, expect some header bytes |
568 | $handle->on_read (sub { |
571 | $handle->on_read (sub { |
569 | # some data is here, now queue the length-header-read (4 octets) |
572 | # some data is here, now queue the length-header-read (4 octets) |
570 | shift->unshift_read_chunk (4, sub { |
573 | shift->unshift_read (chunk => 4, sub { |
571 | # header arrived, decode |
574 | # header arrived, decode |
572 | my $len = unpack "N", $_[1]; |
575 | my $len = unpack "N", $_[1]; |
573 | |
576 | |
574 | # now read the payload |
577 | # now read the payload |
575 | shift->unshift_read_chunk ($len, sub { |
578 | shift->unshift_read (chunk => $len, sub { |
576 | my $xml = $_[1]; |
579 | my $xml = $_[1]; |
577 | # handle xml |
580 | # handle xml |
578 | }); |
581 | }); |
579 | }); |
582 | }); |
580 | }); |
583 | }); |
… | |
… | |
587 | |
590 | |
588 | # request one |
591 | # request one |
589 | $handle->push_write ("request 1\015\012"); |
592 | $handle->push_write ("request 1\015\012"); |
590 | |
593 | |
591 | # we expect "ERROR" or "OK" as response, so push a line read |
594 | # we expect "ERROR" or "OK" as response, so push a line read |
592 | $handle->push_read_line (sub { |
595 | $handle->push_read (line => sub { |
593 | # if we got an "OK", we have to _prepend_ another line, |
596 | # if we got an "OK", we have to _prepend_ another line, |
594 | # so it will be read before the second request reads its 64 bytes |
597 | # so it will be read before the second request reads its 64 bytes |
595 | # which are already in the queue when this callback is called |
598 | # which are already in the queue when this callback is called |
596 | # we don't do this in case we got an error |
599 | # we don't do this in case we got an error |
597 | if ($_[1] eq "OK") { |
600 | if ($_[1] eq "OK") { |
598 | $_[0]->unshift_read_line (sub { |
601 | $_[0]->unshift_read (line => sub { |
599 | my $response = $_[1]; |
602 | my $response = $_[1]; |
600 | ... |
603 | ... |
601 | }); |
604 | }); |
602 | } |
605 | } |
603 | }); |
606 | }); |
604 | |
607 | |
605 | # request two |
608 | # request two |
606 | $handle->push_write ("request 2\015\012"); |
609 | $handle->push_write ("request 2\015\012"); |
607 | |
610 | |
608 | # simply read 64 bytes, always |
611 | # simply read 64 bytes, always |
609 | $handle->push_read_chunk (64, sub { |
612 | $handle->push_read (chunk => 64, sub { |
610 | my $response = $_[1]; |
613 | my $response = $_[1]; |
611 | ... |
614 | ... |
612 | }); |
615 | }); |
613 | |
616 | |
614 | =over 4 |
617 | =over 4 |
… | |
… | |
620 | |
623 | |
621 | if ( |
624 | if ( |
622 | defined $self->{rbuf_max} |
625 | defined $self->{rbuf_max} |
623 | && $self->{rbuf_max} < length $self->{rbuf} |
626 | && $self->{rbuf_max} < length $self->{rbuf} |
624 | ) { |
627 | ) { |
625 | $! = &Errno::ENOSPC; |
628 | return $self->_error (&Errno::ENOSPC, 1); |
626 | $self->error; |
|
|
627 | } |
629 | } |
628 | |
630 | |
629 | return if $self->{in_drain}; |
631 | return if $self->{in_drain}; |
630 | local $self->{in_drain} = 1; |
632 | local $self->{in_drain} = 1; |
631 | |
633 | |
… | |
… | |
633 | no strict 'refs'; |
635 | no strict 'refs'; |
634 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | if (my $cb = shift @{ $self->{_queue} }) { |
635 | unless ($cb->($self)) { |
637 | unless ($cb->($self)) { |
636 | if ($self->{_eof}) { |
638 | if ($self->{_eof}) { |
637 | # no progress can be made (not enough data and no data forthcoming) |
639 | # no progress can be made (not enough data and no data forthcoming) |
638 | $! = &Errno::EPIPE; |
640 | return $self->_error (&Errno::EPIPE, 1); |
639 | $self->error; |
|
|
640 | } |
641 | } |
641 | |
642 | |
642 | unshift @{ $self->{_queue} }, $cb; |
643 | unshift @{ $self->{_queue} }, $cb; |
643 | return; |
644 | return; |
644 | } |
645 | } |
… | |
… | |
650 | && $len == length $self->{rbuf} # and no data has been consumed |
651 | && $len == length $self->{rbuf} # and no data has been consumed |
651 | && !@{ $self->{_queue} } # and the queue is still empty |
652 | && !@{ $self->{_queue} } # and the queue is still empty |
652 | && $self->{on_read} # and we still want to read data |
653 | && $self->{on_read} # and we still want to read data |
653 | ) { |
654 | ) { |
654 | # then no progress can be made |
655 | # then no progress can be made |
655 | $! = &Errno::EPIPE; |
656 | return $self->_error (&Errno::EPIPE, 1); |
656 | $self->error; |
|
|
657 | } |
657 | } |
658 | } else { |
658 | } else { |
659 | # read side becomes idle |
659 | # read side becomes idle |
660 | delete $self->{_rw}; |
660 | delete $self->{_rw}; |
661 | return; |
661 | return; |
662 | } |
662 | } |
663 | } |
663 | } |
664 | |
664 | |
665 | if ($self->{_eof}) { |
|
|
666 | $self->_shutdown; |
|
|
667 | $self->{on_eof}($self) |
665 | $self->{on_eof}($self) |
668 | if $self->{on_eof}; |
666 | if $self->{_eof} && $self->{on_eof}; |
669 | } |
|
|
670 | } |
667 | } |
671 | |
668 | |
672 | =item $handle->on_read ($cb) |
669 | =item $handle->on_read ($cb) |
673 | |
670 | |
674 | This replaces the currently set C<on_read> callback, or clears it (when |
671 | This replaces the currently set C<on_read> callback, or clears it (when |
… | |
… | |
863 | my ($self, $cb) = @_; |
860 | my ($self, $cb) = @_; |
864 | |
861 | |
865 | sub { |
862 | sub { |
866 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
863 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
867 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
864 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
868 | $! = &Errno::EBADMSG; |
865 | $self->_error (&Errno::EBADMSG); |
869 | $self->error; |
|
|
870 | } |
866 | } |
871 | return; |
867 | return; |
872 | } |
868 | } |
873 | |
869 | |
874 | my $len = $1; |
870 | my $len = $1; |
… | |
… | |
877 | my $string = $_[1]; |
873 | my $string = $_[1]; |
878 | $_[0]->unshift_read (chunk => 1, sub { |
874 | $_[0]->unshift_read (chunk => 1, sub { |
879 | if ($_[1] eq ",") { |
875 | if ($_[1] eq ",") { |
880 | $cb->($_[0], $string); |
876 | $cb->($_[0], $string); |
881 | } else { |
877 | } else { |
882 | $! = &Errno::EBADMSG; |
878 | $self->_error (&Errno::EBADMSG); |
883 | $self->error; |
|
|
884 | } |
879 | } |
885 | }); |
880 | }); |
886 | }); |
881 | }); |
887 | |
882 | |
888 | 1 |
883 | 1 |
… | |
… | |
945 | return 1; |
940 | return 1; |
946 | } |
941 | } |
947 | |
942 | |
948 | # reject |
943 | # reject |
949 | if ($reject && $$rbuf =~ $reject) { |
944 | if ($reject && $$rbuf =~ $reject) { |
950 | $! = &Errno::EBADMSG; |
945 | $self->_error (&Errno::EBADMSG); |
951 | $self->error; |
|
|
952 | } |
946 | } |
953 | |
947 | |
954 | # skip |
948 | # skip |
955 | if ($skip && $$rbuf =~ $skip) { |
949 | if ($skip && $$rbuf =~ $skip) { |
956 | $data .= substr $$rbuf, 0, $+[0], ""; |
950 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1055 | |
1049 | |
1056 | if ($len > 0) { |
1050 | if ($len > 0) { |
1057 | $self->{_activity} = AnyEvent->now; |
1051 | $self->{_activity} = AnyEvent->now; |
1058 | |
1052 | |
1059 | $self->{filter_r} |
1053 | $self->{filter_r} |
1060 | ? $self->{filter_r}->($self, $rbuf) |
1054 | ? $self->{filter_r}($self, $rbuf) |
1061 | : $self->_drain_rbuf; |
1055 | : $self->_drain_rbuf; |
1062 | |
1056 | |
1063 | } elsif (defined $len) { |
1057 | } elsif (defined $len) { |
1064 | delete $self->{_rw}; |
1058 | delete $self->{_rw}; |
1065 | delete $self->{_ww}; |
|
|
1066 | delete $self->{_tw}; |
|
|
1067 | $self->{_eof} = 1; |
1059 | $self->{_eof} = 1; |
1068 | $self->_drain_rbuf; |
1060 | $self->_drain_rbuf; |
1069 | |
1061 | |
1070 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1062 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1071 | return $self->error; |
1063 | return $self->_error ($!, 1); |
1072 | } |
1064 | } |
1073 | }); |
1065 | }); |
1074 | } |
1066 | } |
1075 | } |
1067 | } |
1076 | |
1068 | |
… | |
… | |
1095 | |
1087 | |
1096 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1088 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1097 | |
1089 | |
1098 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1090 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1099 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1091 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1100 | $self->error; |
1092 | return $self->_error ($!, 1); |
1101 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1093 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1102 | $! = &Errno::EIO; |
1094 | return $self->_error (&Errno::EIO, 1); |
1103 | $self->error; |
|
|
1104 | } |
1095 | } |
1105 | |
1096 | |
1106 | # all others are fine for our purposes |
1097 | # all others are fine for our purposes |
1107 | } |
1098 | } |
1108 | } |
1099 | } |
… | |
… | |
1123 | call and can be used or changed to your liking. Note that the handshake |
1114 | call and can be used or changed to your liking. Note that the handshake |
1124 | might have already started when this function returns. |
1115 | might have already started when this function returns. |
1125 | |
1116 | |
1126 | =cut |
1117 | =cut |
1127 | |
1118 | |
1128 | # TODO: maybe document... |
|
|
1129 | sub starttls { |
1119 | sub starttls { |
1130 | my ($self, $ssl, $ctx) = @_; |
1120 | my ($self, $ssl, $ctx) = @_; |
1131 | |
1121 | |
1132 | $self->stoptls; |
1122 | $self->stoptls; |
1133 | |
1123 | |