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.15; |
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; |
… | |
… | |
49 | |
49 | |
50 | 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 |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
84 | 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 |
85 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
86 | connection cleanly. |
83 | |
87 | |
|
|
88 | For sockets, this just means that the other side has stopped sending data, |
|
|
89 | you can still try to write data, and, in fact, one can return from the eof |
|
|
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
|
|
92 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
93 | 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 |
94 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
95 | waiting for data. |
|
|
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
99 | |
88 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal) |
89 | |
101 | |
90 | This is the error callback, which is called when, well, some error |
102 | 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 |
103 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
104 | connect or a read error. |
93 | |
105 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
106 | 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 |
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
112 | 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 |
113 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
116 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
119 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
123 | |
140 | |
124 | This sets the callback that is called when the write buffer becomes empty |
141 | 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). |
142 | (or when the callback is set and the buffer is empty already). |
126 | |
143 | |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
144 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
145 | |
|
|
146 | This callback is useful when you don't want to put all of your write data |
|
|
147 | into the queue at once, for example, when you want to write the contents |
|
|
148 | of some file to the socket you might not want to read the whole file into |
|
|
149 | memory and push it into the queue, but instead only read more data from |
|
|
150 | the file when the write queue becomes empty. |
128 | |
151 | |
129 | =item timeout => $fractional_seconds |
152 | =item timeout => $fractional_seconds |
130 | |
153 | |
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
154 | 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 |
155 | 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 |
179 | 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 |
180 | (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 |
181 | amount of data without a callback ever being called as long as the line |
159 | isn't finished). |
182 | isn't finished). |
160 | |
183 | |
|
|
184 | =item autocork => <boolean> |
|
|
185 | |
|
|
186 | When disabled (the default), then C<push_write> will try to immediately |
|
|
187 | write the data to the handle if possible. This avoids having to register |
|
|
188 | a write watcher and wait for the next event loop iteration, but can be |
|
|
189 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
190 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
191 | |
|
|
192 | When enabled, then writes will always be queued till the next event loop |
|
|
193 | iteration. This is efficient when you do many small writes per iteration, |
|
|
194 | but less efficient when you do a single write only. |
|
|
195 | |
|
|
196 | =item no_delay => <boolean> |
|
|
197 | |
|
|
198 | When doing small writes on sockets, your operating system kernel might |
|
|
199 | wait a bit for more data before actually sending it out. This is called |
|
|
200 | the Nagle algorithm, and usually it is beneficial. |
|
|
201 | |
|
|
202 | In some situations you want as low a delay as possible, which cna be |
|
|
203 | accomplishd by setting this option to true. |
|
|
204 | |
|
|
205 | The default is your opertaing system's default behaviour, this option |
|
|
206 | explicitly enables or disables it, if possible. |
|
|
207 | |
161 | =item read_size => <bytes> |
208 | =item read_size => <bytes> |
162 | |
209 | |
163 | The default read block size (the amount of bytes this module will try to read |
210 | The default read block size (the amount of bytes this module will try to read |
164 | during each (loop iteration). Default: C<8192>. |
211 | during each (loop iteration). Default: C<8192>. |
165 | |
212 | |
… | |
… | |
180 | This will not work for partial TLS data that could not yet been |
227 | This will not work for partial TLS data that could not yet been |
181 | encoded. This data will be lost. |
228 | encoded. This data will be lost. |
182 | |
229 | |
183 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
230 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
184 | |
231 | |
185 | When this parameter is given, it enables TLS (SSL) mode, that means it |
232 | When this parameter is given, it enables TLS (SSL) mode, that means |
186 | will start making tls handshake and will transparently encrypt/decrypt |
233 | AnyEvent will start a TLS handshake and will transparently encrypt/decrypt |
187 | data. |
234 | data. |
188 | |
235 | |
189 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
236 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
190 | automatically when you try to create a TLS handle). |
237 | automatically when you try to create a TLS handle). |
191 | |
238 | |
192 | For the TLS server side, use C<accept>, and for the TLS client side of a |
239 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
193 | connection, use C<connect> mode. |
240 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
241 | mode. |
194 | |
242 | |
195 | You can also provide your own TLS connection object, but you have |
243 | You can also provide your own TLS connection object, but you have |
196 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
244 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
197 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
245 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
198 | AnyEvent::Handle. |
246 | AnyEvent::Handle. |
199 | |
247 | |
200 | See the C<starttls> method if you need to start TLs negotiation later. |
248 | See the C<starttls> method for when need to start TLS negotiation later. |
201 | |
249 | |
202 | =item tls_ctx => $ssl_ctx |
250 | =item tls_ctx => $ssl_ctx |
203 | |
251 | |
204 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
252 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
205 | (unless a connection object was specified directly). If this parameter is |
253 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
240 | } |
288 | } |
241 | |
289 | |
242 | $self->{_activity} = AnyEvent->now; |
290 | $self->{_activity} = AnyEvent->now; |
243 | $self->_timeout; |
291 | $self->_timeout; |
244 | |
292 | |
245 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
293 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
294 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
295 | |
|
|
296 | $self->start_read |
|
|
297 | if $self->{on_read}; |
246 | |
298 | |
247 | $self |
299 | $self |
248 | } |
300 | } |
249 | |
301 | |
250 | sub _shutdown { |
302 | sub _shutdown { |
… | |
… | |
254 | delete $self->{_rw}; |
306 | delete $self->{_rw}; |
255 | delete $self->{_ww}; |
307 | delete $self->{_ww}; |
256 | delete $self->{fh}; |
308 | delete $self->{fh}; |
257 | |
309 | |
258 | $self->stoptls; |
310 | $self->stoptls; |
|
|
311 | |
|
|
312 | delete $self->{on_read}; |
|
|
313 | delete $self->{_queue}; |
259 | } |
314 | } |
260 | |
315 | |
261 | sub _error { |
316 | sub _error { |
262 | my ($self, $errno, $fatal) = @_; |
317 | my ($self, $errno, $fatal) = @_; |
263 | |
318 | |
… | |
… | |
309 | |
364 | |
310 | =cut |
365 | =cut |
311 | |
366 | |
312 | sub on_timeout { |
367 | sub on_timeout { |
313 | $_[0]{on_timeout} = $_[1]; |
368 | $_[0]{on_timeout} = $_[1]; |
|
|
369 | } |
|
|
370 | |
|
|
371 | =item $handle->autocork ($boolean) |
|
|
372 | |
|
|
373 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
374 | constructor argument). |
|
|
375 | |
|
|
376 | =cut |
|
|
377 | |
|
|
378 | =item $handle->no_delay ($boolean) |
|
|
379 | |
|
|
380 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
381 | the same name for details). |
|
|
382 | |
|
|
383 | =cut |
|
|
384 | |
|
|
385 | sub no_delay { |
|
|
386 | $_[0]{no_delay} = $_[1]; |
|
|
387 | |
|
|
388 | eval { |
|
|
389 | local $SIG{__DIE__}; |
|
|
390 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
391 | }; |
314 | } |
392 | } |
315 | |
393 | |
316 | ############################################################################# |
394 | ############################################################################# |
317 | |
395 | |
318 | =item $handle->timeout ($seconds) |
396 | =item $handle->timeout ($seconds) |
… | |
… | |
433 | $self->_error ($!, 1); |
511 | $self->_error ($!, 1); |
434 | } |
512 | } |
435 | }; |
513 | }; |
436 | |
514 | |
437 | # try to write data immediately |
515 | # try to write data immediately |
438 | $cb->(); |
516 | $cb->() unless $self->{autocork}; |
439 | |
517 | |
440 | # if still data left in wbuf, we need to poll |
518 | # if still data left in wbuf, we need to poll |
441 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
519 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
442 | if length $self->{wbuf}; |
520 | if length $self->{wbuf}; |
443 | }; |
521 | }; |
… | |
… | |
590 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
668 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
591 | a queue. |
669 | a queue. |
592 | |
670 | |
593 | In the simple case, you just install an C<on_read> callback and whenever |
671 | In the simple case, you just install an C<on_read> callback and whenever |
594 | new data arrives, it will be called. You can then remove some data (if |
672 | new data arrives, it will be called. You can then remove some data (if |
595 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
673 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
596 | or not. |
674 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
675 | partial message has been received so far). |
597 | |
676 | |
598 | In the more complex case, you want to queue multiple callbacks. In this |
677 | In the more complex case, you want to queue multiple callbacks. In this |
599 | case, AnyEvent::Handle will call the first queued callback each time new |
678 | case, AnyEvent::Handle will call the first queued callback each time new |
600 | data arrives (also the first time it is queued) and removes it when it has |
679 | data arrives (also the first time it is queued) and removes it when it has |
601 | done its job (see C<push_read>, below). |
680 | done its job (see C<push_read>, below). |
… | |
… | |
619 | # handle xml |
698 | # handle xml |
620 | }); |
699 | }); |
621 | }); |
700 | }); |
622 | }); |
701 | }); |
623 | |
702 | |
624 | Example 2: Implement a client for a protocol that replies either with |
703 | Example 2: Implement a client for a protocol that replies either with "OK" |
625 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
704 | and another line or "ERROR" for the first request that is sent, and 64 |
626 | second request. Due tot he availability of a full queue, we can just |
705 | bytes for the second request. Due to the availability of a queue, we can |
627 | pipeline sending both requests and manipulate the queue as necessary in |
706 | just pipeline sending both requests and manipulate the queue as necessary |
628 | the callbacks: |
707 | in the callbacks. |
629 | |
708 | |
630 | # request one |
709 | When the first callback is called and sees an "OK" response, it will |
|
|
710 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
711 | 64-byte chunk callback. |
|
|
712 | |
|
|
713 | # request one, returns either "OK + extra line" or "ERROR" |
631 | $handle->push_write ("request 1\015\012"); |
714 | $handle->push_write ("request 1\015\012"); |
632 | |
715 | |
633 | # we expect "ERROR" or "OK" as response, so push a line read |
716 | # we expect "ERROR" or "OK" as response, so push a line read |
634 | $handle->push_read (line => sub { |
717 | $handle->push_read (line => sub { |
635 | # if we got an "OK", we have to _prepend_ another line, |
718 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
642 | ... |
725 | ... |
643 | }); |
726 | }); |
644 | } |
727 | } |
645 | }); |
728 | }); |
646 | |
729 | |
647 | # request two |
730 | # request two, simply returns 64 octets |
648 | $handle->push_write ("request 2\015\012"); |
731 | $handle->push_write ("request 2\015\012"); |
649 | |
732 | |
650 | # simply read 64 bytes, always |
733 | # simply read 64 bytes, always |
651 | $handle->push_read (chunk => 64, sub { |
734 | $handle->push_read (chunk => 64, sub { |
652 | my $response = $_[1]; |
735 | my $response = $_[1]; |
… | |
… | |
664 | |
747 | |
665 | if ( |
748 | if ( |
666 | defined $self->{rbuf_max} |
749 | defined $self->{rbuf_max} |
667 | && $self->{rbuf_max} < length $self->{rbuf} |
750 | && $self->{rbuf_max} < length $self->{rbuf} |
668 | ) { |
751 | ) { |
669 | return $self->_error (&Errno::ENOSPC, 1); |
752 | $self->_error (&Errno::ENOSPC, 1), return; |
670 | } |
753 | } |
671 | |
754 | |
672 | while () { |
755 | while () { |
673 | no strict 'refs'; |
|
|
674 | |
|
|
675 | my $len = length $self->{rbuf}; |
756 | my $len = length $self->{rbuf}; |
676 | |
757 | |
677 | if (my $cb = shift @{ $self->{_queue} }) { |
758 | if (my $cb = shift @{ $self->{_queue} }) { |
678 | unless ($cb->($self)) { |
759 | unless ($cb->($self)) { |
679 | if ($self->{_eof}) { |
760 | if ($self->{_eof}) { |
680 | # no progress can be made (not enough data and no data forthcoming) |
761 | # no progress can be made (not enough data and no data forthcoming) |
681 | $self->_error (&Errno::EPIPE, 1), last; |
762 | $self->_error (&Errno::EPIPE, 1), return; |
682 | } |
763 | } |
683 | |
764 | |
684 | unshift @{ $self->{_queue} }, $cb; |
765 | unshift @{ $self->{_queue} }, $cb; |
685 | last; |
766 | last; |
686 | } |
767 | } |
… | |
… | |
694 | && !@{ $self->{_queue} } # and the queue is still empty |
775 | && !@{ $self->{_queue} } # and the queue is still empty |
695 | && $self->{on_read} # but we still have on_read |
776 | && $self->{on_read} # but we still have on_read |
696 | ) { |
777 | ) { |
697 | # no further data will arrive |
778 | # no further data will arrive |
698 | # so no progress can be made |
779 | # so no progress can be made |
699 | $self->_error (&Errno::EPIPE, 1), last |
780 | $self->_error (&Errno::EPIPE, 1), return |
700 | if $self->{_eof}; |
781 | if $self->{_eof}; |
701 | |
782 | |
702 | last; # more data might arrive |
783 | last; # more data might arrive |
703 | } |
784 | } |
704 | } else { |
785 | } else { |
… | |
… | |
706 | delete $self->{_rw}; |
787 | delete $self->{_rw}; |
707 | last; |
788 | last; |
708 | } |
789 | } |
709 | } |
790 | } |
710 | |
791 | |
|
|
792 | if ($self->{_eof}) { |
|
|
793 | if ($self->{on_eof}) { |
711 | $self->{on_eof}($self) |
794 | $self->{on_eof}($self) |
712 | if $self->{_eof} && $self->{on_eof}; |
795 | } else { |
|
|
796 | $self->_error (0, 1); |
|
|
797 | } |
|
|
798 | } |
713 | |
799 | |
714 | # may need to restart read watcher |
800 | # may need to restart read watcher |
715 | unless ($self->{_rw}) { |
801 | unless ($self->{_rw}) { |
716 | $self->start_read |
802 | $self->start_read |
717 | if $self->{on_read} || @{ $self->{_queue} }; |
803 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
843 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
929 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
844 | 1 |
930 | 1 |
845 | } |
931 | } |
846 | }; |
932 | }; |
847 | |
933 | |
848 | # compatibility with older API |
|
|
849 | sub push_read_chunk { |
|
|
850 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
851 | } |
|
|
852 | |
|
|
853 | sub unshift_read_chunk { |
|
|
854 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
855 | } |
|
|
856 | |
|
|
857 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
934 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
858 | |
935 | |
859 | The callback will be called only once a full line (including the end of |
936 | The callback will be called only once a full line (including the end of |
860 | line marker, C<$eol>) has been read. This line (excluding the end of line |
937 | line marker, C<$eol>) has been read. This line (excluding the end of line |
861 | marker) will be passed to the callback as second argument (C<$line>), and |
938 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
876 | =cut |
953 | =cut |
877 | |
954 | |
878 | register_read_type line => sub { |
955 | register_read_type line => sub { |
879 | my ($self, $cb, $eol) = @_; |
956 | my ($self, $cb, $eol) = @_; |
880 | |
957 | |
881 | $eol = qr|(\015?\012)| if @_ < 3; |
958 | if (@_ < 3) { |
|
|
959 | # this is more than twice as fast as the generic code below |
|
|
960 | sub { |
|
|
961 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
962 | |
|
|
963 | $cb->($_[0], $1, $2); |
|
|
964 | 1 |
|
|
965 | } |
|
|
966 | } else { |
882 | $eol = quotemeta $eol unless ref $eol; |
967 | $eol = quotemeta $eol unless ref $eol; |
883 | $eol = qr|^(.*?)($eol)|s; |
968 | $eol = qr|^(.*?)($eol)|s; |
884 | |
969 | |
885 | sub { |
970 | sub { |
886 | $_[0]{rbuf} =~ s/$eol// or return; |
971 | $_[0]{rbuf} =~ s/$eol// or return; |
887 | |
972 | |
888 | $cb->($_[0], $1, $2); |
973 | $cb->($_[0], $1, $2); |
|
|
974 | 1 |
889 | 1 |
975 | } |
890 | } |
976 | } |
891 | }; |
977 | }; |
892 | |
|
|
893 | # compatibility with older API |
|
|
894 | sub push_read_line { |
|
|
895 | my $self = shift; |
|
|
896 | $self->push_read (line => @_); |
|
|
897 | } |
|
|
898 | |
|
|
899 | sub unshift_read_line { |
|
|
900 | my $self = shift; |
|
|
901 | $self->unshift_read (line => @_); |
|
|
902 | } |
|
|
903 | |
978 | |
904 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
979 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
905 | |
980 | |
906 | Makes a regex match against the regex object C<$accept> and returns |
981 | Makes a regex match against the regex object C<$accept> and returns |
907 | everything up to and including the match. |
982 | everything up to and including the match. |
… | |
… | |
1028 | register_read_type packstring => sub { |
1103 | register_read_type packstring => sub { |
1029 | my ($self, $cb, $format) = @_; |
1104 | my ($self, $cb, $format) = @_; |
1030 | |
1105 | |
1031 | sub { |
1106 | sub { |
1032 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1107 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1033 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1108 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1034 | or return; |
1109 | or return; |
1035 | |
1110 | |
|
|
1111 | $format = length pack $format, $len; |
|
|
1112 | |
|
|
1113 | # bypass unshift if we already have the remaining chunk |
|
|
1114 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1115 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1116 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1117 | $cb->($_[0], $data); |
|
|
1118 | } else { |
1036 | # remove prefix |
1119 | # remove prefix |
1037 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1120 | substr $_[0]{rbuf}, 0, $format, ""; |
1038 | |
1121 | |
1039 | # read rest |
1122 | # read remaining chunk |
1040 | $_[0]->unshift_read (chunk => $len, $cb); |
1123 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1124 | } |
1041 | |
1125 | |
1042 | 1 |
1126 | 1 |
1043 | } |
1127 | } |
1044 | }; |
1128 | }; |
1045 | |
1129 | |
… | |
… | |
1102 | |
1186 | |
1103 | require Storable; |
1187 | require Storable; |
1104 | |
1188 | |
1105 | sub { |
1189 | sub { |
1106 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1190 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1107 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
1191 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1108 | or return; |
1192 | or return; |
1109 | |
1193 | |
|
|
1194 | my $format = length pack "w", $len; |
|
|
1195 | |
|
|
1196 | # bypass unshift if we already have the remaining chunk |
|
|
1197 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1198 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1199 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1200 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1201 | } else { |
1110 | # remove prefix |
1202 | # remove prefix |
1111 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1203 | substr $_[0]{rbuf}, 0, $format, ""; |
1112 | |
1204 | |
1113 | # read rest |
1205 | # read remaining chunk |
1114 | $_[0]->unshift_read (chunk => $len, sub { |
1206 | $_[0]->unshift_read (chunk => $len, sub { |
1115 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1207 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1116 | $cb->($_[0], $ref); |
1208 | $cb->($_[0], $ref); |
1117 | } else { |
1209 | } else { |
1118 | $self->_error (&Errno::EBADMSG); |
1210 | $self->_error (&Errno::EBADMSG); |
|
|
1211 | } |
1119 | } |
1212 | }); |
1120 | }); |
1213 | } |
|
|
1214 | |
|
|
1215 | 1 |
1121 | } |
1216 | } |
1122 | }; |
1217 | }; |
1123 | |
1218 | |
1124 | =back |
1219 | =back |
1125 | |
1220 | |
… | |
… | |
1386 | =over 4 |
1481 | =over 4 |
1387 | |
1482 | |
1388 | =item * all constructor arguments become object members. |
1483 | =item * all constructor arguments become object members. |
1389 | |
1484 | |
1390 | At least initially, when you pass a C<tls>-argument to the constructor it |
1485 | At least initially, when you pass a C<tls>-argument to the constructor it |
1391 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1486 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1392 | mutated later on (for example C<tls> will hold the TLS connection object). |
1487 | mutated later on (for example C<tls> will hold the TLS connection object). |
1393 | |
1488 | |
1394 | =item * other object member names are prefixed with an C<_>. |
1489 | =item * other object member names are prefixed with an C<_>. |
1395 | |
1490 | |
1396 | All object members not explicitly documented (internal use) are prefixed |
1491 | All object members not explicitly documented (internal use) are prefixed |