1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
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.14; |
19 | our $VERSION = 4.232; |
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 | For sockets, this just means that the other side has stopped sending data, |
|
|
85 | you can still try to write data, and, in fact, one can return from the eof |
|
|
86 | callback and continue writing data, as only the read part has been shut |
|
|
87 | down. |
|
|
88 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
89 | While not mandatory, it is I<highly> recommended to set an eof callback, |
85 | otherwise you might end up with a closed socket while you are still |
90 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
91 | waiting for data. |
|
|
92 | |
|
|
93 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
94 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
95 | |
88 | =item on_error => $cb->($handle, $fatal) |
96 | =item on_error => $cb->($handle, $fatal) |
89 | |
97 | |
90 | This is the error callback, which is called when, well, some error |
98 | This is the error callback, which is called when, well, some error |
91 | occured, such as not being able to resolve the hostname, failure to |
99 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
100 | connect or a read error. |
93 | |
101 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
102 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
95 | fatal errors the handle object will be shut down and will not be |
103 | fatal errors the handle object will be shut down and will not be usable |
|
|
104 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
|
|
105 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
106 | (C<EPIPE>) or I/O errors. |
|
|
107 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
108 | Non-fatal errors can be retried by simply returning, but it is recommended |
97 | recommended to simply ignore this parameter and instead abondon the handle |
109 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
110 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
111 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
112 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
113 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
114 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
115 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
116 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
123 | |
136 | |
124 | This sets the callback that is called when the write buffer becomes empty |
137 | This sets the callback that is called when the write buffer becomes empty |
125 | (or when the callback is set and the buffer is empty already). |
138 | (or when the callback is set and the buffer is empty already). |
126 | |
139 | |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
140 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
141 | |
|
|
142 | This callback is useful when you don't want to put all of your write data |
|
|
143 | into the queue at once, for example, when you want to write the contents |
|
|
144 | of some file to the socket you might not want to read the whole file into |
|
|
145 | memory and push it into the queue, but instead only read more data from |
|
|
146 | the file when the write queue becomes empty. |
128 | |
147 | |
129 | =item timeout => $fractional_seconds |
148 | =item timeout => $fractional_seconds |
130 | |
149 | |
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
150 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
132 | seconds pass without a successful read or write on the underlying file |
151 | seconds pass without a successful read or write on the underlying file |
… | |
… | |
156 | be configured to accept only so-and-so much data that it cannot act on |
175 | be configured to accept only so-and-so much data that it cannot act on |
157 | (for example, when expecting a line, an attacker could send an unlimited |
176 | (for example, when expecting a line, an attacker could send an unlimited |
158 | amount of data without a callback ever being called as long as the line |
177 | amount of data without a callback ever being called as long as the line |
159 | isn't finished). |
178 | isn't finished). |
160 | |
179 | |
|
|
180 | =item autocork => <boolean> |
|
|
181 | |
|
|
182 | When disabled (the default), then C<push_write> will try to immediately |
|
|
183 | write the data to the handle if possible. This avoids having to register |
|
|
184 | a write watcher and wait for the next event loop iteration, but can be |
|
|
185 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
186 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
187 | |
|
|
188 | When enabled, then writes will always be queued till the next event loop |
|
|
189 | iteration. This is efficient when you do many small writes per iteration, |
|
|
190 | but less efficient when you do a single write only. |
|
|
191 | |
|
|
192 | =item no_delay => <boolean> |
|
|
193 | |
|
|
194 | When doing small writes on sockets, your operating system kernel might |
|
|
195 | wait a bit for more data before actually sending it out. This is called |
|
|
196 | the Nagle algorithm, and usually it is beneficial. |
|
|
197 | |
|
|
198 | In some situations you want as low a delay as possible, which cna be |
|
|
199 | accomplishd by setting this option to true. |
|
|
200 | |
|
|
201 | The default is your opertaing system's default behaviour, this option |
|
|
202 | explicitly enables or disables it, if possible. |
|
|
203 | |
161 | =item read_size => <bytes> |
204 | =item read_size => <bytes> |
162 | |
205 | |
163 | The default read block size (the amount of bytes this module will try to read |
206 | The default read block size (the amount of bytes this module will try to read |
164 | during each (loop iteration). Default: C<8192>. |
207 | during each (loop iteration). Default: C<8192>. |
165 | |
208 | |
166 | =item low_water_mark => <bytes> |
209 | =item low_water_mark => <bytes> |
167 | |
210 | |
168 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
211 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
169 | buffer: If the write reaches this size or gets even samller it is |
212 | buffer: If the write reaches this size or gets even samller it is |
170 | considered empty. |
213 | considered empty. |
|
|
214 | |
|
|
215 | =item linger => <seconds> |
|
|
216 | |
|
|
217 | If non-zero (default: C<3600>), then the destructor of the |
|
|
218 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
219 | data and will install a watcher that will write out this data. No errors |
|
|
220 | will be reported (this mostly matches how the operating system treats |
|
|
221 | outstanding data at socket close time). |
|
|
222 | |
|
|
223 | This will not work for partial TLS data that could not yet been |
|
|
224 | encoded. This data will be lost. |
171 | |
225 | |
172 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
226 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
173 | |
227 | |
174 | When this parameter is given, it enables TLS (SSL) mode, that means it |
228 | When this parameter is given, it enables TLS (SSL) mode, that means it |
175 | will start making tls handshake and will transparently encrypt/decrypt |
229 | will start making tls handshake and will transparently encrypt/decrypt |
… | |
… | |
184 | You can also provide your own TLS connection object, but you have |
238 | You can also provide your own TLS connection object, but you have |
185 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
239 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
186 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
240 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
187 | AnyEvent::Handle. |
241 | AnyEvent::Handle. |
188 | |
242 | |
189 | See the C<starttls> method if you need to start TLs negotiation later. |
243 | See the C<starttls> method if you need to start TLS negotiation later. |
190 | |
244 | |
191 | =item tls_ctx => $ssl_ctx |
245 | =item tls_ctx => $ssl_ctx |
192 | |
246 | |
193 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
247 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
194 | (unless a connection object was specified directly). If this parameter is |
248 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
229 | } |
283 | } |
230 | |
284 | |
231 | $self->{_activity} = AnyEvent->now; |
285 | $self->{_activity} = AnyEvent->now; |
232 | $self->_timeout; |
286 | $self->_timeout; |
233 | |
287 | |
234 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
288 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
289 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
290 | |
|
|
291 | $self->start_read |
|
|
292 | if $self->{on_read}; |
235 | |
293 | |
236 | $self |
294 | $self |
237 | } |
295 | } |
238 | |
296 | |
239 | sub _shutdown { |
297 | sub _shutdown { |
… | |
… | |
243 | delete $self->{_rw}; |
301 | delete $self->{_rw}; |
244 | delete $self->{_ww}; |
302 | delete $self->{_ww}; |
245 | delete $self->{fh}; |
303 | delete $self->{fh}; |
246 | |
304 | |
247 | $self->stoptls; |
305 | $self->stoptls; |
|
|
306 | |
|
|
307 | delete $self->{on_read}; |
|
|
308 | delete $self->{_queue}; |
248 | } |
309 | } |
249 | |
310 | |
250 | sub _error { |
311 | sub _error { |
251 | my ($self, $errno, $fatal) = @_; |
312 | my ($self, $errno, $fatal) = @_; |
252 | |
313 | |
… | |
… | |
298 | |
359 | |
299 | =cut |
360 | =cut |
300 | |
361 | |
301 | sub on_timeout { |
362 | sub on_timeout { |
302 | $_[0]{on_timeout} = $_[1]; |
363 | $_[0]{on_timeout} = $_[1]; |
|
|
364 | } |
|
|
365 | |
|
|
366 | =item $handle->autocork ($boolean) |
|
|
367 | |
|
|
368 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
369 | constructor argument). |
|
|
370 | |
|
|
371 | =cut |
|
|
372 | |
|
|
373 | =item $handle->no_delay ($boolean) |
|
|
374 | |
|
|
375 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
376 | the same name for details). |
|
|
377 | |
|
|
378 | =cut |
|
|
379 | |
|
|
380 | sub no_delay { |
|
|
381 | $_[0]{no_delay} = $_[1]; |
|
|
382 | |
|
|
383 | eval { |
|
|
384 | local $SIG{__DIE__}; |
|
|
385 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
386 | }; |
303 | } |
387 | } |
304 | |
388 | |
305 | ############################################################################# |
389 | ############################################################################# |
306 | |
390 | |
307 | =item $handle->timeout ($seconds) |
391 | =item $handle->timeout ($seconds) |
… | |
… | |
422 | $self->_error ($!, 1); |
506 | $self->_error ($!, 1); |
423 | } |
507 | } |
424 | }; |
508 | }; |
425 | |
509 | |
426 | # try to write data immediately |
510 | # try to write data immediately |
427 | $cb->(); |
511 | $cb->() unless $self->{autocork}; |
428 | |
512 | |
429 | # if still data left in wbuf, we need to poll |
513 | # if still data left in wbuf, we need to poll |
430 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
514 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
431 | if length $self->{wbuf}; |
515 | if length $self->{wbuf}; |
432 | }; |
516 | }; |
… | |
… | |
489 | =cut |
573 | =cut |
490 | |
574 | |
491 | register_write_type packstring => sub { |
575 | register_write_type packstring => sub { |
492 | my ($self, $format, $string) = @_; |
576 | my ($self, $format, $string) = @_; |
493 | |
577 | |
494 | pack "$format/a", $string |
578 | pack "$format/a*", $string |
495 | }; |
579 | }; |
496 | |
580 | |
497 | =item json => $array_or_hashref |
581 | =item json => $array_or_hashref |
498 | |
582 | |
499 | Encodes the given hash or array reference into a JSON object. Unless you |
583 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
533 | |
617 | |
534 | $self->{json} ? $self->{json}->encode ($ref) |
618 | $self->{json} ? $self->{json}->encode ($ref) |
535 | : JSON::encode_json ($ref) |
619 | : JSON::encode_json ($ref) |
536 | }; |
620 | }; |
537 | |
621 | |
|
|
622 | =item storable => $reference |
|
|
623 | |
|
|
624 | Freezes the given reference using L<Storable> and writes it to the |
|
|
625 | handle. Uses the C<nfreeze> format. |
|
|
626 | |
|
|
627 | =cut |
|
|
628 | |
|
|
629 | register_write_type storable => sub { |
|
|
630 | my ($self, $ref) = @_; |
|
|
631 | |
|
|
632 | require Storable; |
|
|
633 | |
|
|
634 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
635 | }; |
|
|
636 | |
538 | =back |
637 | =back |
539 | |
638 | |
540 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
639 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
541 | |
640 | |
542 | This function (not method) lets you add your own types to C<push_write>. |
641 | This function (not method) lets you add your own types to C<push_write>. |
… | |
… | |
564 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
663 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
565 | a queue. |
664 | a queue. |
566 | |
665 | |
567 | In the simple case, you just install an C<on_read> callback and whenever |
666 | In the simple case, you just install an C<on_read> callback and whenever |
568 | new data arrives, it will be called. You can then remove some data (if |
667 | new data arrives, it will be called. You can then remove some data (if |
569 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
668 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
570 | or not. |
669 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
670 | partial message has been received so far). |
571 | |
671 | |
572 | In the more complex case, you want to queue multiple callbacks. In this |
672 | In the more complex case, you want to queue multiple callbacks. In this |
573 | case, AnyEvent::Handle will call the first queued callback each time new |
673 | case, AnyEvent::Handle will call the first queued callback each time new |
574 | data arrives (also the first time it is queued) and removes it when it has |
674 | data arrives (also the first time it is queued) and removes it when it has |
575 | done its job (see C<push_read>, below). |
675 | done its job (see C<push_read>, below). |
… | |
… | |
593 | # handle xml |
693 | # handle xml |
594 | }); |
694 | }); |
595 | }); |
695 | }); |
596 | }); |
696 | }); |
597 | |
697 | |
598 | Example 2: Implement a client for a protocol that replies either with |
698 | Example 2: Implement a client for a protocol that replies either with "OK" |
599 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
699 | and another line or "ERROR" for the first request that is sent, and 64 |
600 | second request. Due tot he availability of a full queue, we can just |
700 | bytes for the second request. Due to the availability of a queue, we can |
601 | pipeline sending both requests and manipulate the queue as necessary in |
701 | just pipeline sending both requests and manipulate the queue as necessary |
602 | the callbacks: |
702 | in the callbacks. |
603 | |
703 | |
604 | # request one |
704 | When the first callback is called and sees an "OK" response, it will |
|
|
705 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
706 | 64-byte chunk callback. |
|
|
707 | |
|
|
708 | # request one, returns either "OK + extra line" or "ERROR" |
605 | $handle->push_write ("request 1\015\012"); |
709 | $handle->push_write ("request 1\015\012"); |
606 | |
710 | |
607 | # we expect "ERROR" or "OK" as response, so push a line read |
711 | # we expect "ERROR" or "OK" as response, so push a line read |
608 | $handle->push_read (line => sub { |
712 | $handle->push_read (line => sub { |
609 | # if we got an "OK", we have to _prepend_ another line, |
713 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
616 | ... |
720 | ... |
617 | }); |
721 | }); |
618 | } |
722 | } |
619 | }); |
723 | }); |
620 | |
724 | |
621 | # request two |
725 | # request two, simply returns 64 octets |
622 | $handle->push_write ("request 2\015\012"); |
726 | $handle->push_write ("request 2\015\012"); |
623 | |
727 | |
624 | # simply read 64 bytes, always |
728 | # simply read 64 bytes, always |
625 | $handle->push_read (chunk => 64, sub { |
729 | $handle->push_read (chunk => 64, sub { |
626 | my $response = $_[1]; |
730 | my $response = $_[1]; |
… | |
… | |
638 | |
742 | |
639 | if ( |
743 | if ( |
640 | defined $self->{rbuf_max} |
744 | defined $self->{rbuf_max} |
641 | && $self->{rbuf_max} < length $self->{rbuf} |
745 | && $self->{rbuf_max} < length $self->{rbuf} |
642 | ) { |
746 | ) { |
643 | return $self->_error (&Errno::ENOSPC, 1); |
747 | $self->_error (&Errno::ENOSPC, 1), return; |
644 | } |
748 | } |
645 | |
749 | |
646 | while () { |
750 | while () { |
647 | no strict 'refs'; |
|
|
648 | |
|
|
649 | my $len = length $self->{rbuf}; |
751 | my $len = length $self->{rbuf}; |
650 | |
752 | |
651 | if (my $cb = shift @{ $self->{_queue} }) { |
753 | if (my $cb = shift @{ $self->{_queue} }) { |
652 | unless ($cb->($self)) { |
754 | unless ($cb->($self)) { |
653 | if ($self->{_eof}) { |
755 | if ($self->{_eof}) { |
654 | # no progress can be made (not enough data and no data forthcoming) |
756 | # no progress can be made (not enough data and no data forthcoming) |
655 | $self->_error (&Errno::EPIPE, 1), last; |
757 | $self->_error (&Errno::EPIPE, 1), return; |
656 | } |
758 | } |
657 | |
759 | |
658 | unshift @{ $self->{_queue} }, $cb; |
760 | unshift @{ $self->{_queue} }, $cb; |
659 | last; |
761 | last; |
660 | } |
762 | } |
… | |
… | |
668 | && !@{ $self->{_queue} } # and the queue is still empty |
770 | && !@{ $self->{_queue} } # and the queue is still empty |
669 | && $self->{on_read} # but we still have on_read |
771 | && $self->{on_read} # but we still have on_read |
670 | ) { |
772 | ) { |
671 | # no further data will arrive |
773 | # no further data will arrive |
672 | # so no progress can be made |
774 | # so no progress can be made |
673 | $self->_error (&Errno::EPIPE, 1), last |
775 | $self->_error (&Errno::EPIPE, 1), return |
674 | if $self->{_eof}; |
776 | if $self->{_eof}; |
675 | |
777 | |
676 | last; # more data might arrive |
778 | last; # more data might arrive |
677 | } |
779 | } |
678 | } else { |
780 | } else { |
… | |
… | |
680 | delete $self->{_rw}; |
782 | delete $self->{_rw}; |
681 | last; |
783 | last; |
682 | } |
784 | } |
683 | } |
785 | } |
684 | |
786 | |
|
|
787 | if ($self->{_eof}) { |
|
|
788 | if ($self->{on_eof}) { |
685 | $self->{on_eof}($self) |
789 | $self->{on_eof}($self) |
686 | if $self->{_eof} && $self->{on_eof}; |
790 | } else { |
|
|
791 | $self->_error (0, 1); |
|
|
792 | } |
|
|
793 | } |
687 | |
794 | |
688 | # may need to restart read watcher |
795 | # may need to restart read watcher |
689 | unless ($self->{_rw}) { |
796 | unless ($self->{_rw}) { |
690 | $self->start_read |
797 | $self->start_read |
691 | if $self->{on_read} || @{ $self->{_queue} }; |
798 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
817 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
924 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
818 | 1 |
925 | 1 |
819 | } |
926 | } |
820 | }; |
927 | }; |
821 | |
928 | |
822 | # compatibility with older API |
|
|
823 | sub push_read_chunk { |
|
|
824 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
825 | } |
|
|
826 | |
|
|
827 | sub unshift_read_chunk { |
|
|
828 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
829 | } |
|
|
830 | |
|
|
831 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
929 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
832 | |
930 | |
833 | The callback will be called only once a full line (including the end of |
931 | The callback will be called only once a full line (including the end of |
834 | line marker, C<$eol>) has been read. This line (excluding the end of line |
932 | line marker, C<$eol>) has been read. This line (excluding the end of line |
835 | marker) will be passed to the callback as second argument (C<$line>), and |
933 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
850 | =cut |
948 | =cut |
851 | |
949 | |
852 | register_read_type line => sub { |
950 | register_read_type line => sub { |
853 | my ($self, $cb, $eol) = @_; |
951 | my ($self, $cb, $eol) = @_; |
854 | |
952 | |
855 | $eol = qr|(\015?\012)| if @_ < 3; |
953 | if (@_ < 3) { |
|
|
954 | # this is more than twice as fast as the generic code below |
|
|
955 | sub { |
|
|
956 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
957 | |
|
|
958 | $cb->($_[0], $1, $2); |
|
|
959 | 1 |
|
|
960 | } |
|
|
961 | } else { |
856 | $eol = quotemeta $eol unless ref $eol; |
962 | $eol = quotemeta $eol unless ref $eol; |
857 | $eol = qr|^(.*?)($eol)|s; |
963 | $eol = qr|^(.*?)($eol)|s; |
858 | |
964 | |
859 | sub { |
965 | sub { |
860 | $_[0]{rbuf} =~ s/$eol// or return; |
966 | $_[0]{rbuf} =~ s/$eol// or return; |
861 | |
967 | |
862 | $cb->($_[0], $1, $2); |
968 | $cb->($_[0], $1, $2); |
|
|
969 | 1 |
863 | 1 |
970 | } |
864 | } |
971 | } |
865 | }; |
972 | }; |
866 | |
|
|
867 | # compatibility with older API |
|
|
868 | sub push_read_line { |
|
|
869 | my $self = shift; |
|
|
870 | $self->push_read (line => @_); |
|
|
871 | } |
|
|
872 | |
|
|
873 | sub unshift_read_line { |
|
|
874 | my $self = shift; |
|
|
875 | $self->unshift_read (line => @_); |
|
|
876 | } |
|
|
877 | |
973 | |
878 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
974 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
879 | |
975 | |
880 | Makes a regex match against the regex object C<$accept> and returns |
976 | Makes a regex match against the regex object C<$accept> and returns |
881 | everything up to and including the match. |
977 | everything up to and including the match. |
… | |
… | |
1002 | register_read_type packstring => sub { |
1098 | register_read_type packstring => sub { |
1003 | my ($self, $cb, $format) = @_; |
1099 | my ($self, $cb, $format) = @_; |
1004 | |
1100 | |
1005 | sub { |
1101 | sub { |
1006 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1102 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1007 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1103 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1008 | or return; |
1104 | or return; |
1009 | |
1105 | |
|
|
1106 | $format = length pack $format, $len; |
|
|
1107 | |
|
|
1108 | # bypass unshift if we already have the remaining chunk |
|
|
1109 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1110 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1111 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1112 | $cb->($_[0], $data); |
|
|
1113 | } else { |
1010 | # remove prefix |
1114 | # remove prefix |
1011 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1115 | substr $_[0]{rbuf}, 0, $format, ""; |
1012 | |
1116 | |
1013 | # read rest |
1117 | # read remaining chunk |
1014 | $_[0]->unshift_read (chunk => $len, $cb); |
1118 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1119 | } |
1015 | |
1120 | |
1016 | 1 |
1121 | 1 |
1017 | } |
1122 | } |
1018 | }; |
1123 | }; |
1019 | |
1124 | |
… | |
… | |
1034 | the C<json> write type description, above, for an actual example. |
1139 | the C<json> write type description, above, for an actual example. |
1035 | |
1140 | |
1036 | =cut |
1141 | =cut |
1037 | |
1142 | |
1038 | register_read_type json => sub { |
1143 | register_read_type json => sub { |
1039 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1144 | my ($self, $cb) = @_; |
1040 | |
1145 | |
1041 | require JSON; |
1146 | require JSON; |
1042 | |
1147 | |
1043 | my $data; |
1148 | my $data; |
1044 | my $rbuf = \$self->{rbuf}; |
1149 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1056 | 1 |
1161 | 1 |
1057 | } else { |
1162 | } else { |
1058 | $self->{rbuf} = ""; |
1163 | $self->{rbuf} = ""; |
1059 | () |
1164 | () |
1060 | } |
1165 | } |
|
|
1166 | } |
|
|
1167 | }; |
|
|
1168 | |
|
|
1169 | =item storable => $cb->($handle, $ref) |
|
|
1170 | |
|
|
1171 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1172 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1173 | data). |
|
|
1174 | |
|
|
1175 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1176 | |
|
|
1177 | =cut |
|
|
1178 | |
|
|
1179 | register_read_type storable => sub { |
|
|
1180 | my ($self, $cb) = @_; |
|
|
1181 | |
|
|
1182 | require Storable; |
|
|
1183 | |
|
|
1184 | sub { |
|
|
1185 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1186 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1187 | or return; |
|
|
1188 | |
|
|
1189 | my $format = length pack "w", $len; |
|
|
1190 | |
|
|
1191 | # bypass unshift if we already have the remaining chunk |
|
|
1192 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1193 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1194 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1195 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1196 | } else { |
|
|
1197 | # remove prefix |
|
|
1198 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1199 | |
|
|
1200 | # read remaining chunk |
|
|
1201 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1202 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1203 | $cb->($_[0], $ref); |
|
|
1204 | } else { |
|
|
1205 | $self->_error (&Errno::EBADMSG); |
|
|
1206 | } |
|
|
1207 | }); |
|
|
1208 | } |
|
|
1209 | |
|
|
1210 | 1 |
1061 | } |
1211 | } |
1062 | }; |
1212 | }; |
1063 | |
1213 | |
1064 | =back |
1214 | =back |
1065 | |
1215 | |
… | |
… | |
1253 | |
1403 | |
1254 | sub DESTROY { |
1404 | sub DESTROY { |
1255 | my $self = shift; |
1405 | my $self = shift; |
1256 | |
1406 | |
1257 | $self->stoptls; |
1407 | $self->stoptls; |
|
|
1408 | |
|
|
1409 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1410 | |
|
|
1411 | if ($linger && length $self->{wbuf}) { |
|
|
1412 | my $fh = delete $self->{fh}; |
|
|
1413 | my $wbuf = delete $self->{wbuf}; |
|
|
1414 | |
|
|
1415 | my @linger; |
|
|
1416 | |
|
|
1417 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1418 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1419 | |
|
|
1420 | if ($len > 0) { |
|
|
1421 | substr $wbuf, 0, $len, ""; |
|
|
1422 | } else { |
|
|
1423 | @linger = (); # end |
|
|
1424 | } |
|
|
1425 | }); |
|
|
1426 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1427 | @linger = (); |
|
|
1428 | }); |
|
|
1429 | } |
1258 | } |
1430 | } |
1259 | |
1431 | |
1260 | =item AnyEvent::Handle::TLS_CTX |
1432 | =item AnyEvent::Handle::TLS_CTX |
1261 | |
1433 | |
1262 | This function creates and returns the Net::SSLeay::CTX object used by |
1434 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1304 | =over 4 |
1476 | =over 4 |
1305 | |
1477 | |
1306 | =item * all constructor arguments become object members. |
1478 | =item * all constructor arguments become object members. |
1307 | |
1479 | |
1308 | At least initially, when you pass a C<tls>-argument to the constructor it |
1480 | At least initially, when you pass a C<tls>-argument to the constructor it |
1309 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1481 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1310 | mutated later on (for example C<tls> will hold the TLS connection object). |
1482 | mutated later on (for example C<tls> will hold the TLS connection object). |
1311 | |
1483 | |
1312 | =item * other object member names are prefixed with an C<_>. |
1484 | =item * other object member names are prefixed with an C<_>. |
1313 | |
1485 | |
1314 | All object members not explicitly documented (internal use) are prefixed |
1486 | All object members not explicitly documented (internal use) are prefixed |