ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.60 by root, Thu Jun 5 18:30:08 2008 UTC vs.
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC

1package AnyEvent::Handle; 1package AnyEvent::Handle;
2 2
3no warnings; 3no warnings;
4use strict; 4use strict qw(subs vars);
5 5
6use AnyEvent (); 6use AnyEvent ();
7use AnyEvent::Util qw(WSAEWOULDBLOCK); 7use AnyEvent::Util qw(WSAEWOULDBLOCK);
8use Scalar::Util (); 8use Scalar::Util ();
9use Carp (); 9use Carp ();
14 14
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 16
17=cut 17=cut
18 18
19our $VERSION = 4.14; 19our $VERSION = 4.233;
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
50This module is a helper module to make it easier to do event-based I/O on 50This module is a helper module to make it easier to do event-based I/O on
51filehandles. For utility functions for doing non-blocking connects and accepts 51filehandles. For utility functions for doing non-blocking connects and accepts
52on sockets see L<AnyEvent::Util>. 52on sockets see L<AnyEvent::Util>.
53 53
54The L<AnyEvent::Intro> tutorial contains some well-documented
55AnyEvent::Handle examples.
56
54In the following, when the documentation refers to of "bytes" then this 57In the following, when the documentation refers to of "bytes" then this
55means characters. As sysread and syswrite are used for all I/O, their 58means characters. As sysread and syswrite are used for all I/O, their
56treatment of characters applies to this module as well. 59treatment of characters applies to this module as well.
57 60
58All callbacks will be invoked with the handle object as their first 61All 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
73The filehandle this L<AnyEvent::Handle> object will operate on. 76The filehandle this L<AnyEvent::Handle> object will operate on.
74 77
75NOTE: The filehandle will be set to non-blocking (using 78NOTE: The filehandle will be set to non-blocking mode (using
76AnyEvent::Util::fh_nonblocking). 79C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80that mode.
77 81
78=item on_eof => $cb->($handle) 82=item on_eof => $cb->($handle)
79 83
80Set the callback to be called when an end-of-file condition is detcted, 84Set the callback to be called when an end-of-file condition is detected,
81i.e. in the case of a socket, when the other side has closed the 85i.e. in the case of a socket, when the other side has closed the
82connection cleanly. 86connection cleanly.
83 87
88For sockets, this just means that the other side has stopped sending data,
89you can still try to write data, and, in fact, one can return from the eof
90callback and continue writing data, as only the read part has been shut
91down.
92
84While not mandatory, it is highly recommended to set an eof callback, 93While not mandatory, it is I<highly> recommended to set an eof callback,
85otherwise you might end up with a closed socket while you are still 94otherwise you might end up with a closed socket while you are still
86waiting for data. 95waiting for data.
96
97If an EOF condition has been detected but no C<on_eof> callback has been
98set, 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
90This is the error callback, which is called when, well, some error 102This is the error callback, which is called when, well, some error
91occured, such as not being able to resolve the hostname, failure to 103occured, such as not being able to resolve the hostname, failure to
92connect or a read error. 104connect or a read error.
93 105
94Some errors are fatal (which is indicated by C<$fatal> being true). On 106Some errors are fatal (which is indicated by C<$fatal> being true). On
95fatal errors the handle object will be shut down and will not be 107fatal 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
109errors are an EOF condition with active (but unsatisifable) read watchers
110(C<EPIPE>) or I/O errors.
111
96usable. Non-fatal errors can be retried by simply returning, but it is 112Non-fatal errors can be retried by simply returning, but it is recommended
97recommended to simply ignore this parameter and instead abondon the handle 113to simply ignore this parameter and instead abondon the handle object
98object when this callback is invoked. 114when this callback is invoked. Examples of non-fatal errors are timeouts
115C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99 116
100On callback entrance, the value of C<$!> contains the operating system 117On callback entrance, the value of C<$!> contains the operating system
101error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 118error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102 119
103While not mandatory, it is I<highly> recommended to set this callback, as 120While not mandatory, it is I<highly> recommended to set this callback, as
105C<croak>. 122C<croak>.
106 123
107=item on_read => $cb->($handle) 124=item on_read => $cb->($handle)
108 125
109This sets the default read callback, which is called when data arrives 126This sets the default read callback, which is called when data arrives
110and no read request is in the queue. 127and no read request is in the queue (unlike read queue callbacks, this
128callback will only be called when at least one octet of data is in the
129read buffer).
111 130
112To access (and remove data from) the read buffer, use the C<< ->rbuf >> 131To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113method or access the C<$handle->{rbuf}> member directly. 132method or access the C<$handle->{rbuf}> member directly.
114 133
115When an EOF condition is detected then AnyEvent::Handle will first try to 134When an EOF condition is detected then AnyEvent::Handle will first try to
122This sets the callback that is called when the write buffer becomes empty 141This 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). 142(or when the callback is set and the buffer is empty already).
124 143
125To append to the write buffer, use the C<< ->push_write >> method. 144To append to the write buffer, use the C<< ->push_write >> method.
126 145
146This callback is useful when you don't want to put all of your write data
147into the queue at once, for example, when you want to write the contents
148of some file to the socket you might not want to read the whole file into
149memory and push it into the queue, but instead only read more data from
150the file when the write queue becomes empty.
151
127=item timeout => $fractional_seconds 152=item timeout => $fractional_seconds
128 153
129If non-zero, then this enables an "inactivity" timeout: whenever this many 154If non-zero, then this enables an "inactivity" timeout: whenever this many
130seconds pass without a successful read or write on the underlying file 155seconds pass without a successful read or write on the underlying file
131handle, the C<on_timeout> callback will be invoked (and if that one is 156handle, the C<on_timeout> callback will be invoked (and if that one is
132missing, an C<ETIMEDOUT> error will be raised). 157missing, a non-fatal C<ETIMEDOUT> error will be raised).
133 158
134Note that timeout processing is also active when you currently do not have 159Note that timeout processing is also active when you currently do not have
135any outstanding read or write requests: If you plan to keep the connection 160any outstanding read or write requests: If you plan to keep the connection
136idle then you should disable the timout temporarily or ignore the timeout 161idle then you should disable the timout temporarily or ignore the timeout
137in the C<on_timeout> callback. 162in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
163restart the timeout.
138 164
139Zero (the default) disables this timeout. 165Zero (the default) disables this timeout.
140 166
141=item on_timeout => $cb->($handle) 167=item on_timeout => $cb->($handle)
142 168
146 172
147=item rbuf_max => <bytes> 173=item rbuf_max => <bytes>
148 174
149If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) 175If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
150when the read buffer ever (strictly) exceeds this size. This is useful to 176when the read buffer ever (strictly) exceeds this size. This is useful to
151avoid denial-of-service attacks. 177avoid some forms of denial-of-service attacks.
152 178
153For example, a server accepting connections from untrusted sources should 179For example, a server accepting connections from untrusted sources should
154be configured to accept only so-and-so much data that it cannot act on 180be 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 181(for example, when expecting a line, an attacker could send an unlimited
156amount of data without a callback ever being called as long as the line 182amount of data without a callback ever being called as long as the line
157isn't finished). 183isn't finished).
158 184
185=item autocork => <boolean>
186
187When disabled (the default), then C<push_write> will try to immediately
188write the data to the handle, if possible. This avoids having to register
189a write watcher and wait for the next event loop iteration, but can
190be inefficient if you write multiple small chunks (on the wire, this
191disadvantage is usually avoided by your kernel's nagle algorithm, see
192C<no_delay>, but this option can save costly syscalls).
193
194When enabled, then writes will always be queued till the next event loop
195iteration. This is efficient when you do many small writes per iteration,
196but less efficient when you do a single write only per iteration (or when
197the write buffer often is full). It also increases write latency.
198
199=item no_delay => <boolean>
200
201When doing small writes on sockets, your operating system kernel might
202wait a bit for more data before actually sending it out. This is called
203the Nagle algorithm, and usually it is beneficial.
204
205In some situations you want as low a delay as possible, which can be
206accomplishd by setting this option to a true value.
207
208The default is your opertaing system's default behaviour (most likely
209enabled), this option explicitly enables or disables it, if possible.
210
159=item read_size => <bytes> 211=item read_size => <bytes>
160 212
161The default read block size (the amount of bytes this module will try to read 213The default read block size (the amount of bytes this module will
162during each (loop iteration). Default: C<8192>. 214try to read during each loop iteration, which affects memory
215requirements). Default: C<8192>.
163 216
164=item low_water_mark => <bytes> 217=item low_water_mark => <bytes>
165 218
166Sets the amount of bytes (default: C<0>) that make up an "empty" write 219Sets the amount of bytes (default: C<0>) that make up an "empty" write
167buffer: If the write reaches this size or gets even samller it is 220buffer: If the write reaches this size or gets even samller it is
168considered empty. 221considered empty.
169 222
223Sometimes it can be beneficial (for performance reasons) to add data to
224the write buffer before it is fully drained, but this is a rare case, as
225the operating system kernel usually buffers data as well, so the default
226is good in almost all cases.
227
228=item linger => <seconds>
229
230If non-zero (default: C<3600>), then the destructor of the
231AnyEvent::Handle object will check whether there is still outstanding
232write data and will install a watcher that will write this data to the
233socket. No errors will be reported (this mostly matches how the operating
234system treats outstanding data at socket close time).
235
236This will not work for partial TLS data that could not be encoded
237yet. This data will be lost.
238
170=item tls => "accept" | "connect" | Net::SSLeay::SSL object 239=item tls => "accept" | "connect" | Net::SSLeay::SSL object
171 240
172When this parameter is given, it enables TLS (SSL) mode, that means it 241When this parameter is given, it enables TLS (SSL) mode, that means
173will start making tls handshake and will transparently encrypt/decrypt 242AnyEvent will start a TLS handshake as soon as the conenction has been
174data. 243established and will transparently encrypt/decrypt data afterwards.
175 244
176TLS mode requires Net::SSLeay to be installed (it will be loaded 245TLS mode requires Net::SSLeay to be installed (it will be loaded
177automatically when you try to create a TLS handle). 246automatically when you try to create a TLS handle): this module doesn't
247have a dependency on that module, so if your module requires it, you have
248to add the dependency yourself.
178 249
179For the TLS server side, use C<accept>, and for the TLS client side of a 250Unlike TCP, TLS has a server and client side: for the TLS server side, use
180connection, use C<connect> mode. 251C<accept>, and for the TLS client side of a connection, use C<connect>
252mode.
181 253
182You can also provide your own TLS connection object, but you have 254You can also provide your own TLS connection object, but you have
183to make sure that you call either C<Net::SSLeay::set_connect_state> 255to make sure that you call either C<Net::SSLeay::set_connect_state>
184or C<Net::SSLeay::set_accept_state> on it before you pass it to 256or C<Net::SSLeay::set_accept_state> on it before you pass it to
185AnyEvent::Handle. 257AnyEvent::Handle.
186 258
187See the C<starttls> method if you need to start TLs negotiation later. 259See the C<< ->starttls >> method for when need to start TLS negotiation later.
188 260
189=item tls_ctx => $ssl_ctx 261=item tls_ctx => $ssl_ctx
190 262
191Use the given Net::SSLeay::CTX object to create the new TLS connection 263Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
192(unless a connection object was specified directly). If this parameter is 264(unless a connection object was specified directly). If this parameter is
193missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 265missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
194 266
195=item json => JSON or JSON::XS object 267=item json => JSON or JSON::XS object
196 268
197This is the json coder object used by the C<json> read and write types. 269This is the json coder object used by the C<json> read and write types.
198 270
199If you don't supply it, then AnyEvent::Handle will create and use a 271If you don't supply it, then AnyEvent::Handle will create and use a
200suitable one, which will write and expect UTF-8 encoded JSON texts. 272suitable one (on demand), which will write and expect UTF-8 encoded JSON
273texts.
201 274
202Note that you are responsible to depend on the JSON module if you want to 275Note that you are responsible to depend on the JSON module if you want to
203use this functionality, as AnyEvent does not have a dependency itself. 276use this functionality, as AnyEvent does not have a dependency itself.
204 277
205=item filter_r => $cb 278=item filter_r => $cb
206 279
207=item filter_w => $cb 280=item filter_w => $cb
208 281
209These exist, but are undocumented at this time. 282These exist, but are undocumented at this time. (They are used internally
283by the TLS code).
210 284
211=back 285=back
212 286
213=cut 287=cut
214 288
227 } 301 }
228 302
229 $self->{_activity} = AnyEvent->now; 303 $self->{_activity} = AnyEvent->now;
230 $self->_timeout; 304 $self->_timeout;
231 305
232 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 306 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
233 $self->on_read (delete $self->{on_read} ) if $self->{on_read}; 307 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
308
309 $self->start_read
310 if $self->{on_read};
234 311
235 $self 312 $self
236} 313}
237 314
238sub _shutdown { 315sub _shutdown {
242 delete $self->{_rw}; 319 delete $self->{_rw};
243 delete $self->{_ww}; 320 delete $self->{_ww};
244 delete $self->{fh}; 321 delete $self->{fh};
245 322
246 $self->stoptls; 323 $self->stoptls;
324
325 delete $self->{on_read};
326 delete $self->{_queue};
247} 327}
248 328
249sub _error { 329sub _error {
250 my ($self, $errno, $fatal) = @_; 330 my ($self, $errno, $fatal) = @_;
251 331
261 } 341 }
262} 342}
263 343
264=item $fh = $handle->fh 344=item $fh = $handle->fh
265 345
266This method returns the file handle of the L<AnyEvent::Handle> object. 346This method returns the file handle used to create the L<AnyEvent::Handle> object.
267 347
268=cut 348=cut
269 349
270sub fh { $_[0]{fh} } 350sub fh { $_[0]{fh} }
271 351
289 $_[0]{on_eof} = $_[1]; 369 $_[0]{on_eof} = $_[1];
290} 370}
291 371
292=item $handle->on_timeout ($cb) 372=item $handle->on_timeout ($cb)
293 373
294Replace the current C<on_timeout> callback, or disables the callback 374Replace the current C<on_timeout> callback, or disables the callback (but
295(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor 375not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
296argument. 376argument and method.
297 377
298=cut 378=cut
299 379
300sub on_timeout { 380sub on_timeout {
301 $_[0]{on_timeout} = $_[1]; 381 $_[0]{on_timeout} = $_[1];
382}
383
384=item $handle->autocork ($boolean)
385
386Enables or disables the current autocork behaviour (see C<autocork>
387constructor argument).
388
389=cut
390
391=item $handle->no_delay ($boolean)
392
393Enables or disables the C<no_delay> setting (see constructor argument of
394the same name for details).
395
396=cut
397
398sub no_delay {
399 $_[0]{no_delay} = $_[1];
400
401 eval {
402 local $SIG{__DIE__};
403 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
404 };
302} 405}
303 406
304############################################################################# 407#############################################################################
305 408
306=item $handle->timeout ($seconds) 409=item $handle->timeout ($seconds)
421 $self->_error ($!, 1); 524 $self->_error ($!, 1);
422 } 525 }
423 }; 526 };
424 527
425 # try to write data immediately 528 # try to write data immediately
426 $cb->(); 529 $cb->() unless $self->{autocork};
427 530
428 # if still data left in wbuf, we need to poll 531 # if still data left in wbuf, we need to poll
429 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 532 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
430 if length $self->{wbuf}; 533 if length $self->{wbuf};
431 }; 534 };
476 my ($self, $string) = @_; 579 my ($self, $string) = @_;
477 580
478 sprintf "%d:%s,", (length $string), $string 581 sprintf "%d:%s,", (length $string), $string
479}; 582};
480 583
584=item packstring => $format, $data
585
586An octet string prefixed with an encoded length. The encoding C<$format>
587uses the same format as a Perl C<pack> format, but must specify a single
588integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
589optional C<!>, C<< < >> or C<< > >> modifier).
590
591=cut
592
593register_write_type packstring => sub {
594 my ($self, $format, $string) = @_;
595
596 pack "$format/a*", $string
597};
598
481=item json => $array_or_hashref 599=item json => $array_or_hashref
482 600
483Encodes the given hash or array reference into a JSON object. Unless you 601Encodes the given hash or array reference into a JSON object. Unless you
484provide your own JSON object, this means it will be encoded to JSON text 602provide your own JSON object, this means it will be encoded to JSON text
485in UTF-8. 603in UTF-8.
517 635
518 $self->{json} ? $self->{json}->encode ($ref) 636 $self->{json} ? $self->{json}->encode ($ref)
519 : JSON::encode_json ($ref) 637 : JSON::encode_json ($ref)
520}; 638};
521 639
640=item storable => $reference
641
642Freezes the given reference using L<Storable> and writes it to the
643handle. Uses the C<nfreeze> format.
644
645=cut
646
647register_write_type storable => sub {
648 my ($self, $ref) = @_;
649
650 require Storable;
651
652 pack "w/a*", Storable::nfreeze ($ref)
653};
654
522=back 655=back
523 656
524=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 657=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525 658
526This function (not method) lets you add your own types to C<push_write>. 659This function (not method) lets you add your own types to C<push_write>.
548ways, the "simple" way, using only C<on_read> and the "complex" way, using 681ways, the "simple" way, using only C<on_read> and the "complex" way, using
549a queue. 682a queue.
550 683
551In the simple case, you just install an C<on_read> callback and whenever 684In the simple case, you just install an C<on_read> callback and whenever
552new data arrives, it will be called. You can then remove some data (if 685new data arrives, it will be called. You can then remove some data (if
553enough is there) from the read buffer (C<< $handle->rbuf >>) if you want 686enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
554or not. 687leave the data there if you want to accumulate more (e.g. when only a
688partial message has been received so far).
555 689
556In the more complex case, you want to queue multiple callbacks. In this 690In the more complex case, you want to queue multiple callbacks. In this
557case, AnyEvent::Handle will call the first queued callback each time new 691case, AnyEvent::Handle will call the first queued callback each time new
558data arrives and removes it when it has done its job (see C<push_read>, 692data arrives (also the first time it is queued) and removes it when it has
559below). 693done its job (see C<push_read>, below).
560 694
561This way you can, for example, push three line-reads, followed by reading 695This way you can, for example, push three line-reads, followed by reading
562a chunk of data, and AnyEvent::Handle will execute them in order. 696a chunk of data, and AnyEvent::Handle will execute them in order.
563 697
564Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by 698Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
577 # handle xml 711 # handle xml
578 }); 712 });
579 }); 713 });
580 }); 714 });
581 715
582Example 2: Implement a client for a protocol that replies either with 716Example 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 717and another line or "ERROR" for the first request that is sent, and 64
584second request. Due tot he availability of a full queue, we can just 718bytes for the second request. Due to the availability of a queue, we can
585pipeline sending both requests and manipulate the queue as necessary in 719just pipeline sending both requests and manipulate the queue as necessary
586the callbacks: 720in the callbacks.
587 721
588 # request one 722When the first callback is called and sees an "OK" response, it will
723C<unshift> another line-read. This line-read will be queued I<before> the
72464-byte chunk callback.
725
726 # request one, returns either "OK + extra line" or "ERROR"
589 $handle->push_write ("request 1\015\012"); 727 $handle->push_write ("request 1\015\012");
590 728
591 # we expect "ERROR" or "OK" as response, so push a line read 729 # we expect "ERROR" or "OK" as response, so push a line read
592 $handle->push_read (line => sub { 730 $handle->push_read (line => sub {
593 # if we got an "OK", we have to _prepend_ another line, 731 # if we got an "OK", we have to _prepend_ another line,
600 ... 738 ...
601 }); 739 });
602 } 740 }
603 }); 741 });
604 742
605 # request two 743 # request two, simply returns 64 octets
606 $handle->push_write ("request 2\015\012"); 744 $handle->push_write ("request 2\015\012");
607 745
608 # simply read 64 bytes, always 746 # simply read 64 bytes, always
609 $handle->push_read (chunk => 64, sub { 747 $handle->push_read (chunk => 64, sub {
610 my $response = $_[1]; 748 my $response = $_[1];
622 760
623 if ( 761 if (
624 defined $self->{rbuf_max} 762 defined $self->{rbuf_max}
625 && $self->{rbuf_max} < length $self->{rbuf} 763 && $self->{rbuf_max} < length $self->{rbuf}
626 ) { 764 ) {
627 return $self->_error (&Errno::ENOSPC, 1); 765 $self->_error (&Errno::ENOSPC, 1), return;
628 } 766 }
629 767
630 while () { 768 while () {
631 no strict 'refs';
632
633 my $len = length $self->{rbuf}; 769 my $len = length $self->{rbuf};
634 770
635 if (my $cb = shift @{ $self->{_queue} }) { 771 if (my $cb = shift @{ $self->{_queue} }) {
636 unless ($cb->($self)) { 772 unless ($cb->($self)) {
637 if ($self->{_eof}) { 773 if ($self->{_eof}) {
638 # no progress can be made (not enough data and no data forthcoming) 774 # no progress can be made (not enough data and no data forthcoming)
639 return $self->_error (&Errno::EPIPE, 1); 775 $self->_error (&Errno::EPIPE, 1), return;
640 } 776 }
641 777
642 unshift @{ $self->{_queue} }, $cb; 778 unshift @{ $self->{_queue} }, $cb;
643 last; 779 last;
644 } 780 }
645 } elsif ($self->{on_read}) { 781 } elsif ($self->{on_read}) {
782 last unless $len;
783
646 $self->{on_read}($self); 784 $self->{on_read}($self);
647 785
648 if ( 786 if (
649 $len == length $self->{rbuf} # if no data has been consumed 787 $len == length $self->{rbuf} # if no data has been consumed
650 && !@{ $self->{_queue} } # and the queue is still empty 788 && !@{ $self->{_queue} } # and the queue is still empty
651 && $self->{on_read} # but we still have on_read 789 && $self->{on_read} # but we still have on_read
652 ) { 790 ) {
653 # no further data will arrive 791 # no further data will arrive
654 # so no progress can be made 792 # so no progress can be made
655 return $self->_error (&Errno::EPIPE, 1) 793 $self->_error (&Errno::EPIPE, 1), return
656 if $self->{_eof}; 794 if $self->{_eof};
657 795
658 last; # more data might arrive 796 last; # more data might arrive
659 } 797 }
660 } else { 798 } else {
662 delete $self->{_rw}; 800 delete $self->{_rw};
663 last; 801 last;
664 } 802 }
665 } 803 }
666 804
805 if ($self->{_eof}) {
806 if ($self->{on_eof}) {
667 $self->{on_eof}($self) 807 $self->{on_eof}($self)
668 if $self->{_eof} && $self->{on_eof}; 808 } else {
809 $self->_error (0, 1);
810 }
811 }
669 812
670 # may need to restart read watcher 813 # may need to restart read watcher
671 unless ($self->{_rw}) { 814 unless ($self->{_rw}) {
672 $self->start_read 815 $self->start_read
673 if $self->{on_read} || @{ $self->{_queue} }; 816 if $self->{on_read} || @{ $self->{_queue} };
799 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); 942 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
800 1 943 1
801 } 944 }
802}; 945};
803 946
804# compatibility with older API
805sub push_read_chunk {
806 $_[0]->push_read (chunk => $_[1], $_[2]);
807}
808
809sub unshift_read_chunk {
810 $_[0]->unshift_read (chunk => $_[1], $_[2]);
811}
812
813=item line => [$eol, ]$cb->($handle, $line, $eol) 947=item line => [$eol, ]$cb->($handle, $line, $eol)
814 948
815The callback will be called only once a full line (including the end of 949The callback will be called only once a full line (including the end of
816line marker, C<$eol>) has been read. This line (excluding the end of line 950line marker, C<$eol>) has been read. This line (excluding the end of line
817marker) will be passed to the callback as second argument (C<$line>), and 951marker) will be passed to the callback as second argument (C<$line>), and
832=cut 966=cut
833 967
834register_read_type line => sub { 968register_read_type line => sub {
835 my ($self, $cb, $eol) = @_; 969 my ($self, $cb, $eol) = @_;
836 970
837 $eol = qr|(\015?\012)| if @_ < 3; 971 if (@_ < 3) {
838 $eol = quotemeta $eol unless ref $eol; 972 # this is more than twice as fast as the generic code below
839 $eol = qr|^(.*?)($eol)|s;
840
841 sub { 973 sub {
842 $_[0]{rbuf} =~ s/$eol// or return; 974 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
843 975
844 $cb->($_[0], $1, $2); 976 $cb->($_[0], $1, $2);
845 1
846 }
847};
848
849# compatibility with older API
850sub push_read_line {
851 my $self = shift;
852 $self->push_read (line => @_);
853}
854
855sub unshift_read_line {
856 my $self = shift;
857 $self->unshift_read (line => @_);
858}
859
860=item netstring => $cb->($handle, $string)
861
862A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
863
864Throws an error with C<$!> set to EBADMSG on format violations.
865
866=cut
867
868register_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 } 977 1
876 return;
877 } 978 }
979 } else {
980 $eol = quotemeta $eol unless ref $eol;
981 $eol = qr|^(.*?)($eol)|s;
878 982
879 my $len = $1; 983 sub {
984 $_[0]{rbuf} =~ s/$eol// or return;
880 985
881 $self->unshift_read (chunk => $len, sub { 986 $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 }); 987 1
890 }); 988 }
891
892 1
893 } 989 }
894}; 990};
895 991
896=item regex => $accept[, $reject[, $skip], $cb->($handle, $data) 992=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
897 993
961 1057
962 () 1058 ()
963 } 1059 }
964}; 1060};
965 1061
1062=item netstring => $cb->($handle, $string)
1063
1064A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
1065
1066Throws an error with C<$!> set to EBADMSG on format violations.
1067
1068=cut
1069
1070register_read_type netstring => sub {
1071 my ($self, $cb) = @_;
1072
1073 sub {
1074 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1075 if ($_[0]{rbuf} =~ /[^0-9]/) {
1076 $self->_error (&Errno::EBADMSG);
1077 }
1078 return;
1079 }
1080
1081 my $len = $1;
1082
1083 $self->unshift_read (chunk => $len, sub {
1084 my $string = $_[1];
1085 $_[0]->unshift_read (chunk => 1, sub {
1086 if ($_[1] eq ",") {
1087 $cb->($_[0], $string);
1088 } else {
1089 $self->_error (&Errno::EBADMSG);
1090 }
1091 });
1092 });
1093
1094 1
1095 }
1096};
1097
1098=item packstring => $format, $cb->($handle, $string)
1099
1100An octet string prefixed with an encoded length. The encoding C<$format>
1101uses the same format as a Perl C<pack> format, but must specify a single
1102integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1103optional C<!>, C<< < >> or C<< > >> modifier).
1104
1105DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
1106
1107Example: read a block of data prefixed by its length in BER-encoded
1108format (very efficient).
1109
1110 $handle->push_read (packstring => "w", sub {
1111 my ($handle, $data) = @_;
1112 });
1113
1114=cut
1115
1116register_read_type packstring => sub {
1117 my ($self, $cb, $format) = @_;
1118
1119 sub {
1120 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1121 defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1122 or return;
1123
1124 $format = length pack $format, $len;
1125
1126 # bypass unshift if we already have the remaining chunk
1127 if ($format + $len <= length $_[0]{rbuf}) {
1128 my $data = substr $_[0]{rbuf}, $format, $len;
1129 substr $_[0]{rbuf}, 0, $format + $len, "";
1130 $cb->($_[0], $data);
1131 } else {
1132 # remove prefix
1133 substr $_[0]{rbuf}, 0, $format, "";
1134
1135 # read remaining chunk
1136 $_[0]->unshift_read (chunk => $len, $cb);
1137 }
1138
1139 1
1140 }
1141};
1142
966=item json => $cb->($handle, $hash_or_arrayref) 1143=item json => $cb->($handle, $hash_or_arrayref)
967 1144
968Reads a JSON object or array, decodes it and passes it to the callback. 1145Reads a JSON object or array, decodes it and passes it to the callback.
969 1146
970If a C<json> object was passed to the constructor, then that will be used 1147If a C<json> object was passed to the constructor, then that will be used
980the C<json> write type description, above, for an actual example. 1157the C<json> write type description, above, for an actual example.
981 1158
982=cut 1159=cut
983 1160
984register_read_type json => sub { 1161register_read_type json => sub {
985 my ($self, $cb, $accept, $reject, $skip) = @_; 1162 my ($self, $cb) = @_;
986 1163
987 require JSON; 1164 require JSON;
988 1165
989 my $data; 1166 my $data;
990 my $rbuf = \$self->{rbuf}; 1167 my $rbuf = \$self->{rbuf};
1002 1 1179 1
1003 } else { 1180 } else {
1004 $self->{rbuf} = ""; 1181 $self->{rbuf} = "";
1005 () 1182 ()
1006 } 1183 }
1184 }
1185};
1186
1187=item storable => $cb->($handle, $ref)
1188
1189Deserialises a L<Storable> frozen representation as written by the
1190C<storable> write type (BER-encoded length prefix followed by nfreeze'd
1191data).
1192
1193Raises C<EBADMSG> error if the data could not be decoded.
1194
1195=cut
1196
1197register_read_type storable => sub {
1198 my ($self, $cb) = @_;
1199
1200 require Storable;
1201
1202 sub {
1203 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1204 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1205 or return;
1206
1207 my $format = length pack "w", $len;
1208
1209 # bypass unshift if we already have the remaining chunk
1210 if ($format + $len <= length $_[0]{rbuf}) {
1211 my $data = substr $_[0]{rbuf}, $format, $len;
1212 substr $_[0]{rbuf}, 0, $format + $len, "";
1213 $cb->($_[0], Storable::thaw ($data));
1214 } else {
1215 # remove prefix
1216 substr $_[0]{rbuf}, 0, $format, "";
1217
1218 # read remaining chunk
1219 $_[0]->unshift_read (chunk => $len, sub {
1220 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1221 $cb->($_[0], $ref);
1222 } else {
1223 $self->_error (&Errno::EBADMSG);
1224 }
1225 });
1226 }
1227
1228 1
1007 } 1229 }
1008}; 1230};
1009 1231
1010=back 1232=back
1011 1233
1157 # basically, this is deep magic (because SSL_read should have the same issues) 1379 # basically, this is deep magic (because SSL_read should have the same issues)
1158 # but the openssl maintainers basically said: "trust us, it just works". 1380 # but the openssl maintainers basically said: "trust us, it just works".
1159 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1381 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1160 # and mismaintained ssleay-module doesn't even offer them). 1382 # and mismaintained ssleay-module doesn't even offer them).
1161 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html 1383 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1384 #
1385 # in short: this is a mess.
1386 #
1387 # note that we do not try to kepe the length constant between writes as we are required to do.
1388 # we assume that most (but not all) of this insanity only applies to non-blocking cases,
1389 # and we drive openssl fully in blocking mode here.
1162 Net::SSLeay::CTX_set_mode ($self->{tls}, 1390 Net::SSLeay::CTX_set_mode ($self->{tls},
1163 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1391 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1164 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1392 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1165 1393
1166 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1394 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1199 1427
1200sub DESTROY { 1428sub DESTROY {
1201 my $self = shift; 1429 my $self = shift;
1202 1430
1203 $self->stoptls; 1431 $self->stoptls;
1432
1433 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1434
1435 if ($linger && length $self->{wbuf}) {
1436 my $fh = delete $self->{fh};
1437 my $wbuf = delete $self->{wbuf};
1438
1439 my @linger;
1440
1441 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
1442 my $len = syswrite $fh, $wbuf, length $wbuf;
1443
1444 if ($len > 0) {
1445 substr $wbuf, 0, $len, "";
1446 } else {
1447 @linger = (); # end
1448 }
1449 });
1450 push @linger, AnyEvent->timer (after => $linger, cb => sub {
1451 @linger = ();
1452 });
1453 }
1204} 1454}
1205 1455
1206=item AnyEvent::Handle::TLS_CTX 1456=item AnyEvent::Handle::TLS_CTX
1207 1457
1208This function creates and returns the Net::SSLeay::CTX object used by 1458This function creates and returns the Net::SSLeay::CTX object used by
1250=over 4 1500=over 4
1251 1501
1252=item * all constructor arguments become object members. 1502=item * all constructor arguments become object members.
1253 1503
1254At least initially, when you pass a C<tls>-argument to the constructor it 1504At least initially, when you pass a C<tls>-argument to the constructor it
1255will end up in C<< $handle->{tls} >>. Those members might be changes or 1505will end up in C<< $handle->{tls} >>. Those members might be changed or
1256mutated later on (for example C<tls> will hold the TLS connection object). 1506mutated later on (for example C<tls> will hold the TLS connection object).
1257 1507
1258=item * other object member names are prefixed with an C<_>. 1508=item * other object member names are prefixed with an C<_>.
1259 1509
1260All object members not explicitly documented (internal use) are prefixed 1510All object members not explicitly documented (internal use) are prefixed

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines