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