… | |
… | |
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 = 4.234; |
19 | our $VERSION = 4.331; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
27 | |
27 | |
28 | my $handle = |
28 | my $handle = |
29 | AnyEvent::Handle->new ( |
29 | AnyEvent::Handle->new ( |
30 | fh => \*STDIN, |
30 | fh => \*STDIN, |
31 | on_eof => sub { |
31 | on_eof => sub { |
32 | $cv->broadcast; |
32 | $cv->send; |
33 | }, |
33 | }, |
34 | ); |
34 | ); |
35 | |
35 | |
36 | # send some request line |
36 | # send some request line |
37 | $handle->push_write ("getinfo\015\012"); |
37 | $handle->push_write ("getinfo\015\012"); |
… | |
… | |
84 | Set the callback to be called when an end-of-file condition is detected, |
84 | Set the callback to be called when an end-of-file condition is detected, |
85 | i.e. in the case of a socket, when the other side has closed the |
85 | i.e. in the case of a socket, when the other side has closed the |
86 | connection cleanly. |
86 | connection cleanly. |
87 | |
87 | |
88 | For sockets, this just means that the other side has stopped sending data, |
88 | For sockets, this just means that the other side has stopped sending data, |
89 | you can still try to write data, and, in fact, one can return from the eof |
89 | you can still try to write data, and, in fact, one can return from the EOF |
90 | callback and continue writing data, as only the read part has been shut |
90 | callback and continue writing data, as only the read part has been shut |
91 | down. |
91 | down. |
92 | |
92 | |
93 | While not mandatory, it is I<highly> recommended to set an eof callback, |
93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
94 | otherwise you might end up with a closed socket while you are still |
94 | otherwise you might end up with a closed socket while you are still |
95 | waiting for data. |
95 | waiting for data. |
96 | |
96 | |
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
… | |
… | |
232 | write data and will install a watcher that will write this data to the |
232 | write data and will install a watcher that will write this data to the |
233 | socket. No errors will be reported (this mostly matches how the operating |
233 | socket. No errors will be reported (this mostly matches how the operating |
234 | system treats outstanding data at socket close time). |
234 | system treats outstanding data at socket close time). |
235 | |
235 | |
236 | This will not work for partial TLS data that could not be encoded |
236 | This will not work for partial TLS data that could not be encoded |
237 | yet. This data will be lost. |
237 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
238 | help. |
238 | |
239 | |
239 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
240 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
240 | |
241 | |
241 | When this parameter is given, it enables TLS (SSL) mode, that means |
242 | When this parameter is given, it enables TLS (SSL) mode, that means |
242 | AnyEvent will start a TLS handshake as soon as the conenction has been |
243 | AnyEvent will start a TLS handshake as soon as the conenction has been |
… | |
… | |
273 | texts. |
274 | texts. |
274 | |
275 | |
275 | Note that you are responsible to depend on the JSON module if you want to |
276 | Note that you are responsible to depend on the JSON module if you want to |
276 | use this functionality, as AnyEvent does not have a dependency itself. |
277 | use this functionality, as AnyEvent does not have a dependency itself. |
277 | |
278 | |
278 | =item filter_r => $cb |
|
|
279 | |
|
|
280 | =item filter_w => $cb |
|
|
281 | |
|
|
282 | These exist, but are undocumented at this time. (They are used internally |
|
|
283 | by the TLS code). |
|
|
284 | |
|
|
285 | =back |
279 | =back |
286 | |
280 | |
287 | =cut |
281 | =cut |
288 | |
282 | |
289 | sub new { |
283 | sub new { |
… | |
… | |
293 | |
287 | |
294 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
288 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
295 | |
289 | |
296 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
290 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
297 | |
291 | |
298 | if ($self->{tls}) { |
|
|
299 | require Net::SSLeay; |
|
|
300 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
292 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
301 | } |
293 | if $self->{tls}; |
302 | |
294 | |
303 | $self->{_activity} = AnyEvent->now; |
295 | $self->{_activity} = AnyEvent->now; |
304 | $self->_timeout; |
296 | $self->_timeout; |
305 | |
297 | |
306 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
298 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
… | |
… | |
318 | delete $self->{_tw}; |
310 | delete $self->{_tw}; |
319 | delete $self->{_rw}; |
311 | delete $self->{_rw}; |
320 | delete $self->{_ww}; |
312 | delete $self->{_ww}; |
321 | delete $self->{fh}; |
313 | delete $self->{fh}; |
322 | |
314 | |
323 | $self->stoptls; |
315 | &_freetls; |
324 | |
316 | |
325 | delete $self->{on_read}; |
317 | delete $self->{on_read}; |
326 | delete $self->{_queue}; |
318 | delete $self->{_queue}; |
327 | } |
319 | } |
328 | |
320 | |
… | |
… | |
334 | |
326 | |
335 | $! = $errno; |
327 | $! = $errno; |
336 | |
328 | |
337 | if ($self->{on_error}) { |
329 | if ($self->{on_error}) { |
338 | $self->{on_error}($self, $fatal); |
330 | $self->{on_error}($self, $fatal); |
339 | } else { |
331 | } elsif ($self->{fh}) { |
340 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
332 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
341 | } |
333 | } |
342 | } |
334 | } |
343 | |
335 | |
344 | =item $fh = $handle->fh |
336 | =item $fh = $handle->fh |
… | |
… | |
382 | } |
374 | } |
383 | |
375 | |
384 | =item $handle->autocork ($boolean) |
376 | =item $handle->autocork ($boolean) |
385 | |
377 | |
386 | Enables or disables the current autocork behaviour (see C<autocork> |
378 | Enables or disables the current autocork behaviour (see C<autocork> |
387 | constructor argument). |
379 | constructor argument). Changes will only take effect on the next write. |
388 | |
380 | |
389 | =cut |
381 | =cut |
|
|
382 | |
|
|
383 | sub autocork { |
|
|
384 | $_[0]{autocork} = $_[1]; |
|
|
385 | } |
390 | |
386 | |
391 | =item $handle->no_delay ($boolean) |
387 | =item $handle->no_delay ($boolean) |
392 | |
388 | |
393 | Enables or disables the C<no_delay> setting (see constructor argument of |
389 | Enables or disables the C<no_delay> setting (see constructor argument of |
394 | the same name for details). |
390 | the same name for details). |
… | |
… | |
487 | my ($self, $cb) = @_; |
483 | my ($self, $cb) = @_; |
488 | |
484 | |
489 | $self->{on_drain} = $cb; |
485 | $self->{on_drain} = $cb; |
490 | |
486 | |
491 | $cb->($self) |
487 | $cb->($self) |
492 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
488 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
493 | } |
489 | } |
494 | |
490 | |
495 | =item $handle->push_write ($data) |
491 | =item $handle->push_write ($data) |
496 | |
492 | |
497 | Queues the given scalar to be written. You can push as much data as you |
493 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
514 | substr $self->{wbuf}, 0, $len, ""; |
510 | substr $self->{wbuf}, 0, $len, ""; |
515 | |
511 | |
516 | $self->{_activity} = AnyEvent->now; |
512 | $self->{_activity} = AnyEvent->now; |
517 | |
513 | |
518 | $self->{on_drain}($self) |
514 | $self->{on_drain}($self) |
519 | if $self->{low_water_mark} >= length $self->{wbuf} |
515 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
520 | && $self->{on_drain}; |
516 | && $self->{on_drain}; |
521 | |
517 | |
522 | delete $self->{_ww} unless length $self->{wbuf}; |
518 | delete $self->{_ww} unless length $self->{wbuf}; |
523 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
519 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
524 | $self->_error ($!, 1); |
520 | $self->_error ($!, 1); |
… | |
… | |
548 | |
544 | |
549 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
545 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
550 | ->($self, @_); |
546 | ->($self, @_); |
551 | } |
547 | } |
552 | |
548 | |
553 | if ($self->{filter_w}) { |
549 | if ($self->{tls}) { |
554 | $self->{filter_w}($self, \$_[0]); |
550 | $self->{_tls_wbuf} .= $_[0]; |
|
|
551 | |
|
|
552 | &_dotls ($self); |
555 | } else { |
553 | } else { |
556 | $self->{wbuf} .= $_[0]; |
554 | $self->{wbuf} .= $_[0]; |
557 | $self->_drain_wbuf; |
555 | $self->_drain_wbuf; |
558 | } |
556 | } |
559 | } |
557 | } |
… | |
… | |
576 | =cut |
574 | =cut |
577 | |
575 | |
578 | register_write_type netstring => sub { |
576 | register_write_type netstring => sub { |
579 | my ($self, $string) = @_; |
577 | my ($self, $string) = @_; |
580 | |
578 | |
581 | sprintf "%d:%s,", (length $string), $string |
579 | (length $string) . ":$string," |
582 | }; |
580 | }; |
583 | |
581 | |
584 | =item packstring => $format, $data |
582 | =item packstring => $format, $data |
585 | |
583 | |
586 | An octet string prefixed with an encoded length. The encoding C<$format> |
584 | An octet string prefixed with an encoded length. The encoding C<$format> |
… | |
… | |
795 | |
793 | |
796 | last; # more data might arrive |
794 | last; # more data might arrive |
797 | } |
795 | } |
798 | } else { |
796 | } else { |
799 | # read side becomes idle |
797 | # read side becomes idle |
800 | delete $self->{_rw}; |
798 | delete $self->{_rw} unless $self->{tls}; |
801 | last; |
799 | last; |
802 | } |
800 | } |
803 | } |
801 | } |
804 | |
802 | |
805 | if ($self->{_eof}) { |
803 | if ($self->{_eof}) { |
… | |
… | |
1100 | An octet string prefixed with an encoded length. The encoding C<$format> |
1098 | An octet string prefixed with an encoded length. The encoding C<$format> |
1101 | uses the same format as a Perl C<pack> format, but must specify a single |
1099 | uses the same format as a Perl C<pack> format, but must specify a single |
1102 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1100 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1103 | optional C<!>, C<< < >> or C<< > >> modifier). |
1101 | optional C<!>, C<< < >> or C<< > >> modifier). |
1104 | |
1102 | |
1105 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
1103 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1104 | EPP uses a prefix of C<N> (4 octtes). |
1106 | |
1105 | |
1107 | Example: read a block of data prefixed by its length in BER-encoded |
1106 | Example: read a block of data prefixed by its length in BER-encoded |
1108 | format (very efficient). |
1107 | format (very efficient). |
1109 | |
1108 | |
1110 | $handle->push_read (packstring => "w", sub { |
1109 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1263 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1262 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1264 | you change the C<on_read> callback or push/unshift a read callback, and it |
1263 | you change the C<on_read> callback or push/unshift a read callback, and it |
1265 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1264 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1266 | there are any read requests in the queue. |
1265 | there are any read requests in the queue. |
1267 | |
1266 | |
|
|
1267 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1268 | half-duplex connections). |
|
|
1269 | |
1268 | =cut |
1270 | =cut |
1269 | |
1271 | |
1270 | sub stop_read { |
1272 | sub stop_read { |
1271 | my ($self) = @_; |
1273 | my ($self) = @_; |
1272 | |
1274 | |
1273 | delete $self->{_rw}; |
1275 | delete $self->{_rw} unless $self->{tls}; |
1274 | } |
1276 | } |
1275 | |
1277 | |
1276 | sub start_read { |
1278 | sub start_read { |
1277 | my ($self) = @_; |
1279 | my ($self) = @_; |
1278 | |
1280 | |
1279 | unless ($self->{_rw} || $self->{_eof}) { |
1281 | unless ($self->{_rw} || $self->{_eof}) { |
1280 | Scalar::Util::weaken $self; |
1282 | Scalar::Util::weaken $self; |
1281 | |
1283 | |
1282 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1284 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1283 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1285 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1284 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1286 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1285 | |
1287 | |
1286 | if ($len > 0) { |
1288 | if ($len > 0) { |
1287 | $self->{_activity} = AnyEvent->now; |
1289 | $self->{_activity} = AnyEvent->now; |
1288 | |
1290 | |
1289 | $self->{filter_r} |
1291 | if ($self->{tls}) { |
1290 | ? $self->{filter_r}($self, $rbuf) |
1292 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1291 | : $self->{_in_drain} || $self->_drain_rbuf; |
1293 | |
|
|
1294 | &_dotls ($self); |
|
|
1295 | } else { |
|
|
1296 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1297 | } |
1292 | |
1298 | |
1293 | } elsif (defined $len) { |
1299 | } elsif (defined $len) { |
1294 | delete $self->{_rw}; |
1300 | delete $self->{_rw}; |
1295 | $self->{_eof} = 1; |
1301 | $self->{_eof} = 1; |
1296 | $self->_drain_rbuf unless $self->{_in_drain}; |
1302 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1300 | } |
1306 | } |
1301 | }); |
1307 | }); |
1302 | } |
1308 | } |
1303 | } |
1309 | } |
1304 | |
1310 | |
|
|
1311 | # poll the write BIO and send the data if applicable |
1305 | sub _dotls { |
1312 | sub _dotls { |
1306 | my ($self) = @_; |
1313 | my ($self) = @_; |
1307 | |
1314 | |
1308 | my $buf; |
1315 | my $tmp; |
1309 | |
1316 | |
1310 | if (length $self->{_tls_wbuf}) { |
1317 | if (length $self->{_tls_wbuf}) { |
1311 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1318 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1312 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1319 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1313 | } |
1320 | } |
1314 | } |
1321 | } |
1315 | |
1322 | |
1316 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1317 | $self->{wbuf} .= $buf; |
|
|
1318 | $self->_drain_wbuf; |
|
|
1319 | } |
|
|
1320 | |
|
|
1321 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1323 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1322 | if (length $buf) { |
1324 | unless (length $tmp) { |
1323 | $self->{rbuf} .= $buf; |
|
|
1324 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1325 | } else { |
|
|
1326 | # let's treat SSL-eof as we treat normal EOF |
1325 | # let's treat SSL-eof as we treat normal EOF |
|
|
1326 | delete $self->{_rw}; |
1327 | $self->{_eof} = 1; |
1327 | $self->{_eof} = 1; |
1328 | $self->_shutdown; |
1328 | &_freetls; |
1329 | return; |
|
|
1330 | } |
1329 | } |
1331 | } |
|
|
1332 | |
1330 | |
|
|
1331 | $self->{rbuf} .= $tmp; |
|
|
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1333 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1334 | } |
|
|
1335 | |
1333 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1336 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1334 | |
1337 | |
1335 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1338 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
1336 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1339 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
1337 | return $self->_error ($!, 1); |
1340 | return $self->_error ($!, 1); |
1338 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1341 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1339 | return $self->_error (&Errno::EIO, 1); |
1342 | return $self->_error (&Errno::EIO, 1); |
1340 | } |
1343 | } |
1341 | |
1344 | |
1342 | # all others are fine for our purposes |
1345 | # all other errors are fine for our purposes |
|
|
1346 | } |
|
|
1347 | |
|
|
1348 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1349 | $self->{wbuf} .= $tmp; |
|
|
1350 | $self->_drain_wbuf; |
1343 | } |
1351 | } |
1344 | } |
1352 | } |
1345 | |
1353 | |
1346 | =item $handle->starttls ($tls[, $tls_ctx]) |
1354 | =item $handle->starttls ($tls[, $tls_ctx]) |
1347 | |
1355 | |
… | |
… | |
1357 | |
1365 | |
1358 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1366 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1359 | call and can be used or changed to your liking. Note that the handshake |
1367 | call and can be used or changed to your liking. Note that the handshake |
1360 | might have already started when this function returns. |
1368 | might have already started when this function returns. |
1361 | |
1369 | |
|
|
1370 | If it an error to start a TLS handshake more than once per |
|
|
1371 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1372 | |
1362 | =cut |
1373 | =cut |
1363 | |
1374 | |
1364 | sub starttls { |
1375 | sub starttls { |
1365 | my ($self, $ssl, $ctx) = @_; |
1376 | my ($self, $ssl, $ctx) = @_; |
1366 | |
1377 | |
1367 | $self->stoptls; |
1378 | require Net::SSLeay; |
1368 | |
1379 | |
|
|
1380 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
|
|
1381 | if $self->{tls}; |
|
|
1382 | |
1369 | if ($ssl eq "accept") { |
1383 | if ($ssl eq "accept") { |
1370 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1371 | Net::SSLeay::set_accept_state ($ssl); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
1372 | } elsif ($ssl eq "connect") { |
1386 | } elsif ($ssl eq "connect") { |
1373 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1387 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1382 | # and mismaintained ssleay-module doesn't even offer them). |
1396 | # and mismaintained ssleay-module doesn't even offer them). |
1383 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1397 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1384 | # |
1398 | # |
1385 | # in short: this is a mess. |
1399 | # in short: this is a mess. |
1386 | # |
1400 | # |
1387 | # note that we do not try to kepe the length constant between writes as we are required to do. |
1401 | # note that we do not try to keep the length constant between writes as we are required to do. |
1388 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1402 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1389 | # and we drive openssl fully in blocking mode here. |
1403 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1404 | # have identity issues in that area. |
1390 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1405 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1391 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1406 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1392 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1407 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1393 | |
1408 | |
1394 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1409 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1395 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1410 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1396 | |
1411 | |
1397 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1412 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1398 | |
1413 | |
1399 | $self->{filter_w} = sub { |
1414 | &_dotls; # need to trigger the initial handshake |
1400 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1415 | $self->start_read; # make sure we actually do read |
1401 | &_dotls; |
|
|
1402 | }; |
|
|
1403 | $self->{filter_r} = sub { |
|
|
1404 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1405 | &_dotls; |
|
|
1406 | }; |
|
|
1407 | } |
1416 | } |
1408 | |
1417 | |
1409 | =item $handle->stoptls |
1418 | =item $handle->stoptls |
1410 | |
1419 | |
1411 | Destroys the SSL connection, if any. Partial read or write data will be |
1420 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1412 | lost. |
1421 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1422 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1423 | afterwards. |
1413 | |
1424 | |
1414 | =cut |
1425 | =cut |
1415 | |
1426 | |
1416 | sub stoptls { |
1427 | sub stoptls { |
1417 | my ($self) = @_; |
1428 | my ($self) = @_; |
1418 | |
1429 | |
|
|
1430 | if ($self->{tls}) { |
|
|
1431 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1432 | |
|
|
1433 | &_dotls; |
|
|
1434 | |
|
|
1435 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1436 | # we, we... have to use openssl :/ |
|
|
1437 | &_freetls; |
|
|
1438 | } |
|
|
1439 | } |
|
|
1440 | |
|
|
1441 | sub _freetls { |
|
|
1442 | my ($self) = @_; |
|
|
1443 | |
|
|
1444 | return unless $self->{tls}; |
|
|
1445 | |
1419 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1446 | Net::SSLeay::free (delete $self->{tls}); |
1420 | |
1447 | |
1421 | delete $self->{_rbio}; |
1448 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1422 | delete $self->{_wbio}; |
|
|
1423 | delete $self->{_tls_wbuf}; |
|
|
1424 | delete $self->{filter_r}; |
|
|
1425 | delete $self->{filter_w}; |
|
|
1426 | } |
1449 | } |
1427 | |
1450 | |
1428 | sub DESTROY { |
1451 | sub DESTROY { |
1429 | my $self = shift; |
1452 | my $self = shift; |
1430 | |
1453 | |
1431 | $self->stoptls; |
1454 | &_freetls; |
1432 | |
1455 | |
1433 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1456 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1434 | |
1457 | |
1435 | if ($linger && length $self->{wbuf}) { |
1458 | if ($linger && length $self->{wbuf}) { |
1436 | my $fh = delete $self->{fh}; |
1459 | my $fh = delete $self->{fh}; |
… | |
… | |
1451 | @linger = (); |
1474 | @linger = (); |
1452 | }); |
1475 | }); |
1453 | } |
1476 | } |
1454 | } |
1477 | } |
1455 | |
1478 | |
|
|
1479 | =item $handle->destroy |
|
|
1480 | |
|
|
1481 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1482 | no further callbacks will be invoked and resources will be freed as much |
|
|
1483 | as possible. You must not call any methods on the object afterwards. |
|
|
1484 | |
|
|
1485 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1486 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1487 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1488 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1489 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1490 | that case. |
|
|
1491 | |
|
|
1492 | The handle might still linger in the background and write out remaining |
|
|
1493 | data, as specified by the C<linger> option, however. |
|
|
1494 | |
|
|
1495 | =cut |
|
|
1496 | |
|
|
1497 | sub destroy { |
|
|
1498 | my ($self) = @_; |
|
|
1499 | |
|
|
1500 | $self->DESTROY; |
|
|
1501 | %$self = (); |
|
|
1502 | } |
|
|
1503 | |
1456 | =item AnyEvent::Handle::TLS_CTX |
1504 | =item AnyEvent::Handle::TLS_CTX |
1457 | |
1505 | |
1458 | This function creates and returns the Net::SSLeay::CTX object used by |
1506 | This function creates and returns the Net::SSLeay::CTX object used by |
1459 | default for TLS mode. |
1507 | default for TLS mode. |
1460 | |
1508 | |
… | |
… | |
1488 | } |
1536 | } |
1489 | } |
1537 | } |
1490 | |
1538 | |
1491 | =back |
1539 | =back |
1492 | |
1540 | |
|
|
1541 | |
|
|
1542 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1543 | |
|
|
1544 | =over 4 |
|
|
1545 | |
|
|
1546 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1547 | still get further invocations! |
|
|
1548 | |
|
|
1549 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1550 | read or write callbacks. |
|
|
1551 | |
|
|
1552 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1553 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1554 | ->destroy >> method. |
|
|
1555 | |
|
|
1556 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1557 | reading? |
|
|
1558 | |
|
|
1559 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1560 | communication channels, one for each direction. Or put differently. The |
|
|
1561 | read and write directions are not independent of each other: you cannot |
|
|
1562 | write data unless you are also prepared to read, and vice versa. |
|
|
1563 | |
|
|
1564 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1565 | callback invocations when you are not expecting any read data - the reason |
|
|
1566 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1567 | |
|
|
1568 | During the connection, you have to make sure that you always have a |
|
|
1569 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1570 | connection (or when you no longer want to use it) you can call the |
|
|
1571 | C<destroy> method. |
|
|
1572 | |
|
|
1573 | =item How do I read data until the other side closes the connection? |
|
|
1574 | |
|
|
1575 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1576 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1577 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1578 | will be in C<$_[0]{rbuf}>: |
|
|
1579 | |
|
|
1580 | $handle->on_read (sub { }); |
|
|
1581 | $handle->on_eof (undef); |
|
|
1582 | $handle->on_error (sub { |
|
|
1583 | my $data = delete $_[0]{rbuf}; |
|
|
1584 | undef $handle; |
|
|
1585 | }); |
|
|
1586 | |
|
|
1587 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1588 | and packets loss, might get closed quite violently with an error, when in |
|
|
1589 | fact, all data has been received. |
|
|
1590 | |
|
|
1591 | It is usually better to use acknowledgements when transferring data, |
|
|
1592 | to make sure the other side hasn't just died and you got the data |
|
|
1593 | intact. This is also one reason why so many internet protocols have an |
|
|
1594 | explicit QUIT command. |
|
|
1595 | |
|
|
1596 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1597 | all data has been written? |
|
|
1598 | |
|
|
1599 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1600 | and destroy the handle in there - with the default setting of |
|
|
1601 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1602 | written to the socket: |
|
|
1603 | |
|
|
1604 | $handle->push_write (...); |
|
|
1605 | $handle->on_drain (sub { |
|
|
1606 | warn "all data submitted to the kernel\n"; |
|
|
1607 | undef $handle; |
|
|
1608 | }); |
|
|
1609 | |
|
|
1610 | =back |
|
|
1611 | |
|
|
1612 | |
1493 | =head1 SUBCLASSING AnyEvent::Handle |
1613 | =head1 SUBCLASSING AnyEvent::Handle |
1494 | |
1614 | |
1495 | In many cases, you might want to subclass AnyEvent::Handle. |
1615 | In many cases, you might want to subclass AnyEvent::Handle. |
1496 | |
1616 | |
1497 | To make this easier, a given version of AnyEvent::Handle uses these |
1617 | To make this easier, a given version of AnyEvent::Handle uses these |