… | |
… | |
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.1; |
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 | |
102 | |
98 | 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 |
99 | 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 |
100 | die. |
105 | C<croak>. |
101 | |
106 | |
102 | =item on_read => $cb->($self) |
107 | =item on_read => $cb->($handle) |
103 | |
108 | |
104 | 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 |
105 | and no read request is in the queue. |
110 | and no read request is in the queue. |
106 | |
111 | |
107 | 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 >> |
108 | method or access the C<$self->{rbuf}> member directly. |
113 | method or access the C<$handle->{rbuf}> member directly. |
109 | |
114 | |
110 | 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 |
111 | 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 |
112 | 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 |
113 | error will be raised (with C<$!> set to C<EPIPE>). |
118 | error will be raised (with C<$!> set to C<EPIPE>). |
114 | |
119 | |
115 | =item on_drain => $cb->() |
120 | =item on_drain => $cb->($handle) |
116 | |
121 | |
117 | 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 |
118 | (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). |
119 | |
124 | |
120 | 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. |
121 | |
146 | |
122 | =item rbuf_max => <bytes> |
147 | =item rbuf_max => <bytes> |
123 | |
148 | |
124 | 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>) |
125 | 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 |
… | |
… | |
132 | isn't finished). |
157 | isn't finished). |
133 | |
158 | |
134 | =item read_size => <bytes> |
159 | =item read_size => <bytes> |
135 | |
160 | |
136 | 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 |
137 | on each [loop iteration). Default: C<4096>. |
162 | during each (loop iteration). Default: C<8192>. |
138 | |
163 | |
139 | =item low_water_mark => <bytes> |
164 | =item low_water_mark => <bytes> |
140 | |
165 | |
141 | 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 |
142 | 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 |
… | |
… | |
165 | |
190 | |
166 | 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 |
167 | (unless a connection object was specified directly). If this parameter is |
192 | (unless a connection object was specified directly). If this parameter is |
168 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
193 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
169 | |
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 | |
170 | =back |
211 | =back |
171 | |
212 | |
172 | =cut |
213 | =cut |
173 | |
214 | |
174 | sub new { |
215 | sub new { |
… | |
… | |
183 | if ($self->{tls}) { |
224 | if ($self->{tls}) { |
184 | require Net::SSLeay; |
225 | require Net::SSLeay; |
185 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
226 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
186 | } |
227 | } |
187 | |
228 | |
188 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
229 | # $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop |
189 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
230 | # $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop |
|
|
231 | # $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop |
190 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
191 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
233 | |
|
|
234 | $self->{_activity} = AnyEvent->now; |
|
|
235 | $self->_timeout; |
192 | |
236 | |
193 | $self->start_read; |
237 | $self->start_read; |
194 | |
238 | |
195 | $self |
239 | $self |
196 | } |
240 | } |
197 | |
241 | |
198 | sub _shutdown { |
242 | sub _shutdown { |
199 | my ($self) = @_; |
243 | my ($self) = @_; |
200 | |
244 | |
|
|
245 | delete $self->{_tw}; |
201 | delete $self->{rw}; |
246 | delete $self->{_rw}; |
202 | delete $self->{ww}; |
247 | delete $self->{_ww}; |
203 | delete $self->{fh}; |
248 | delete $self->{fh}; |
204 | } |
|
|
205 | |
249 | |
|
|
250 | $self->stoptls; |
|
|
251 | } |
|
|
252 | |
206 | sub error { |
253 | sub _error { |
207 | my ($self) = @_; |
254 | my ($self, $errno, $fatal) = @_; |
208 | |
255 | |
209 | { |
|
|
210 | local $!; |
|
|
211 | $self->_shutdown; |
256 | $self->_shutdown |
212 | } |
257 | if $fatal; |
|
|
258 | |
|
|
259 | $! = $errno; |
213 | |
260 | |
214 | if ($self->{on_error}) { |
261 | if ($self->{on_error}) { |
215 | $self->{on_error}($self); |
262 | $self->{on_error}($self, $fatal); |
216 | } else { |
263 | } else { |
217 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
264 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
218 | } |
265 | } |
219 | } |
266 | } |
220 | |
267 | |
221 | =item $fh = $handle->fh |
268 | =item $fh = $handle->fh |
222 | |
269 | |
223 | This method returns the file handle of the L<AnyEvent::Handle> object. |
270 | This method returns the file handle of the L<AnyEvent::Handle> object. |
224 | |
271 | |
225 | =cut |
272 | =cut |
226 | |
273 | |
227 | sub fh { $_[0]->{fh} } |
274 | sub fh { $_[0]{fh} } |
228 | |
275 | |
229 | =item $handle->on_error ($cb) |
276 | =item $handle->on_error ($cb) |
230 | |
277 | |
231 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
278 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
232 | |
279 | |
… | |
… | |
242 | |
289 | |
243 | =cut |
290 | =cut |
244 | |
291 | |
245 | sub on_eof { |
292 | sub on_eof { |
246 | $_[0]{on_eof} = $_[1]; |
293 | $_[0]{on_eof} = $_[1]; |
|
|
294 | } |
|
|
295 | |
|
|
296 | =item $handle->on_timeout ($cb) |
|
|
297 | |
|
|
298 | Replace the current C<on_timeout> callback, or disables the callback |
|
|
299 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
|
|
300 | argument. |
|
|
301 | |
|
|
302 | =cut |
|
|
303 | |
|
|
304 | sub on_timeout { |
|
|
305 | $_[0]{on_timeout} = $_[1]; |
|
|
306 | } |
|
|
307 | |
|
|
308 | ############################################################################# |
|
|
309 | |
|
|
310 | =item $handle->timeout ($seconds) |
|
|
311 | |
|
|
312 | Configures (or disables) the inactivity timeout. |
|
|
313 | |
|
|
314 | =cut |
|
|
315 | |
|
|
316 | sub timeout { |
|
|
317 | my ($self, $timeout) = @_; |
|
|
318 | |
|
|
319 | $self->{timeout} = $timeout; |
|
|
320 | $self->_timeout; |
|
|
321 | } |
|
|
322 | |
|
|
323 | # reset the timeout watcher, as neccessary |
|
|
324 | # also check for time-outs |
|
|
325 | sub _timeout { |
|
|
326 | my ($self) = @_; |
|
|
327 | |
|
|
328 | if ($self->{timeout}) { |
|
|
329 | my $NOW = AnyEvent->now; |
|
|
330 | |
|
|
331 | # when would the timeout trigger? |
|
|
332 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
333 | |
|
|
334 | # now or in the past already? |
|
|
335 | if ($after <= 0) { |
|
|
336 | $self->{_activity} = $NOW; |
|
|
337 | |
|
|
338 | if ($self->{on_timeout}) { |
|
|
339 | $self->{on_timeout}($self); |
|
|
340 | } else { |
|
|
341 | $self->_error (&Errno::ETIMEDOUT); |
|
|
342 | } |
|
|
343 | |
|
|
344 | # callbakx could have changed timeout value, optimise |
|
|
345 | return unless $self->{timeout}; |
|
|
346 | |
|
|
347 | # calculate new after |
|
|
348 | $after = $self->{timeout}; |
|
|
349 | } |
|
|
350 | |
|
|
351 | Scalar::Util::weaken $self; |
|
|
352 | |
|
|
353 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
354 | delete $self->{_tw}; |
|
|
355 | $self->_timeout; |
|
|
356 | }); |
|
|
357 | } else { |
|
|
358 | delete $self->{_tw}; |
|
|
359 | } |
247 | } |
360 | } |
248 | |
361 | |
249 | ############################################################################# |
362 | ############################################################################# |
250 | |
363 | |
251 | =back |
364 | =back |
… | |
… | |
288 | =cut |
401 | =cut |
289 | |
402 | |
290 | sub _drain_wbuf { |
403 | sub _drain_wbuf { |
291 | my ($self) = @_; |
404 | my ($self) = @_; |
292 | |
405 | |
293 | if (!$self->{ww} && length $self->{wbuf}) { |
406 | if (!$self->{_ww} && length $self->{wbuf}) { |
294 | |
407 | |
295 | Scalar::Util::weaken $self; |
408 | Scalar::Util::weaken $self; |
296 | |
409 | |
297 | my $cb = sub { |
410 | my $cb = sub { |
298 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
411 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
299 | |
412 | |
300 | if ($len >= 0) { |
413 | if ($len >= 0) { |
301 | substr $self->{wbuf}, 0, $len, ""; |
414 | substr $self->{wbuf}, 0, $len, ""; |
|
|
415 | |
|
|
416 | $self->{_activity} = AnyEvent->now; |
302 | |
417 | |
303 | $self->{on_drain}($self) |
418 | $self->{on_drain}($self) |
304 | if $self->{low_water_mark} >= length $self->{wbuf} |
419 | if $self->{low_water_mark} >= length $self->{wbuf} |
305 | && $self->{on_drain}; |
420 | && $self->{on_drain}; |
306 | |
421 | |
307 | delete $self->{ww} unless length $self->{wbuf}; |
422 | delete $self->{_ww} unless length $self->{wbuf}; |
308 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
423 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
309 | $self->error; |
424 | $self->_error ($!, 1); |
310 | } |
425 | } |
311 | }; |
426 | }; |
312 | |
427 | |
313 | # try to write data immediately |
428 | # try to write data immediately |
314 | $cb->(); |
429 | $cb->(); |
315 | |
430 | |
316 | # if still data left in wbuf, we need to poll |
431 | # if still data left in wbuf, we need to poll |
317 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
432 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
318 | if length $self->{wbuf}; |
433 | if length $self->{wbuf}; |
319 | }; |
434 | }; |
320 | } |
435 | } |
321 | |
436 | |
322 | our %WH; |
437 | our %WH; |
… | |
… | |
334 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
449 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
335 | ->($self, @_); |
450 | ->($self, @_); |
336 | } |
451 | } |
337 | |
452 | |
338 | if ($self->{filter_w}) { |
453 | if ($self->{filter_w}) { |
339 | $self->{filter_w}->($self, \$_[0]); |
454 | $self->{filter_w}($self, \$_[0]); |
340 | } else { |
455 | } else { |
341 | $self->{wbuf} .= $_[0]; |
456 | $self->{wbuf} .= $_[0]; |
342 | $self->_drain_wbuf; |
457 | $self->_drain_wbuf; |
343 | } |
458 | } |
344 | } |
459 | } |
345 | |
460 | |
346 | =item $handle->push_write (type => @args) |
461 | =item $handle->push_write (type => @args) |
347 | |
462 | |
348 | =item $handle->unshift_write (type => @args) |
|
|
349 | |
|
|
350 | Instead of formatting your data yourself, you can also let this module do |
463 | Instead of formatting your data yourself, you can also let this module do |
351 | the job by specifying a type and type-specific arguments. |
464 | the job by specifying a type and type-specific arguments. |
352 | |
465 | |
353 | Predefined types are (if you have ideas for additional types, feel free to |
466 | Predefined types are (if you have ideas for additional types, feel free to |
354 | drop by and tell us): |
467 | drop by and tell us): |
… | |
… | |
358 | =item netstring => $string |
471 | =item netstring => $string |
359 | |
472 | |
360 | Formats the given value as netstring |
473 | Formats the given value as netstring |
361 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
474 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
362 | |
475 | |
363 | =back |
|
|
364 | |
|
|
365 | =cut |
476 | =cut |
366 | |
477 | |
367 | register_write_type netstring => sub { |
478 | register_write_type netstring => sub { |
368 | my ($self, $string) = @_; |
479 | my ($self, $string) = @_; |
369 | |
480 | |
370 | sprintf "%d:%s,", (length $string), $string |
481 | sprintf "%d:%s,", (length $string), $string |
371 | }; |
482 | }; |
372 | |
483 | |
|
|
484 | =item json => $array_or_hashref |
|
|
485 | |
|
|
486 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
487 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
488 | in UTF-8. |
|
|
489 | |
|
|
490 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
491 | one end of a handle and read them at the other end without using any |
|
|
492 | additional framing. |
|
|
493 | |
|
|
494 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
495 | this module doesn't need delimiters after or between JSON texts to be |
|
|
496 | able to read them, many other languages depend on that. |
|
|
497 | |
|
|
498 | A simple RPC protocol that interoperates easily with others is to send |
|
|
499 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
500 | they mimic how function argument passing works) and a newline after each |
|
|
501 | JSON text: |
|
|
502 | |
|
|
503 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
504 | $handle->push_write ("\012"); |
|
|
505 | |
|
|
506 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
507 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
508 | |
|
|
509 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
510 | |
|
|
511 | Other languages could read single lines terminated by a newline and pass |
|
|
512 | this line into their JSON decoder of choice. |
|
|
513 | |
|
|
514 | =cut |
|
|
515 | |
|
|
516 | register_write_type json => sub { |
|
|
517 | my ($self, $ref) = @_; |
|
|
518 | |
|
|
519 | require JSON; |
|
|
520 | |
|
|
521 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
522 | : JSON::encode_json ($ref) |
|
|
523 | }; |
|
|
524 | |
|
|
525 | =back |
|
|
526 | |
373 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
527 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
374 | |
528 | |
375 | This function (not method) lets you add your own types to C<push_write>. |
529 | This function (not method) lets you add your own types to C<push_write>. |
376 | Whenever the given C<type> is used, C<push_write> will invoke the code |
530 | Whenever the given C<type> is used, C<push_write> will invoke the code |
377 | reference with the handle object and the remaining arguments. |
531 | reference with the handle object and the remaining arguments. |
378 | |
532 | |
… | |
… | |
414 | the specified number of bytes which give an XML datagram. |
568 | the specified number of bytes which give an XML datagram. |
415 | |
569 | |
416 | # in the default state, expect some header bytes |
570 | # in the default state, expect some header bytes |
417 | $handle->on_read (sub { |
571 | $handle->on_read (sub { |
418 | # some data is here, now queue the length-header-read (4 octets) |
572 | # some data is here, now queue the length-header-read (4 octets) |
419 | shift->unshift_read_chunk (4, sub { |
573 | shift->unshift_read (chunk => 4, sub { |
420 | # header arrived, decode |
574 | # header arrived, decode |
421 | my $len = unpack "N", $_[1]; |
575 | my $len = unpack "N", $_[1]; |
422 | |
576 | |
423 | # now read the payload |
577 | # now read the payload |
424 | shift->unshift_read_chunk ($len, sub { |
578 | shift->unshift_read (chunk => $len, sub { |
425 | my $xml = $_[1]; |
579 | my $xml = $_[1]; |
426 | # handle xml |
580 | # handle xml |
427 | }); |
581 | }); |
428 | }); |
582 | }); |
429 | }); |
583 | }); |
… | |
… | |
436 | |
590 | |
437 | # request one |
591 | # request one |
438 | $handle->push_write ("request 1\015\012"); |
592 | $handle->push_write ("request 1\015\012"); |
439 | |
593 | |
440 | # we expect "ERROR" or "OK" as response, so push a line read |
594 | # we expect "ERROR" or "OK" as response, so push a line read |
441 | $handle->push_read_line (sub { |
595 | $handle->push_read (line => sub { |
442 | # if we got an "OK", we have to _prepend_ another line, |
596 | # if we got an "OK", we have to _prepend_ another line, |
443 | # so it will be read before the second request reads its 64 bytes |
597 | # so it will be read before the second request reads its 64 bytes |
444 | # which are already in the queue when this callback is called |
598 | # which are already in the queue when this callback is called |
445 | # we don't do this in case we got an error |
599 | # we don't do this in case we got an error |
446 | if ($_[1] eq "OK") { |
600 | if ($_[1] eq "OK") { |
447 | $_[0]->unshift_read_line (sub { |
601 | $_[0]->unshift_read (line => sub { |
448 | my $response = $_[1]; |
602 | my $response = $_[1]; |
449 | ... |
603 | ... |
450 | }); |
604 | }); |
451 | } |
605 | } |
452 | }); |
606 | }); |
453 | |
607 | |
454 | # request two |
608 | # request two |
455 | $handle->push_write ("request 2\015\012"); |
609 | $handle->push_write ("request 2\015\012"); |
456 | |
610 | |
457 | # simply read 64 bytes, always |
611 | # simply read 64 bytes, always |
458 | $handle->push_read_chunk (64, sub { |
612 | $handle->push_read (chunk => 64, sub { |
459 | my $response = $_[1]; |
613 | my $response = $_[1]; |
460 | ... |
614 | ... |
461 | }); |
615 | }); |
462 | |
616 | |
463 | =over 4 |
617 | =over 4 |
… | |
… | |
469 | |
623 | |
470 | if ( |
624 | if ( |
471 | defined $self->{rbuf_max} |
625 | defined $self->{rbuf_max} |
472 | && $self->{rbuf_max} < length $self->{rbuf} |
626 | && $self->{rbuf_max} < length $self->{rbuf} |
473 | ) { |
627 | ) { |
474 | $! = &Errno::ENOSPC; return $self->error; |
628 | return $self->_error (&Errno::ENOSPC, 1); |
475 | } |
629 | } |
476 | |
630 | |
477 | return if $self->{in_drain}; |
631 | return if $self->{in_drain}; |
478 | local $self->{in_drain} = 1; |
632 | local $self->{in_drain} = 1; |
479 | |
633 | |
480 | while (my $len = length $self->{rbuf}) { |
634 | while (my $len = length $self->{rbuf}) { |
481 | no strict 'refs'; |
635 | no strict 'refs'; |
482 | if (my $cb = shift @{ $self->{queue} }) { |
636 | if (my $cb = shift @{ $self->{_queue} }) { |
483 | unless ($cb->($self)) { |
637 | unless ($cb->($self)) { |
484 | if ($self->{eof}) { |
638 | if ($self->{_eof}) { |
485 | # no progress can be made (not enough data and no data forthcoming) |
639 | # no progress can be made (not enough data and no data forthcoming) |
486 | $! = &Errno::EPIPE; return $self->error; |
640 | return $self->_error (&Errno::EPIPE, 1); |
487 | } |
641 | } |
488 | |
642 | |
489 | unshift @{ $self->{queue} }, $cb; |
643 | unshift @{ $self->{_queue} }, $cb; |
490 | return; |
644 | return; |
491 | } |
645 | } |
492 | } elsif ($self->{on_read}) { |
646 | } elsif ($self->{on_read}) { |
493 | $self->{on_read}($self); |
647 | $self->{on_read}($self); |
494 | |
648 | |
495 | if ( |
649 | if ( |
496 | $self->{eof} # if no further data will arrive |
650 | $self->{_eof} # if no further data will arrive |
497 | && $len == length $self->{rbuf} # and no data has been consumed |
651 | && $len == length $self->{rbuf} # and no data has been consumed |
498 | && !@{ $self->{queue} } # and the queue is still empty |
652 | && !@{ $self->{_queue} } # and the queue is still empty |
499 | && $self->{on_read} # and we still want to read data |
653 | && $self->{on_read} # and we still want to read data |
500 | ) { |
654 | ) { |
501 | # then no progress can be made |
655 | # then no progress can be made |
502 | $! = &Errno::EPIPE; return $self->error; |
656 | return $self->_error (&Errno::EPIPE, 1); |
503 | } |
657 | } |
504 | } else { |
658 | } else { |
505 | # read side becomes idle |
659 | # read side becomes idle |
506 | delete $self->{rw}; |
660 | delete $self->{_rw}; |
507 | return; |
661 | return; |
508 | } |
662 | } |
509 | } |
663 | } |
510 | |
664 | |
511 | if ($self->{eof}) { |
|
|
512 | $self->_shutdown; |
|
|
513 | $self->{on_eof}($self) |
665 | $self->{on_eof}($self) |
514 | if $self->{on_eof}; |
666 | if $self->{_eof} && $self->{on_eof}; |
515 | } |
|
|
516 | } |
667 | } |
517 | |
668 | |
518 | =item $handle->on_read ($cb) |
669 | =item $handle->on_read ($cb) |
519 | |
670 | |
520 | This replaces the currently set C<on_read> callback, or clears it (when |
671 | This replaces the currently set C<on_read> callback, or clears it (when |
… | |
… | |
582 | |
733 | |
583 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
734 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
584 | ->($self, $cb, @_); |
735 | ->($self, $cb, @_); |
585 | } |
736 | } |
586 | |
737 | |
587 | push @{ $self->{queue} }, $cb; |
738 | push @{ $self->{_queue} }, $cb; |
588 | $self->_drain_rbuf; |
739 | $self->_drain_rbuf; |
589 | } |
740 | } |
590 | |
741 | |
591 | sub unshift_read { |
742 | sub unshift_read { |
592 | my $self = shift; |
743 | my $self = shift; |
… | |
… | |
598 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
749 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
599 | ->($self, $cb, @_); |
750 | ->($self, $cb, @_); |
600 | } |
751 | } |
601 | |
752 | |
602 | |
753 | |
603 | unshift @{ $self->{queue} }, $cb; |
754 | unshift @{ $self->{_queue} }, $cb; |
604 | $self->_drain_rbuf; |
755 | $self->_drain_rbuf; |
605 | } |
756 | } |
606 | |
757 | |
607 | =item $handle->push_read (type => @args, $cb) |
758 | =item $handle->push_read (type => @args, $cb) |
608 | |
759 | |
… | |
… | |
615 | Predefined types are (if you have ideas for additional types, feel free to |
766 | Predefined types are (if you have ideas for additional types, feel free to |
616 | drop by and tell us): |
767 | drop by and tell us): |
617 | |
768 | |
618 | =over 4 |
769 | =over 4 |
619 | |
770 | |
620 | =item chunk => $octets, $cb->($self, $data) |
771 | =item chunk => $octets, $cb->($handle, $data) |
621 | |
772 | |
622 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
773 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
623 | data read to the callback. The callback will never be called with less |
774 | data read to the callback. The callback will never be called with less |
624 | data. |
775 | data. |
625 | |
776 | |
… | |
… | |
648 | |
799 | |
649 | sub unshift_read_chunk { |
800 | sub unshift_read_chunk { |
650 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
801 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
651 | } |
802 | } |
652 | |
803 | |
653 | =item line => [$eol, ]$cb->($self, $line, $eol) |
804 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
654 | |
805 | |
655 | The callback will be called only once a full line (including the end of |
806 | The callback will be called only once a full line (including the end of |
656 | line marker, C<$eol>) has been read. This line (excluding the end of line |
807 | line marker, C<$eol>) has been read. This line (excluding the end of line |
657 | marker) will be passed to the callback as second argument (C<$line>), and |
808 | marker) will be passed to the callback as second argument (C<$line>), and |
658 | the end of line marker as the third argument (C<$eol>). |
809 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
695 | sub unshift_read_line { |
846 | sub unshift_read_line { |
696 | my $self = shift; |
847 | my $self = shift; |
697 | $self->unshift_read (line => @_); |
848 | $self->unshift_read (line => @_); |
698 | } |
849 | } |
699 | |
850 | |
700 | =item netstring => $cb->($string) |
851 | =item netstring => $cb->($handle, $string) |
701 | |
852 | |
702 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
853 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
703 | |
854 | |
704 | Throws an error with C<$!> set to EBADMSG on format violations. |
855 | Throws an error with C<$!> set to EBADMSG on format violations. |
705 | |
856 | |
… | |
… | |
709 | my ($self, $cb) = @_; |
860 | my ($self, $cb) = @_; |
710 | |
861 | |
711 | sub { |
862 | sub { |
712 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
863 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
713 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
864 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
714 | $! = &Errno::EBADMSG; |
865 | $self->_error (&Errno::EBADMSG); |
715 | $self->error; |
|
|
716 | } |
866 | } |
717 | return; |
867 | return; |
718 | } |
868 | } |
719 | |
869 | |
720 | my $len = $1; |
870 | my $len = $1; |
… | |
… | |
723 | my $string = $_[1]; |
873 | my $string = $_[1]; |
724 | $_[0]->unshift_read (chunk => 1, sub { |
874 | $_[0]->unshift_read (chunk => 1, sub { |
725 | if ($_[1] eq ",") { |
875 | if ($_[1] eq ",") { |
726 | $cb->($_[0], $string); |
876 | $cb->($_[0], $string); |
727 | } else { |
877 | } else { |
728 | $! = &Errno::EBADMSG; |
878 | $self->_error (&Errno::EBADMSG); |
729 | $self->error; |
|
|
730 | } |
879 | } |
731 | }); |
880 | }); |
732 | }); |
881 | }); |
733 | |
882 | |
734 | 1 |
883 | 1 |
735 | } |
884 | } |
736 | }; |
885 | }; |
737 | |
886 | |
738 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
887 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
739 | |
888 | |
740 | Makes a regex match against the regex object C<$accept> and returns |
889 | Makes a regex match against the regex object C<$accept> and returns |
741 | everything up to and including the match. |
890 | everything up to and including the match. |
742 | |
891 | |
743 | Example: read a single line terminated by '\n'. |
892 | Example: read a single line terminated by '\n'. |
… | |
… | |
791 | return 1; |
940 | return 1; |
792 | } |
941 | } |
793 | |
942 | |
794 | # reject |
943 | # reject |
795 | if ($reject && $$rbuf =~ $reject) { |
944 | if ($reject && $$rbuf =~ $reject) { |
796 | $! = &Errno::EBADMSG; |
945 | $self->_error (&Errno::EBADMSG); |
797 | $self->error; |
|
|
798 | } |
946 | } |
799 | |
947 | |
800 | # skip |
948 | # skip |
801 | if ($skip && $$rbuf =~ $skip) { |
949 | if ($skip && $$rbuf =~ $skip) { |
802 | $data .= substr $$rbuf, 0, $+[0], ""; |
950 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
804 | |
952 | |
805 | () |
953 | () |
806 | } |
954 | } |
807 | }; |
955 | }; |
808 | |
956 | |
|
|
957 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
958 | |
|
|
959 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
960 | |
|
|
961 | If a C<json> object was passed to the constructor, then that will be used |
|
|
962 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
963 | |
|
|
964 | This read type uses the incremental parser available with JSON version |
|
|
965 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
966 | dependency on your own: this module will load the JSON module, but |
|
|
967 | AnyEvent does not depend on it itself. |
|
|
968 | |
|
|
969 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
970 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
971 | the C<json> write type description, above, for an actual example. |
|
|
972 | |
|
|
973 | =cut |
|
|
974 | |
|
|
975 | register_read_type json => sub { |
|
|
976 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
977 | |
|
|
978 | require JSON; |
|
|
979 | |
|
|
980 | my $data; |
|
|
981 | my $rbuf = \$self->{rbuf}; |
|
|
982 | |
|
|
983 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
984 | |
|
|
985 | sub { |
|
|
986 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
987 | |
|
|
988 | if ($ref) { |
|
|
989 | $self->{rbuf} = $json->incr_text; |
|
|
990 | $json->incr_text = ""; |
|
|
991 | $cb->($self, $ref); |
|
|
992 | |
|
|
993 | 1 |
|
|
994 | } else { |
|
|
995 | $self->{rbuf} = ""; |
|
|
996 | () |
|
|
997 | } |
|
|
998 | } |
|
|
999 | }; |
|
|
1000 | |
809 | =back |
1001 | =back |
810 | |
1002 | |
811 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
1003 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
812 | |
1004 | |
813 | This function (not method) lets you add your own types to C<push_read>. |
1005 | This function (not method) lets you add your own types to C<push_read>. |
814 | |
1006 | |
815 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1007 | Whenever the given C<type> is used, C<push_read> will invoke the code |
816 | reference with the handle object, the callback and the remaining |
1008 | reference with the handle object, the callback and the remaining |
… | |
… | |
818 | |
1010 | |
819 | The code reference is supposed to return a callback (usually a closure) |
1011 | The code reference is supposed to return a callback (usually a closure) |
820 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1012 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
821 | |
1013 | |
822 | It should invoke the passed callback when it is done reading (remember to |
1014 | It should invoke the passed callback when it is done reading (remember to |
823 | pass C<$self> as first argument as all other callbacks do that). |
1015 | pass C<$handle> as first argument as all other callbacks do that). |
824 | |
1016 | |
825 | Note that this is a function, and all types registered this way will be |
1017 | Note that this is a function, and all types registered this way will be |
826 | global, so try to use unique names. |
1018 | global, so try to use unique names. |
827 | |
1019 | |
828 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1020 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
… | |
… | |
840 | =cut |
1032 | =cut |
841 | |
1033 | |
842 | sub stop_read { |
1034 | sub stop_read { |
843 | my ($self) = @_; |
1035 | my ($self) = @_; |
844 | |
1036 | |
845 | delete $self->{rw}; |
1037 | delete $self->{_rw}; |
846 | } |
1038 | } |
847 | |
1039 | |
848 | sub start_read { |
1040 | sub start_read { |
849 | my ($self) = @_; |
1041 | my ($self) = @_; |
850 | |
1042 | |
851 | unless ($self->{rw} || $self->{eof}) { |
1043 | unless ($self->{_rw} || $self->{_eof}) { |
852 | Scalar::Util::weaken $self; |
1044 | Scalar::Util::weaken $self; |
853 | |
1045 | |
854 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1046 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
855 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1047 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
856 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1048 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
857 | |
1049 | |
858 | if ($len > 0) { |
1050 | if ($len > 0) { |
|
|
1051 | $self->{_activity} = AnyEvent->now; |
|
|
1052 | |
859 | $self->{filter_r} |
1053 | $self->{filter_r} |
860 | ? $self->{filter_r}->($self, $rbuf) |
1054 | ? $self->{filter_r}($self, $rbuf) |
861 | : $self->_drain_rbuf; |
1055 | : $self->_drain_rbuf; |
862 | |
1056 | |
863 | } elsif (defined $len) { |
1057 | } elsif (defined $len) { |
864 | delete $self->{rw}; |
1058 | delete $self->{_rw}; |
865 | $self->{eof} = 1; |
1059 | $self->{_eof} = 1; |
866 | $self->_drain_rbuf; |
1060 | $self->_drain_rbuf; |
867 | |
1061 | |
868 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
1062 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
869 | return $self->error; |
1063 | return $self->_error ($!, 1); |
870 | } |
1064 | } |
871 | }); |
1065 | }); |
872 | } |
1066 | } |
873 | } |
1067 | } |
874 | |
1068 | |
875 | sub _dotls { |
1069 | sub _dotls { |
876 | my ($self) = @_; |
1070 | my ($self) = @_; |
877 | |
1071 | |
878 | if (length $self->{tls_wbuf}) { |
1072 | if (length $self->{_tls_wbuf}) { |
879 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { |
1073 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
880 | substr $self->{tls_wbuf}, 0, $len, ""; |
1074 | substr $self->{_tls_wbuf}, 0, $len, ""; |
881 | } |
1075 | } |
882 | } |
1076 | } |
883 | |
1077 | |
884 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
1078 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
885 | $self->{wbuf} .= $buf; |
1079 | $self->{wbuf} .= $buf; |
886 | $self->_drain_wbuf; |
1080 | $self->_drain_wbuf; |
887 | } |
1081 | } |
888 | |
1082 | |
889 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1083 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
… | |
… | |
893 | |
1087 | |
894 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1088 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
895 | |
1089 | |
896 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1090 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
897 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1091 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
898 | $self->error; |
1092 | return $self->_error ($!, 1); |
899 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1093 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
900 | $! = &Errno::EIO; |
1094 | return $self->_error (&Errno::EIO, 1); |
901 | $self->error; |
|
|
902 | } |
1095 | } |
903 | |
1096 | |
904 | # all others are fine for our purposes |
1097 | # all others are fine for our purposes |
905 | } |
1098 | } |
906 | } |
1099 | } |
… | |
… | |
915 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1108 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
916 | |
1109 | |
917 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1110 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
918 | used when AnyEvent::Handle has to create its own TLS connection object. |
1111 | used when AnyEvent::Handle has to create its own TLS connection object. |
919 | |
1112 | |
920 | =cut |
1113 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
1114 | call and can be used or changed to your liking. Note that the handshake |
|
|
1115 | might have already started when this function returns. |
921 | |
1116 | |
922 | # TODO: maybe document... |
1117 | =cut |
|
|
1118 | |
923 | sub starttls { |
1119 | sub starttls { |
924 | my ($self, $ssl, $ctx) = @_; |
1120 | my ($self, $ssl, $ctx) = @_; |
925 | |
1121 | |
926 | $self->stoptls; |
1122 | $self->stoptls; |
927 | |
1123 | |
… | |
… | |
942 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1138 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
943 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1139 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
944 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1140 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
945 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1141 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
946 | |
1142 | |
947 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1143 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
948 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1144 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
949 | |
1145 | |
950 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
1146 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
951 | |
1147 | |
952 | $self->{filter_w} = sub { |
1148 | $self->{filter_w} = sub { |
953 | $_[0]{tls_wbuf} .= ${$_[1]}; |
1149 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
954 | &_dotls; |
1150 | &_dotls; |
955 | }; |
1151 | }; |
956 | $self->{filter_r} = sub { |
1152 | $self->{filter_r} = sub { |
957 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
1153 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
958 | &_dotls; |
1154 | &_dotls; |
959 | }; |
1155 | }; |
960 | } |
1156 | } |
961 | |
1157 | |
962 | =item $handle->stoptls |
1158 | =item $handle->stoptls |
… | |
… | |
968 | |
1164 | |
969 | sub stoptls { |
1165 | sub stoptls { |
970 | my ($self) = @_; |
1166 | my ($self) = @_; |
971 | |
1167 | |
972 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1168 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
1169 | |
973 | delete $self->{tls_rbio}; |
1170 | delete $self->{_rbio}; |
974 | delete $self->{tls_wbio}; |
1171 | delete $self->{_wbio}; |
975 | delete $self->{tls_wbuf}; |
1172 | delete $self->{_tls_wbuf}; |
976 | delete $self->{filter_r}; |
1173 | delete $self->{filter_r}; |
977 | delete $self->{filter_w}; |
1174 | delete $self->{filter_w}; |
978 | } |
1175 | } |
979 | |
1176 | |
980 | sub DESTROY { |
1177 | sub DESTROY { |
… | |
… | |
1018 | } |
1215 | } |
1019 | } |
1216 | } |
1020 | |
1217 | |
1021 | =back |
1218 | =back |
1022 | |
1219 | |
|
|
1220 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1221 | |
|
|
1222 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1223 | |
|
|
1224 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1225 | conventions: |
|
|
1226 | |
|
|
1227 | =over 4 |
|
|
1228 | |
|
|
1229 | =item * all constructor arguments become object members. |
|
|
1230 | |
|
|
1231 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1232 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
|
|
1233 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1234 | |
|
|
1235 | =item * other object member names are prefixed with an C<_>. |
|
|
1236 | |
|
|
1237 | All object members not explicitly documented (internal use) are prefixed |
|
|
1238 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1239 | for use for subclasses. |
|
|
1240 | |
|
|
1241 | =item * all members not documented here and not prefixed with an underscore |
|
|
1242 | are free to use in subclasses. |
|
|
1243 | |
|
|
1244 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1245 | member variables, but thats just life, at least it is documented. |
|
|
1246 | |
|
|
1247 | =back |
|
|
1248 | |
1023 | =head1 AUTHOR |
1249 | =head1 AUTHOR |
1024 | |
1250 | |
1025 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1251 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1026 | |
1252 | |
1027 | =cut |
1253 | =cut |