… | |
… | |
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 filehandles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
|
|
17 | This module is experimental. |
|
|
18 | |
16 | |
19 | =cut |
17 | =cut |
20 | |
18 | |
21 | our $VERSION = '0.04'; |
19 | our $VERSION = '0.04'; |
22 | |
20 | |
… | |
… | |
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 |
… | |
… | |
83 | waiting for data. |
84 | waiting for data. |
84 | |
85 | |
85 | =item on_error => $cb->($self) |
86 | =item on_error => $cb->($self) |
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 | ocurs, 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 callbakc 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 | |
… | |
… | |
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 acces sthe C<$self->{rbuf}> member directly. |
111 | method or access the C<$self->{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>). |
… | |
… | |
139 | |
143 | |
140 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
144 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
141 | buffer: If the write reaches this size or gets even samller it is |
145 | buffer: If the write reaches this size or gets even samller it is |
142 | considered empty. |
146 | considered empty. |
143 | |
147 | |
|
|
148 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
|
|
149 | |
|
|
150 | When this parameter is given, it enables TLS (SSL) mode, that means it |
|
|
151 | will start making tls handshake and will transparently encrypt/decrypt |
|
|
152 | data. |
|
|
153 | |
|
|
154 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
|
|
155 | automatically when you try to create a TLS handle). |
|
|
156 | |
|
|
157 | For the TLS server side, use C<accept>, and for the TLS client side of a |
|
|
158 | connection, use C<connect> mode. |
|
|
159 | |
|
|
160 | You can also provide your own TLS connection object, but you have |
|
|
161 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
|
|
162 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
|
|
163 | AnyEvent::Handle. |
|
|
164 | |
|
|
165 | See the C<starttls> method if you need to start TLs negotiation later. |
|
|
166 | |
|
|
167 | =item tls_ctx => $ssl_ctx |
|
|
168 | |
|
|
169 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
|
|
170 | (unless a connection object was specified directly). If this parameter is |
|
|
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
|
|
172 | |
144 | =back |
173 | =back |
145 | |
174 | |
146 | =cut |
175 | =cut |
147 | |
176 | |
148 | sub new { |
177 | sub new { |
… | |
… | |
151 | my $self = bless { @_ }, $class; |
180 | my $self = bless { @_ }, $class; |
152 | |
181 | |
153 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
182 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
154 | |
183 | |
155 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
184 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
|
|
185 | |
|
|
186 | if ($self->{tls}) { |
|
|
187 | require Net::SSLeay; |
|
|
188 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
|
|
189 | } |
156 | |
190 | |
157 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
191 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
158 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
192 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
159 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
193 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
160 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
194 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
… | |
… | |
178 | { |
212 | { |
179 | local $!; |
213 | local $!; |
180 | $self->_shutdown; |
214 | $self->_shutdown; |
181 | } |
215 | } |
182 | |
216 | |
183 | if ($self->{on_error}) { |
|
|
184 | $self->{on_error}($self); |
217 | $self->{on_error}($self) |
185 | } else { |
218 | if $self->{on_error}; |
|
|
219 | |
186 | die "AnyEvent::Handle uncaught fatal error: $!"; |
220 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
187 | } |
|
|
188 | } |
221 | } |
189 | |
222 | |
190 | =item $fh = $handle->fh |
223 | =item $fh = $handle->fh |
191 | |
224 | |
192 | This method returns the filehandle of the L<AnyEvent::Handle> object. |
225 | This method returns the file handle of the L<AnyEvent::Handle> object. |
193 | |
226 | |
194 | =cut |
227 | =cut |
195 | |
228 | |
196 | sub fh { $_[0]->{fh} } |
229 | sub fh { $_[0]->{fh} } |
197 | |
230 | |
… | |
… | |
225 | for reading. |
258 | for reading. |
226 | |
259 | |
227 | The write queue is very simple: you can add data to its end, and |
260 | The write queue is very simple: you can add data to its end, and |
228 | AnyEvent::Handle will automatically try to get rid of it for you. |
261 | AnyEvent::Handle will automatically try to get rid of it for you. |
229 | |
262 | |
230 | When data could be writtena nd the write buffer is shorter then the low |
263 | When data could be written and the write buffer is shorter then the low |
231 | water mark, the C<on_drain> callback will be invoked. |
264 | water mark, the C<on_drain> callback will be invoked. |
232 | |
265 | |
233 | =over 4 |
266 | =over 4 |
234 | |
267 | |
235 | =item $handle->on_drain ($cb) |
268 | =item $handle->on_drain ($cb) |
… | |
… | |
257 | =cut |
290 | =cut |
258 | |
291 | |
259 | sub _drain_wbuf { |
292 | sub _drain_wbuf { |
260 | my ($self) = @_; |
293 | my ($self) = @_; |
261 | |
294 | |
262 | unless ($self->{ww}) { |
295 | if (!$self->{ww} && length $self->{wbuf}) { |
|
|
296 | |
263 | Scalar::Util::weaken $self; |
297 | Scalar::Util::weaken $self; |
|
|
298 | |
264 | my $cb = sub { |
299 | my $cb = sub { |
265 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
300 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
266 | |
301 | |
267 | if ($len > 0) { |
302 | if ($len >= 0) { |
268 | substr $self->{wbuf}, 0, $len, ""; |
303 | substr $self->{wbuf}, 0, $len, ""; |
269 | |
304 | |
270 | $self->{on_drain}($self) |
305 | $self->{on_drain}($self) |
271 | if $self->{low_water_mark} >= length $self->{wbuf} |
306 | if $self->{low_water_mark} >= length $self->{wbuf} |
272 | && $self->{on_drain}; |
307 | && $self->{on_drain}; |
273 | |
308 | |
274 | delete $self->{ww} unless length $self->{wbuf}; |
309 | delete $self->{ww} unless length $self->{wbuf}; |
275 | } elsif ($! != EAGAIN && $! != EINTR) { |
310 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
276 | $self->error; |
311 | $self->error; |
277 | } |
312 | } |
278 | }; |
313 | }; |
279 | |
314 | |
|
|
315 | # try to write data immediately |
|
|
316 | $cb->(); |
|
|
317 | |
|
|
318 | # if still data left in wbuf, we need to poll |
280 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
319 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
281 | |
320 | if length $self->{wbuf}; |
282 | $cb->($self); |
|
|
283 | }; |
321 | }; |
|
|
322 | } |
|
|
323 | |
|
|
324 | our %WH; |
|
|
325 | |
|
|
326 | sub register_write_type($$) { |
|
|
327 | $WH{$_[0]} = $_[1]; |
284 | } |
328 | } |
285 | |
329 | |
286 | sub push_write { |
330 | sub push_write { |
287 | my $self = shift; |
331 | my $self = shift; |
|
|
332 | |
|
|
333 | if (@_ > 1) { |
|
|
334 | my $type = shift; |
|
|
335 | |
|
|
336 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
|
|
337 | ->($self, @_); |
|
|
338 | } |
288 | |
339 | |
289 | if ($self->{filter_w}) { |
340 | if ($self->{filter_w}) { |
290 | $self->{filter_w}->($self, \$_[0]); |
341 | $self->{filter_w}->($self, \$_[0]); |
291 | } else { |
342 | } else { |
292 | $self->{wbuf} .= $_[0]; |
343 | $self->{wbuf} .= $_[0]; |
293 | $self->_drain_wbuf; |
344 | $self->_drain_wbuf; |
294 | } |
345 | } |
295 | } |
346 | } |
|
|
347 | |
|
|
348 | =item $handle->push_write (type => @args) |
|
|
349 | |
|
|
350 | =item $handle->unshift_write (type => @args) |
|
|
351 | |
|
|
352 | Instead of formatting your data yourself, you can also let this module do |
|
|
353 | the job by specifying a type and type-specific arguments. |
|
|
354 | |
|
|
355 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
356 | drop by and tell us): |
|
|
357 | |
|
|
358 | =over 4 |
|
|
359 | |
|
|
360 | =item netstring => $string |
|
|
361 | |
|
|
362 | Formats the given value as netstring |
|
|
363 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
|
|
364 | |
|
|
365 | =back |
|
|
366 | |
|
|
367 | =cut |
|
|
368 | |
|
|
369 | register_write_type netstring => sub { |
|
|
370 | my ($self, $string) = @_; |
|
|
371 | |
|
|
372 | sprintf "%d:%s,", (length $string), $string |
|
|
373 | }; |
|
|
374 | |
|
|
375 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
|
|
376 | |
|
|
377 | This function (not method) lets you add your own types to C<push_write>. |
|
|
378 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
379 | reference with the handle object and the remaining arguments. |
|
|
380 | |
|
|
381 | The code reference is supposed to return a single octet string that will |
|
|
382 | be appended to the write buffer. |
|
|
383 | |
|
|
384 | Note that this is a function, and all types registered this way will be |
|
|
385 | global, so try to use unique names. |
|
|
386 | |
|
|
387 | =cut |
296 | |
388 | |
297 | ############################################################################# |
389 | ############################################################################# |
298 | |
390 | |
299 | =back |
391 | =back |
300 | |
392 | |
… | |
… | |
379 | |
471 | |
380 | if ( |
472 | if ( |
381 | defined $self->{rbuf_max} |
473 | defined $self->{rbuf_max} |
382 | && $self->{rbuf_max} < length $self->{rbuf} |
474 | && $self->{rbuf_max} < length $self->{rbuf} |
383 | ) { |
475 | ) { |
384 | $! = &Errno::ENOSPC; return $self->error; |
476 | $! = &Errno::ENOSPC; |
|
|
477 | $self->error; |
385 | } |
478 | } |
386 | |
479 | |
387 | return if $self->{in_drain}; |
480 | return if $self->{in_drain}; |
388 | local $self->{in_drain} = 1; |
481 | local $self->{in_drain} = 1; |
389 | |
482 | |
390 | while (my $len = length $self->{rbuf}) { |
483 | while (my $len = length $self->{rbuf}) { |
391 | no strict 'refs'; |
484 | no strict 'refs'; |
392 | if (my $cb = shift @{ $self->{queue} }) { |
485 | if (my $cb = shift @{ $self->{queue} }) { |
393 | if (!$cb->($self)) { |
486 | unless ($cb->($self)) { |
394 | if ($self->{eof}) { |
487 | if ($self->{eof}) { |
395 | # no progress can be made (not enough data and no data forthcoming) |
488 | # no progress can be made (not enough data and no data forthcoming) |
396 | $! = &Errno::EPIPE; return $self->error; |
489 | $! = &Errno::EPIPE; |
|
|
490 | $self->error; |
397 | } |
491 | } |
398 | |
492 | |
399 | unshift @{ $self->{queue} }, $cb; |
493 | unshift @{ $self->{queue} }, $cb; |
400 | return; |
494 | return; |
401 | } |
495 | } |
… | |
… | |
407 | && $len == length $self->{rbuf} # and no data has been consumed |
501 | && $len == length $self->{rbuf} # and no data has been consumed |
408 | && !@{ $self->{queue} } # and the queue is still empty |
502 | && !@{ $self->{queue} } # and the queue is still empty |
409 | && $self->{on_read} # and we still want to read data |
503 | && $self->{on_read} # and we still want to read data |
410 | ) { |
504 | ) { |
411 | # then no progress can be made |
505 | # then no progress can be made |
412 | $! = &Errno::EPIPE; return $self->error; |
506 | $! = &Errno::EPIPE; |
|
|
507 | $self->error; |
413 | } |
508 | } |
414 | } else { |
509 | } else { |
415 | # read side becomes idle |
510 | # read side becomes idle |
416 | delete $self->{rw}; |
511 | delete $self->{rw}; |
417 | return; |
512 | return; |
… | |
… | |
463 | Append the given callback to the end of the queue (C<push_read>) or |
558 | Append the given callback to the end of the queue (C<push_read>) or |
464 | prepend it (C<unshift_read>). |
559 | prepend it (C<unshift_read>). |
465 | |
560 | |
466 | The callback is called each time some additional read data arrives. |
561 | The callback is called each time some additional read data arrives. |
467 | |
562 | |
468 | It must check wether enough data is in the read buffer already. |
563 | It must check whether enough data is in the read buffer already. |
469 | |
564 | |
470 | If not enough data is available, it must return the empty list or a false |
565 | If not enough data is available, it must return the empty list or a false |
471 | value, in which case it will be called repeatedly until enough data is |
566 | value, in which case it will be called repeatedly until enough data is |
472 | available (or an error condition is detected). |
567 | available (or an error condition is detected). |
473 | |
568 | |
… | |
… | |
475 | interested in (which can be none at all) and return a true value. After returning |
570 | interested in (which can be none at all) and return a true value. After returning |
476 | true, it will be removed from the queue. |
571 | true, it will be removed from the queue. |
477 | |
572 | |
478 | =cut |
573 | =cut |
479 | |
574 | |
|
|
575 | our %RH; |
|
|
576 | |
|
|
577 | sub register_read_type($$) { |
|
|
578 | $RH{$_[0]} = $_[1]; |
|
|
579 | } |
|
|
580 | |
480 | sub push_read { |
581 | sub push_read { |
481 | my ($self, $cb) = @_; |
582 | my $self = shift; |
|
|
583 | my $cb = pop; |
|
|
584 | |
|
|
585 | if (@_) { |
|
|
586 | my $type = shift; |
|
|
587 | |
|
|
588 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
|
|
589 | ->($self, $cb, @_); |
|
|
590 | } |
482 | |
591 | |
483 | push @{ $self->{queue} }, $cb; |
592 | push @{ $self->{queue} }, $cb; |
484 | $self->_drain_rbuf; |
593 | $self->_drain_rbuf; |
485 | } |
594 | } |
486 | |
595 | |
487 | sub unshift_read { |
596 | sub unshift_read { |
488 | my ($self, $cb) = @_; |
597 | my $self = shift; |
|
|
598 | my $cb = pop; |
489 | |
599 | |
|
|
600 | if (@_) { |
|
|
601 | my $type = shift; |
|
|
602 | |
|
|
603 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
|
|
604 | ->($self, $cb, @_); |
|
|
605 | } |
|
|
606 | |
|
|
607 | |
490 | push @{ $self->{queue} }, $cb; |
608 | unshift @{ $self->{queue} }, $cb; |
491 | $self->_drain_rbuf; |
609 | $self->_drain_rbuf; |
492 | } |
610 | } |
493 | |
611 | |
494 | =item $handle->push_read_chunk ($len, $cb->($self, $data)) |
612 | =item $handle->push_read (type => @args, $cb) |
495 | |
613 | |
496 | =item $handle->unshift_read_chunk ($len, $cb->($self, $data)) |
614 | =item $handle->unshift_read (type => @args, $cb) |
497 | |
615 | |
498 | Append the given callback to the end of the queue (C<push_read_chunk>) or |
616 | Instead of providing a callback that parses the data itself you can chose |
499 | prepend it (C<unshift_read_chunk>). |
617 | between a number of predefined parsing formats, for chunks of data, lines |
|
|
618 | etc. |
500 | |
619 | |
501 | The callback will be called only once C<$len> bytes have been read, and |
620 | Predefined types are (if you have ideas for additional types, feel free to |
502 | these C<$len> bytes will be passed to the callback. |
621 | drop by and tell us): |
503 | |
622 | |
504 | =cut |
623 | =over 4 |
505 | |
624 | |
506 | sub _read_chunk($$) { |
625 | =item chunk => $octets, $cb->($self, $data) |
|
|
626 | |
|
|
627 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
|
|
628 | data read to the callback. The callback will never be called with less |
|
|
629 | data. |
|
|
630 | |
|
|
631 | Example: read 2 bytes. |
|
|
632 | |
|
|
633 | $handle->push_read (chunk => 2, sub { |
|
|
634 | warn "yay ", unpack "H*", $_[1]; |
|
|
635 | }); |
|
|
636 | |
|
|
637 | =cut |
|
|
638 | |
|
|
639 | register_read_type chunk => sub { |
507 | my ($self, $len, $cb) = @_; |
640 | my ($self, $cb, $len) = @_; |
508 | |
641 | |
509 | sub { |
642 | sub { |
510 | $len <= length $_[0]{rbuf} or return; |
643 | $len <= length $_[0]{rbuf} or return; |
511 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
644 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
512 | 1 |
645 | 1 |
513 | } |
646 | } |
514 | } |
647 | }; |
515 | |
648 | |
|
|
649 | # compatibility with older API |
516 | sub push_read_chunk { |
650 | sub push_read_chunk { |
517 | $_[0]->push_read (&_read_chunk); |
651 | $_[0]->push_read (chunk => $_[1], $_[2]); |
518 | } |
652 | } |
519 | |
|
|
520 | |
653 | |
521 | sub unshift_read_chunk { |
654 | sub unshift_read_chunk { |
522 | $_[0]->unshift_read (&_read_chunk); |
655 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
523 | } |
656 | } |
524 | |
657 | |
525 | =item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol)) |
658 | =item line => [$eol, ]$cb->($self, $line, $eol) |
526 | |
|
|
527 | =item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol)) |
|
|
528 | |
|
|
529 | Append the given callback to the end of the queue (C<push_read_line>) or |
|
|
530 | prepend it (C<unshift_read_line>). |
|
|
531 | |
659 | |
532 | The callback will be called only once a full line (including the end of |
660 | The callback will be called only once a full line (including the end of |
533 | line marker, C<$eol>) has been read. This line (excluding the end of line |
661 | line marker, C<$eol>) has been read. This line (excluding the end of line |
534 | marker) will be passed to the callback as second argument (C<$line>), and |
662 | marker) will be passed to the callback as second argument (C<$line>), and |
535 | the end of line marker as the third argument (C<$eol>). |
663 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
546 | Partial lines at the end of the stream will never be returned, as they are |
674 | Partial lines at the end of the stream will never be returned, as they are |
547 | not marked by the end of line marker. |
675 | not marked by the end of line marker. |
548 | |
676 | |
549 | =cut |
677 | =cut |
550 | |
678 | |
551 | sub _read_line($$) { |
679 | register_read_type line => sub { |
552 | my $self = shift; |
680 | my ($self, $cb, $eol) = @_; |
553 | my $cb = pop; |
|
|
554 | my $eol = @_ ? shift : qr|(\015?\012)|; |
|
|
555 | my $pos; |
|
|
556 | |
681 | |
|
|
682 | $eol = qr|(\015?\012)| if @_ < 3; |
557 | $eol = quotemeta $eol unless ref $eol; |
683 | $eol = quotemeta $eol unless ref $eol; |
558 | $eol = qr|^(.*?)($eol)|s; |
684 | $eol = qr|^(.*?)($eol)|s; |
559 | |
685 | |
560 | sub { |
686 | sub { |
561 | $_[0]{rbuf} =~ s/$eol// or return; |
687 | $_[0]{rbuf} =~ s/$eol// or return; |
562 | |
688 | |
563 | $cb->($_[0], $1, $2); |
689 | $cb->($_[0], $1, $2); |
564 | 1 |
690 | 1 |
565 | } |
691 | } |
566 | } |
692 | }; |
567 | |
693 | |
|
|
694 | # compatibility with older API |
568 | sub push_read_line { |
695 | sub push_read_line { |
569 | $_[0]->push_read (&_read_line); |
696 | my $self = shift; |
|
|
697 | $self->push_read (line => @_); |
570 | } |
698 | } |
571 | |
699 | |
572 | sub unshift_read_line { |
700 | sub unshift_read_line { |
573 | $_[0]->unshift_read (&_read_line); |
701 | my $self = shift; |
|
|
702 | $self->unshift_read (line => @_); |
574 | } |
703 | } |
|
|
704 | |
|
|
705 | =item netstring => $cb->($string) |
|
|
706 | |
|
|
707 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
708 | |
|
|
709 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
710 | |
|
|
711 | =cut |
|
|
712 | |
|
|
713 | register_read_type netstring => sub { |
|
|
714 | my ($self, $cb) = @_; |
|
|
715 | |
|
|
716 | sub { |
|
|
717 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
718 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
719 | $! = &Errno::EBADMSG; |
|
|
720 | $self->error; |
|
|
721 | } |
|
|
722 | return; |
|
|
723 | } |
|
|
724 | |
|
|
725 | my $len = $1; |
|
|
726 | |
|
|
727 | $self->unshift_read (chunk => $len, sub { |
|
|
728 | my $string = $_[1]; |
|
|
729 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
730 | if ($_[1] eq ",") { |
|
|
731 | $cb->($_[0], $string); |
|
|
732 | } else { |
|
|
733 | $! = &Errno::EBADMSG; |
|
|
734 | $self->error; |
|
|
735 | } |
|
|
736 | }); |
|
|
737 | }); |
|
|
738 | |
|
|
739 | 1 |
|
|
740 | } |
|
|
741 | }; |
|
|
742 | |
|
|
743 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
|
|
744 | |
|
|
745 | Makes a regex match against the regex object C<$accept> and returns |
|
|
746 | everything up to and including the match. |
|
|
747 | |
|
|
748 | Example: read a single line terminated by '\n'. |
|
|
749 | |
|
|
750 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
751 | |
|
|
752 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
753 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
754 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
755 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
756 | receive buffer overflow). |
|
|
757 | |
|
|
758 | Example: expect a single decimal number followed by whitespace, reject |
|
|
759 | anything else (not the use of an anchor). |
|
|
760 | |
|
|
761 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
762 | |
|
|
763 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
764 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
765 | and everything preceding and including the match will be accepted |
|
|
766 | unconditionally. This is useful to skip large amounts of data that you |
|
|
767 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
768 | have to start matching from the beginning. This is purely an optimisation |
|
|
769 | and is usually worth only when you expect more than a few kilobytes. |
|
|
770 | |
|
|
771 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
772 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
773 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
774 | it only accepts something not ending in either \015 or \012, as these are |
|
|
775 | required for the accept regex. |
|
|
776 | |
|
|
777 | $handle->push_read (regex => |
|
|
778 | qr<\015\012\015\012>, |
|
|
779 | undef, # no reject |
|
|
780 | qr<^.*[^\015\012]>, |
|
|
781 | sub { ... }); |
|
|
782 | |
|
|
783 | =cut |
|
|
784 | |
|
|
785 | register_read_type regex => sub { |
|
|
786 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
787 | |
|
|
788 | my $data; |
|
|
789 | my $rbuf = \$self->{rbuf}; |
|
|
790 | |
|
|
791 | sub { |
|
|
792 | # accept |
|
|
793 | if ($$rbuf =~ $accept) { |
|
|
794 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
795 | $cb->($self, $data); |
|
|
796 | return 1; |
|
|
797 | } |
|
|
798 | |
|
|
799 | # reject |
|
|
800 | if ($reject && $$rbuf =~ $reject) { |
|
|
801 | $! = &Errno::EBADMSG; |
|
|
802 | $self->error; |
|
|
803 | } |
|
|
804 | |
|
|
805 | # skip |
|
|
806 | if ($skip && $$rbuf =~ $skip) { |
|
|
807 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
808 | } |
|
|
809 | |
|
|
810 | () |
|
|
811 | } |
|
|
812 | }; |
|
|
813 | |
|
|
814 | =back |
|
|
815 | |
|
|
816 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
|
|
817 | |
|
|
818 | This function (not method) lets you add your own types to C<push_read>. |
|
|
819 | |
|
|
820 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
821 | reference with the handle object, the callback and the remaining |
|
|
822 | arguments. |
|
|
823 | |
|
|
824 | The code reference is supposed to return a callback (usually a closure) |
|
|
825 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
826 | |
|
|
827 | It should invoke the passed callback when it is done reading (remember to |
|
|
828 | pass C<$self> as first argument as all other callbacks do that). |
|
|
829 | |
|
|
830 | Note that this is a function, and all types registered this way will be |
|
|
831 | global, so try to use unique names. |
|
|
832 | |
|
|
833 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
834 | search for C<register_read_type>)). |
575 | |
835 | |
576 | =item $handle->stop_read |
836 | =item $handle->stop_read |
577 | |
837 | |
578 | =item $handle->start_read |
838 | =item $handle->start_read |
579 | |
839 | |
580 | In rare cases you actually do not want to read anything from the |
840 | In rare cases you actually do not want to read anything from the |
581 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
841 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
582 | any queued callbacks will be executed then. To start readign again, call |
842 | any queued callbacks will be executed then. To start reading again, call |
583 | C<start_read>. |
843 | C<start_read>. |
584 | |
844 | |
585 | =cut |
845 | =cut |
586 | |
846 | |
587 | sub stop_read { |
847 | sub stop_read { |
… | |
… | |
608 | } elsif (defined $len) { |
868 | } elsif (defined $len) { |
609 | delete $self->{rw}; |
869 | delete $self->{rw}; |
610 | $self->{eof} = 1; |
870 | $self->{eof} = 1; |
611 | $self->_drain_rbuf; |
871 | $self->_drain_rbuf; |
612 | |
872 | |
613 | } elsif ($! != EAGAIN && $! != EINTR) { |
873 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
614 | return $self->error; |
874 | return $self->error; |
615 | } |
875 | } |
616 | }); |
876 | }); |
617 | } |
877 | } |
618 | } |
878 | } |
619 | |
879 | |
|
|
880 | sub _dotls { |
|
|
881 | my ($self) = @_; |
|
|
882 | |
|
|
883 | if (length $self->{tls_wbuf}) { |
|
|
884 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { |
|
|
885 | substr $self->{tls_wbuf}, 0, $len, ""; |
|
|
886 | } |
|
|
887 | } |
|
|
888 | |
|
|
889 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
|
|
890 | $self->{wbuf} .= $buf; |
|
|
891 | $self->_drain_wbuf; |
|
|
892 | } |
|
|
893 | |
|
|
894 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
895 | $self->{rbuf} .= $buf; |
|
|
896 | $self->_drain_rbuf; |
|
|
897 | } |
|
|
898 | |
|
|
899 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
900 | |
|
|
901 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
902 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
903 | $self->error; |
|
|
904 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
|
|
905 | $! = &Errno::EIO; |
|
|
906 | $self->error; |
|
|
907 | } |
|
|
908 | |
|
|
909 | # all others are fine for our purposes |
|
|
910 | } |
|
|
911 | } |
|
|
912 | |
|
|
913 | =item $handle->starttls ($tls[, $tls_ctx]) |
|
|
914 | |
|
|
915 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
|
|
916 | object is created, you can also do that at a later time by calling |
|
|
917 | C<starttls>. |
|
|
918 | |
|
|
919 | The first argument is the same as the C<tls> constructor argument (either |
|
|
920 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
|
|
921 | |
|
|
922 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
|
|
923 | used when AnyEvent::Handle has to create its own TLS connection object. |
|
|
924 | |
|
|
925 | =cut |
|
|
926 | |
|
|
927 | # TODO: maybe document... |
|
|
928 | sub starttls { |
|
|
929 | my ($self, $ssl, $ctx) = @_; |
|
|
930 | |
|
|
931 | $self->stoptls; |
|
|
932 | |
|
|
933 | if ($ssl eq "accept") { |
|
|
934 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
935 | Net::SSLeay::set_accept_state ($ssl); |
|
|
936 | } elsif ($ssl eq "connect") { |
|
|
937 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
938 | Net::SSLeay::set_connect_state ($ssl); |
|
|
939 | } |
|
|
940 | |
|
|
941 | $self->{tls} = $ssl; |
|
|
942 | |
|
|
943 | # basically, this is deep magic (because SSL_read should have the same issues) |
|
|
944 | # but the openssl maintainers basically said: "trust us, it just works". |
|
|
945 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
|
|
946 | # and mismaintained ssleay-module doesn't even offer them). |
|
|
947 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
948 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
|
|
949 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
|
|
950 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
951 | |
|
|
952 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
|
|
953 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
|
|
954 | |
|
|
955 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
|
|
956 | |
|
|
957 | $self->{filter_w} = sub { |
|
|
958 | $_[0]{tls_wbuf} .= ${$_[1]}; |
|
|
959 | &_dotls; |
|
|
960 | }; |
|
|
961 | $self->{filter_r} = sub { |
|
|
962 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
|
|
963 | &_dotls; |
|
|
964 | }; |
|
|
965 | } |
|
|
966 | |
|
|
967 | =item $handle->stoptls |
|
|
968 | |
|
|
969 | Destroys the SSL connection, if any. Partial read or write data will be |
|
|
970 | lost. |
|
|
971 | |
|
|
972 | =cut |
|
|
973 | |
|
|
974 | sub stoptls { |
|
|
975 | my ($self) = @_; |
|
|
976 | |
|
|
977 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
978 | delete $self->{tls_rbio}; |
|
|
979 | delete $self->{tls_wbio}; |
|
|
980 | delete $self->{tls_wbuf}; |
|
|
981 | delete $self->{filter_r}; |
|
|
982 | delete $self->{filter_w}; |
|
|
983 | } |
|
|
984 | |
|
|
985 | sub DESTROY { |
|
|
986 | my $self = shift; |
|
|
987 | |
|
|
988 | $self->stoptls; |
|
|
989 | } |
|
|
990 | |
|
|
991 | =item AnyEvent::Handle::TLS_CTX |
|
|
992 | |
|
|
993 | This function creates and returns the Net::SSLeay::CTX object used by |
|
|
994 | default for TLS mode. |
|
|
995 | |
|
|
996 | The context is created like this: |
|
|
997 | |
|
|
998 | Net::SSLeay::load_error_strings; |
|
|
999 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1000 | Net::SSLeay::randomize; |
|
|
1001 | |
|
|
1002 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1003 | |
|
|
1004 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1005 | |
|
|
1006 | =cut |
|
|
1007 | |
|
|
1008 | our $TLS_CTX; |
|
|
1009 | |
|
|
1010 | sub TLS_CTX() { |
|
|
1011 | $TLS_CTX || do { |
|
|
1012 | require Net::SSLeay; |
|
|
1013 | |
|
|
1014 | Net::SSLeay::load_error_strings (); |
|
|
1015 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1016 | Net::SSLeay::randomize (); |
|
|
1017 | |
|
|
1018 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1019 | |
|
|
1020 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1021 | |
|
|
1022 | $TLS_CTX |
|
|
1023 | } |
|
|
1024 | } |
|
|
1025 | |
620 | =back |
1026 | =back |
621 | |
1027 | |
622 | =head1 AUTHOR |
1028 | =head1 AUTHOR |
623 | |
1029 | |
624 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1030 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |