… | |
… | |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict; |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util (); |
7 | use AnyEvent::Util qw(WSAWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw/EAGAIN EINTR/; |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | This module is experimental. |
|
|
18 | |
|
|
19 | =cut |
17 | =cut |
20 | |
18 | |
21 | our $VERSION = '0.04'; |
19 | our $VERSION = '0.04'; |
22 | |
20 | |
23 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
… | |
… | |
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 | |
49 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
… | |
… | |
72 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | |
74 | |
74 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
76 | |
77 | |
77 | =item on_eof => $cb->($self) |
78 | =item on_eof => $cb->($handle) |
78 | |
79 | |
79 | Set the callback to be called on EOF. |
80 | Set the callback to be called on EOF. |
80 | |
81 | |
81 | While not mandatory, it is highly recommended to set an eof callback, |
82 | While not mandatory, it is highly recommended to set an eof callback, |
82 | otherwise you might end up with a closed socket while you are still |
83 | otherwise you might end up with a closed socket while you are still |
83 | waiting for data. |
84 | waiting for data. |
84 | |
85 | |
85 | =item on_error => $cb->($self) |
86 | =item on_error => $cb->($handle) |
86 | |
87 | |
87 | This is the fatal error callback, that is called when, well, a fatal error |
88 | This is the fatal error callback, that is called when, well, a fatal error |
88 | occurs, such as not being able to resolve the hostname, failure to connect |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
89 | or a read error. |
90 | or a read error. |
90 | |
91 | |
91 | The object will not be in a usable state when this callback has been |
92 | The object will not be in a usable state when this callback has been |
92 | called. |
93 | called. |
93 | |
94 | |
94 | On callback entrance, the value of C<$!> contains the operating system |
95 | On callback entrance, the value of C<$!> contains the operating system |
95 | error (or C<ENOSPC> or C<EPIPE>). |
96 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
|
|
97 | |
|
|
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
96 | |
100 | |
97 | While not mandatory, it is I<highly> recommended to set this callback, as |
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
98 | you will not be notified of errors otherwise. The default simply calls |
102 | you will not be notified of errors otherwise. The default simply calls |
99 | die. |
103 | die. |
100 | |
104 | |
101 | =item on_read => $cb->($self) |
105 | =item on_read => $cb->($handle) |
102 | |
106 | |
103 | This sets the default read callback, which is called when data arrives |
107 | This sets the default read callback, which is called when data arrives |
104 | and no read request is in the queue. |
108 | and no read request is in the queue. |
105 | |
109 | |
106 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
107 | method or access the C<$self->{rbuf}> member directly. |
111 | method or access the C<$handle->{rbuf}> member directly. |
108 | |
112 | |
109 | When an EOF condition is detected then AnyEvent::Handle will first try to |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
110 | feed all the remaining data to the queued callbacks and C<on_read> before |
114 | feed all the remaining data to the queued callbacks and C<on_read> before |
111 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
115 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
112 | error will be raised (with C<$!> set to C<EPIPE>). |
116 | error will be raised (with C<$!> set to C<EPIPE>). |
113 | |
117 | |
114 | =item on_drain => $cb->() |
118 | =item on_drain => $cb->($handle) |
115 | |
119 | |
116 | This sets the callback that is called when the write buffer becomes empty |
120 | This 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). |
121 | (or when the callback is set and the buffer is empty already). |
118 | |
122 | |
119 | To append to the write buffer, use the C<< ->push_write >> method. |
123 | To append to the write buffer, use the C<< ->push_write >> method. |
… | |
… | |
164 | |
168 | |
165 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
169 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
166 | (unless a connection object was specified directly). If this parameter is |
170 | (unless a connection object was specified directly). If this parameter is |
167 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
168 | |
172 | |
|
|
173 | =item json => JSON or JSON::XS object |
|
|
174 | |
|
|
175 | This is the json coder object used by the C<json> read and write types. |
|
|
176 | |
|
|
177 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
178 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
|
|
179 | |
|
|
180 | Note that you are responsible to depend on the JSON module if you want to |
|
|
181 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
182 | |
|
|
183 | =item filter_r => $cb |
|
|
184 | |
|
|
185 | =item filter_w => $cb |
|
|
186 | |
|
|
187 | These exist, but are undocumented at this time. |
|
|
188 | |
169 | =back |
189 | =back |
170 | |
190 | |
171 | =cut |
191 | =cut |
172 | |
192 | |
173 | sub new { |
193 | sub new { |
… | |
… | |
195 | } |
215 | } |
196 | |
216 | |
197 | sub _shutdown { |
217 | sub _shutdown { |
198 | my ($self) = @_; |
218 | my ($self) = @_; |
199 | |
219 | |
200 | delete $self->{rw}; |
220 | delete $self->{_rw}; |
201 | delete $self->{ww}; |
221 | delete $self->{_ww}; |
202 | delete $self->{fh}; |
222 | delete $self->{fh}; |
203 | } |
223 | } |
204 | |
224 | |
205 | sub error { |
225 | sub error { |
206 | my ($self) = @_; |
226 | my ($self) = @_; |
… | |
… | |
208 | { |
228 | { |
209 | local $!; |
229 | local $!; |
210 | $self->_shutdown; |
230 | $self->_shutdown; |
211 | } |
231 | } |
212 | |
232 | |
213 | if ($self->{on_error}) { |
|
|
214 | $self->{on_error}($self); |
233 | $self->{on_error}($self) |
215 | } else { |
234 | if $self->{on_error}; |
|
|
235 | |
216 | die "AnyEvent::Handle uncaught fatal error: $!"; |
236 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
217 | } |
|
|
218 | } |
237 | } |
219 | |
238 | |
220 | =item $fh = $handle->fh |
239 | =item $fh = $handle->fh |
221 | |
240 | |
222 | This method returns the file handle of the L<AnyEvent::Handle> object. |
241 | This method returns the file handle of the L<AnyEvent::Handle> object. |
223 | |
242 | |
224 | =cut |
243 | =cut |
225 | |
244 | |
226 | sub fh { $_[0]->{fh} } |
245 | sub fh { $_[0]{fh} } |
227 | |
246 | |
228 | =item $handle->on_error ($cb) |
247 | =item $handle->on_error ($cb) |
229 | |
248 | |
230 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
249 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
231 | |
250 | |
… | |
… | |
287 | =cut |
306 | =cut |
288 | |
307 | |
289 | sub _drain_wbuf { |
308 | sub _drain_wbuf { |
290 | my ($self) = @_; |
309 | my ($self) = @_; |
291 | |
310 | |
292 | unless ($self->{ww}) { |
311 | if (!$self->{_ww} && length $self->{wbuf}) { |
|
|
312 | |
293 | Scalar::Util::weaken $self; |
313 | Scalar::Util::weaken $self; |
|
|
314 | |
294 | my $cb = sub { |
315 | my $cb = sub { |
295 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
316 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
296 | |
317 | |
297 | if ($len > 0) { |
318 | if ($len >= 0) { |
298 | substr $self->{wbuf}, 0, $len, ""; |
319 | substr $self->{wbuf}, 0, $len, ""; |
299 | |
320 | |
300 | $self->{on_drain}($self) |
321 | $self->{on_drain}($self) |
301 | if $self->{low_water_mark} >= length $self->{wbuf} |
322 | if $self->{low_water_mark} >= length $self->{wbuf} |
302 | && $self->{on_drain}; |
323 | && $self->{on_drain}; |
303 | |
324 | |
304 | delete $self->{ww} unless length $self->{wbuf}; |
325 | delete $self->{_ww} unless length $self->{wbuf}; |
305 | } elsif ($! != EAGAIN && $! != EINTR) { |
326 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
306 | $self->error; |
327 | $self->error; |
307 | } |
328 | } |
308 | }; |
329 | }; |
309 | |
330 | |
|
|
331 | # try to write data immediately |
|
|
332 | $cb->(); |
|
|
333 | |
|
|
334 | # if still data left in wbuf, we need to poll |
310 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
335 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
311 | |
336 | if length $self->{wbuf}; |
312 | $cb->($self); |
|
|
313 | }; |
337 | }; |
|
|
338 | } |
|
|
339 | |
|
|
340 | our %WH; |
|
|
341 | |
|
|
342 | sub register_write_type($$) { |
|
|
343 | $WH{$_[0]} = $_[1]; |
314 | } |
344 | } |
315 | |
345 | |
316 | sub push_write { |
346 | sub push_write { |
317 | my $self = shift; |
347 | my $self = shift; |
|
|
348 | |
|
|
349 | if (@_ > 1) { |
|
|
350 | my $type = shift; |
|
|
351 | |
|
|
352 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
|
|
353 | ->($self, @_); |
|
|
354 | } |
318 | |
355 | |
319 | if ($self->{filter_w}) { |
356 | if ($self->{filter_w}) { |
320 | $self->{filter_w}->($self, \$_[0]); |
357 | $self->{filter_w}->($self, \$_[0]); |
321 | } else { |
358 | } else { |
322 | $self->{wbuf} .= $_[0]; |
359 | $self->{wbuf} .= $_[0]; |
323 | $self->_drain_wbuf; |
360 | $self->_drain_wbuf; |
324 | } |
361 | } |
325 | } |
362 | } |
|
|
363 | |
|
|
364 | =item $handle->push_write (type => @args) |
|
|
365 | |
|
|
366 | =item $handle->unshift_write (type => @args) |
|
|
367 | |
|
|
368 | Instead of formatting your data yourself, you can also let this module do |
|
|
369 | the job by specifying a type and type-specific arguments. |
|
|
370 | |
|
|
371 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
372 | drop by and tell us): |
|
|
373 | |
|
|
374 | =over 4 |
|
|
375 | |
|
|
376 | =item netstring => $string |
|
|
377 | |
|
|
378 | Formats the given value as netstring |
|
|
379 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
|
|
380 | |
|
|
381 | =back |
|
|
382 | |
|
|
383 | =cut |
|
|
384 | |
|
|
385 | register_write_type netstring => sub { |
|
|
386 | my ($self, $string) = @_; |
|
|
387 | |
|
|
388 | sprintf "%d:%s,", (length $string), $string |
|
|
389 | }; |
|
|
390 | |
|
|
391 | =item json => $array_or_hashref |
|
|
392 | |
|
|
393 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
394 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
395 | in UTF-8. |
|
|
396 | |
|
|
397 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
398 | one end of a handle and read them at the other end without using any |
|
|
399 | additional framing. |
|
|
400 | |
|
|
401 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
402 | this module doesn't need delimiters after or between JSON texts to be |
|
|
403 | able to read them, many other languages depend on that. |
|
|
404 | |
|
|
405 | A simple RPC protocol that interoperates easily with others is to send |
|
|
406 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
407 | they mimic how function argument passing works) and a newline after each |
|
|
408 | JSON text: |
|
|
409 | |
|
|
410 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
411 | $handle->push_write ("\012"); |
|
|
412 | |
|
|
413 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
414 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
415 | |
|
|
416 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
417 | |
|
|
418 | Other languages could read single lines terminated by a newline and pass |
|
|
419 | this line into their JSON decoder of choice. |
|
|
420 | |
|
|
421 | =cut |
|
|
422 | |
|
|
423 | register_write_type json => sub { |
|
|
424 | my ($self, $ref) = @_; |
|
|
425 | |
|
|
426 | require JSON; |
|
|
427 | |
|
|
428 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
429 | : JSON::encode_json ($ref) |
|
|
430 | }; |
|
|
431 | |
|
|
432 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
|
|
433 | |
|
|
434 | This function (not method) lets you add your own types to C<push_write>. |
|
|
435 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
436 | reference with the handle object and the remaining arguments. |
|
|
437 | |
|
|
438 | The code reference is supposed to return a single octet string that will |
|
|
439 | be appended to the write buffer. |
|
|
440 | |
|
|
441 | Note that this is a function, and all types registered this way will be |
|
|
442 | global, so try to use unique names. |
|
|
443 | |
|
|
444 | =cut |
326 | |
445 | |
327 | ############################################################################# |
446 | ############################################################################# |
328 | |
447 | |
329 | =back |
448 | =back |
330 | |
449 | |
… | |
… | |
409 | |
528 | |
410 | if ( |
529 | if ( |
411 | defined $self->{rbuf_max} |
530 | defined $self->{rbuf_max} |
412 | && $self->{rbuf_max} < length $self->{rbuf} |
531 | && $self->{rbuf_max} < length $self->{rbuf} |
413 | ) { |
532 | ) { |
414 | $! = &Errno::ENOSPC; return $self->error; |
533 | $! = &Errno::ENOSPC; |
|
|
534 | $self->error; |
415 | } |
535 | } |
416 | |
536 | |
417 | return if $self->{in_drain}; |
537 | return if $self->{in_drain}; |
418 | local $self->{in_drain} = 1; |
538 | local $self->{in_drain} = 1; |
419 | |
539 | |
420 | while (my $len = length $self->{rbuf}) { |
540 | while (my $len = length $self->{rbuf}) { |
421 | no strict 'refs'; |
541 | no strict 'refs'; |
422 | if (my $cb = shift @{ $self->{queue} }) { |
542 | if (my $cb = shift @{ $self->{_queue} }) { |
423 | if (!$cb->($self)) { |
543 | unless ($cb->($self)) { |
424 | if ($self->{eof}) { |
544 | if ($self->{_eof}) { |
425 | # no progress can be made (not enough data and no data forthcoming) |
545 | # no progress can be made (not enough data and no data forthcoming) |
426 | $! = &Errno::EPIPE; return $self->error; |
546 | $! = &Errno::EPIPE; |
|
|
547 | $self->error; |
427 | } |
548 | } |
428 | |
549 | |
429 | unshift @{ $self->{queue} }, $cb; |
550 | unshift @{ $self->{_queue} }, $cb; |
430 | return; |
551 | return; |
431 | } |
552 | } |
432 | } elsif ($self->{on_read}) { |
553 | } elsif ($self->{on_read}) { |
433 | $self->{on_read}($self); |
554 | $self->{on_read}($self); |
434 | |
555 | |
435 | if ( |
556 | if ( |
436 | $self->{eof} # if no further data will arrive |
557 | $self->{_eof} # if no further data will arrive |
437 | && $len == length $self->{rbuf} # and no data has been consumed |
558 | && $len == length $self->{rbuf} # and no data has been consumed |
438 | && !@{ $self->{queue} } # and the queue is still empty |
559 | && !@{ $self->{_queue} } # and the queue is still empty |
439 | && $self->{on_read} # and we still want to read data |
560 | && $self->{on_read} # and we still want to read data |
440 | ) { |
561 | ) { |
441 | # then no progress can be made |
562 | # then no progress can be made |
442 | $! = &Errno::EPIPE; return $self->error; |
563 | $! = &Errno::EPIPE; |
|
|
564 | $self->error; |
443 | } |
565 | } |
444 | } else { |
566 | } else { |
445 | # read side becomes idle |
567 | # read side becomes idle |
446 | delete $self->{rw}; |
568 | delete $self->{_rw}; |
447 | return; |
569 | return; |
448 | } |
570 | } |
449 | } |
571 | } |
450 | |
572 | |
451 | if ($self->{eof}) { |
573 | if ($self->{_eof}) { |
452 | $self->_shutdown; |
574 | $self->_shutdown; |
453 | $self->{on_eof}($self) |
575 | $self->{on_eof}($self) |
454 | if $self->{on_eof}; |
576 | if $self->{on_eof}; |
455 | } |
577 | } |
456 | } |
578 | } |
… | |
… | |
505 | interested in (which can be none at all) and return a true value. After returning |
627 | interested in (which can be none at all) and return a true value. After returning |
506 | true, it will be removed from the queue. |
628 | true, it will be removed from the queue. |
507 | |
629 | |
508 | =cut |
630 | =cut |
509 | |
631 | |
|
|
632 | our %RH; |
|
|
633 | |
|
|
634 | sub register_read_type($$) { |
|
|
635 | $RH{$_[0]} = $_[1]; |
|
|
636 | } |
|
|
637 | |
510 | sub push_read { |
638 | sub push_read { |
511 | my ($self, $cb) = @_; |
639 | my $self = shift; |
|
|
640 | my $cb = pop; |
512 | |
641 | |
|
|
642 | if (@_) { |
|
|
643 | my $type = shift; |
|
|
644 | |
|
|
645 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
|
|
646 | ->($self, $cb, @_); |
|
|
647 | } |
|
|
648 | |
513 | push @{ $self->{queue} }, $cb; |
649 | push @{ $self->{_queue} }, $cb; |
514 | $self->_drain_rbuf; |
650 | $self->_drain_rbuf; |
515 | } |
651 | } |
516 | |
652 | |
517 | sub unshift_read { |
653 | sub unshift_read { |
518 | my ($self, $cb) = @_; |
654 | my $self = shift; |
|
|
655 | my $cb = pop; |
519 | |
656 | |
|
|
657 | if (@_) { |
|
|
658 | my $type = shift; |
|
|
659 | |
|
|
660 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
|
|
661 | ->($self, $cb, @_); |
|
|
662 | } |
|
|
663 | |
|
|
664 | |
520 | push @{ $self->{queue} }, $cb; |
665 | unshift @{ $self->{_queue} }, $cb; |
521 | $self->_drain_rbuf; |
666 | $self->_drain_rbuf; |
522 | } |
667 | } |
523 | |
668 | |
524 | =item $handle->push_read_chunk ($len, $cb->($self, $data)) |
669 | =item $handle->push_read (type => @args, $cb) |
525 | |
670 | |
526 | =item $handle->unshift_read_chunk ($len, $cb->($self, $data)) |
671 | =item $handle->unshift_read (type => @args, $cb) |
527 | |
672 | |
528 | Append the given callback to the end of the queue (C<push_read_chunk>) or |
673 | Instead of providing a callback that parses the data itself you can chose |
529 | prepend it (C<unshift_read_chunk>). |
674 | between a number of predefined parsing formats, for chunks of data, lines |
|
|
675 | etc. |
530 | |
676 | |
531 | The callback will be called only once C<$len> bytes have been read, and |
677 | Predefined types are (if you have ideas for additional types, feel free to |
532 | these C<$len> bytes will be passed to the callback. |
678 | drop by and tell us): |
533 | |
679 | |
534 | =cut |
680 | =over 4 |
535 | |
681 | |
536 | sub _read_chunk($$) { |
682 | =item chunk => $octets, $cb->($handle, $data) |
|
|
683 | |
|
|
684 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
|
|
685 | data read to the callback. The callback will never be called with less |
|
|
686 | data. |
|
|
687 | |
|
|
688 | Example: read 2 bytes. |
|
|
689 | |
|
|
690 | $handle->push_read (chunk => 2, sub { |
|
|
691 | warn "yay ", unpack "H*", $_[1]; |
|
|
692 | }); |
|
|
693 | |
|
|
694 | =cut |
|
|
695 | |
|
|
696 | register_read_type chunk => sub { |
537 | my ($self, $len, $cb) = @_; |
697 | my ($self, $cb, $len) = @_; |
538 | |
698 | |
539 | sub { |
699 | sub { |
540 | $len <= length $_[0]{rbuf} or return; |
700 | $len <= length $_[0]{rbuf} or return; |
541 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
701 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
542 | 1 |
702 | 1 |
543 | } |
703 | } |
544 | } |
704 | }; |
545 | |
705 | |
|
|
706 | # compatibility with older API |
546 | sub push_read_chunk { |
707 | sub push_read_chunk { |
547 | $_[0]->push_read (&_read_chunk); |
708 | $_[0]->push_read (chunk => $_[1], $_[2]); |
548 | } |
709 | } |
549 | |
|
|
550 | |
710 | |
551 | sub unshift_read_chunk { |
711 | sub unshift_read_chunk { |
552 | $_[0]->unshift_read (&_read_chunk); |
712 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
553 | } |
713 | } |
554 | |
714 | |
555 | =item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol)) |
715 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
556 | |
|
|
557 | =item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol)) |
|
|
558 | |
|
|
559 | Append the given callback to the end of the queue (C<push_read_line>) or |
|
|
560 | prepend it (C<unshift_read_line>). |
|
|
561 | |
716 | |
562 | The callback will be called only once a full line (including the end of |
717 | The callback will be called only once a full line (including the end of |
563 | line marker, C<$eol>) has been read. This line (excluding the end of line |
718 | line marker, C<$eol>) has been read. This line (excluding the end of line |
564 | marker) will be passed to the callback as second argument (C<$line>), and |
719 | marker) will be passed to the callback as second argument (C<$line>), and |
565 | the end of line marker as the third argument (C<$eol>). |
720 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
576 | Partial lines at the end of the stream will never be returned, as they are |
731 | Partial lines at the end of the stream will never be returned, as they are |
577 | not marked by the end of line marker. |
732 | not marked by the end of line marker. |
578 | |
733 | |
579 | =cut |
734 | =cut |
580 | |
735 | |
581 | sub _read_line($$) { |
736 | register_read_type line => sub { |
582 | my $self = shift; |
737 | my ($self, $cb, $eol) = @_; |
583 | my $cb = pop; |
|
|
584 | my $eol = @_ ? shift : qr|(\015?\012)|; |
|
|
585 | my $pos; |
|
|
586 | |
738 | |
|
|
739 | $eol = qr|(\015?\012)| if @_ < 3; |
587 | $eol = quotemeta $eol unless ref $eol; |
740 | $eol = quotemeta $eol unless ref $eol; |
588 | $eol = qr|^(.*?)($eol)|s; |
741 | $eol = qr|^(.*?)($eol)|s; |
589 | |
742 | |
590 | sub { |
743 | sub { |
591 | $_[0]{rbuf} =~ s/$eol// or return; |
744 | $_[0]{rbuf} =~ s/$eol// or return; |
592 | |
745 | |
593 | $cb->($_[0], $1, $2); |
746 | $cb->($_[0], $1, $2); |
594 | 1 |
747 | 1 |
595 | } |
748 | } |
596 | } |
749 | }; |
597 | |
750 | |
|
|
751 | # compatibility with older API |
598 | sub push_read_line { |
752 | sub push_read_line { |
599 | $_[0]->push_read (&_read_line); |
753 | my $self = shift; |
|
|
754 | $self->push_read (line => @_); |
600 | } |
755 | } |
601 | |
756 | |
602 | sub unshift_read_line { |
757 | sub unshift_read_line { |
603 | $_[0]->unshift_read (&_read_line); |
758 | my $self = shift; |
|
|
759 | $self->unshift_read (line => @_); |
604 | } |
760 | } |
|
|
761 | |
|
|
762 | =item netstring => $cb->($handle, $string) |
|
|
763 | |
|
|
764 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
765 | |
|
|
766 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
767 | |
|
|
768 | =cut |
|
|
769 | |
|
|
770 | register_read_type netstring => sub { |
|
|
771 | my ($self, $cb) = @_; |
|
|
772 | |
|
|
773 | sub { |
|
|
774 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
775 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
776 | $! = &Errno::EBADMSG; |
|
|
777 | $self->error; |
|
|
778 | } |
|
|
779 | return; |
|
|
780 | } |
|
|
781 | |
|
|
782 | my $len = $1; |
|
|
783 | |
|
|
784 | $self->unshift_read (chunk => $len, sub { |
|
|
785 | my $string = $_[1]; |
|
|
786 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
787 | if ($_[1] eq ",") { |
|
|
788 | $cb->($_[0], $string); |
|
|
789 | } else { |
|
|
790 | $! = &Errno::EBADMSG; |
|
|
791 | $self->error; |
|
|
792 | } |
|
|
793 | }); |
|
|
794 | }); |
|
|
795 | |
|
|
796 | 1 |
|
|
797 | } |
|
|
798 | }; |
|
|
799 | |
|
|
800 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
|
|
801 | |
|
|
802 | Makes a regex match against the regex object C<$accept> and returns |
|
|
803 | everything up to and including the match. |
|
|
804 | |
|
|
805 | Example: read a single line terminated by '\n'. |
|
|
806 | |
|
|
807 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
808 | |
|
|
809 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
810 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
811 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
812 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
813 | receive buffer overflow). |
|
|
814 | |
|
|
815 | Example: expect a single decimal number followed by whitespace, reject |
|
|
816 | anything else (not the use of an anchor). |
|
|
817 | |
|
|
818 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
819 | |
|
|
820 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
821 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
822 | and everything preceding and including the match will be accepted |
|
|
823 | unconditionally. This is useful to skip large amounts of data that you |
|
|
824 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
825 | have to start matching from the beginning. This is purely an optimisation |
|
|
826 | and is usually worth only when you expect more than a few kilobytes. |
|
|
827 | |
|
|
828 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
829 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
830 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
831 | it only accepts something not ending in either \015 or \012, as these are |
|
|
832 | required for the accept regex. |
|
|
833 | |
|
|
834 | $handle->push_read (regex => |
|
|
835 | qr<\015\012\015\012>, |
|
|
836 | undef, # no reject |
|
|
837 | qr<^.*[^\015\012]>, |
|
|
838 | sub { ... }); |
|
|
839 | |
|
|
840 | =cut |
|
|
841 | |
|
|
842 | register_read_type regex => sub { |
|
|
843 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
844 | |
|
|
845 | my $data; |
|
|
846 | my $rbuf = \$self->{rbuf}; |
|
|
847 | |
|
|
848 | sub { |
|
|
849 | # accept |
|
|
850 | if ($$rbuf =~ $accept) { |
|
|
851 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
852 | $cb->($self, $data); |
|
|
853 | return 1; |
|
|
854 | } |
|
|
855 | |
|
|
856 | # reject |
|
|
857 | if ($reject && $$rbuf =~ $reject) { |
|
|
858 | $! = &Errno::EBADMSG; |
|
|
859 | $self->error; |
|
|
860 | } |
|
|
861 | |
|
|
862 | # skip |
|
|
863 | if ($skip && $$rbuf =~ $skip) { |
|
|
864 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
865 | } |
|
|
866 | |
|
|
867 | () |
|
|
868 | } |
|
|
869 | }; |
|
|
870 | |
|
|
871 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
872 | |
|
|
873 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
874 | |
|
|
875 | If a C<json> object was passed to the constructor, then that will be used |
|
|
876 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
877 | |
|
|
878 | This read type uses the incremental parser available with JSON version |
|
|
879 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
880 | dependency on your own: this module will load the JSON module, but |
|
|
881 | AnyEvent does not depend on it itself. |
|
|
882 | |
|
|
883 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
884 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
885 | the C<json> write type description, above, for an actual example. |
|
|
886 | |
|
|
887 | =cut |
|
|
888 | |
|
|
889 | register_read_type json => sub { |
|
|
890 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
891 | |
|
|
892 | require JSON; |
|
|
893 | |
|
|
894 | my $data; |
|
|
895 | my $rbuf = \$self->{rbuf}; |
|
|
896 | |
|
|
897 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
898 | |
|
|
899 | sub { |
|
|
900 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
901 | |
|
|
902 | if ($ref) { |
|
|
903 | $self->{rbuf} = $json->incr_text; |
|
|
904 | $json->incr_text = ""; |
|
|
905 | $cb->($self, $ref); |
|
|
906 | |
|
|
907 | 1 |
|
|
908 | } else { |
|
|
909 | $self->{rbuf} = ""; |
|
|
910 | () |
|
|
911 | } |
|
|
912 | } |
|
|
913 | }; |
|
|
914 | |
|
|
915 | =back |
|
|
916 | |
|
|
917 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
|
|
918 | |
|
|
919 | This function (not method) lets you add your own types to C<push_read>. |
|
|
920 | |
|
|
921 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
922 | reference with the handle object, the callback and the remaining |
|
|
923 | arguments. |
|
|
924 | |
|
|
925 | The code reference is supposed to return a callback (usually a closure) |
|
|
926 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
927 | |
|
|
928 | It should invoke the passed callback when it is done reading (remember to |
|
|
929 | pass C<$handle> as first argument as all other callbacks do that). |
|
|
930 | |
|
|
931 | Note that this is a function, and all types registered this way will be |
|
|
932 | global, so try to use unique names. |
|
|
933 | |
|
|
934 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
935 | search for C<register_read_type>)). |
605 | |
936 | |
606 | =item $handle->stop_read |
937 | =item $handle->stop_read |
607 | |
938 | |
608 | =item $handle->start_read |
939 | =item $handle->start_read |
609 | |
940 | |
… | |
… | |
615 | =cut |
946 | =cut |
616 | |
947 | |
617 | sub stop_read { |
948 | sub stop_read { |
618 | my ($self) = @_; |
949 | my ($self) = @_; |
619 | |
950 | |
620 | delete $self->{rw}; |
951 | delete $self->{_rw}; |
621 | } |
952 | } |
622 | |
953 | |
623 | sub start_read { |
954 | sub start_read { |
624 | my ($self) = @_; |
955 | my ($self) = @_; |
625 | |
956 | |
626 | unless ($self->{rw} || $self->{eof}) { |
957 | unless ($self->{_rw} || $self->{_eof}) { |
627 | Scalar::Util::weaken $self; |
958 | Scalar::Util::weaken $self; |
628 | |
959 | |
629 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
960 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
630 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
961 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
631 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
962 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
632 | |
963 | |
633 | if ($len > 0) { |
964 | if ($len > 0) { |
634 | $self->{filter_r} |
965 | $self->{filter_r} |
635 | ? $self->{filter_r}->($self, $rbuf) |
966 | ? $self->{filter_r}->($self, $rbuf) |
636 | : $self->_drain_rbuf; |
967 | : $self->_drain_rbuf; |
637 | |
968 | |
638 | } elsif (defined $len) { |
969 | } elsif (defined $len) { |
639 | delete $self->{rw}; |
970 | delete $self->{_rw}; |
640 | $self->{eof} = 1; |
971 | $self->{_eof} = 1; |
641 | $self->_drain_rbuf; |
972 | $self->_drain_rbuf; |
642 | |
973 | |
643 | } elsif ($! != EAGAIN && $! != EINTR) { |
974 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
644 | return $self->error; |
975 | return $self->error; |
645 | } |
976 | } |
646 | }); |
977 | }); |
647 | } |
978 | } |
648 | } |
979 | } |
649 | |
980 | |
650 | sub _dotls { |
981 | sub _dotls { |
651 | my ($self) = @_; |
982 | my ($self) = @_; |
652 | |
983 | |
653 | if (length $self->{tls_wbuf}) { |
984 | if (length $self->{_tls_wbuf}) { |
654 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { |
985 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
655 | substr $self->{tls_wbuf}, 0, $len, ""; |
986 | substr $self->{_tls_wbuf}, 0, $len, ""; |
656 | } |
987 | } |
657 | } |
988 | } |
658 | |
989 | |
659 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
990 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
660 | $self->{wbuf} .= $buf; |
991 | $self->{wbuf} .= $buf; |
661 | $self->_drain_wbuf; |
992 | $self->_drain_wbuf; |
662 | } |
993 | } |
663 | |
994 | |
664 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
995 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
… | |
… | |
690 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1021 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
691 | |
1022 | |
692 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1023 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
693 | used when AnyEvent::Handle has to create its own TLS connection object. |
1024 | used when AnyEvent::Handle has to create its own TLS connection object. |
694 | |
1025 | |
|
|
1026 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
1027 | call and can be used or changed to your liking. Note that the handshake |
|
|
1028 | might have already started when this function returns. |
|
|
1029 | |
695 | =cut |
1030 | =cut |
696 | |
1031 | |
697 | # TODO: maybe document... |
1032 | # TODO: maybe document... |
698 | sub starttls { |
1033 | sub starttls { |
699 | my ($self, $ssl, $ctx) = @_; |
1034 | my ($self, $ssl, $ctx) = @_; |
… | |
… | |
714 | # but the openssl maintainers basically said: "trust us, it just works". |
1049 | # but the openssl maintainers basically said: "trust us, it just works". |
715 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1050 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
716 | # and mismaintained ssleay-module doesn't even offer them). |
1051 | # and mismaintained ssleay-module doesn't even offer them). |
717 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1052 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
718 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1053 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
719 | (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1054 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
720 | | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1055 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
721 | |
1056 | |
722 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1057 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
723 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1058 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
724 | |
1059 | |
725 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
1060 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
726 | |
1061 | |
727 | $self->{filter_w} = sub { |
1062 | $self->{filter_w} = sub { |
728 | $_[0]{tls_wbuf} .= ${$_[1]}; |
1063 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
729 | &_dotls; |
1064 | &_dotls; |
730 | }; |
1065 | }; |
731 | $self->{filter_r} = sub { |
1066 | $self->{filter_r} = sub { |
732 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
1067 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
733 | &_dotls; |
1068 | &_dotls; |
734 | }; |
1069 | }; |
735 | } |
1070 | } |
736 | |
1071 | |
737 | =item $handle->stoptls |
1072 | =item $handle->stoptls |
… | |
… | |
743 | |
1078 | |
744 | sub stoptls { |
1079 | sub stoptls { |
745 | my ($self) = @_; |
1080 | my ($self) = @_; |
746 | |
1081 | |
747 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1082 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
1083 | |
748 | delete $self->{tls_rbio}; |
1084 | delete $self->{_rbio}; |
749 | delete $self->{tls_wbio}; |
1085 | delete $self->{_wbio}; |
750 | delete $self->{tls_wbuf}; |
1086 | delete $self->{_tls_wbuf}; |
751 | delete $self->{filter_r}; |
1087 | delete $self->{filter_r}; |
752 | delete $self->{filter_w}; |
1088 | delete $self->{filter_w}; |
753 | } |
1089 | } |
754 | |
1090 | |
755 | sub DESTROY { |
1091 | sub DESTROY { |
… | |
… | |
793 | } |
1129 | } |
794 | } |
1130 | } |
795 | |
1131 | |
796 | =back |
1132 | =back |
797 | |
1133 | |
|
|
1134 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1135 | |
|
|
1136 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1137 | |
|
|
1138 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1139 | conventions: |
|
|
1140 | |
|
|
1141 | =over 4 |
|
|
1142 | |
|
|
1143 | =item * all constructor arguments become object members. |
|
|
1144 | |
|
|
1145 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1146 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
|
|
1147 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1148 | |
|
|
1149 | =item * other object member names are prefixed with an C<_>. |
|
|
1150 | |
|
|
1151 | All object members not explicitly documented (internal use) are prefixed |
|
|
1152 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1153 | for use for subclasses. |
|
|
1154 | |
|
|
1155 | =item * all members not documented here and not prefixed with an underscore |
|
|
1156 | are free to use in subclasses. |
|
|
1157 | |
|
|
1158 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1159 | member variables, but thats just life, at least it is documented. |
|
|
1160 | |
|
|
1161 | =back |
|
|
1162 | |
798 | =head1 AUTHOR |
1163 | =head1 AUTHOR |
799 | |
1164 | |
800 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1165 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
801 | |
1166 | |
802 | =cut |
1167 | =cut |