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.38 by root, Mon May 26 21:28:33 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
… …
463 477
464 if ( 478 if (
465 defined $self->{rbuf_max} 479 defined $self->{rbuf_max}
466 && $self->{rbuf_max} < length $self->{rbuf} 480 && $self->{rbuf_max} < length $self->{rbuf}
467 ) { 481 ) {
468 $! = &Errno::ENOSPC; return $self->error; 482 $! = &Errno::ENOSPC;
483 $self->error;
469 } 484 }
470 485
471 return if $self->{in_drain}; 486 return if $self->{in_drain};
472 local $self->{in_drain} = 1; 487 local $self->{in_drain} = 1;
473 488
474 while (my $len = length $self->{rbuf}) { 489 while (my $len = length $self->{rbuf}) {
475 no strict 'refs'; 490 no strict 'refs';
476 if (my $cb = shift @{ $self->{queue} }) { 491 if (my $cb = shift @{ $self->{_queue} }) {
477 unless ($cb->($self)) { 492 unless ($cb->($self)) {
478 if ($self->{eof}) { 493 if ($self->{_eof}) {
479 # no progress can be made (not enough data and no data forthcoming) 494 # no progress can be made (not enough data and no data forthcoming)
480 $! = &Errno::EPIPE; return $self->error; 495 $! = &Errno::EPIPE;
496 $self->error;
481 } 497 }
482 498
483 unshift @{ $self->{queue} }, $cb; 499 unshift @{ $self->{_queue} }, $cb;
484 return; 500 return;
485 } 501 }
486 } elsif ($self->{on_read}) { 502 } elsif ($self->{on_read}) {
487 $self->{on_read}($self); 503 $self->{on_read}($self);
488 504
489 if ( 505 if (
490 $self->{eof} # if no further data will arrive 506 $self->{_eof} # if no further data will arrive
491 && $len == length $self->{rbuf} # and no data has been consumed 507 && $len == length $self->{rbuf} # and no data has been consumed
492 && !@{ $self->{queue} } # and the queue is still empty 508 && !@{ $self->{_queue} } # and the queue is still empty
493 && $self->{on_read} # and we still want to read data 509 && $self->{on_read} # and we still want to read data
494 ) { 510 ) {
495 # then no progress can be made 511 # then no progress can be made
496 $! = &Errno::EPIPE; return $self->error; 512 $! = &Errno::EPIPE;
513 $self->error;
497 } 514 }
498 } else { 515 } else {
499 # read side becomes idle 516 # read side becomes idle
500 delete $self->{rw}; 517 delete $self->{_rw};
501 return; 518 return;
502 } 519 }
503 } 520 }
504 521
505 if ($self->{eof}) { 522 if ($self->{_eof}) {
506 $self->_shutdown; 523 $self->_shutdown;
507 $self->{on_eof}($self) 524 $self->{on_eof}($self)
508 if $self->{on_eof}; 525 if $self->{on_eof};
509 } 526 }
510} 527}
… …
576 593
577 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 594 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
578 ->($self, $cb, @_); 595 ->($self, $cb, @_);
579 } 596 }
580 597
581 push @{ $self->{queue} }, $cb; 598 push @{ $self->{_queue} }, $cb;
582 $self->_drain_rbuf; 599 $self->_drain_rbuf;
583} 600}
584 601
585sub unshift_read { 602sub unshift_read {
586 my $self = shift; 603 my $self = shift;
… …
592 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 609 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
593 ->($self, $cb, @_); 610 ->($self, $cb, @_);
594 } 611 }
595 612
596 613
597 unshift @{ $self->{queue} }, $cb; 614 unshift @{ $self->{_queue} }, $cb;
598 $self->_drain_rbuf; 615 $self->_drain_rbuf;
599} 616}
600 617
601=item $handle->push_read (type => @args, $cb) 618=item $handle->push_read (type => @args, $cb)
602 619
… …
727 744
728 1 745 1
729 } 746 }
730}; 747};
731 748
749=item regex => $accept[, $reject[, $skip], $cb->($data)
750
751Makes a regex match against the regex object C<$accept> and returns
752everything up to and including the match.
753
754Example: read a single line terminated by '\n'.
755
756 $handle->push_read (regex => qr<\n>, sub { ... });
757
758If C<$reject> is given and not undef, then it determines when the data is
759to be rejected: it is matched against the data when the C<$accept> regex
760does not match and generates an C<EBADMSG> error when it matches. This is
761useful to quickly reject wrong data (to avoid waiting for a timeout or a
762receive buffer overflow).
763
764Example: expect a single decimal number followed by whitespace, reject
765anything else (not the use of an anchor).
766
767 $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
768
769If C<$skip> is given and not C<undef>, then it will be matched against
770the receive buffer when neither C<$accept> nor C<$reject> match,
771and everything preceding and including the match will be accepted
772unconditionally. This is useful to skip large amounts of data that you
773know cannot be matched, so that the C<$accept> or C<$reject> regex do not
774have to start matching from the beginning. This is purely an optimisation
775and is usually worth only when you expect more than a few kilobytes.
776
777Example: expect a http header, which ends at C<\015\012\015\012>. Since we
778expect the header to be very large (it isn't in practise, but...), we use
779a skip regex to skip initial portions. The skip regex is tricky in that
780it only accepts something not ending in either \015 or \012, as these are
781required for the accept regex.
782
783 $handle->push_read (regex =>
784 qr<\015\012\015\012>,
785 undef, # no reject
786 qr<^.*[^\015\012]>,
787 sub { ... });
788
789=cut
790
791register_read_type regex => sub {
792 my ($self, $cb, $accept, $reject, $skip) = @_;
793
794 my $data;
795 my $rbuf = \$self->{rbuf};
796
797 sub {
798 # accept
799 if ($$rbuf =~ $accept) {
800 $data .= substr $$rbuf, 0, $+[0], "";
801 $cb->($self, $data);
802 return 1;
803 }
804
805 # reject
806 if ($reject && $$rbuf =~ $reject) {
807 $! = &Errno::EBADMSG;
808 $self->error;
809 }
810
811 # skip
812 if ($skip && $$rbuf =~ $skip) {
813 $data .= substr $$rbuf, 0, $+[0], "";
814 }
815
816 ()
817 }
818};
819
732=back 820=back
733 821
734=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) 822=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
735 823
736This function (not method) lets you add your own types to C<push_read>. 824This function (not method) lets you add your own types to C<push_read>.
… …
763=cut 851=cut
764 852
765sub stop_read { 853sub stop_read {
766 my ($self) = @_; 854 my ($self) = @_;
767 855
768 delete $self->{rw}; 856 delete $self->{_rw};
769} 857}
770 858
771sub start_read { 859sub start_read {
772 my ($self) = @_; 860 my ($self) = @_;
773 861
774 unless ($self->{rw} || $self->{eof}) { 862 unless ($self->{_rw} || $self->{_eof}) {
775 Scalar::Util::weaken $self; 863 Scalar::Util::weaken $self;
776 864
777 $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 865 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
778 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; 866 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
779 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 867 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
780 868
781 if ($len > 0) { 869 if ($len > 0) {
782 $self->{filter_r} 870 $self->{filter_r}
783 ? $self->{filter_r}->($self, $rbuf) 871 ? $self->{filter_r}->($self, $rbuf)
784 : $self->_drain_rbuf; 872 : $self->_drain_rbuf;
785 873
786 } elsif (defined $len) { 874 } elsif (defined $len) {
787 delete $self->{rw}; 875 delete $self->{_rw};
788 $self->{eof} = 1; 876 $self->{_eof} = 1;
789 $self->_drain_rbuf; 877 $self->_drain_rbuf;
790 878
791 } elsif ($! != EAGAIN && $! != EINTR) { 879 } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
792 return $self->error; 880 return $self->error;
793 } 881 }
794 }); 882 });
795 } 883 }
796} 884}
797 885
798sub _dotls { 886sub _dotls {
799 my ($self) = @_; 887 my ($self) = @_;
800 888
801 if (length $self->{tls_wbuf}) { 889 if (length $self->{_tls_wbuf}) {
802 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { 890 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
803 substr $self->{tls_wbuf}, 0, $len, ""; 891 substr $self->{_tls_wbuf}, 0, $len, "";
804 } 892 }
805 } 893 }
806 894
807 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { 895 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
808 $self->{wbuf} .= $buf; 896 $self->{wbuf} .= $buf;
809 $self->_drain_wbuf; 897 $self->_drain_wbuf;
810 } 898 }
811 899
812 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { 900 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
… …
838C<"connect">, C<"accept"> or an existing Net::SSLeay object). 926C<"connect">, C<"accept"> or an existing Net::SSLeay object).
839 927
840The second argument is the optional C<Net::SSLeay::CTX> object that is 928The second argument is the optional C<Net::SSLeay::CTX> object that is
841used when AnyEvent::Handle has to create its own TLS connection object. 929used when AnyEvent::Handle has to create its own TLS connection object.
842 930
931The TLS connection object will end up in C<< $handle->{tls} >> after this
932call and can be used or changed to your liking. Note that the handshake
933might have already started when this function returns.
934
843=cut 935=cut
844 936
845# TODO: maybe document... 937# TODO: maybe document...
846sub starttls { 938sub starttls {
847 my ($self, $ssl, $ctx) = @_; 939 my ($self, $ssl, $ctx) = @_;
… …
862 # but the openssl maintainers basically said: "trust us, it just works". 954 # but the openssl maintainers basically said: "trust us, it just works".
863 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 955 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
864 # and mismaintained ssleay-module doesn't even offer them). 956 # and mismaintained ssleay-module doesn't even offer them).
865 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html 957 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
866 Net::SSLeay::CTX_set_mode ($self->{tls}, 958 Net::SSLeay::CTX_set_mode ($self->{tls},
867 (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 959 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
868 | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 960 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
869 961
870 $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 962 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
871 $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 963 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872 964
873 Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); 965 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
874 966
875 $self->{filter_w} = sub { 967 $self->{filter_w} = sub {
876 $_[0]{tls_wbuf} .= ${$_[1]}; 968 $_[0]{_tls_wbuf} .= ${$_[1]};
877 &_dotls; 969 &_dotls;
878 }; 970 };
879 $self->{filter_r} = sub { 971 $self->{filter_r} = sub {
880 Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); 972 Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
881 &_dotls; 973 &_dotls;
882 }; 974 };
883} 975}
884 976
885=item $handle->stoptls 977=item $handle->stoptls
… …
891 983
892sub stoptls { 984sub stoptls {
893 my ($self) = @_; 985 my ($self) = @_;
894 986
895 Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; 987 Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
988
896 delete $self->{tls_rbio}; 989 delete $self->{_rbio};
897 delete $self->{tls_wbio}; 990 delete $self->{_wbio};
898 delete $self->{tls_wbuf}; 991 delete $self->{_tls_wbuf};
899 delete $self->{filter_r}; 992 delete $self->{filter_r};
900 delete $self->{filter_w}; 993 delete $self->{filter_w};
901} 994}
902 995
903sub DESTROY { 996sub DESTROY {
… …
941 } 1034 }
942} 1035}
943 1036
944=back 1037=back
945 1038
1039=head1 SUBCLASSING AnyEvent::Handle
1040
1041In many cases, you might want to subclass AnyEvent::Handle.
1042
1043To make this easier, a given version of AnyEvent::Handle uses these
1044conventions:
1045
1046=over 4
1047
1048=item * all constructor arguments become object members.
1049
1050At least initially, when you pass a C<tls>-argument to the constructor it
1051will end up in C<< $handle->{tls} >>. Those members might be changes or
1052mutated later on (for example C<tls> will hold the TLS connection object).
1053
1054=item * other object member names are prefixed with an C<_>.
1055
1056All object members not explicitly documented (internal use) are prefixed
1057with an underscore character, so the remaining non-C<_>-namespace is free
1058for use for subclasses.
1059
1060=item * all members not documented here and not prefixed with an underscore
1061are free to use in subclasses.
1062
1063Of course, new versions of AnyEvent::Handle may introduce more "public"
1064member variables, but thats just life, at least it is documented.
1065
1066=back
1067
946=head1 AUTHOR 1068=head1 AUTHOR
947 1069
948Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. 1070Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
949 1071
950=cut 1072=cut

Diff Legend

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