… | |
… | |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict; |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util (); |
7 | use AnyEvent::Util qw(WSAWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw/EAGAIN EINTR/; |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
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 | This module is experimental. |
|
|
18 | |
|
|
19 | =cut |
17 | =cut |
20 | |
18 | |
21 | our $VERSION = '0.04'; |
19 | our $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 | |
49 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
… | |
… | |
91 | The object will not be in a usable state when this callback has been |
92 | The object will not be in a usable state when this callback has been |
92 | called. |
93 | called. |
93 | |
94 | |
94 | On callback entrance, the value of C<$!> contains the operating system |
95 | On callback entrance, the value of C<$!> contains the operating system |
95 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
96 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
|
|
97 | |
|
|
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
96 | |
100 | |
97 | While not mandatory, it is I<highly> recommended to set this callback, as |
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
98 | you will not be notified of errors otherwise. The default simply calls |
102 | you will not be notified of errors otherwise. The default simply calls |
99 | die. |
103 | die. |
100 | |
104 | |
… | |
… | |
164 | |
168 | |
165 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
169 | Use 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 |
167 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
168 | |
172 | |
|
|
173 | =item filter_r => $cb |
|
|
174 | |
|
|
175 | =item filter_w => $cb |
|
|
176 | |
|
|
177 | These exist, but are undocumented at this time. |
|
|
178 | |
169 | =back |
179 | =back |
170 | |
180 | |
171 | =cut |
181 | =cut |
172 | |
|
|
173 | our (%RH, %WH); |
|
|
174 | |
|
|
175 | sub register_read_type($$) { |
|
|
176 | $RH{$_[0]} = $_[1]; |
|
|
177 | } |
|
|
178 | |
|
|
179 | sub register_write_type($$) { |
|
|
180 | $WH{$_[0]} = $_[1]; |
|
|
181 | } |
|
|
182 | |
182 | |
183 | sub new { |
183 | sub new { |
184 | my $class = shift; |
184 | my $class = shift; |
185 | |
185 | |
186 | my $self = bless { @_ }, $class; |
186 | my $self = bless { @_ }, $class; |
… | |
… | |
205 | } |
205 | } |
206 | |
206 | |
207 | sub _shutdown { |
207 | sub _shutdown { |
208 | my ($self) = @_; |
208 | my ($self) = @_; |
209 | |
209 | |
210 | delete $self->{rw}; |
210 | delete $self->{_rw}; |
211 | delete $self->{ww}; |
211 | delete $self->{_ww}; |
212 | delete $self->{fh}; |
212 | delete $self->{fh}; |
213 | } |
213 | } |
214 | |
214 | |
215 | sub error { |
215 | sub error { |
216 | my ($self) = @_; |
216 | my ($self) = @_; |
… | |
… | |
218 | { |
218 | { |
219 | local $!; |
219 | local $!; |
220 | $self->_shutdown; |
220 | $self->_shutdown; |
221 | } |
221 | } |
222 | |
222 | |
223 | if ($self->{on_error}) { |
|
|
224 | $self->{on_error}($self); |
223 | $self->{on_error}($self) |
225 | } else { |
224 | if $self->{on_error}; |
|
|
225 | |
226 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
226 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
227 | } |
|
|
228 | } |
227 | } |
229 | |
228 | |
230 | =item $fh = $handle->fh |
229 | =item $fh = $handle->fh |
231 | |
230 | |
232 | This method returns the file handle of the L<AnyEvent::Handle> object. |
231 | This method returns the file handle of the L<AnyEvent::Handle> object. |
233 | |
232 | |
234 | =cut |
233 | =cut |
235 | |
234 | |
236 | sub fh { $_[0]->{fh} } |
235 | sub fh { $_[0]{fh} } |
237 | |
236 | |
238 | =item $handle->on_error ($cb) |
237 | =item $handle->on_error ($cb) |
239 | |
238 | |
240 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
239 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
241 | |
240 | |
… | |
… | |
297 | =cut |
296 | =cut |
298 | |
297 | |
299 | sub _drain_wbuf { |
298 | sub _drain_wbuf { |
300 | my ($self) = @_; |
299 | my ($self) = @_; |
301 | |
300 | |
302 | if (!$self->{ww} && length $self->{wbuf}) { |
301 | if (!$self->{_ww} && length $self->{wbuf}) { |
|
|
302 | |
303 | Scalar::Util::weaken $self; |
303 | Scalar::Util::weaken $self; |
|
|
304 | |
304 | my $cb = sub { |
305 | my $cb = sub { |
305 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
306 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
306 | |
307 | |
307 | if ($len >= 0) { |
308 | if ($len >= 0) { |
308 | substr $self->{wbuf}, 0, $len, ""; |
309 | substr $self->{wbuf}, 0, $len, ""; |
309 | |
310 | |
310 | $self->{on_drain}($self) |
311 | $self->{on_drain}($self) |
311 | if $self->{low_water_mark} >= length $self->{wbuf} |
312 | if $self->{low_water_mark} >= length $self->{wbuf} |
312 | && $self->{on_drain}; |
313 | && $self->{on_drain}; |
313 | |
314 | |
314 | delete $self->{ww} unless length $self->{wbuf}; |
315 | delete $self->{_ww} unless length $self->{wbuf}; |
315 | } elsif ($! != EAGAIN && $! != EINTR) { |
316 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
316 | $self->error; |
317 | $self->error; |
317 | } |
318 | } |
318 | }; |
319 | }; |
319 | |
320 | |
|
|
321 | # try to write data immediately |
|
|
322 | $cb->(); |
|
|
323 | |
|
|
324 | # if still data left in wbuf, we need to poll |
320 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
325 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
321 | |
326 | if length $self->{wbuf}; |
322 | $cb->($self); |
|
|
323 | }; |
327 | }; |
|
|
328 | } |
|
|
329 | |
|
|
330 | our %WH; |
|
|
331 | |
|
|
332 | sub register_write_type($$) { |
|
|
333 | $WH{$_[0]} = $_[1]; |
324 | } |
334 | } |
325 | |
335 | |
326 | sub push_write { |
336 | sub push_write { |
327 | my $self = shift; |
337 | my $self = shift; |
328 | |
338 | |
… | |
… | |
346 | =item $handle->unshift_write (type => @args) |
356 | =item $handle->unshift_write (type => @args) |
347 | |
357 | |
348 | Instead of formatting your data yourself, you can also let this module do |
358 | Instead of formatting your data yourself, you can also let this module do |
349 | the job by specifying a type and type-specific arguments. |
359 | the job by specifying a type and type-specific arguments. |
350 | |
360 | |
351 | Predefined types are: |
361 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
362 | drop by and tell us): |
352 | |
363 | |
353 | =over 4 |
364 | =over 4 |
354 | |
365 | |
355 | =item netstring => $string |
366 | =item netstring => $string |
356 | |
367 | |
357 | Formats the given value as netstring |
368 | Formats the given value as netstring |
358 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
369 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
359 | |
370 | |
|
|
371 | =back |
|
|
372 | |
360 | =cut |
373 | =cut |
361 | |
374 | |
362 | register_write_type netstring => sub { |
375 | register_write_type netstring => sub { |
363 | my ($self, $string) = @_; |
376 | my ($self, $string) = @_; |
364 | |
377 | |
365 | sprintf "%d:%s,", (length $string), $string |
378 | sprintf "%d:%s,", (length $string), $string |
366 | }; |
379 | }; |
367 | |
380 | |
368 | =back |
381 | =item json => $array_or_hashref |
369 | |
382 | |
370 | =cut |
383 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
371 | |
384 | |
|
|
385 | This function (not method) lets you add your own types to C<push_write>. |
|
|
386 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
387 | reference with the handle object and the remaining arguments. |
372 | |
388 | |
|
|
389 | The code reference is supposed to return a single octet string that will |
|
|
390 | be appended to the write buffer. |
|
|
391 | |
|
|
392 | Note that this is a function, and all types registered this way will be |
|
|
393 | global, so try to use unique names. |
|
|
394 | |
|
|
395 | =cut |
373 | |
396 | |
374 | ############################################################################# |
397 | ############################################################################# |
375 | |
398 | |
376 | =back |
399 | =back |
377 | |
400 | |
… | |
… | |
456 | |
479 | |
457 | if ( |
480 | if ( |
458 | defined $self->{rbuf_max} |
481 | defined $self->{rbuf_max} |
459 | && $self->{rbuf_max} < length $self->{rbuf} |
482 | && $self->{rbuf_max} < length $self->{rbuf} |
460 | ) { |
483 | ) { |
461 | $! = &Errno::ENOSPC; return $self->error; |
484 | $! = &Errno::ENOSPC; |
|
|
485 | $self->error; |
462 | } |
486 | } |
463 | |
487 | |
464 | return if $self->{in_drain}; |
488 | return if $self->{in_drain}; |
465 | local $self->{in_drain} = 1; |
489 | local $self->{in_drain} = 1; |
466 | |
490 | |
467 | while (my $len = length $self->{rbuf}) { |
491 | while (my $len = length $self->{rbuf}) { |
468 | no strict 'refs'; |
492 | no strict 'refs'; |
469 | if (my $cb = shift @{ $self->{queue} }) { |
493 | if (my $cb = shift @{ $self->{_queue} }) { |
470 | unless ($cb->($self)) { |
494 | unless ($cb->($self)) { |
471 | if ($self->{eof}) { |
495 | if ($self->{_eof}) { |
472 | # 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) |
473 | $! = &Errno::EPIPE; return $self->error; |
497 | $! = &Errno::EPIPE; |
|
|
498 | $self->error; |
474 | } |
499 | } |
475 | |
500 | |
476 | unshift @{ $self->{queue} }, $cb; |
501 | unshift @{ $self->{_queue} }, $cb; |
477 | return; |
502 | return; |
478 | } |
503 | } |
479 | } elsif ($self->{on_read}) { |
504 | } elsif ($self->{on_read}) { |
480 | $self->{on_read}($self); |
505 | $self->{on_read}($self); |
481 | |
506 | |
482 | if ( |
507 | if ( |
483 | $self->{eof} # if no further data will arrive |
508 | $self->{_eof} # if no further data will arrive |
484 | && $len == length $self->{rbuf} # and no data has been consumed |
509 | && $len == length $self->{rbuf} # and no data has been consumed |
485 | && !@{ $self->{queue} } # and the queue is still empty |
510 | && !@{ $self->{_queue} } # and the queue is still empty |
486 | && $self->{on_read} # and we still want to read data |
511 | && $self->{on_read} # and we still want to read data |
487 | ) { |
512 | ) { |
488 | # then no progress can be made |
513 | # then no progress can be made |
489 | $! = &Errno::EPIPE; return $self->error; |
514 | $! = &Errno::EPIPE; |
|
|
515 | $self->error; |
490 | } |
516 | } |
491 | } else { |
517 | } else { |
492 | # read side becomes idle |
518 | # read side becomes idle |
493 | delete $self->{rw}; |
519 | delete $self->{_rw}; |
494 | return; |
520 | return; |
495 | } |
521 | } |
496 | } |
522 | } |
497 | |
523 | |
498 | if ($self->{eof}) { |
524 | if ($self->{_eof}) { |
499 | $self->_shutdown; |
525 | $self->_shutdown; |
500 | $self->{on_eof}($self) |
526 | $self->{on_eof}($self) |
501 | if $self->{on_eof}; |
527 | if $self->{on_eof}; |
502 | } |
528 | } |
503 | } |
529 | } |
… | |
… | |
552 | interested in (which can be none at all) and return a true value. After returning |
578 | interested in (which can be none at all) and return a true value. After returning |
553 | true, it will be removed from the queue. |
579 | true, it will be removed from the queue. |
554 | |
580 | |
555 | =cut |
581 | =cut |
556 | |
582 | |
|
|
583 | our %RH; |
|
|
584 | |
|
|
585 | sub register_read_type($$) { |
|
|
586 | $RH{$_[0]} = $_[1]; |
|
|
587 | } |
|
|
588 | |
557 | sub push_read { |
589 | sub push_read { |
558 | my $self = shift; |
590 | my $self = shift; |
559 | my $cb = pop; |
591 | my $cb = pop; |
560 | |
592 | |
561 | if (@_) { |
593 | if (@_) { |
… | |
… | |
563 | |
595 | |
564 | $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") |
565 | ->($self, $cb, @_); |
597 | ->($self, $cb, @_); |
566 | } |
598 | } |
567 | |
599 | |
568 | push @{ $self->{queue} }, $cb; |
600 | push @{ $self->{_queue} }, $cb; |
569 | $self->_drain_rbuf; |
601 | $self->_drain_rbuf; |
570 | } |
602 | } |
571 | |
603 | |
572 | sub unshift_read { |
604 | sub unshift_read { |
573 | my $self = shift; |
605 | my $self = shift; |
… | |
… | |
579 | $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") |
580 | ->($self, $cb, @_); |
612 | ->($self, $cb, @_); |
581 | } |
613 | } |
582 | |
614 | |
583 | |
615 | |
584 | unshift @{ $self->{queue} }, $cb; |
616 | unshift @{ $self->{_queue} }, $cb; |
585 | $self->_drain_rbuf; |
617 | $self->_drain_rbuf; |
586 | } |
618 | } |
587 | |
619 | |
588 | =item $handle->push_read (type => @args, $cb) |
620 | =item $handle->push_read (type => @args, $cb) |
589 | |
621 | |
… | |
… | |
591 | |
623 | |
592 | Instead of providing a callback that parses the data itself you can chose |
624 | Instead of providing a callback that parses the data itself you can chose |
593 | between a number of predefined parsing formats, for chunks of data, lines |
625 | between a number of predefined parsing formats, for chunks of data, lines |
594 | etc. |
626 | etc. |
595 | |
627 | |
596 | The types currently supported are: |
628 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
629 | drop by and tell us): |
597 | |
630 | |
598 | =over 4 |
631 | =over 4 |
599 | |
632 | |
600 | =item chunk => $octets, $cb->($self, $data) |
633 | =item chunk => $octets, $cb->($self, $data) |
601 | |
634 | |
… | |
… | |
713 | |
746 | |
714 | 1 |
747 | 1 |
715 | } |
748 | } |
716 | }; |
749 | }; |
717 | |
750 | |
|
|
751 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
|
|
752 | |
|
|
753 | Makes a regex match against the regex object C<$accept> and returns |
|
|
754 | everything up to and including the match. |
|
|
755 | |
|
|
756 | Example: read a single line terminated by '\n'. |
|
|
757 | |
|
|
758 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
759 | |
|
|
760 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
761 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
762 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
763 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
764 | receive buffer overflow). |
|
|
765 | |
|
|
766 | Example: expect a single decimal number followed by whitespace, reject |
|
|
767 | anything else (not the use of an anchor). |
|
|
768 | |
|
|
769 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
770 | |
|
|
771 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
772 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
773 | and everything preceding and including the match will be accepted |
|
|
774 | unconditionally. This is useful to skip large amounts of data that you |
|
|
775 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
776 | have to start matching from the beginning. This is purely an optimisation |
|
|
777 | and is usually worth only when you expect more than a few kilobytes. |
|
|
778 | |
|
|
779 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
780 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
781 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
782 | it only accepts something not ending in either \015 or \012, as these are |
|
|
783 | required 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 | |
|
|
793 | register_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 | |
718 | =back |
822 | =back |
|
|
823 | |
|
|
824 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
|
|
825 | |
|
|
826 | This function (not method) lets you add your own types to C<push_read>. |
|
|
827 | |
|
|
828 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
829 | reference with the handle object, the callback and the remaining |
|
|
830 | arguments. |
|
|
831 | |
|
|
832 | The code reference is supposed to return a callback (usually a closure) |
|
|
833 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
834 | |
|
|
835 | It should invoke the passed callback when it is done reading (remember to |
|
|
836 | pass C<$self> as first argument as all other callbacks do that). |
|
|
837 | |
|
|
838 | Note that this is a function, and all types registered this way will be |
|
|
839 | global, so try to use unique names. |
|
|
840 | |
|
|
841 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
842 | search for C<register_read_type>)). |
719 | |
843 | |
720 | =item $handle->stop_read |
844 | =item $handle->stop_read |
721 | |
845 | |
722 | =item $handle->start_read |
846 | =item $handle->start_read |
723 | |
847 | |
… | |
… | |
729 | =cut |
853 | =cut |
730 | |
854 | |
731 | sub stop_read { |
855 | sub stop_read { |
732 | my ($self) = @_; |
856 | my ($self) = @_; |
733 | |
857 | |
734 | delete $self->{rw}; |
858 | delete $self->{_rw}; |
735 | } |
859 | } |
736 | |
860 | |
737 | sub start_read { |
861 | sub start_read { |
738 | my ($self) = @_; |
862 | my ($self) = @_; |
739 | |
863 | |
740 | unless ($self->{rw} || $self->{eof}) { |
864 | unless ($self->{_rw} || $self->{_eof}) { |
741 | Scalar::Util::weaken $self; |
865 | Scalar::Util::weaken $self; |
742 | |
866 | |
743 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
867 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
744 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
868 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
745 | 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; |
746 | |
870 | |
747 | if ($len > 0) { |
871 | if ($len > 0) { |
748 | $self->{filter_r} |
872 | $self->{filter_r} |
749 | ? $self->{filter_r}->($self, $rbuf) |
873 | ? $self->{filter_r}->($self, $rbuf) |
750 | : $self->_drain_rbuf; |
874 | : $self->_drain_rbuf; |
751 | |
875 | |
752 | } elsif (defined $len) { |
876 | } elsif (defined $len) { |
753 | delete $self->{rw}; |
877 | delete $self->{_rw}; |
754 | $self->{eof} = 1; |
878 | $self->{_eof} = 1; |
755 | $self->_drain_rbuf; |
879 | $self->_drain_rbuf; |
756 | |
880 | |
757 | } elsif ($! != EAGAIN && $! != EINTR) { |
881 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
758 | return $self->error; |
882 | return $self->error; |
759 | } |
883 | } |
760 | }); |
884 | }); |
761 | } |
885 | } |
762 | } |
886 | } |
763 | |
887 | |
764 | sub _dotls { |
888 | sub _dotls { |
765 | my ($self) = @_; |
889 | my ($self) = @_; |
766 | |
890 | |
767 | if (length $self->{tls_wbuf}) { |
891 | if (length $self->{_tls_wbuf}) { |
768 | 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) { |
769 | substr $self->{tls_wbuf}, 0, $len, ""; |
893 | substr $self->{_tls_wbuf}, 0, $len, ""; |
770 | } |
894 | } |
771 | } |
895 | } |
772 | |
896 | |
773 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
897 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
774 | $self->{wbuf} .= $buf; |
898 | $self->{wbuf} .= $buf; |
775 | $self->_drain_wbuf; |
899 | $self->_drain_wbuf; |
776 | } |
900 | } |
777 | |
901 | |
778 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
902 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
… | |
… | |
804 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
928 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
805 | |
929 | |
806 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
930 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
807 | used when AnyEvent::Handle has to create its own TLS connection object. |
931 | used when AnyEvent::Handle has to create its own TLS connection object. |
808 | |
932 | |
|
|
933 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
934 | call and can be used or changed to your liking. Note that the handshake |
|
|
935 | might have already started when this function returns. |
|
|
936 | |
809 | =cut |
937 | =cut |
810 | |
938 | |
811 | # TODO: maybe document... |
939 | # TODO: maybe document... |
812 | sub starttls { |
940 | sub starttls { |
813 | my ($self, $ssl, $ctx) = @_; |
941 | my ($self, $ssl, $ctx) = @_; |
… | |
… | |
828 | # but the openssl maintainers basically said: "trust us, it just works". |
956 | # but the openssl maintainers basically said: "trust us, it just works". |
829 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
957 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
830 | # and mismaintained ssleay-module doesn't even offer them). |
958 | # and mismaintained ssleay-module doesn't even offer them). |
831 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
959 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
832 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
960 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
833 | (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
961 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
834 | | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
962 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
835 | |
963 | |
836 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
964 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
837 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
965 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
838 | |
966 | |
839 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
967 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
840 | |
968 | |
841 | $self->{filter_w} = sub { |
969 | $self->{filter_w} = sub { |
842 | $_[0]{tls_wbuf} .= ${$_[1]}; |
970 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
843 | &_dotls; |
971 | &_dotls; |
844 | }; |
972 | }; |
845 | $self->{filter_r} = sub { |
973 | $self->{filter_r} = sub { |
846 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
974 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
847 | &_dotls; |
975 | &_dotls; |
848 | }; |
976 | }; |
849 | } |
977 | } |
850 | |
978 | |
851 | =item $handle->stoptls |
979 | =item $handle->stoptls |
… | |
… | |
857 | |
985 | |
858 | sub stoptls { |
986 | sub stoptls { |
859 | my ($self) = @_; |
987 | my ($self) = @_; |
860 | |
988 | |
861 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
989 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
990 | |
862 | delete $self->{tls_rbio}; |
991 | delete $self->{_rbio}; |
863 | delete $self->{tls_wbio}; |
992 | delete $self->{_wbio}; |
864 | delete $self->{tls_wbuf}; |
993 | delete $self->{_tls_wbuf}; |
865 | delete $self->{filter_r}; |
994 | delete $self->{filter_r}; |
866 | delete $self->{filter_w}; |
995 | delete $self->{filter_w}; |
867 | } |
996 | } |
868 | |
997 | |
869 | sub DESTROY { |
998 | sub DESTROY { |
… | |
… | |
907 | } |
1036 | } |
908 | } |
1037 | } |
909 | |
1038 | |
910 | =back |
1039 | =back |
911 | |
1040 | |
|
|
1041 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1042 | |
|
|
1043 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1044 | |
|
|
1045 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1046 | conventions: |
|
|
1047 | |
|
|
1048 | =over 4 |
|
|
1049 | |
|
|
1050 | =item * all constructor arguments become object members. |
|
|
1051 | |
|
|
1052 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1053 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
|
|
1054 | mutated 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 | |
|
|
1058 | All object members not explicitly documented (internal use) are prefixed |
|
|
1059 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1060 | for use for subclasses. |
|
|
1061 | |
|
|
1062 | =item * all members not documented here and not prefixed with an underscore |
|
|
1063 | are free to use in subclasses. |
|
|
1064 | |
|
|
1065 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1066 | member variables, but thats just life, at least it is documented. |
|
|
1067 | |
|
|
1068 | =back |
|
|
1069 | |
912 | =head1 AUTHOR |
1070 | =head1 AUTHOR |
913 | |
1071 | |
914 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1072 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
915 | |
1073 | |
916 | =cut |
1074 | =cut |