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.30 by root, Sat May 24 23:56:26 2008 UTC vs.
Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC

… …
2 2
3no warnings; 3no warnings;
4use strict; 4use strict;
5 5
6use AnyEvent (); 6use AnyEvent ();
7use AnyEvent::Util (); 7use AnyEvent::Util qw(WSAWOULDBLOCK);
8use Scalar::Util (); 8use Scalar::Util ();
9use Carp (); 9use Carp ();
10use Fcntl (); 10use Fcntl ();
11use Errno qw/EAGAIN EINTR/; 11use Errno qw/EAGAIN EINTR/;
12 12
13=head1 NAME 13=head1 NAME
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
17This module is experimental.
18
19=cut 17=cut
20 18
21our $VERSION = '0.04'; 19our $VERSION = '0.04';
22 20
23=head1 SYNOPSIS 21=head1 SYNOPSIS
… …
25 use AnyEvent; 23 use AnyEvent;
26 use AnyEvent::Handle; 24 use AnyEvent::Handle;
27 25
28 my $cv = AnyEvent->condvar; 26 my $cv = AnyEvent->condvar;
29 27
30 my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); 28 my $handle =
31
32 #TODO
33
34 # or use the constructor to pass the callback:
35
36 my $ae_fh2 =
37 AnyEvent::Handle->new ( 29 AnyEvent::Handle->new (
38 fh => \*STDIN, 30 fh => \*STDIN,
39 on_eof => sub { 31 on_eof => sub {
40 $cv->broadcast; 32 $cv->broadcast;
41 }, 33 },
42 #TODO
43 ); 34 );
44 35
45 $cv->wait; 36 # send some request line
37 $handle->push_write ("getinfo\015\012");
38
39 # read the response line
40 $handle->push_read (line => sub {
41 my ($handle, $line) = @_;
42 warn "read line <$line>\n";
43 $cv->send;
44 });
45
46 $cv->recv;
46 47
47=head1 DESCRIPTION 48=head1 DESCRIPTION
48 49
49This module is a helper module to make it easier to do event-based I/O on 50This module is a helper module to make it easier to do event-based I/O on
50filehandles. For utility functions for doing non-blocking connects and accepts 51filehandles. For utility functions for doing non-blocking connects and accepts
… …
91The object will not be in a usable state when this callback has been 92The object will not be in a usable state when this callback has been
92called. 93called.
93 94
94On callback entrance, the value of C<$!> contains the operating system 95On callback entrance, the value of C<$!> contains the operating system
95error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). 96error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
97
98The callback should throw an exception. If it returns, then
99AnyEvent::Handle will C<croak> for you.
96 100
97While not mandatory, it is I<highly> recommended to set this callback, as 101While not mandatory, it is I<highly> recommended to set this callback, as
98you will not be notified of errors otherwise. The default simply calls 102you will not be notified of errors otherwise. The default simply calls
99die. 103die.
100 104
… …
164 168
165Use the given Net::SSLeay::CTX object to create the new TLS connection 169Use the given Net::SSLeay::CTX object to create the new TLS connection
166(unless a connection object was specified directly). If this parameter is 170(unless a connection object was specified directly). If this parameter is
167missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 171missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168 172
173=item filter_r => $cb
174
175=item filter_w => $cb
176
177These exist, but are undocumented at this time.
178
169=back 179=back
170 180
171=cut 181=cut
172 182
173sub new { 183sub new {
… …
195} 205}
196 206
197sub _shutdown { 207sub _shutdown {
198 my ($self) = @_; 208 my ($self) = @_;
199 209
200 delete $self->{rw}; 210 delete $self->{_rw};
201 delete $self->{ww}; 211 delete $self->{_ww};
202 delete $self->{fh}; 212 delete $self->{fh};
203} 213}
204 214
205sub error { 215sub error {
206 my ($self) = @_; 216 my ($self) = @_;
… …
208 { 218 {
209 local $!; 219 local $!;
210 $self->_shutdown; 220 $self->_shutdown;
211 } 221 }
212 222
213 if ($self->{on_error}) {
214 $self->{on_error}($self); 223 $self->{on_error}($self)
215 } else { 224 if $self->{on_error};
225
216 Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; 226 Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
217 }
218} 227}
219 228
220=item $fh = $handle->fh 229=item $fh = $handle->fh
221 230
222This method returns the file handle of the L<AnyEvent::Handle> object. 231This method returns the file handle of the L<AnyEvent::Handle> object.
223 232
224=cut 233=cut
225 234
226sub fh { $_[0]->{fh} } 235sub fh { $_[0]{fh} }
227 236
228=item $handle->on_error ($cb) 237=item $handle->on_error ($cb)
229 238
230Replace the current C<on_error> callback (see the C<on_error> constructor argument). 239Replace the current C<on_error> callback (see the C<on_error> constructor argument).
231 240
… …
287=cut 296=cut
288 297
289sub _drain_wbuf { 298sub _drain_wbuf {
290 my ($self) = @_; 299 my ($self) = @_;
291 300
292 if (!$self->{ww} && length $self->{wbuf}) { 301 if (!$self->{_ww} && length $self->{wbuf}) {
302
293 Scalar::Util::weaken $self; 303 Scalar::Util::weaken $self;
304
294 my $cb = sub { 305 my $cb = sub {
295 my $len = syswrite $self->{fh}, $self->{wbuf}; 306 my $len = syswrite $self->{fh}, $self->{wbuf};
296 307
297 if ($len >= 0) { 308 if ($len >= 0) {
298 substr $self->{wbuf}, 0, $len, ""; 309 substr $self->{wbuf}, 0, $len, "";
299 310
300 $self->{on_drain}($self) 311 $self->{on_drain}($self)
301 if $self->{low_water_mark} >= length $self->{wbuf} 312 if $self->{low_water_mark} >= length $self->{wbuf}
302 && $self->{on_drain}; 313 && $self->{on_drain};
303 314
304 delete $self->{ww} unless length $self->{wbuf}; 315 delete $self->{_ww} unless length $self->{wbuf};
305 } elsif ($! != EAGAIN && $! != EINTR) { 316 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
306 $self->error; 317 $self->error;
307 } 318 }
308 }; 319 };
309 320
321 # try to write data immediately
322 $cb->();
323
324 # if still data left in wbuf, we need to poll
310 $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); 325 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
311 326 if length $self->{wbuf};
312 $cb->($self);
313 }; 327 };
314} 328}
315 329
316our %WH; 330our %WH;
317 331
… …
361register_write_type netstring => sub { 375register_write_type netstring => sub {
362 my ($self, $string) = @_; 376 my ($self, $string) = @_;
363 377
364 sprintf "%d:%s,", (length $string), $string 378 sprintf "%d:%s,", (length $string), $string
365}; 379};
380
381=item json => $array_or_hashref
366 382
367=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) 383=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)
368 384
369This function (not method) lets you add your own types to C<push_write>. 385This function (not method) lets you add your own types to C<push_write>.
370Whenever the given C<type> is used, C<push_write> will invoke the code 386Whenever the given C<type> is used, C<push_write> will invoke the code
… …
463 479
464 if ( 480 if (
465 defined $self->{rbuf_max} 481 defined $self->{rbuf_max}
466 && $self->{rbuf_max} < length $self->{rbuf} 482 && $self->{rbuf_max} < length $self->{rbuf}
467 ) { 483 ) {
468 $! = &Errno::ENOSPC; return $self->error; 484 $! = &Errno::ENOSPC;
485 $self->error;
469 } 486 }
470 487
471 return if $self->{in_drain}; 488 return if $self->{in_drain};
472 local $self->{in_drain} = 1; 489 local $self->{in_drain} = 1;
473 490
474 while (my $len = length $self->{rbuf}) { 491 while (my $len = length $self->{rbuf}) {
475 no strict 'refs'; 492 no strict 'refs';
476 if (my $cb = shift @{ $self->{queue} }) { 493 if (my $cb = shift @{ $self->{_queue} }) {
477 unless ($cb->($self)) { 494 unless ($cb->($self)) {
478 if ($self->{eof}) { 495 if ($self->{_eof}) {
479 # no progress can be made (not enough data and no data forthcoming) 496 # no progress can be made (not enough data and no data forthcoming)
480 $! = &Errno::EPIPE; return $self->error; 497 $! = &Errno::EPIPE;
498 $self->error;
481 } 499 }
482 500
483 unshift @{ $self->{queue} }, $cb; 501 unshift @{ $self->{_queue} }, $cb;
484 return; 502 return;
485 } 503 }
486 } elsif ($self->{on_read}) { 504 } elsif ($self->{on_read}) {
487 $self->{on_read}($self); 505 $self->{on_read}($self);
488 506
489 if ( 507 if (
490 $self->{eof} # if no further data will arrive 508 $self->{_eof} # if no further data will arrive
491 && $len == length $self->{rbuf} # and no data has been consumed 509 && $len == length $self->{rbuf} # and no data has been consumed
492 && !@{ $self->{queue} } # and the queue is still empty 510 && !@{ $self->{_queue} } # and the queue is still empty
493 && $self->{on_read} # and we still want to read data 511 && $self->{on_read} # and we still want to read data
494 ) { 512 ) {
495 # then no progress can be made 513 # then no progress can be made
496 $! = &Errno::EPIPE; return $self->error; 514 $! = &Errno::EPIPE;
515 $self->error;
497 } 516 }
498 } else { 517 } else {
499 # read side becomes idle 518 # read side becomes idle
500 delete $self->{rw}; 519 delete $self->{_rw};
501 return; 520 return;
502 } 521 }
503 } 522 }
504 523
505 if ($self->{eof}) { 524 if ($self->{_eof}) {
506 $self->_shutdown; 525 $self->_shutdown;
507 $self->{on_eof}($self) 526 $self->{on_eof}($self)
508 if $self->{on_eof}; 527 if $self->{on_eof};
509 } 528 }
510} 529}
… …
576 595
577 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 596 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
578 ->($self, $cb, @_); 597 ->($self, $cb, @_);
579 } 598 }
580 599
581 push @{ $self->{queue} }, $cb; 600 push @{ $self->{_queue} }, $cb;
582 $self->_drain_rbuf; 601 $self->_drain_rbuf;
583} 602}
584 603
585sub unshift_read { 604sub unshift_read {
586 my $self = shift; 605 my $self = shift;
… …
592 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 611 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
593 ->($self, $cb, @_); 612 ->($self, $cb, @_);
594 } 613 }
595 614
596 615
597 unshift @{ $self->{queue} }, $cb; 616 unshift @{ $self->{_queue} }, $cb;
598 $self->_drain_rbuf; 617 $self->_drain_rbuf;
599} 618}
600 619
601=item $handle->push_read (type => @args, $cb) 620=item $handle->push_read (type => @args, $cb)
602 621
… …
727 746
728 1 747 1
729 } 748 }
730}; 749};
731 750
751=item regex => $accept[, $reject[, $skip], $cb->($data)
752
753Makes a regex match against the regex object C<$accept> and returns
754everything up to and including the match.
755
756Example: read a single line terminated by '\n'.
757
758 $handle->push_read (regex => qr<\n>, sub { ... });
759
760If C<$reject> is given and not undef, then it determines when the data is
761to be rejected: it is matched against the data when the C<$accept> regex
762does not match and generates an C<EBADMSG> error when it matches. This is
763useful to quickly reject wrong data (to avoid waiting for a timeout or a
764receive buffer overflow).
765
766Example: expect a single decimal number followed by whitespace, reject
767anything else (not the use of an anchor).
768
769 $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
770
771If C<$skip> is given and not C<undef>, then it will be matched against
772the receive buffer when neither C<$accept> nor C<$reject> match,
773and everything preceding and including the match will be accepted
774unconditionally. This is useful to skip large amounts of data that you
775know cannot be matched, so that the C<$accept> or C<$reject> regex do not
776have to start matching from the beginning. This is purely an optimisation
777and is usually worth only when you expect more than a few kilobytes.
778
779Example: expect a http header, which ends at C<\015\012\015\012>. Since we
780expect the header to be very large (it isn't in practise, but...), we use
781a skip regex to skip initial portions. The skip regex is tricky in that
782it only accepts something not ending in either \015 or \012, as these are
783required for the accept regex.
784
785 $handle->push_read (regex =>
786 qr<\015\012\015\012>,
787 undef, # no reject
788 qr<^.*[^\015\012]>,
789 sub { ... });
790
791=cut
792
793register_read_type regex => sub {
794 my ($self, $cb, $accept, $reject, $skip) = @_;
795
796 my $data;
797 my $rbuf = \$self->{rbuf};
798
799 sub {
800 # accept
801 if ($$rbuf =~ $accept) {
802 $data .= substr $$rbuf, 0, $+[0], "";
803 $cb->($self, $data);
804 return 1;
805 }
806
807 # reject
808 if ($reject && $$rbuf =~ $reject) {
809 $! = &Errno::EBADMSG;
810 $self->error;
811 }
812
813 # skip
814 if ($skip && $$rbuf =~ $skip) {
815 $data .= substr $$rbuf, 0, $+[0], "";
816 }
817
818 ()
819 }
820};
821
732=back 822=back
733 823
734=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) 824=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
735 825
736This function (not method) lets you add your own types to C<push_read>. 826This function (not method) lets you add your own types to C<push_read>.
… …
763=cut 853=cut
764 854
765sub stop_read { 855sub stop_read {
766 my ($self) = @_; 856 my ($self) = @_;
767 857
768 delete $self->{rw}; 858 delete $self->{_rw};
769} 859}
770 860
771sub start_read { 861sub start_read {
772 my ($self) = @_; 862 my ($self) = @_;
773 863
774 unless ($self->{rw} || $self->{eof}) { 864 unless ($self->{_rw} || $self->{_eof}) {
775 Scalar::Util::weaken $self; 865 Scalar::Util::weaken $self;
776 866
777 $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 867 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
778 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; 868 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
779 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 869 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
780 870
781 if ($len > 0) { 871 if ($len > 0) {
782 $self->{filter_r} 872 $self->{filter_r}
783 ? $self->{filter_r}->($self, $rbuf) 873 ? $self->{filter_r}->($self, $rbuf)
784 : $self->_drain_rbuf; 874 : $self->_drain_rbuf;
785 875
786 } elsif (defined $len) { 876 } elsif (defined $len) {
787 delete $self->{rw}; 877 delete $self->{_rw};
788 $self->{eof} = 1; 878 $self->{_eof} = 1;
789 $self->_drain_rbuf; 879 $self->_drain_rbuf;
790 880
791 } elsif ($! != EAGAIN && $! != EINTR) { 881 } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
792 return $self->error; 882 return $self->error;
793 } 883 }
794 }); 884 });
795 } 885 }
796} 886}
797 887
798sub _dotls { 888sub _dotls {
799 my ($self) = @_; 889 my ($self) = @_;
800 890
801 if (length $self->{tls_wbuf}) { 891 if (length $self->{_tls_wbuf}) {
802 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { 892 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
803 substr $self->{tls_wbuf}, 0, $len, ""; 893 substr $self->{_tls_wbuf}, 0, $len, "";
804 } 894 }
805 } 895 }
806 896
807 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { 897 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
808 $self->{wbuf} .= $buf; 898 $self->{wbuf} .= $buf;
809 $self->_drain_wbuf; 899 $self->_drain_wbuf;
810 } 900 }
811 901
812 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { 902 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
… …
838C<"connect">, C<"accept"> or an existing Net::SSLeay object). 928C<"connect">, C<"accept"> or an existing Net::SSLeay object).
839 929
840The second argument is the optional C<Net::SSLeay::CTX> object that is 930The second argument is the optional C<Net::SSLeay::CTX> object that is
841used when AnyEvent::Handle has to create its own TLS connection object. 931used when AnyEvent::Handle has to create its own TLS connection object.
842 932
933The TLS connection object will end up in C<< $handle->{tls} >> after this
934call and can be used or changed to your liking. Note that the handshake
935might have already started when this function returns.
936
843=cut 937=cut
844 938
845# TODO: maybe document... 939# TODO: maybe document...
846sub starttls { 940sub starttls {
847 my ($self, $ssl, $ctx) = @_; 941 my ($self, $ssl, $ctx) = @_;
… …
862 # but the openssl maintainers basically said: "trust us, it just works". 956 # but the openssl maintainers basically said: "trust us, it just works".
863 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 957 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
864 # and mismaintained ssleay-module doesn't even offer them). 958 # and mismaintained ssleay-module doesn't even offer them).
865 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html 959 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
866 Net::SSLeay::CTX_set_mode ($self->{tls}, 960 Net::SSLeay::CTX_set_mode ($self->{tls},
867 (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 961 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
868 | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 962 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
869 963
870 $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 964 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
871 $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 965 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872 966
873 Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); 967 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
874 968
875 $self->{filter_w} = sub { 969 $self->{filter_w} = sub {
876 $_[0]{tls_wbuf} .= ${$_[1]}; 970 $_[0]{_tls_wbuf} .= ${$_[1]};
877 &_dotls; 971 &_dotls;
878 }; 972 };
879 $self->{filter_r} = sub { 973 $self->{filter_r} = sub {
880 Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); 974 Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
881 &_dotls; 975 &_dotls;
882 }; 976 };
883} 977}
884 978
885=item $handle->stoptls 979=item $handle->stoptls
… …
891 985
892sub stoptls { 986sub stoptls {
893 my ($self) = @_; 987 my ($self) = @_;
894 988
895 Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; 989 Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
990
896 delete $self->{tls_rbio}; 991 delete $self->{_rbio};
897 delete $self->{tls_wbio}; 992 delete $self->{_wbio};
898 delete $self->{tls_wbuf}; 993 delete $self->{_tls_wbuf};
899 delete $self->{filter_r}; 994 delete $self->{filter_r};
900 delete $self->{filter_w}; 995 delete $self->{filter_w};
901} 996}
902 997
903sub DESTROY { 998sub DESTROY {
… …
941 } 1036 }
942} 1037}
943 1038
944=back 1039=back
945 1040
1041=head1 SUBCLASSING AnyEvent::Handle
1042
1043In many cases, you might want to subclass AnyEvent::Handle.
1044
1045To make this easier, a given version of AnyEvent::Handle uses these
1046conventions:
1047
1048=over 4
1049
1050=item * all constructor arguments become object members.
1051
1052At least initially, when you pass a C<tls>-argument to the constructor it
1053will end up in C<< $handle->{tls} >>. Those members might be changes or
1054mutated later on (for example C<tls> will hold the TLS connection object).
1055
1056=item * other object member names are prefixed with an C<_>.
1057
1058All object members not explicitly documented (internal use) are prefixed
1059with an underscore character, so the remaining non-C<_>-namespace is free
1060for use for subclasses.
1061
1062=item * all members not documented here and not prefixed with an underscore
1063are free to use in subclasses.
1064
1065Of course, new versions of AnyEvent::Handle may introduce more "public"
1066member variables, but thats just life, at least it is documented.
1067
1068=back
1069
946=head1 AUTHOR 1070=head1 AUTHOR
947 1071
948Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. 1072Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
949 1073
950=cut 1074=cut

Diff Legend

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