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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines