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.31 by root, Sun May 25 00:08:49 2008 UTC vs.
Revision 1.40 by root, Tue May 27 05:36:27 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
… …
73The filehandle this L<AnyEvent::Handle> object will operate on. 73The filehandle this L<AnyEvent::Handle> object will operate on.
74 74
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->($self) 78=item on_eof => $cb->($handle)
79 79
80Set the callback to be called on EOF. 80Set the callback to be called on EOF.
81 81
82While not mandatory, it is highly recommended to set an eof callback, 82While not mandatory, it is highly recommended to set an eof callback,
83otherwise you might end up with a closed socket while you are still 83otherwise you might end up with a closed socket while you are still
84waiting for data. 84waiting for data.
85 85
86=item on_error => $cb->($self) 86=item on_error => $cb->($handle)
87 87
88This is the fatal error callback, that is called when, well, a fatal error 88This is the fatal error callback, that is called when, well, a fatal error
89occurs, such as not being able to resolve the hostname, failure to connect 89occurs, such as not being able to resolve the hostname, failure to connect
90or a read error. 90or a read error.
91 91
… …
93called. 93called.
94 94
95On callback entrance, the value of C<$!> contains the operating system 95On callback entrance, the value of C<$!> contains the operating system
96error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). 96error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
97 97
98The callback should throw an exception. If it returns, then
99AnyEvent::Handle will C<croak> for you.
100
98While 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
99you will not be notified of errors otherwise. The default simply calls 102you will not be notified of errors otherwise. The default simply calls
100die. 103die.
101 104
102=item on_read => $cb->($self) 105=item on_read => $cb->($handle)
103 106
104This sets the default read callback, which is called when data arrives 107This sets the default read callback, which is called when data arrives
105and no read request is in the queue. 108and no read request is in the queue.
106 109
107To access (and remove data from) the read buffer, use the C<< ->rbuf >> 110To access (and remove data from) the read buffer, use the C<< ->rbuf >>
108method or access the C<$self->{rbuf}> member directly. 111method or access the C<$handle->{rbuf}> member directly.
109 112
110When an EOF condition is detected then AnyEvent::Handle will first try to 113When an EOF condition is detected then AnyEvent::Handle will first try to
111feed all the remaining data to the queued callbacks and C<on_read> before 114feed all the remaining data to the queued callbacks and C<on_read> before
112calling the C<on_eof> callback. If no progress can be made, then a fatal 115calling the C<on_eof> callback. If no progress can be made, then a fatal
113error will be raised (with C<$!> set to C<EPIPE>). 116error will be raised (with C<$!> set to C<EPIPE>).
114 117
115=item on_drain => $cb->() 118=item on_drain => $cb->($handle)
116 119
117This sets the callback that is called when the write buffer becomes empty 120This sets the callback that is called when the write buffer becomes empty
118(or when the callback is set and the buffer is empty already). 121(or when the callback is set and the buffer is empty already).
119 122
120To append to the write buffer, use the C<< ->push_write >> method. 123To append to the write buffer, use the C<< ->push_write >> method.
… …
165 168
166Use 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
167(unless a connection object was specified directly). If this parameter is 170(unless a connection object was specified directly). If this parameter is
168missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 171missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
169 172
173=item json => JSON or JSON::XS object
174
175This is the json coder object used by the C<json> read and write types.
176
177If you don't supply it, then AnyEvent::Handle will use C<encode_json> and
178C<decode_json>.
179
180Note that you are responsible to depend on the JSON module if you want to
181use this functionality, as AnyEvent does not have a dependency itself.
182
183=item filter_r => $cb
184
185=item filter_w => $cb
186
187These exist, but are undocumented at this time.
188
170=back 189=back
171 190
172=cut 191=cut
173 192
174sub new { 193sub new {
… …
196} 215}
197 216
198sub _shutdown { 217sub _shutdown {
199 my ($self) = @_; 218 my ($self) = @_;
200 219
201 delete $self->{rw}; 220 delete $self->{_rw};
202 delete $self->{ww}; 221 delete $self->{_ww};
203 delete $self->{fh}; 222 delete $self->{fh};
204} 223}
205 224
206sub error { 225sub error {
207 my ($self) = @_; 226 my ($self) = @_;
… …
209 { 228 {
210 local $!; 229 local $!;
211 $self->_shutdown; 230 $self->_shutdown;
212 } 231 }
213 232
214 if ($self->{on_error}) {
215 $self->{on_error}($self); 233 $self->{on_error}($self)
216 } else { 234 if $self->{on_error};
235
217 Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; 236 Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
218 }
219} 237}
220 238
221=item $fh = $handle->fh 239=item $fh = $handle->fh
222 240
223This method returns the file handle of the L<AnyEvent::Handle> object. 241This method returns the file handle of the L<AnyEvent::Handle> object.
224 242
225=cut 243=cut
226 244
227sub fh { $_[0]->{fh} } 245sub fh { $_[0]{fh} }
228 246
229=item $handle->on_error ($cb) 247=item $handle->on_error ($cb)
230 248
231Replace the current C<on_error> callback (see the C<on_error> constructor argument). 249Replace the current C<on_error> callback (see the C<on_error> constructor argument).
232 250
… …
288=cut 306=cut
289 307
290sub _drain_wbuf { 308sub _drain_wbuf {
291 my ($self) = @_; 309 my ($self) = @_;
292 310
293 if (!$self->{ww} && length $self->{wbuf}) { 311 if (!$self->{_ww} && length $self->{wbuf}) {
312
294 Scalar::Util::weaken $self; 313 Scalar::Util::weaken $self;
314
295 my $cb = sub { 315 my $cb = sub {
296 my $len = syswrite $self->{fh}, $self->{wbuf}; 316 my $len = syswrite $self->{fh}, $self->{wbuf};
297 317
298 if ($len >= 0) { 318 if ($len >= 0) {
299 substr $self->{wbuf}, 0, $len, ""; 319 substr $self->{wbuf}, 0, $len, "";
300 320
301 $self->{on_drain}($self) 321 $self->{on_drain}($self)
302 if $self->{low_water_mark} >= length $self->{wbuf} 322 if $self->{low_water_mark} >= length $self->{wbuf}
303 && $self->{on_drain}; 323 && $self->{on_drain};
304 324
305 delete $self->{ww} unless length $self->{wbuf}; 325 delete $self->{_ww} unless length $self->{wbuf};
306 } elsif ($! != EAGAIN && $! != EINTR) { 326 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
307 $self->error; 327 $self->error;
308 } 328 }
309 }; 329 };
310 330
331 # try to write data immediately
332 $cb->();
333
334 # if still data left in wbuf, we need to poll
311 $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); 335 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
312 336 if length $self->{wbuf};
313 $cb->($self);
314 }; 337 };
315} 338}
316 339
317our %WH; 340our %WH;
318 341
… …
363 my ($self, $string) = @_; 386 my ($self, $string) = @_;
364 387
365 sprintf "%d:%s,", (length $string), $string 388 sprintf "%d:%s,", (length $string), $string
366}; 389};
367 390
391=item json => $array_or_hashref
392
393Encodes the given hash or array reference into a JSON object. Unless you
394provide your own JSON object, this means it will be encoded to JSON text
395in UTF-8.
396
397JSON objects (and arrays) are self-delimiting, so you can write JSON at
398one end of a handle and read them at the other end without using any
399additional framing.
400
401=cut
402
403register_write_type json => sub {
404 my ($self, $ref) = @_;
405
406 require JSON;
407
408 $self->{json} ? $self->{json}->encode ($ref)
409 : JSON::encode_json ($ref)
410};
411
368=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) 412=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
369 413
370This function (not method) lets you add your own types to C<push_write>. 414This function (not method) lets you add your own types to C<push_write>.
371Whenever the given C<type> is used, C<push_write> will invoke the code 415Whenever the given C<type> is used, C<push_write> will invoke the code
372reference with the handle object and the remaining arguments. 416reference with the handle object and the remaining arguments.
373 417
… …
464 508
465 if ( 509 if (
466 defined $self->{rbuf_max} 510 defined $self->{rbuf_max}
467 && $self->{rbuf_max} < length $self->{rbuf} 511 && $self->{rbuf_max} < length $self->{rbuf}
468 ) { 512 ) {
469 $! = &Errno::ENOSPC; return $self->error; 513 $! = &Errno::ENOSPC;
514 $self->error;
470 } 515 }
471 516
472 return if $self->{in_drain}; 517 return if $self->{in_drain};
473 local $self->{in_drain} = 1; 518 local $self->{in_drain} = 1;
474 519
475 while (my $len = length $self->{rbuf}) { 520 while (my $len = length $self->{rbuf}) {
476 no strict 'refs'; 521 no strict 'refs';
477 if (my $cb = shift @{ $self->{queue} }) { 522 if (my $cb = shift @{ $self->{_queue} }) {
478 unless ($cb->($self)) { 523 unless ($cb->($self)) {
479 if ($self->{eof}) { 524 if ($self->{_eof}) {
480 # no progress can be made (not enough data and no data forthcoming) 525 # no progress can be made (not enough data and no data forthcoming)
481 $! = &Errno::EPIPE; return $self->error; 526 $! = &Errno::EPIPE;
527 $self->error;
482 } 528 }
483 529
484 unshift @{ $self->{queue} }, $cb; 530 unshift @{ $self->{_queue} }, $cb;
485 return; 531 return;
486 } 532 }
487 } elsif ($self->{on_read}) { 533 } elsif ($self->{on_read}) {
488 $self->{on_read}($self); 534 $self->{on_read}($self);
489 535
490 if ( 536 if (
491 $self->{eof} # if no further data will arrive 537 $self->{_eof} # if no further data will arrive
492 && $len == length $self->{rbuf} # and no data has been consumed 538 && $len == length $self->{rbuf} # and no data has been consumed
493 && !@{ $self->{queue} } # and the queue is still empty 539 && !@{ $self->{_queue} } # and the queue is still empty
494 && $self->{on_read} # and we still want to read data 540 && $self->{on_read} # and we still want to read data
495 ) { 541 ) {
496 # then no progress can be made 542 # then no progress can be made
497 $! = &Errno::EPIPE; return $self->error; 543 $! = &Errno::EPIPE;
544 $self->error;
498 } 545 }
499 } else { 546 } else {
500 # read side becomes idle 547 # read side becomes idle
501 delete $self->{rw}; 548 delete $self->{_rw};
502 return; 549 return;
503 } 550 }
504 } 551 }
505 552
506 if ($self->{eof}) { 553 if ($self->{_eof}) {
507 $self->_shutdown; 554 $self->_shutdown;
508 $self->{on_eof}($self) 555 $self->{on_eof}($self)
509 if $self->{on_eof}; 556 if $self->{on_eof};
510 } 557 }
511} 558}
… …
577 624
578 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 625 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
579 ->($self, $cb, @_); 626 ->($self, $cb, @_);
580 } 627 }
581 628
582 push @{ $self->{queue} }, $cb; 629 push @{ $self->{_queue} }, $cb;
583 $self->_drain_rbuf; 630 $self->_drain_rbuf;
584} 631}
585 632
586sub unshift_read { 633sub unshift_read {
587 my $self = shift; 634 my $self = shift;
… …
593 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 640 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
594 ->($self, $cb, @_); 641 ->($self, $cb, @_);
595 } 642 }
596 643
597 644
598 unshift @{ $self->{queue} }, $cb; 645 unshift @{ $self->{_queue} }, $cb;
599 $self->_drain_rbuf; 646 $self->_drain_rbuf;
600} 647}
601 648
602=item $handle->push_read (type => @args, $cb) 649=item $handle->push_read (type => @args, $cb)
603 650
… …
610Predefined types are (if you have ideas for additional types, feel free to 657Predefined types are (if you have ideas for additional types, feel free to
611drop by and tell us): 658drop by and tell us):
612 659
613=over 4 660=over 4
614 661
615=item chunk => $octets, $cb->($self, $data) 662=item chunk => $octets, $cb->($handle, $data)
616 663
617Invoke the callback only once C<$octets> bytes have been read. Pass the 664Invoke the callback only once C<$octets> bytes have been read. Pass the
618data read to the callback. The callback will never be called with less 665data read to the callback. The callback will never be called with less
619data. 666data.
620 667
… …
643 690
644sub unshift_read_chunk { 691sub unshift_read_chunk {
645 $_[0]->unshift_read (chunk => $_[1], $_[2]); 692 $_[0]->unshift_read (chunk => $_[1], $_[2]);
646} 693}
647 694
648=item line => [$eol, ]$cb->($self, $line, $eol) 695=item line => [$eol, ]$cb->($handle, $line, $eol)
649 696
650The callback will be called only once a full line (including the end of 697The callback will be called only once a full line (including the end of
651line marker, C<$eol>) has been read. This line (excluding the end of line 698line marker, C<$eol>) has been read. This line (excluding the end of line
652marker) will be passed to the callback as second argument (C<$line>), and 699marker) will be passed to the callback as second argument (C<$line>), and
653the end of line marker as the third argument (C<$eol>). 700the end of line marker as the third argument (C<$eol>).
… …
690sub unshift_read_line { 737sub unshift_read_line {
691 my $self = shift; 738 my $self = shift;
692 $self->unshift_read (line => @_); 739 $self->unshift_read (line => @_);
693} 740}
694 741
695=item netstring => $cb->($string) 742=item netstring => $cb->($handle, $string)
696 743
697A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). 744A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
698 745
699Throws an error with C<$!> set to EBADMSG on format violations. 746Throws an error with C<$!> set to EBADMSG on format violations.
700 747
… …
728 775
729 1 776 1
730 } 777 }
731}; 778};
732 779
780=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
781
782Makes a regex match against the regex object C<$accept> and returns
783everything up to and including the match.
784
785Example: read a single line terminated by '\n'.
786
787 $handle->push_read (regex => qr<\n>, sub { ... });
788
789If C<$reject> is given and not undef, then it determines when the data is
790to be rejected: it is matched against the data when the C<$accept> regex
791does not match and generates an C<EBADMSG> error when it matches. This is
792useful to quickly reject wrong data (to avoid waiting for a timeout or a
793receive buffer overflow).
794
795Example: expect a single decimal number followed by whitespace, reject
796anything else (not the use of an anchor).
797
798 $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
799
800If C<$skip> is given and not C<undef>, then it will be matched against
801the receive buffer when neither C<$accept> nor C<$reject> match,
802and everything preceding and including the match will be accepted
803unconditionally. This is useful to skip large amounts of data that you
804know cannot be matched, so that the C<$accept> or C<$reject> regex do not
805have to start matching from the beginning. This is purely an optimisation
806and is usually worth only when you expect more than a few kilobytes.
807
808Example: expect a http header, which ends at C<\015\012\015\012>. Since we
809expect the header to be very large (it isn't in practise, but...), we use
810a skip regex to skip initial portions. The skip regex is tricky in that
811it only accepts something not ending in either \015 or \012, as these are
812required for the accept regex.
813
814 $handle->push_read (regex =>
815 qr<\015\012\015\012>,
816 undef, # no reject
817 qr<^.*[^\015\012]>,
818 sub { ... });
819
820=cut
821
822register_read_type regex => sub {
823 my ($self, $cb, $accept, $reject, $skip) = @_;
824
825 my $data;
826 my $rbuf = \$self->{rbuf};
827
828 sub {
829 # accept
830 if ($$rbuf =~ $accept) {
831 $data .= substr $$rbuf, 0, $+[0], "";
832 $cb->($self, $data);
833 return 1;
834 }
835
836 # reject
837 if ($reject && $$rbuf =~ $reject) {
838 $! = &Errno::EBADMSG;
839 $self->error;
840 }
841
842 # skip
843 if ($skip && $$rbuf =~ $skip) {
844 $data .= substr $$rbuf, 0, $+[0], "";
845 }
846
847 ()
848 }
849};
850
851=item json => $cb->($handle, $hash_or_arrayref)
852
853Reads a JSON object or array, decodes it and passes it to the callback.
854
855If a C<json> object was passed to the constructor, then that will be used
856for the final decode, otherwise it will create a JSON coder expecting UTF-8.
857
858This read type uses the incremental parser available with JSON version
8592.09 (and JSON::XS version 2.2) and above. You have to provide a
860dependency on your own: this module will load the JSON module, but
861AnyEvent does not depend on it itself.
862
863Since JSON texts are fully self-delimiting, the C<json> read and write
864types are an ideal simple RPC protocol: just exchange JSON datagrams.
865
866=cut
867
868register_read_type json => sub {
869 my ($self, $cb, $accept, $reject, $skip) = @_;
870
871 require JSON;
872
873 my $data;
874 my $rbuf = \$self->{rbuf};
875
876 my $json = $self->{json} ||= JSON::XS->new->utf8;
877
878 sub {
879 my $ref = $json->incr_parse ($self->{rbuf});
880
881 if ($ref) {
882 $self->{rbuf} = $json->incr_text;
883 $json->incr_text = "";
884 $cb->($self, $ref);
885
886 1
887 } else {
888 $self->{rbuf} = "";
889 ()
890 }
891 }
892};
893
733=back 894=back
734 895
735=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) 896=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
736 897
737This function (not method) lets you add your own types to C<push_read>. 898This function (not method) lets you add your own types to C<push_read>.
738 899
739Whenever the given C<type> is used, C<push_read> will invoke the code 900Whenever the given C<type> is used, C<push_read> will invoke the code
740reference with the handle object, the callback and the remaining 901reference with the handle object, the callback and the remaining
… …
742 903
743The code reference is supposed to return a callback (usually a closure) 904The code reference is supposed to return a callback (usually a closure)
744that works as a plain read callback (see C<< ->push_read ($cb) >>). 905that works as a plain read callback (see C<< ->push_read ($cb) >>).
745 906
746It should invoke the passed callback when it is done reading (remember to 907It should invoke the passed callback when it is done reading (remember to
747pass C<$self> as first argument as all other callbacks do that). 908pass C<$handle> as first argument as all other callbacks do that).
748 909
749Note that this is a function, and all types registered this way will be 910Note that this is a function, and all types registered this way will be
750global, so try to use unique names. 911global, so try to use unique names.
751 912
752For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 913For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
… …
764=cut 925=cut
765 926
766sub stop_read { 927sub stop_read {
767 my ($self) = @_; 928 my ($self) = @_;
768 929
769 delete $self->{rw}; 930 delete $self->{_rw};
770} 931}
771 932
772sub start_read { 933sub start_read {
773 my ($self) = @_; 934 my ($self) = @_;
774 935
775 unless ($self->{rw} || $self->{eof}) { 936 unless ($self->{_rw} || $self->{_eof}) {
776 Scalar::Util::weaken $self; 937 Scalar::Util::weaken $self;
777 938
778 $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 939 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
779 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; 940 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
780 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 941 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
781 942
782 if ($len > 0) { 943 if ($len > 0) {
783 $self->{filter_r} 944 $self->{filter_r}
784 ? $self->{filter_r}->($self, $rbuf) 945 ? $self->{filter_r}->($self, $rbuf)
785 : $self->_drain_rbuf; 946 : $self->_drain_rbuf;
786 947
787 } elsif (defined $len) { 948 } elsif (defined $len) {
788 delete $self->{rw}; 949 delete $self->{_rw};
789 $self->{eof} = 1; 950 $self->{_eof} = 1;
790 $self->_drain_rbuf; 951 $self->_drain_rbuf;
791 952
792 } elsif ($! != EAGAIN && $! != EINTR) { 953 } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
793 return $self->error; 954 return $self->error;
794 } 955 }
795 }); 956 });
796 } 957 }
797} 958}
798 959
799sub _dotls { 960sub _dotls {
800 my ($self) = @_; 961 my ($self) = @_;
801 962
802 if (length $self->{tls_wbuf}) { 963 if (length $self->{_tls_wbuf}) {
803 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { 964 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
804 substr $self->{tls_wbuf}, 0, $len, ""; 965 substr $self->{_tls_wbuf}, 0, $len, "";
805 } 966 }
806 } 967 }
807 968
808 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { 969 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
809 $self->{wbuf} .= $buf; 970 $self->{wbuf} .= $buf;
810 $self->_drain_wbuf; 971 $self->_drain_wbuf;
811 } 972 }
812 973
813 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { 974 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
… …
839C<"connect">, C<"accept"> or an existing Net::SSLeay object). 1000C<"connect">, C<"accept"> or an existing Net::SSLeay object).
840 1001
841The second argument is the optional C<Net::SSLeay::CTX> object that is 1002The second argument is the optional C<Net::SSLeay::CTX> object that is
842used when AnyEvent::Handle has to create its own TLS connection object. 1003used when AnyEvent::Handle has to create its own TLS connection object.
843 1004
1005The TLS connection object will end up in C<< $handle->{tls} >> after this
1006call and can be used or changed to your liking. Note that the handshake
1007might have already started when this function returns.
1008
844=cut 1009=cut
845 1010
846# TODO: maybe document... 1011# TODO: maybe document...
847sub starttls { 1012sub starttls {
848 my ($self, $ssl, $ctx) = @_; 1013 my ($self, $ssl, $ctx) = @_;
… …
863 # but the openssl maintainers basically said: "trust us, it just works". 1028 # but the openssl maintainers basically said: "trust us, it just works".
864 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1029 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
865 # and mismaintained ssleay-module doesn't even offer them). 1030 # and mismaintained ssleay-module doesn't even offer them).
866 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html 1031 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
867 Net::SSLeay::CTX_set_mode ($self->{tls}, 1032 Net::SSLeay::CTX_set_mode ($self->{tls},
868 (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1033 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
869 | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1034 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
870 1035
871 $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1036 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872 $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1037 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
873 1038
874 Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); 1039 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
875 1040
876 $self->{filter_w} = sub { 1041 $self->{filter_w} = sub {
877 $_[0]{tls_wbuf} .= ${$_[1]}; 1042 $_[0]{_tls_wbuf} .= ${$_[1]};
878 &_dotls; 1043 &_dotls;
879 }; 1044 };
880 $self->{filter_r} = sub { 1045 $self->{filter_r} = sub {
881 Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); 1046 Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
882 &_dotls; 1047 &_dotls;
883 }; 1048 };
884} 1049}
885 1050
886=item $handle->stoptls 1051=item $handle->stoptls
… …
892 1057
893sub stoptls { 1058sub stoptls {
894 my ($self) = @_; 1059 my ($self) = @_;
895 1060
896 Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; 1061 Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
1062
897 delete $self->{tls_rbio}; 1063 delete $self->{_rbio};
898 delete $self->{tls_wbio}; 1064 delete $self->{_wbio};
899 delete $self->{tls_wbuf}; 1065 delete $self->{_tls_wbuf};
900 delete $self->{filter_r}; 1066 delete $self->{filter_r};
901 delete $self->{filter_w}; 1067 delete $self->{filter_w};
902} 1068}
903 1069
904sub DESTROY { 1070sub DESTROY {
… …
942 } 1108 }
943} 1109}
944 1110
945=back 1111=back
946 1112
1113=head1 SUBCLASSING AnyEvent::Handle
1114
1115In many cases, you might want to subclass AnyEvent::Handle.
1116
1117To make this easier, a given version of AnyEvent::Handle uses these
1118conventions:
1119
1120=over 4
1121
1122=item * all constructor arguments become object members.
1123
1124At least initially, when you pass a C<tls>-argument to the constructor it
1125will end up in C<< $handle->{tls} >>. Those members might be changes or
1126mutated later on (for example C<tls> will hold the TLS connection object).
1127
1128=item * other object member names are prefixed with an C<_>.
1129
1130All object members not explicitly documented (internal use) are prefixed
1131with an underscore character, so the remaining non-C<_>-namespace is free
1132for use for subclasses.
1133
1134=item * all members not documented here and not prefixed with an underscore
1135are free to use in subclasses.
1136
1137Of course, new versions of AnyEvent::Handle may introduce more "public"
1138member variables, but thats just life, at least it is documented.
1139
1140=back
1141
947=head1 AUTHOR 1142=head1 AUTHOR
948 1143
949Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. 1144Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
950 1145
951=cut 1146=cut

Diff Legend

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