… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = 4.13; |
19 | our $VERSION = 4.22; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
76 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
77 | |
77 | |
78 | =item on_eof => $cb->($handle) |
78 | =item on_eof => $cb->($handle) |
79 | |
79 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
80 | Set the callback to be called when an end-of-file condition is detected, |
81 | i.e. in the case of a socket, when the other side has closed the |
81 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
82 | connection cleanly. |
83 | |
83 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
84 | While not mandatory, it is highly recommended to set an eof callback, |
85 | otherwise you might end up with a closed socket while you are still |
85 | otherwise you might end up with a closed socket while you are still |
… | |
… | |
105 | C<croak>. |
105 | C<croak>. |
106 | |
106 | |
107 | =item on_read => $cb->($handle) |
107 | =item on_read => $cb->($handle) |
108 | |
108 | |
109 | This sets the default read callback, which is called when data arrives |
109 | This sets the default read callback, which is called when data arrives |
110 | and no read request is in the queue. |
110 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
111 | callback will only be called when at least one octet of data is in the |
|
|
112 | read buffer). |
111 | |
113 | |
112 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
114 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
113 | method or access the C<$handle->{rbuf}> member directly. |
115 | method or access the C<$handle->{rbuf}> member directly. |
114 | |
116 | |
115 | When an EOF condition is detected then AnyEvent::Handle will first try to |
117 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
121 | |
123 | |
122 | This sets the callback that is called when the write buffer becomes empty |
124 | This sets the callback that is called when the write buffer becomes empty |
123 | (or when the callback is set and the buffer is empty already). |
125 | (or when the callback is set and the buffer is empty already). |
124 | |
126 | |
125 | To append to the write buffer, use the C<< ->push_write >> method. |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
128 | |
|
|
129 | This callback is useful when you don't want to put all of your write data |
|
|
130 | into the queue at once, for example, when you want to write the contents |
|
|
131 | of some file to the socket you might not want to read the whole file into |
|
|
132 | memory and push it into the queue, but instead only read more data from |
|
|
133 | the file when the write queue becomes empty. |
126 | |
134 | |
127 | =item timeout => $fractional_seconds |
135 | =item timeout => $fractional_seconds |
128 | |
136 | |
129 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
137 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
130 | seconds pass without a successful read or write on the underlying file |
138 | seconds pass without a successful read or write on the underlying file |
… | |
… | |
154 | be configured to accept only so-and-so much data that it cannot act on |
162 | be configured to accept only so-and-so much data that it cannot act on |
155 | (for example, when expecting a line, an attacker could send an unlimited |
163 | (for example, when expecting a line, an attacker could send an unlimited |
156 | amount of data without a callback ever being called as long as the line |
164 | amount of data without a callback ever being called as long as the line |
157 | isn't finished). |
165 | isn't finished). |
158 | |
166 | |
|
|
167 | =item autocork => <boolean> |
|
|
168 | |
|
|
169 | When disabled (the default), then C<push_write> will try to immediately |
|
|
170 | write the data to the handle if possible. This avoids having to register |
|
|
171 | a write watcher and wait for the next event loop iteration, but can be |
|
|
172 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
173 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
174 | |
|
|
175 | When enabled, then writes will always be queued till the next event loop |
|
|
176 | iteration. This is efficient when you do many small writes per iteration, |
|
|
177 | but less efficient when you do a single write only. |
|
|
178 | |
|
|
179 | =item no_delay => <boolean> |
|
|
180 | |
|
|
181 | When doing small writes on sockets, your operating system kernel might |
|
|
182 | wait a bit for more data before actually sending it out. This is called |
|
|
183 | the Nagle algorithm, and usually it is beneficial. |
|
|
184 | |
|
|
185 | In some situations you want as low a delay as possible, which cna be |
|
|
186 | accomplishd by setting this option to true. |
|
|
187 | |
|
|
188 | The default is your opertaing system's default behaviour, this option |
|
|
189 | explicitly enables or disables it, if possible. |
|
|
190 | |
159 | =item read_size => <bytes> |
191 | =item read_size => <bytes> |
160 | |
192 | |
161 | The default read block size (the amount of bytes this module will try to read |
193 | The default read block size (the amount of bytes this module will try to read |
162 | during each (loop iteration). Default: C<8192>. |
194 | during each (loop iteration). Default: C<8192>. |
163 | |
195 | |
164 | =item low_water_mark => <bytes> |
196 | =item low_water_mark => <bytes> |
165 | |
197 | |
166 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
198 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
167 | buffer: If the write reaches this size or gets even samller it is |
199 | buffer: If the write reaches this size or gets even samller it is |
168 | considered empty. |
200 | considered empty. |
|
|
201 | |
|
|
202 | =item linger => <seconds> |
|
|
203 | |
|
|
204 | If non-zero (default: C<3600>), then the destructor of the |
|
|
205 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
206 | data and will install a watcher that will write out this data. No errors |
|
|
207 | will be reported (this mostly matches how the operating system treats |
|
|
208 | outstanding data at socket close time). |
|
|
209 | |
|
|
210 | This will not work for partial TLS data that could not yet been |
|
|
211 | encoded. This data will be lost. |
169 | |
212 | |
170 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
213 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
171 | |
214 | |
172 | When this parameter is given, it enables TLS (SSL) mode, that means it |
215 | When this parameter is given, it enables TLS (SSL) mode, that means it |
173 | will start making tls handshake and will transparently encrypt/decrypt |
216 | will start making tls handshake and will transparently encrypt/decrypt |
… | |
… | |
182 | You can also provide your own TLS connection object, but you have |
225 | You can also provide your own TLS connection object, but you have |
183 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
226 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
184 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
227 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
185 | AnyEvent::Handle. |
228 | AnyEvent::Handle. |
186 | |
229 | |
187 | See the C<starttls> method if you need to start TLs negotiation later. |
230 | See the C<starttls> method if you need to start TLS negotiation later. |
188 | |
231 | |
189 | =item tls_ctx => $ssl_ctx |
232 | =item tls_ctx => $ssl_ctx |
190 | |
233 | |
191 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
234 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
192 | (unless a connection object was specified directly). If this parameter is |
235 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
227 | } |
270 | } |
228 | |
271 | |
229 | $self->{_activity} = AnyEvent->now; |
272 | $self->{_activity} = AnyEvent->now; |
230 | $self->_timeout; |
273 | $self->_timeout; |
231 | |
274 | |
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
275 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
233 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
276 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
277 | |
|
|
278 | $self->start_read |
|
|
279 | if $self->{on_read}; |
234 | |
280 | |
235 | $self |
281 | $self |
236 | } |
282 | } |
237 | |
283 | |
238 | sub _shutdown { |
284 | sub _shutdown { |
… | |
… | |
297 | |
343 | |
298 | =cut |
344 | =cut |
299 | |
345 | |
300 | sub on_timeout { |
346 | sub on_timeout { |
301 | $_[0]{on_timeout} = $_[1]; |
347 | $_[0]{on_timeout} = $_[1]; |
|
|
348 | } |
|
|
349 | |
|
|
350 | =item $handle->autocork ($boolean) |
|
|
351 | |
|
|
352 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
353 | constructor argument). |
|
|
354 | |
|
|
355 | =cut |
|
|
356 | |
|
|
357 | =item $handle->no_delay ($boolean) |
|
|
358 | |
|
|
359 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
360 | the same name for details). |
|
|
361 | |
|
|
362 | =cut |
|
|
363 | |
|
|
364 | sub no_delay { |
|
|
365 | $_[0]{no_delay} = $_[1]; |
|
|
366 | |
|
|
367 | eval { |
|
|
368 | local $SIG{__DIE__}; |
|
|
369 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
370 | }; |
302 | } |
371 | } |
303 | |
372 | |
304 | ############################################################################# |
373 | ############################################################################# |
305 | |
374 | |
306 | =item $handle->timeout ($seconds) |
375 | =item $handle->timeout ($seconds) |
… | |
… | |
421 | $self->_error ($!, 1); |
490 | $self->_error ($!, 1); |
422 | } |
491 | } |
423 | }; |
492 | }; |
424 | |
493 | |
425 | # try to write data immediately |
494 | # try to write data immediately |
426 | $cb->(); |
495 | $cb->() unless $self->{autocork}; |
427 | |
496 | |
428 | # if still data left in wbuf, we need to poll |
497 | # if still data left in wbuf, we need to poll |
429 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
498 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
430 | if length $self->{wbuf}; |
499 | if length $self->{wbuf}; |
431 | }; |
500 | }; |
… | |
… | |
476 | my ($self, $string) = @_; |
545 | my ($self, $string) = @_; |
477 | |
546 | |
478 | sprintf "%d:%s,", (length $string), $string |
547 | sprintf "%d:%s,", (length $string), $string |
479 | }; |
548 | }; |
480 | |
549 | |
|
|
550 | =item packstring => $format, $data |
|
|
551 | |
|
|
552 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
553 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
554 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
555 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
556 | |
|
|
557 | =cut |
|
|
558 | |
|
|
559 | register_write_type packstring => sub { |
|
|
560 | my ($self, $format, $string) = @_; |
|
|
561 | |
|
|
562 | pack "$format/a*", $string |
|
|
563 | }; |
|
|
564 | |
481 | =item json => $array_or_hashref |
565 | =item json => $array_or_hashref |
482 | |
566 | |
483 | Encodes the given hash or array reference into a JSON object. Unless you |
567 | Encodes the given hash or array reference into a JSON object. Unless you |
484 | provide your own JSON object, this means it will be encoded to JSON text |
568 | provide your own JSON object, this means it will be encoded to JSON text |
485 | in UTF-8. |
569 | in UTF-8. |
… | |
… | |
517 | |
601 | |
518 | $self->{json} ? $self->{json}->encode ($ref) |
602 | $self->{json} ? $self->{json}->encode ($ref) |
519 | : JSON::encode_json ($ref) |
603 | : JSON::encode_json ($ref) |
520 | }; |
604 | }; |
521 | |
605 | |
|
|
606 | =item storable => $reference |
|
|
607 | |
|
|
608 | Freezes the given reference using L<Storable> and writes it to the |
|
|
609 | handle. Uses the C<nfreeze> format. |
|
|
610 | |
|
|
611 | =cut |
|
|
612 | |
|
|
613 | register_write_type storable => sub { |
|
|
614 | my ($self, $ref) = @_; |
|
|
615 | |
|
|
616 | require Storable; |
|
|
617 | |
|
|
618 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
619 | }; |
|
|
620 | |
522 | =back |
621 | =back |
523 | |
622 | |
524 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
623 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
525 | |
624 | |
526 | This function (not method) lets you add your own types to C<push_write>. |
625 | This function (not method) lets you add your own types to C<push_write>. |
… | |
… | |
548 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
647 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
549 | a queue. |
648 | a queue. |
550 | |
649 | |
551 | In the simple case, you just install an C<on_read> callback and whenever |
650 | In the simple case, you just install an C<on_read> callback and whenever |
552 | new data arrives, it will be called. You can then remove some data (if |
651 | new data arrives, it will be called. You can then remove some data (if |
553 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
652 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
554 | or not. |
653 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
654 | partial message has been received so far). |
555 | |
655 | |
556 | In the more complex case, you want to queue multiple callbacks. In this |
656 | In the more complex case, you want to queue multiple callbacks. In this |
557 | case, AnyEvent::Handle will call the first queued callback each time new |
657 | case, AnyEvent::Handle will call the first queued callback each time new |
558 | data arrives and removes it when it has done its job (see C<push_read>, |
658 | data arrives (also the first time it is queued) and removes it when it has |
559 | below). |
659 | done its job (see C<push_read>, below). |
560 | |
660 | |
561 | This way you can, for example, push three line-reads, followed by reading |
661 | This way you can, for example, push three line-reads, followed by reading |
562 | a chunk of data, and AnyEvent::Handle will execute them in order. |
662 | a chunk of data, and AnyEvent::Handle will execute them in order. |
563 | |
663 | |
564 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
664 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
577 | # handle xml |
677 | # handle xml |
578 | }); |
678 | }); |
579 | }); |
679 | }); |
580 | }); |
680 | }); |
581 | |
681 | |
582 | Example 2: Implement a client for a protocol that replies either with |
682 | Example 2: Implement a client for a protocol that replies either with "OK" |
583 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
683 | and another line or "ERROR" for the first request that is sent, and 64 |
584 | second request. Due tot he availability of a full queue, we can just |
684 | bytes for the second request. Due to the availability of a queue, we can |
585 | pipeline sending both requests and manipulate the queue as necessary in |
685 | just pipeline sending both requests and manipulate the queue as necessary |
586 | the callbacks: |
686 | in the callbacks. |
587 | |
687 | |
588 | # request one |
688 | When the first callback is called and sees an "OK" response, it will |
|
|
689 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
690 | 64-byte chunk callback. |
|
|
691 | |
|
|
692 | # request one, returns either "OK + extra line" or "ERROR" |
589 | $handle->push_write ("request 1\015\012"); |
693 | $handle->push_write ("request 1\015\012"); |
590 | |
694 | |
591 | # we expect "ERROR" or "OK" as response, so push a line read |
695 | # we expect "ERROR" or "OK" as response, so push a line read |
592 | $handle->push_read (line => sub { |
696 | $handle->push_read (line => sub { |
593 | # if we got an "OK", we have to _prepend_ another line, |
697 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
600 | ... |
704 | ... |
601 | }); |
705 | }); |
602 | } |
706 | } |
603 | }); |
707 | }); |
604 | |
708 | |
605 | # request two |
709 | # request two, simply returns 64 octets |
606 | $handle->push_write ("request 2\015\012"); |
710 | $handle->push_write ("request 2\015\012"); |
607 | |
711 | |
608 | # simply read 64 bytes, always |
712 | # simply read 64 bytes, always |
609 | $handle->push_read (chunk => 64, sub { |
713 | $handle->push_read (chunk => 64, sub { |
610 | my $response = $_[1]; |
714 | my $response = $_[1]; |
… | |
… | |
634 | |
738 | |
635 | if (my $cb = shift @{ $self->{_queue} }) { |
739 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | unless ($cb->($self)) { |
740 | unless ($cb->($self)) { |
637 | if ($self->{_eof}) { |
741 | if ($self->{_eof}) { |
638 | # no progress can be made (not enough data and no data forthcoming) |
742 | # no progress can be made (not enough data and no data forthcoming) |
639 | return $self->_error (&Errno::EPIPE, 1); |
743 | $self->_error (&Errno::EPIPE, 1), last; |
640 | } |
744 | } |
641 | |
745 | |
642 | unshift @{ $self->{_queue} }, $cb; |
746 | unshift @{ $self->{_queue} }, $cb; |
643 | last; |
747 | last; |
644 | } |
748 | } |
645 | } elsif ($self->{on_read}) { |
749 | } elsif ($self->{on_read}) { |
|
|
750 | last unless $len; |
|
|
751 | |
646 | $self->{on_read}($self); |
752 | $self->{on_read}($self); |
647 | |
753 | |
648 | if ( |
754 | if ( |
649 | $len == length $self->{rbuf} # if no data has been consumed |
755 | $len == length $self->{rbuf} # if no data has been consumed |
650 | && !@{ $self->{_queue} } # and the queue is still empty |
756 | && !@{ $self->{_queue} } # and the queue is still empty |
651 | && $self->{on_read} # but we still have on_read |
757 | && $self->{on_read} # but we still have on_read |
652 | ) { |
758 | ) { |
653 | # no further data will arrive |
759 | # no further data will arrive |
654 | # so no progress can be made |
760 | # so no progress can be made |
655 | return $self->_error (&Errno::EPIPE, 1) |
761 | $self->_error (&Errno::EPIPE, 1), last |
656 | if $self->{_eof}; |
762 | if $self->{_eof}; |
657 | |
763 | |
658 | last; # more data might arrive |
764 | last; # more data might arrive |
659 | } |
765 | } |
660 | } else { |
766 | } else { |
… | |
… | |
799 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
905 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
800 | 1 |
906 | 1 |
801 | } |
907 | } |
802 | }; |
908 | }; |
803 | |
909 | |
804 | # compatibility with older API |
|
|
805 | sub push_read_chunk { |
|
|
806 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
807 | } |
|
|
808 | |
|
|
809 | sub unshift_read_chunk { |
|
|
810 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
811 | } |
|
|
812 | |
|
|
813 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
910 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
814 | |
911 | |
815 | The callback will be called only once a full line (including the end of |
912 | The callback will be called only once a full line (including the end of |
816 | line marker, C<$eol>) has been read. This line (excluding the end of line |
913 | line marker, C<$eol>) has been read. This line (excluding the end of line |
817 | marker) will be passed to the callback as second argument (C<$line>), and |
914 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
832 | =cut |
929 | =cut |
833 | |
930 | |
834 | register_read_type line => sub { |
931 | register_read_type line => sub { |
835 | my ($self, $cb, $eol) = @_; |
932 | my ($self, $cb, $eol) = @_; |
836 | |
933 | |
837 | $eol = qr|(\015?\012)| if @_ < 3; |
934 | if (@_ < 3) { |
838 | $eol = quotemeta $eol unless ref $eol; |
935 | # this is more than twice as fast as the generic code below |
839 | $eol = qr|^(.*?)($eol)|s; |
|
|
840 | |
|
|
841 | sub { |
936 | sub { |
842 | $_[0]{rbuf} =~ s/$eol// or return; |
937 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
843 | |
938 | |
844 | $cb->($_[0], $1, $2); |
939 | $cb->($_[0], $1, $2); |
845 | 1 |
|
|
846 | } |
|
|
847 | }; |
|
|
848 | |
|
|
849 | # compatibility with older API |
|
|
850 | sub push_read_line { |
|
|
851 | my $self = shift; |
|
|
852 | $self->push_read (line => @_); |
|
|
853 | } |
|
|
854 | |
|
|
855 | sub unshift_read_line { |
|
|
856 | my $self = shift; |
|
|
857 | $self->unshift_read (line => @_); |
|
|
858 | } |
|
|
859 | |
|
|
860 | =item netstring => $cb->($handle, $string) |
|
|
861 | |
|
|
862 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
863 | |
|
|
864 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
865 | |
|
|
866 | =cut |
|
|
867 | |
|
|
868 | register_read_type netstring => sub { |
|
|
869 | my ($self, $cb) = @_; |
|
|
870 | |
|
|
871 | sub { |
|
|
872 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
873 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
874 | $self->_error (&Errno::EBADMSG); |
|
|
875 | } |
940 | 1 |
876 | return; |
|
|
877 | } |
941 | } |
|
|
942 | } else { |
|
|
943 | $eol = quotemeta $eol unless ref $eol; |
|
|
944 | $eol = qr|^(.*?)($eol)|s; |
878 | |
945 | |
879 | my $len = $1; |
946 | sub { |
|
|
947 | $_[0]{rbuf} =~ s/$eol// or return; |
880 | |
948 | |
881 | $self->unshift_read (chunk => $len, sub { |
949 | $cb->($_[0], $1, $2); |
882 | my $string = $_[1]; |
|
|
883 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
884 | if ($_[1] eq ",") { |
|
|
885 | $cb->($_[0], $string); |
|
|
886 | } else { |
|
|
887 | $self->_error (&Errno::EBADMSG); |
|
|
888 | } |
|
|
889 | }); |
950 | 1 |
890 | }); |
951 | } |
891 | |
|
|
892 | 1 |
|
|
893 | } |
952 | } |
894 | }; |
953 | }; |
895 | |
954 | |
896 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
955 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
897 | |
956 | |
… | |
… | |
961 | |
1020 | |
962 | () |
1021 | () |
963 | } |
1022 | } |
964 | }; |
1023 | }; |
965 | |
1024 | |
|
|
1025 | =item netstring => $cb->($handle, $string) |
|
|
1026 | |
|
|
1027 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1028 | |
|
|
1029 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1030 | |
|
|
1031 | =cut |
|
|
1032 | |
|
|
1033 | register_read_type netstring => sub { |
|
|
1034 | my ($self, $cb) = @_; |
|
|
1035 | |
|
|
1036 | sub { |
|
|
1037 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1038 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1039 | $self->_error (&Errno::EBADMSG); |
|
|
1040 | } |
|
|
1041 | return; |
|
|
1042 | } |
|
|
1043 | |
|
|
1044 | my $len = $1; |
|
|
1045 | |
|
|
1046 | $self->unshift_read (chunk => $len, sub { |
|
|
1047 | my $string = $_[1]; |
|
|
1048 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1049 | if ($_[1] eq ",") { |
|
|
1050 | $cb->($_[0], $string); |
|
|
1051 | } else { |
|
|
1052 | $self->_error (&Errno::EBADMSG); |
|
|
1053 | } |
|
|
1054 | }); |
|
|
1055 | }); |
|
|
1056 | |
|
|
1057 | 1 |
|
|
1058 | } |
|
|
1059 | }; |
|
|
1060 | |
|
|
1061 | =item packstring => $format, $cb->($handle, $string) |
|
|
1062 | |
|
|
1063 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1064 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1065 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1066 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1067 | |
|
|
1068 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1069 | |
|
|
1070 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1071 | format (very efficient). |
|
|
1072 | |
|
|
1073 | $handle->push_read (packstring => "w", sub { |
|
|
1074 | my ($handle, $data) = @_; |
|
|
1075 | }); |
|
|
1076 | |
|
|
1077 | =cut |
|
|
1078 | |
|
|
1079 | register_read_type packstring => sub { |
|
|
1080 | my ($self, $cb, $format) = @_; |
|
|
1081 | |
|
|
1082 | sub { |
|
|
1083 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1084 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1085 | or return; |
|
|
1086 | |
|
|
1087 | $format = length pack $format, $len; |
|
|
1088 | |
|
|
1089 | # bypass unshift if we already have the remaining chunk |
|
|
1090 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1091 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1092 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1093 | $cb->($_[0], $data); |
|
|
1094 | } else { |
|
|
1095 | # remove prefix |
|
|
1096 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1097 | |
|
|
1098 | # read remaining chunk |
|
|
1099 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1100 | } |
|
|
1101 | |
|
|
1102 | 1 |
|
|
1103 | } |
|
|
1104 | }; |
|
|
1105 | |
966 | =item json => $cb->($handle, $hash_or_arrayref) |
1106 | =item json => $cb->($handle, $hash_or_arrayref) |
967 | |
1107 | |
968 | Reads a JSON object or array, decodes it and passes it to the callback. |
1108 | Reads a JSON object or array, decodes it and passes it to the callback. |
969 | |
1109 | |
970 | If a C<json> object was passed to the constructor, then that will be used |
1110 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
980 | the C<json> write type description, above, for an actual example. |
1120 | the C<json> write type description, above, for an actual example. |
981 | |
1121 | |
982 | =cut |
1122 | =cut |
983 | |
1123 | |
984 | register_read_type json => sub { |
1124 | register_read_type json => sub { |
985 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1125 | my ($self, $cb) = @_; |
986 | |
1126 | |
987 | require JSON; |
1127 | require JSON; |
988 | |
1128 | |
989 | my $data; |
1129 | my $data; |
990 | my $rbuf = \$self->{rbuf}; |
1130 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1002 | 1 |
1142 | 1 |
1003 | } else { |
1143 | } else { |
1004 | $self->{rbuf} = ""; |
1144 | $self->{rbuf} = ""; |
1005 | () |
1145 | () |
1006 | } |
1146 | } |
|
|
1147 | } |
|
|
1148 | }; |
|
|
1149 | |
|
|
1150 | =item storable => $cb->($handle, $ref) |
|
|
1151 | |
|
|
1152 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1153 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1154 | data). |
|
|
1155 | |
|
|
1156 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1157 | |
|
|
1158 | =cut |
|
|
1159 | |
|
|
1160 | register_read_type storable => sub { |
|
|
1161 | my ($self, $cb) = @_; |
|
|
1162 | |
|
|
1163 | require Storable; |
|
|
1164 | |
|
|
1165 | sub { |
|
|
1166 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1167 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1168 | or return; |
|
|
1169 | |
|
|
1170 | my $format = length pack "w", $len; |
|
|
1171 | |
|
|
1172 | # bypass unshift if we already have the remaining chunk |
|
|
1173 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1174 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1175 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1176 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1177 | } else { |
|
|
1178 | # remove prefix |
|
|
1179 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1180 | |
|
|
1181 | # read remaining chunk |
|
|
1182 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1183 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1184 | $cb->($_[0], $ref); |
|
|
1185 | } else { |
|
|
1186 | $self->_error (&Errno::EBADMSG); |
|
|
1187 | } |
|
|
1188 | }); |
|
|
1189 | } |
|
|
1190 | |
|
|
1191 | 1 |
1007 | } |
1192 | } |
1008 | }; |
1193 | }; |
1009 | |
1194 | |
1010 | =back |
1195 | =back |
1011 | |
1196 | |
… | |
… | |
1199 | |
1384 | |
1200 | sub DESTROY { |
1385 | sub DESTROY { |
1201 | my $self = shift; |
1386 | my $self = shift; |
1202 | |
1387 | |
1203 | $self->stoptls; |
1388 | $self->stoptls; |
|
|
1389 | |
|
|
1390 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1391 | |
|
|
1392 | if ($linger && length $self->{wbuf}) { |
|
|
1393 | my $fh = delete $self->{fh}; |
|
|
1394 | my $wbuf = delete $self->{wbuf}; |
|
|
1395 | |
|
|
1396 | my @linger; |
|
|
1397 | |
|
|
1398 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1399 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1400 | |
|
|
1401 | if ($len > 0) { |
|
|
1402 | substr $wbuf, 0, $len, ""; |
|
|
1403 | } else { |
|
|
1404 | @linger = (); # end |
|
|
1405 | } |
|
|
1406 | }); |
|
|
1407 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1408 | @linger = (); |
|
|
1409 | }); |
|
|
1410 | } |
1204 | } |
1411 | } |
1205 | |
1412 | |
1206 | =item AnyEvent::Handle::TLS_CTX |
1413 | =item AnyEvent::Handle::TLS_CTX |
1207 | |
1414 | |
1208 | This function creates and returns the Net::SSLeay::CTX object used by |
1415 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1250 | =over 4 |
1457 | =over 4 |
1251 | |
1458 | |
1252 | =item * all constructor arguments become object members. |
1459 | =item * all constructor arguments become object members. |
1253 | |
1460 | |
1254 | At least initially, when you pass a C<tls>-argument to the constructor it |
1461 | At least initially, when you pass a C<tls>-argument to the constructor it |
1255 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1462 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1256 | mutated later on (for example C<tls> will hold the TLS connection object). |
1463 | mutated later on (for example C<tls> will hold the TLS connection object). |
1257 | |
1464 | |
1258 | =item * other object member names are prefixed with an C<_>. |
1465 | =item * other object member names are prefixed with an C<_>. |
1259 | |
1466 | |
1260 | All object members not explicitly documented (internal use) are prefixed |
1467 | All object members not explicitly documented (internal use) are prefixed |