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.26 by root, Sat May 24 15:20:46 2008 UTC vs.
Revision 1.59 by root, Thu Jun 5 16:53:11 2008 UTC

2 2
3no warnings; 3no warnings;
4use strict; 4use strict;
5 5
6use AnyEvent (); 6use AnyEvent ();
7use AnyEvent::Util (); 7use AnyEvent::Util qw(WSAEWOULDBLOCK);
8use Scalar::Util (); 8use Scalar::Util ();
9use Carp (); 9use Carp ();
10use Fcntl (); 10use Fcntl ();
11use Errno qw/EAGAIN EINTR/; 11use Errno qw(EAGAIN EINTR);
12 12
13=head1 NAME 13=head1 NAME
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
17This module is experimental.
18
19=cut 17=cut
20 18
21our $VERSION = '0.04'; 19our $VERSION = 4.13;
22 20
23=head1 SYNOPSIS 21=head1 SYNOPSIS
24 22
25 use AnyEvent; 23 use AnyEvent;
26 use AnyEvent::Handle; 24 use AnyEvent::Handle;
27 25
28 my $cv = AnyEvent->condvar; 26 my $cv = AnyEvent->condvar;
29 27
30 my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); 28 my $handle =
31
32 #TODO
33
34 # or use the constructor to pass the callback:
35
36 my $ae_fh2 =
37 AnyEvent::Handle->new ( 29 AnyEvent::Handle->new (
38 fh => \*STDIN, 30 fh => \*STDIN,
39 on_eof => sub { 31 on_eof => sub {
40 $cv->broadcast; 32 $cv->broadcast;
41 }, 33 },
42 #TODO
43 ); 34 );
44 35
45 $cv->wait; 36 # send some request line
37 $handle->push_write ("getinfo\015\012");
38
39 # read the response line
40 $handle->push_read (line => sub {
41 my ($handle, $line) = @_;
42 warn "read line <$line>\n";
43 $cv->send;
44 });
45
46 $cv->recv;
46 47
47=head1 DESCRIPTION 48=head1 DESCRIPTION
48 49
49This 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
50filehandles. For utility functions for doing non-blocking connects and accepts 51filehandles. For utility functions for doing non-blocking connects and accepts
72The filehandle this L<AnyEvent::Handle> object will operate on. 73The filehandle this L<AnyEvent::Handle> object will operate on.
73 74
74NOTE: The filehandle will be set to non-blocking (using 75NOTE: The filehandle will be set to non-blocking (using
75AnyEvent::Util::fh_nonblocking). 76AnyEvent::Util::fh_nonblocking).
76 77
77=item on_eof => $cb->($self) 78=item on_eof => $cb->($handle)
78 79
79Set the callback to be called on EOF. 80Set the callback to be called when an end-of-file condition is detcted,
81i.e. in the case of a socket, when the other side has closed the
82connection cleanly.
80 83
81While not mandatory, it is highly recommended to set an eof callback, 84While not mandatory, it is highly recommended to set an eof callback,
82otherwise you might end up with a closed socket while you are still 85otherwise you might end up with a closed socket while you are still
83waiting for data. 86waiting for data.
84 87
85=item on_error => $cb->($self) 88=item on_error => $cb->($handle, $fatal)
86 89
87This is the fatal error callback, that is called when, well, a fatal error 90This is the error callback, which is called when, well, some error
88occurs, such as not being able to resolve the hostname, failure to connect 91occured, such as not being able to resolve the hostname, failure to
89or a read error. 92connect or a read error.
90 93
91The object will not be in a usable state when this callback has been 94Some errors are fatal (which is indicated by C<$fatal> being true). On
92called. 95fatal errors the handle object will be shut down and will not be
96usable. Non-fatal errors can be retried by simply returning, but it is
97recommended to simply ignore this parameter and instead abondon the handle
98object when this callback is invoked.
93 99
94On callback entrance, the value of C<$!> contains the operating system 100On callback entrance, the value of C<$!> contains the operating system
95error (or C<ENOSPC> or C<EPIPE>). 101error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
96 102
97While not mandatory, it is I<highly> recommended to set this callback, as 103While not mandatory, it is I<highly> recommended to set this callback, as
98you will not be notified of errors otherwise. The default simply calls 104you will not be notified of errors otherwise. The default simply calls
99die. 105C<croak>.
100 106
101=item on_read => $cb->($self) 107=item on_read => $cb->($handle)
102 108
103This sets the default read callback, which is called when data arrives 109This sets the default read callback, which is called when data arrives
104and no read request is in the queue. 110and no read request is in the queue.
105 111
106To access (and remove data from) the read buffer, use the C<< ->rbuf >> 112To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107method or access the C<$self->{rbuf}> member directly. 113method or access the C<$handle->{rbuf}> member directly.
108 114
109When an EOF condition is detected then AnyEvent::Handle will first try to 115When an EOF condition is detected then AnyEvent::Handle will first try to
110feed all the remaining data to the queued callbacks and C<on_read> before 116feed all the remaining data to the queued callbacks and C<on_read> before
111calling the C<on_eof> callback. If no progress can be made, then a fatal 117calling the C<on_eof> callback. If no progress can be made, then a fatal
112error will be raised (with C<$!> set to C<EPIPE>). 118error will be raised (with C<$!> set to C<EPIPE>).
113 119
114=item on_drain => $cb->() 120=item on_drain => $cb->($handle)
115 121
116This sets the callback that is called when the write buffer becomes empty 122This sets the callback that is called when the write buffer becomes empty
117(or when the callback is set and the buffer is empty already). 123(or when the callback is set and the buffer is empty already).
118 124
119To append to the write buffer, use the C<< ->push_write >> method. 125To append to the write buffer, use the C<< ->push_write >> method.
126
127=item timeout => $fractional_seconds
128
129If non-zero, then this enables an "inactivity" timeout: whenever this many
130seconds 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
132missing, an C<ETIMEDOUT> error will be raised).
133
134Note 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
136idle then you should disable the timout temporarily or ignore the timeout
137in the C<on_timeout> callback.
138
139Zero (the default) disables this timeout.
140
141=item on_timeout => $cb->($handle)
142
143Called whenever the inactivity timeout passes. If you return from this
144callback, then the timeout will be reset as if some activity had happened,
145so this condition is not fatal in any way.
120 146
121=item rbuf_max => <bytes> 147=item rbuf_max => <bytes>
122 148
123If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) 149If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
124when the read buffer ever (strictly) exceeds this size. This is useful to 150when the read buffer ever (strictly) exceeds this size. This is useful to
131isn't finished). 157isn't finished).
132 158
133=item read_size => <bytes> 159=item read_size => <bytes>
134 160
135The default read block size (the amount of bytes this module will try to read 161The default read block size (the amount of bytes this module will try to read
136on each [loop iteration). Default: C<4096>. 162during each (loop iteration). Default: C<8192>.
137 163
138=item low_water_mark => <bytes> 164=item low_water_mark => <bytes>
139 165
140Sets the amount of bytes (default: C<0>) that make up an "empty" write 166Sets the amount of bytes (default: C<0>) that make up an "empty" write
141buffer: If the write reaches this size or gets even samller it is 167buffer: If the write reaches this size or gets even samller it is
164 190
165Use the given Net::SSLeay::CTX object to create the new TLS connection 191Use the given Net::SSLeay::CTX object to create the new TLS connection
166(unless a connection object was specified directly). If this parameter is 192(unless a connection object was specified directly). If this parameter is
167missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 193missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168 194
195=item json => JSON or JSON::XS object
196
197This is the json coder object used by the C<json> read and write types.
198
199If 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.
201
202Note 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.
204
205=item filter_r => $cb
206
207=item filter_w => $cb
208
209These exist, but are undocumented at this time.
210
169=back 211=back
170 212
171=cut 213=cut
172 214
173sub new { 215sub new {
182 if ($self->{tls}) { 224 if ($self->{tls}) {
183 require Net::SSLeay; 225 require Net::SSLeay;
184 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); 226 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
185 } 227 }
186 228
187 $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; 229 $self->{_activity} = AnyEvent->now;
188 $self->on_error (delete $self->{on_error}) if $self->{on_error}; 230 $self->_timeout;
231
189 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 232 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
190 $self->on_read (delete $self->{on_read} ) if $self->{on_read}; 233 $self->on_read (delete $self->{on_read} ) if $self->{on_read};
191 234
192 $self->start_read;
193
194 $self 235 $self
195} 236}
196 237
197sub _shutdown { 238sub _shutdown {
198 my ($self) = @_; 239 my ($self) = @_;
199 240
241 delete $self->{_tw};
200 delete $self->{rw}; 242 delete $self->{_rw};
201 delete $self->{ww}; 243 delete $self->{_ww};
202 delete $self->{fh}; 244 delete $self->{fh};
203}
204 245
246 $self->stoptls;
247}
248
205sub error { 249sub _error {
206 my ($self) = @_; 250 my ($self, $errno, $fatal) = @_;
207 251
208 {
209 local $!;
210 $self->_shutdown; 252 $self->_shutdown
211 } 253 if $fatal;
254
255 $! = $errno;
212 256
213 if ($self->{on_error}) { 257 if ($self->{on_error}) {
214 $self->{on_error}($self); 258 $self->{on_error}($self, $fatal);
215 } else { 259 } else {
216 die "AnyEvent::Handle uncaught fatal error: $!"; 260 Carp::croak "AnyEvent::Handle uncaught error: $!";
217 } 261 }
218} 262}
219 263
220=item $fh = $handle->fh 264=item $fh = $handle->fh
221 265
222This method returns the file handle of the L<AnyEvent::Handle> object. 266This method returns the file handle of the L<AnyEvent::Handle> object.
223 267
224=cut 268=cut
225 269
226sub fh { $_[0]->{fh} } 270sub fh { $_[0]{fh} }
227 271
228=item $handle->on_error ($cb) 272=item $handle->on_error ($cb)
229 273
230Replace the current C<on_error> callback (see the C<on_error> constructor argument). 274Replace the current C<on_error> callback (see the C<on_error> constructor argument).
231 275
241 285
242=cut 286=cut
243 287
244sub on_eof { 288sub on_eof {
245 $_[0]{on_eof} = $_[1]; 289 $_[0]{on_eof} = $_[1];
290}
291
292=item $handle->on_timeout ($cb)
293
294Replace the current C<on_timeout> callback, or disables the callback
295(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
296argument.
297
298=cut
299
300sub on_timeout {
301 $_[0]{on_timeout} = $_[1];
302}
303
304#############################################################################
305
306=item $handle->timeout ($seconds)
307
308Configures (or disables) the inactivity timeout.
309
310=cut
311
312sub timeout {
313 my ($self, $timeout) = @_;
314
315 $self->{timeout} = $timeout;
316 $self->_timeout;
317}
318
319# reset the timeout watcher, as neccessary
320# also check for time-outs
321sub _timeout {
322 my ($self) = @_;
323
324 if ($self->{timeout}) {
325 my $NOW = AnyEvent->now;
326
327 # when would the timeout trigger?
328 my $after = $self->{_activity} + $self->{timeout} - $NOW;
329
330 # now or in the past already?
331 if ($after <= 0) {
332 $self->{_activity} = $NOW;
333
334 if ($self->{on_timeout}) {
335 $self->{on_timeout}($self);
336 } else {
337 $self->_error (&Errno::ETIMEDOUT);
338 }
339
340 # callback could have changed timeout value, optimise
341 return unless $self->{timeout};
342
343 # calculate new after
344 $after = $self->{timeout};
345 }
346
347 Scalar::Util::weaken $self;
348 return unless $self; # ->error could have destroyed $self
349
350 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
351 delete $self->{_tw};
352 $self->_timeout;
353 });
354 } else {
355 delete $self->{_tw};
356 }
246} 357}
247 358
248############################################################################# 359#############################################################################
249 360
250=back 361=back
287=cut 398=cut
288 399
289sub _drain_wbuf { 400sub _drain_wbuf {
290 my ($self) = @_; 401 my ($self) = @_;
291 402
292 unless ($self->{ww}) { 403 if (!$self->{_ww} && length $self->{wbuf}) {
404
293 Scalar::Util::weaken $self; 405 Scalar::Util::weaken $self;
406
294 my $cb = sub { 407 my $cb = sub {
295 my $len = syswrite $self->{fh}, $self->{wbuf}; 408 my $len = syswrite $self->{fh}, $self->{wbuf};
296 409
297 if ($len > 0) { 410 if ($len >= 0) {
298 substr $self->{wbuf}, 0, $len, ""; 411 substr $self->{wbuf}, 0, $len, "";
412
413 $self->{_activity} = AnyEvent->now;
299 414
300 $self->{on_drain}($self) 415 $self->{on_drain}($self)
301 if $self->{low_water_mark} >= length $self->{wbuf} 416 if $self->{low_water_mark} >= length $self->{wbuf}
302 && $self->{on_drain}; 417 && $self->{on_drain};
303 418
304 delete $self->{ww} unless length $self->{wbuf}; 419 delete $self->{_ww} unless length $self->{wbuf};
305 } elsif ($! != EAGAIN && $! != EINTR) { 420 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
306 $self->error; 421 $self->_error ($!, 1);
307 } 422 }
308 }; 423 };
309 424
425 # try to write data immediately
426 $cb->();
427
428 # if still data left in wbuf, we need to poll
310 $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); 429 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
311 430 if length $self->{wbuf};
312 $cb->($self);
313 }; 431 };
432}
433
434our %WH;
435
436sub register_write_type($$) {
437 $WH{$_[0]} = $_[1];
314} 438}
315 439
316sub push_write { 440sub push_write {
317 my $self = shift; 441 my $self = shift;
318 442
443 if (@_ > 1) {
444 my $type = shift;
445
446 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
447 ->($self, @_);
448 }
449
319 if ($self->{filter_w}) { 450 if ($self->{filter_w}) {
320 $self->{filter_w}->($self, \$_[0]); 451 $self->{filter_w}($self, \$_[0]);
321 } else { 452 } else {
322 $self->{wbuf} .= $_[0]; 453 $self->{wbuf} .= $_[0];
323 $self->_drain_wbuf; 454 $self->_drain_wbuf;
324 } 455 }
325} 456}
457
458=item $handle->push_write (type => @args)
459
460Instead of formatting your data yourself, you can also let this module do
461the job by specifying a type and type-specific arguments.
462
463Predefined types are (if you have ideas for additional types, feel free to
464drop by and tell us):
465
466=over 4
467
468=item netstring => $string
469
470Formats the given value as netstring
471(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
472
473=cut
474
475register_write_type netstring => sub {
476 my ($self, $string) = @_;
477
478 sprintf "%d:%s,", (length $string), $string
479};
480
481=item json => $array_or_hashref
482
483Encodes 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
485in UTF-8.
486
487JSON objects (and arrays) are self-delimiting, so you can write JSON at
488one end of a handle and read them at the other end without using any
489additional framing.
490
491The generated JSON text is guaranteed not to contain any newlines: While
492this module doesn't need delimiters after or between JSON texts to be
493able to read them, many other languages depend on that.
494
495A simple RPC protocol that interoperates easily with others is to send
496JSON arrays (or objects, although arrays are usually the better choice as
497they mimic how function argument passing works) and a newline after each
498JSON text:
499
500 $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
501 $handle->push_write ("\012");
502
503An AnyEvent::Handle receiver would simply use the C<json> read type and
504rely on the fact that the newline will be skipped as leading whitespace:
505
506 $handle->push_read (json => sub { my $array = $_[1]; ... });
507
508Other languages could read single lines terminated by a newline and pass
509this line into their JSON decoder of choice.
510
511=cut
512
513register_write_type json => sub {
514 my ($self, $ref) = @_;
515
516 require JSON;
517
518 $self->{json} ? $self->{json}->encode ($ref)
519 : JSON::encode_json ($ref)
520};
521
522=back
523
524=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525
526This function (not method) lets you add your own types to C<push_write>.
527Whenever the given C<type> is used, C<push_write> will invoke the code
528reference with the handle object and the remaining arguments.
529
530The code reference is supposed to return a single octet string that will
531be appended to the write buffer.
532
533Note that this is a function, and all types registered this way will be
534global, so try to use unique names.
535
536=cut
326 537
327############################################################################# 538#############################################################################
328 539
329=back 540=back
330 541
354the specified number of bytes which give an XML datagram. 565the specified number of bytes which give an XML datagram.
355 566
356 # in the default state, expect some header bytes 567 # in the default state, expect some header bytes
357 $handle->on_read (sub { 568 $handle->on_read (sub {
358 # some data is here, now queue the length-header-read (4 octets) 569 # some data is here, now queue the length-header-read (4 octets)
359 shift->unshift_read_chunk (4, sub { 570 shift->unshift_read (chunk => 4, sub {
360 # header arrived, decode 571 # header arrived, decode
361 my $len = unpack "N", $_[1]; 572 my $len = unpack "N", $_[1];
362 573
363 # now read the payload 574 # now read the payload
364 shift->unshift_read_chunk ($len, sub { 575 shift->unshift_read (chunk => $len, sub {
365 my $xml = $_[1]; 576 my $xml = $_[1];
366 # handle xml 577 # handle xml
367 }); 578 });
368 }); 579 });
369 }); 580 });
376 587
377 # request one 588 # request one
378 $handle->push_write ("request 1\015\012"); 589 $handle->push_write ("request 1\015\012");
379 590
380 # we expect "ERROR" or "OK" as response, so push a line read 591 # we expect "ERROR" or "OK" as response, so push a line read
381 $handle->push_read_line (sub { 592 $handle->push_read (line => sub {
382 # if we got an "OK", we have to _prepend_ another line, 593 # if we got an "OK", we have to _prepend_ another line,
383 # so it will be read before the second request reads its 64 bytes 594 # so it will be read before the second request reads its 64 bytes
384 # which are already in the queue when this callback is called 595 # which are already in the queue when this callback is called
385 # we don't do this in case we got an error 596 # we don't do this in case we got an error
386 if ($_[1] eq "OK") { 597 if ($_[1] eq "OK") {
387 $_[0]->unshift_read_line (sub { 598 $_[0]->unshift_read (line => sub {
388 my $response = $_[1]; 599 my $response = $_[1];
389 ... 600 ...
390 }); 601 });
391 } 602 }
392 }); 603 });
393 604
394 # request two 605 # request two
395 $handle->push_write ("request 2\015\012"); 606 $handle->push_write ("request 2\015\012");
396 607
397 # simply read 64 bytes, always 608 # simply read 64 bytes, always
398 $handle->push_read_chunk (64, sub { 609 $handle->push_read (chunk => 64, sub {
399 my $response = $_[1]; 610 my $response = $_[1];
400 ... 611 ...
401 }); 612 });
402 613
403=over 4 614=over 4
404 615
405=cut 616=cut
406 617
407sub _drain_rbuf { 618sub _drain_rbuf {
408 my ($self) = @_; 619 my ($self) = @_;
620
621 local $self->{_in_drain} = 1;
409 622
410 if ( 623 if (
411 defined $self->{rbuf_max} 624 defined $self->{rbuf_max}
412 && $self->{rbuf_max} < length $self->{rbuf} 625 && $self->{rbuf_max} < length $self->{rbuf}
413 ) { 626 ) {
414 $! = &Errno::ENOSPC; return $self->error; 627 return $self->_error (&Errno::ENOSPC, 1);
415 } 628 }
416 629
417 return if $self->{in_drain}; 630 while () {
418 local $self->{in_drain} = 1;
419
420 while (my $len = length $self->{rbuf}) {
421 no strict 'refs'; 631 no strict 'refs';
632
633 my $len = length $self->{rbuf};
634
422 if (my $cb = shift @{ $self->{queue} }) { 635 if (my $cb = shift @{ $self->{_queue} }) {
423 if (!$cb->($self)) { 636 unless ($cb->($self)) {
424 if ($self->{eof}) { 637 if ($self->{_eof}) {
425 # no progress can be made (not enough data and no data forthcoming) 638 # no progress can be made (not enough data and no data forthcoming)
426 $! = &Errno::EPIPE; return $self->error; 639 return $self->_error (&Errno::EPIPE, 1);
427 } 640 }
428 641
429 unshift @{ $self->{queue} }, $cb; 642 unshift @{ $self->{_queue} }, $cb;
430 return; 643 last;
431 } 644 }
432 } elsif ($self->{on_read}) { 645 } elsif ($self->{on_read}) {
433 $self->{on_read}($self); 646 $self->{on_read}($self);
434 647
435 if ( 648 if (
436 $self->{eof} # if no further data will arrive
437 && $len == length $self->{rbuf} # and no data has been consumed 649 $len == length $self->{rbuf} # if no data has been consumed
438 && !@{ $self->{queue} } # and the queue is still empty 650 && !@{ $self->{_queue} } # and the queue is still empty
439 && $self->{on_read} # and we still want to read data 651 && $self->{on_read} # but we still have on_read
440 ) { 652 ) {
653 # no further data will arrive
441 # then no progress can be made 654 # so no progress can be made
442 $! = &Errno::EPIPE; return $self->error; 655 return $self->_error (&Errno::EPIPE, 1)
656 if $self->{_eof};
657
658 last; # more data might arrive
443 } 659 }
444 } else { 660 } else {
445 # read side becomes idle 661 # read side becomes idle
446 delete $self->{rw}; 662 delete $self->{_rw};
447 return; 663 last;
448 } 664 }
449 } 665 }
450 666
451 if ($self->{eof}) {
452 $self->_shutdown;
453 $self->{on_eof}($self) 667 $self->{on_eof}($self)
454 if $self->{on_eof}; 668 if $self->{_eof} && $self->{on_eof};
669
670 # may need to restart read watcher
671 unless ($self->{_rw}) {
672 $self->start_read
673 if $self->{on_read} || @{ $self->{_queue} };
455 } 674 }
456} 675}
457 676
458=item $handle->on_read ($cb) 677=item $handle->on_read ($cb)
459 678
465 684
466sub on_read { 685sub on_read {
467 my ($self, $cb) = @_; 686 my ($self, $cb) = @_;
468 687
469 $self->{on_read} = $cb; 688 $self->{on_read} = $cb;
689 $self->_drain_rbuf if $cb && !$self->{_in_drain};
470} 690}
471 691
472=item $handle->rbuf 692=item $handle->rbuf
473 693
474Returns the read buffer (as a modifiable lvalue). 694Returns the read buffer (as a modifiable lvalue).
505interested in (which can be none at all) and return a true value. After returning 725interested in (which can be none at all) and return a true value. After returning
506true, it will be removed from the queue. 726true, it will be removed from the queue.
507 727
508=cut 728=cut
509 729
730our %RH;
731
732sub register_read_type($$) {
733 $RH{$_[0]} = $_[1];
734}
735
510sub push_read { 736sub push_read {
511 my ($self, $cb) = @_; 737 my $self = shift;
738 my $cb = pop;
512 739
740 if (@_) {
741 my $type = shift;
742
743 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
744 ->($self, $cb, @_);
745 }
746
513 push @{ $self->{queue} }, $cb; 747 push @{ $self->{_queue} }, $cb;
514 $self->_drain_rbuf; 748 $self->_drain_rbuf unless $self->{_in_drain};
515} 749}
516 750
517sub unshift_read { 751sub unshift_read {
518 my ($self, $cb) = @_; 752 my $self = shift;
753 my $cb = pop;
519 754
755 if (@_) {
756 my $type = shift;
757
758 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
759 ->($self, $cb, @_);
760 }
761
762
520 push @{ $self->{queue} }, $cb; 763 unshift @{ $self->{_queue} }, $cb;
521 $self->_drain_rbuf; 764 $self->_drain_rbuf unless $self->{_in_drain};
522} 765}
523 766
524=item $handle->push_read_chunk ($len, $cb->($self, $data)) 767=item $handle->push_read (type => @args, $cb)
525 768
526=item $handle->unshift_read_chunk ($len, $cb->($self, $data)) 769=item $handle->unshift_read (type => @args, $cb)
527 770
528Append the given callback to the end of the queue (C<push_read_chunk>) or 771Instead of providing a callback that parses the data itself you can chose
529prepend it (C<unshift_read_chunk>). 772between a number of predefined parsing formats, for chunks of data, lines
773etc.
530 774
531The callback will be called only once C<$len> bytes have been read, and 775Predefined types are (if you have ideas for additional types, feel free to
532these C<$len> bytes will be passed to the callback. 776drop by and tell us):
533 777
534=cut 778=over 4
535 779
536sub _read_chunk($$) { 780=item chunk => $octets, $cb->($handle, $data)
781
782Invoke the callback only once C<$octets> bytes have been read. Pass the
783data read to the callback. The callback will never be called with less
784data.
785
786Example: read 2 bytes.
787
788 $handle->push_read (chunk => 2, sub {
789 warn "yay ", unpack "H*", $_[1];
790 });
791
792=cut
793
794register_read_type chunk => sub {
537 my ($self, $len, $cb) = @_; 795 my ($self, $cb, $len) = @_;
538 796
539 sub { 797 sub {
540 $len <= length $_[0]{rbuf} or return; 798 $len <= length $_[0]{rbuf} or return;
541 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); 799 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
542 1 800 1
543 } 801 }
544} 802};
545 803
804# compatibility with older API
546sub push_read_chunk { 805sub push_read_chunk {
547 $_[0]->push_read (&_read_chunk); 806 $_[0]->push_read (chunk => $_[1], $_[2]);
548} 807}
549
550 808
551sub unshift_read_chunk { 809sub unshift_read_chunk {
552 $_[0]->unshift_read (&_read_chunk); 810 $_[0]->unshift_read (chunk => $_[1], $_[2]);
553} 811}
554 812
555=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol)) 813=item line => [$eol, ]$cb->($handle, $line, $eol)
556
557=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
558
559Append the given callback to the end of the queue (C<push_read_line>) or
560prepend it (C<unshift_read_line>).
561 814
562The callback will be called only once a full line (including the end of 815The callback will be called only once a full line (including the end of
563line marker, C<$eol>) has been read. This line (excluding the end of line 816line marker, C<$eol>) has been read. This line (excluding the end of line
564marker) will be passed to the callback as second argument (C<$line>), and 817marker) will be passed to the callback as second argument (C<$line>), and
565the end of line marker as the third argument (C<$eol>). 818the end of line marker as the third argument (C<$eol>).
576Partial lines at the end of the stream will never be returned, as they are 829Partial lines at the end of the stream will never be returned, as they are
577not marked by the end of line marker. 830not marked by the end of line marker.
578 831
579=cut 832=cut
580 833
581sub _read_line($$) { 834register_read_type line => sub {
582 my $self = shift; 835 my ($self, $cb, $eol) = @_;
583 my $cb = pop;
584 my $eol = @_ ? shift : qr|(\015?\012)|;
585 my $pos;
586 836
837 $eol = qr|(\015?\012)| if @_ < 3;
587 $eol = quotemeta $eol unless ref $eol; 838 $eol = quotemeta $eol unless ref $eol;
588 $eol = qr|^(.*?)($eol)|s; 839 $eol = qr|^(.*?)($eol)|s;
589 840
590 sub { 841 sub {
591 $_[0]{rbuf} =~ s/$eol// or return; 842 $_[0]{rbuf} =~ s/$eol// or return;
592 843
593 $cb->($_[0], $1, $2); 844 $cb->($_[0], $1, $2);
594 1 845 1
595 } 846 }
596} 847};
597 848
849# compatibility with older API
598sub push_read_line { 850sub push_read_line {
599 $_[0]->push_read (&_read_line); 851 my $self = shift;
852 $self->push_read (line => @_);
600} 853}
601 854
602sub unshift_read_line { 855sub unshift_read_line {
603 $_[0]->unshift_read (&_read_line); 856 my $self = shift;
857 $self->unshift_read (line => @_);
604} 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 }
876 return;
877 }
878
879 my $len = $1;
880
881 $self->unshift_read (chunk => $len, sub {
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 });
890 });
891
892 1
893 }
894};
895
896=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
897
898Makes a regex match against the regex object C<$accept> and returns
899everything up to and including the match.
900
901Example: read a single line terminated by '\n'.
902
903 $handle->push_read (regex => qr<\n>, sub { ... });
904
905If C<$reject> is given and not undef, then it determines when the data is
906to be rejected: it is matched against the data when the C<$accept> regex
907does not match and generates an C<EBADMSG> error when it matches. This is
908useful to quickly reject wrong data (to avoid waiting for a timeout or a
909receive buffer overflow).
910
911Example: expect a single decimal number followed by whitespace, reject
912anything else (not the use of an anchor).
913
914 $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
915
916If C<$skip> is given and not C<undef>, then it will be matched against
917the receive buffer when neither C<$accept> nor C<$reject> match,
918and everything preceding and including the match will be accepted
919unconditionally. This is useful to skip large amounts of data that you
920know cannot be matched, so that the C<$accept> or C<$reject> regex do not
921have to start matching from the beginning. This is purely an optimisation
922and is usually worth only when you expect more than a few kilobytes.
923
924Example: expect a http header, which ends at C<\015\012\015\012>. Since we
925expect the header to be very large (it isn't in practise, but...), we use
926a skip regex to skip initial portions. The skip regex is tricky in that
927it only accepts something not ending in either \015 or \012, as these are
928required for the accept regex.
929
930 $handle->push_read (regex =>
931 qr<\015\012\015\012>,
932 undef, # no reject
933 qr<^.*[^\015\012]>,
934 sub { ... });
935
936=cut
937
938register_read_type regex => sub {
939 my ($self, $cb, $accept, $reject, $skip) = @_;
940
941 my $data;
942 my $rbuf = \$self->{rbuf};
943
944 sub {
945 # accept
946 if ($$rbuf =~ $accept) {
947 $data .= substr $$rbuf, 0, $+[0], "";
948 $cb->($self, $data);
949 return 1;
950 }
951
952 # reject
953 if ($reject && $$rbuf =~ $reject) {
954 $self->_error (&Errno::EBADMSG);
955 }
956
957 # skip
958 if ($skip && $$rbuf =~ $skip) {
959 $data .= substr $$rbuf, 0, $+[0], "";
960 }
961
962 ()
963 }
964};
965
966=item json => $cb->($handle, $hash_or_arrayref)
967
968Reads a JSON object or array, decodes it and passes it to the callback.
969
970If a C<json> object was passed to the constructor, then that will be used
971for the final decode, otherwise it will create a JSON coder expecting UTF-8.
972
973This read type uses the incremental parser available with JSON version
9742.09 (and JSON::XS version 2.2) and above. You have to provide a
975dependency on your own: this module will load the JSON module, but
976AnyEvent does not depend on it itself.
977
978Since JSON texts are fully self-delimiting, the C<json> read and write
979types are an ideal simple RPC protocol: just exchange JSON datagrams. See
980the C<json> write type description, above, for an actual example.
981
982=cut
983
984register_read_type json => sub {
985 my ($self, $cb, $accept, $reject, $skip) = @_;
986
987 require JSON;
988
989 my $data;
990 my $rbuf = \$self->{rbuf};
991
992 my $json = $self->{json} ||= JSON->new->utf8;
993
994 sub {
995 my $ref = $json->incr_parse ($self->{rbuf});
996
997 if ($ref) {
998 $self->{rbuf} = $json->incr_text;
999 $json->incr_text = "";
1000 $cb->($self, $ref);
1001
1002 1
1003 } else {
1004 $self->{rbuf} = "";
1005 ()
1006 }
1007 }
1008};
1009
1010=back
1011
1012=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1013
1014This function (not method) lets you add your own types to C<push_read>.
1015
1016Whenever the given C<type> is used, C<push_read> will invoke the code
1017reference with the handle object, the callback and the remaining
1018arguments.
1019
1020The code reference is supposed to return a callback (usually a closure)
1021that works as a plain read callback (see C<< ->push_read ($cb) >>).
1022
1023It should invoke the passed callback when it is done reading (remember to
1024pass C<$handle> as first argument as all other callbacks do that).
1025
1026Note that this is a function, and all types registered this way will be
1027global, so try to use unique names.
1028
1029For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
1030search for C<register_read_type>)).
605 1031
606=item $handle->stop_read 1032=item $handle->stop_read
607 1033
608=item $handle->start_read 1034=item $handle->start_read
609 1035
610In rare cases you actually do not want to read anything from the 1036In rare cases you actually do not want to read anything from the
611socket. In this case you can call C<stop_read>. Neither C<on_read> no 1037socket. In this case you can call C<stop_read>. Neither C<on_read> nor
612any queued callbacks will be executed then. To start reading again, call 1038any queued callbacks will be executed then. To start reading again, call
613C<start_read>. 1039C<start_read>.
614 1040
1041Note that AnyEvent::Handle will automatically C<start_read> for you when
1042you change the C<on_read> callback or push/unshift a read callback, and it
1043will automatically C<stop_read> for you when neither C<on_read> is set nor
1044there are any read requests in the queue.
1045
615=cut 1046=cut
616 1047
617sub stop_read { 1048sub stop_read {
618 my ($self) = @_; 1049 my ($self) = @_;
619 1050
620 delete $self->{rw}; 1051 delete $self->{_rw};
621} 1052}
622 1053
623sub start_read { 1054sub start_read {
624 my ($self) = @_; 1055 my ($self) = @_;
625 1056
626 unless ($self->{rw} || $self->{eof}) { 1057 unless ($self->{_rw} || $self->{_eof}) {
627 Scalar::Util::weaken $self; 1058 Scalar::Util::weaken $self;
628 1059
629 $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1060 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
630 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; 1061 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
631 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1062 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
632 1063
633 if ($len > 0) { 1064 if ($len > 0) {
1065 $self->{_activity} = AnyEvent->now;
1066
634 $self->{filter_r} 1067 $self->{filter_r}
635 ? $self->{filter_r}->($self, $rbuf) 1068 ? $self->{filter_r}($self, $rbuf)
636 : $self->_drain_rbuf; 1069 : $self->{_in_drain} || $self->_drain_rbuf;
637 1070
638 } elsif (defined $len) { 1071 } elsif (defined $len) {
639 delete $self->{rw}; 1072 delete $self->{_rw};
640 $self->{eof} = 1; 1073 $self->{_eof} = 1;
641 $self->_drain_rbuf; 1074 $self->_drain_rbuf unless $self->{_in_drain};
642 1075
643 } elsif ($! != EAGAIN && $! != EINTR) { 1076 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
644 return $self->error; 1077 return $self->_error ($!, 1);
645 } 1078 }
646 }); 1079 });
647 } 1080 }
648} 1081}
649 1082
650sub _dotls { 1083sub _dotls {
651 my ($self) = @_; 1084 my ($self) = @_;
652 1085
1086 my $buf;
1087
653 if (length $self->{tls_wbuf}) { 1088 if (length $self->{_tls_wbuf}) {
654 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { 1089 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
655 substr $self->{tls_wbuf}, 0, $len, ""; 1090 substr $self->{_tls_wbuf}, 0, $len, "";
656 } 1091 }
657 } 1092 }
658 1093
659 if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { 1094 if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
660 $self->{wbuf} .= $buf; 1095 $self->{wbuf} .= $buf;
661 $self->_drain_wbuf; 1096 $self->_drain_wbuf;
662 } 1097 }
663 1098
664 while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { 1099 while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1100 if (length $buf) {
665 $self->{rbuf} .= $buf; 1101 $self->{rbuf} .= $buf;
666 $self->_drain_rbuf; 1102 $self->_drain_rbuf unless $self->{_in_drain};
1103 } else {
1104 # let's treat SSL-eof as we treat normal EOF
1105 $self->{_eof} = 1;
1106 $self->_shutdown;
1107 return;
1108 }
667 } 1109 }
668 1110
669 my $err = Net::SSLeay::get_error ($self->{tls}, -1); 1111 my $err = Net::SSLeay::get_error ($self->{tls}, -1);
670 1112
671 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { 1113 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
672 if ($err == Net::SSLeay::ERROR_SYSCALL ()) { 1114 if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
673 $self->error; 1115 return $self->_error ($!, 1);
674 } elsif ($err == Net::SSLeay::ERROR_SSL ()) { 1116 } elsif ($err == Net::SSLeay::ERROR_SSL ()) {
675 $! = &Errno::EIO; 1117 return $self->_error (&Errno::EIO, 1);
676 $self->error;
677 } 1118 }
678 1119
679 # all others are fine for our purposes 1120 # all others are fine for our purposes
680 } 1121 }
681} 1122}
690C<"connect">, C<"accept"> or an existing Net::SSLeay object). 1131C<"connect">, C<"accept"> or an existing Net::SSLeay object).
691 1132
692The second argument is the optional C<Net::SSLeay::CTX> object that is 1133The second argument is the optional C<Net::SSLeay::CTX> object that is
693used when AnyEvent::Handle has to create its own TLS connection object. 1134used when AnyEvent::Handle has to create its own TLS connection object.
694 1135
695=cut 1136The TLS connection object will end up in C<< $handle->{tls} >> after this
1137call and can be used or changed to your liking. Note that the handshake
1138might have already started when this function returns.
696 1139
697# TODO: maybe document... 1140=cut
1141
698sub starttls { 1142sub starttls {
699 my ($self, $ssl, $ctx) = @_; 1143 my ($self, $ssl, $ctx) = @_;
700 1144
701 $self->stoptls; 1145 $self->stoptls;
702 1146
712 1156
713 # basically, this is deep magic (because SSL_read should have the same issues) 1157 # basically, this is deep magic (because SSL_read should have the same issues)
714 # but the openssl maintainers basically said: "trust us, it just works". 1158 # but the openssl maintainers basically said: "trust us, it just works".
715 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1159 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
716 # and mismaintained ssleay-module doesn't even offer them). 1160 # and mismaintained ssleay-module doesn't even offer them).
1161 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
717 Net::SSLeay::CTX_set_mode ($self->{tls}, 1162 Net::SSLeay::CTX_set_mode ($self->{tls},
718 (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1163 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
719 | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1164 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
720 1165
721 $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1166 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
722 $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1167 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
723 1168
724 Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); 1169 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
725 1170
726 $self->{filter_w} = sub { 1171 $self->{filter_w} = sub {
727 $_[0]{tls_wbuf} .= ${$_[1]}; 1172 $_[0]{_tls_wbuf} .= ${$_[1]};
728 &_dotls; 1173 &_dotls;
729 }; 1174 };
730 $self->{filter_r} = sub { 1175 $self->{filter_r} = sub {
731 Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); 1176 Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
732 &_dotls; 1177 &_dotls;
733 }; 1178 };
734} 1179}
735 1180
736=item $handle->stoptls 1181=item $handle->stoptls
742 1187
743sub stoptls { 1188sub stoptls {
744 my ($self) = @_; 1189 my ($self) = @_;
745 1190
746 Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; 1191 Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
1192
747 delete $self->{tls_rbio}; 1193 delete $self->{_rbio};
748 delete $self->{tls_wbio}; 1194 delete $self->{_wbio};
749 delete $self->{tls_wbuf}; 1195 delete $self->{_tls_wbuf};
750 delete $self->{filter_r}; 1196 delete $self->{filter_r};
751 delete $self->{filter_w}; 1197 delete $self->{filter_w};
752} 1198}
753 1199
754sub DESTROY { 1200sub DESTROY {
792 } 1238 }
793} 1239}
794 1240
795=back 1241=back
796 1242
1243=head1 SUBCLASSING AnyEvent::Handle
1244
1245In many cases, you might want to subclass AnyEvent::Handle.
1246
1247To make this easier, a given version of AnyEvent::Handle uses these
1248conventions:
1249
1250=over 4
1251
1252=item * all constructor arguments become object members.
1253
1254At 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
1256mutated later on (for example C<tls> will hold the TLS connection object).
1257
1258=item * other object member names are prefixed with an C<_>.
1259
1260All object members not explicitly documented (internal use) are prefixed
1261with an underscore character, so the remaining non-C<_>-namespace is free
1262for use for subclasses.
1263
1264=item * all members not documented here and not prefixed with an underscore
1265are free to use in subclasses.
1266
1267Of course, new versions of AnyEvent::Handle may introduce more "public"
1268member variables, but thats just life, at least it is documented.
1269
1270=back
1271
797=head1 AUTHOR 1272=head1 AUTHOR
798 1273
799Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. 1274Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
800 1275
801=cut 1276=cut

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines