… | |
… | |
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.3; |
19 | our $VERSION = 4.33; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
59 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
60 | |
60 | |
61 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
62 | argument. |
62 | argument. |
63 | |
63 | |
64 | =head2 SIGPIPE is not handled by this module |
|
|
65 | |
|
|
66 | SIGPIPE is not handled by this module, so one of the practical |
|
|
67 | requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} = |
|
|
68 | 'IGNORE'>). At least, this is highly recommend in a networked program: If |
|
|
69 | you use AnyEvent::Handle in a filter program (like sort), exiting on |
|
|
70 | SIGPIPE is probably the right thing to do. |
|
|
71 | |
|
|
72 | =head1 METHODS |
64 | =head1 METHODS |
73 | |
65 | |
74 | =over 4 |
66 | =over 4 |
75 | |
67 | |
76 | =item B<new (%args)> |
68 | =item B<new (%args)> |
… | |
… | |
92 | 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, |
93 | 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 |
94 | connection cleanly. |
86 | connection cleanly. |
95 | |
87 | |
96 | 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, |
97 | 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 |
98 | 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 |
99 | down. |
91 | down. |
100 | |
92 | |
101 | 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, |
102 | 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 |
103 | waiting for data. |
95 | waiting for data. |
104 | |
96 | |
105 | 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 |
106 | 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>. |
… | |
… | |
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). |
… | |
… | |
550 | ->($self, @_); |
546 | ->($self, @_); |
551 | } |
547 | } |
552 | |
548 | |
553 | if ($self->{tls}) { |
549 | if ($self->{tls}) { |
554 | $self->{_tls_wbuf} .= $_[0]; |
550 | $self->{_tls_wbuf} .= $_[0]; |
|
|
551 | |
555 | &_dotls ($self); |
552 | &_dotls ($self); |
556 | } else { |
553 | } else { |
557 | $self->{wbuf} .= $_[0]; |
554 | $self->{wbuf} .= $_[0]; |
558 | $self->_drain_wbuf; |
555 | $self->_drain_wbuf; |
559 | } |
556 | } |
… | |
… | |
577 | =cut |
574 | =cut |
578 | |
575 | |
579 | register_write_type netstring => sub { |
576 | register_write_type netstring => sub { |
580 | my ($self, $string) = @_; |
577 | my ($self, $string) = @_; |
581 | |
578 | |
582 | sprintf "%d:%s,", (length $string), $string |
579 | (length $string) . ":$string," |
583 | }; |
580 | }; |
584 | |
581 | |
585 | =item packstring => $format, $data |
582 | =item packstring => $format, $data |
586 | |
583 | |
587 | 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> |
… | |
… | |
1101 | 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> |
1102 | 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 |
1103 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1100 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1104 | optional C<!>, C<< < >> or C<< > >> modifier). |
1101 | optional C<!>, C<< < >> or C<< > >> modifier). |
1105 | |
1102 | |
1106 | 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). |
1107 | |
1105 | |
1108 | 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 |
1109 | format (very efficient). |
1107 | format (very efficient). |
1110 | |
1108 | |
1111 | $handle->push_read (packstring => "w", sub { |
1109 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1290 | if ($len > 0) { |
1288 | if ($len > 0) { |
1291 | $self->{_activity} = AnyEvent->now; |
1289 | $self->{_activity} = AnyEvent->now; |
1292 | |
1290 | |
1293 | if ($self->{tls}) { |
1291 | if ($self->{tls}) { |
1294 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1292 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
|
|
1293 | |
1295 | &_dotls ($self); |
1294 | &_dotls ($self); |
1296 | } else { |
1295 | } else { |
1297 | $self->_drain_rbuf unless $self->{_in_drain}; |
1296 | $self->_drain_rbuf unless $self->{_in_drain}; |
1298 | } |
1297 | } |
1299 | |
1298 | |
… | |
… | |
1307 | } |
1306 | } |
1308 | }); |
1307 | }); |
1309 | } |
1308 | } |
1310 | } |
1309 | } |
1311 | |
1310 | |
|
|
1311 | # poll the write BIO and send the data if applicable |
1312 | sub _dotls { |
1312 | sub _dotls { |
1313 | my ($self) = @_; |
1313 | my ($self) = @_; |
1314 | |
1314 | |
1315 | my $buf; |
1315 | my $tmp; |
1316 | |
1316 | |
1317 | if (length $self->{_tls_wbuf}) { |
1317 | if (length $self->{_tls_wbuf}) { |
1318 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1318 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1319 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1319 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1320 | } |
1320 | } |
1321 | } |
1321 | } |
1322 | |
1322 | |
1323 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1323 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1324 | unless (length $buf) { |
1324 | unless (length $tmp) { |
1325 | # 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}; |
1326 | delete $self->{_rw}; |
1327 | $self->{_eof} = 1; |
1327 | $self->{_eof} = 1; |
1328 | &_freetls; |
1328 | &_freetls; |
1329 | } |
1329 | } |
1330 | |
1330 | |
1331 | $self->{rbuf} .= $buf; |
1331 | $self->{rbuf} .= $tmp; |
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
1333 | $self->{tls} or return; # tls session might have gone away in callback |
1333 | $self->{tls} or return; # tls session might have gone away in callback |
1334 | } |
1334 | } |
1335 | |
1335 | |
1336 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1336 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1337 | |
1337 | |
1338 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1338 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
1339 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1339 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
1340 | return $self->_error ($!, 1); |
1340 | return $self->_error ($!, 1); |
1341 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1341 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1342 | return $self->_error (&Errno::EIO, 1); |
1342 | return $self->_error (&Errno::EIO, 1); |
1343 | } |
1343 | } |
1344 | |
1344 | |
1345 | # all others are fine for our purposes |
1345 | # all other errors are fine for our purposes |
1346 | } |
1346 | } |
1347 | |
1347 | |
1348 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1348 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1349 | $self->{wbuf} .= $buf; |
1349 | $self->{wbuf} .= $tmp; |
1350 | $self->_drain_wbuf; |
1350 | $self->_drain_wbuf; |
1351 | } |
1351 | } |
1352 | } |
1352 | } |
1353 | |
1353 | |
1354 | =item $handle->starttls ($tls[, $tls_ctx]) |
1354 | =item $handle->starttls ($tls[, $tls_ctx]) |
… | |
… | |
1375 | sub starttls { |
1375 | sub starttls { |
1376 | my ($self, $ssl, $ctx) = @_; |
1376 | my ($self, $ssl, $ctx) = @_; |
1377 | |
1377 | |
1378 | require Net::SSLeay; |
1378 | require Net::SSLeay; |
1379 | |
1379 | |
1380 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
1380 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1381 | if $self->{tls}; |
1381 | if $self->{tls}; |
1382 | |
1382 | |
1383 | if ($ssl eq "accept") { |
1383 | if ($ssl eq "accept") { |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
… | |
… | |
1474 | @linger = (); |
1474 | @linger = (); |
1475 | }); |
1475 | }); |
1476 | } |
1476 | } |
1477 | } |
1477 | } |
1478 | |
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 | |
1479 | =item AnyEvent::Handle::TLS_CTX |
1504 | =item AnyEvent::Handle::TLS_CTX |
1480 | |
1505 | |
1481 | 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 |
1482 | default for TLS mode. |
1507 | default for TLS mode. |
1483 | |
1508 | |
… | |
… | |
1516 | |
1541 | |
1517 | =head1 NONFREQUENTLY ASKED QUESTIONS |
1542 | =head1 NONFREQUENTLY ASKED QUESTIONS |
1518 | |
1543 | |
1519 | =over 4 |
1544 | =over 4 |
1520 | |
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 | |
1521 | =item How do I read data until the other side closes the connection? |
1573 | =item How do I read data until the other side closes the connection? |
1522 | |
1574 | |
1523 | If you just want to read your data into a perl scalar, the easiest way to achieve this is |
1575 | If you just want to read your data into a perl scalar, the easiest way |
1524 | by setting an C<on_read> callback that does nothing, clearing the C<on_eof> callback |
1576 | to achieve this is by setting an C<on_read> callback that does nothing, |
1525 | and in the C<on_error> callback, the data will be in C<$_[0]{rbuf}>: |
1577 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1578 | will be in C<$_[0]{rbuf}>: |
1526 | |
1579 | |
1527 | $handle->on_read (sub { }); |
1580 | $handle->on_read (sub { }); |
1528 | $handle->on_eof (undef); |
1581 | $handle->on_eof (undef); |
1529 | $handle->on_error (sub { |
1582 | $handle->on_error (sub { |
1530 | my $data = delete $_[0]{rbuf}; |
1583 | my $data = delete $_[0]{rbuf}; |
… | |
… | |
1533 | |
1586 | |
1534 | The reason to use C<on_error> is that TCP connections, due to latencies |
1587 | The reason to use C<on_error> is that TCP connections, due to latencies |
1535 | and packets loss, might get closed quite violently with an error, when in |
1588 | and packets loss, might get closed quite violently with an error, when in |
1536 | fact, all data has been received. |
1589 | fact, all data has been received. |
1537 | |
1590 | |
1538 | It is usually better to use acknowledgements when transfering data, |
1591 | It is usually better to use acknowledgements when transferring data, |
1539 | to make sure the other side hasn't just died and you got the data |
1592 | to make sure the other side hasn't just died and you got the data |
1540 | intact. This is also one reason why so many internet protocols have an |
1593 | intact. This is also one reason why so many internet protocols have an |
1541 | explicit QUIT command. |
1594 | explicit QUIT command. |
1542 | |
1595 | |
1543 | |
|
|
1544 | =item I don't want to destroy the handle too early - how do I wait until all data has been sent? |
1596 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1597 | all data has been written? |
1545 | |
1598 | |
1546 | After writing your last bits of data, set the C<on_drain> callback |
1599 | After writing your last bits of data, set the C<on_drain> callback |
1547 | and destroy the handle in there - with the default setting of |
1600 | and destroy the handle in there - with the default setting of |
1548 | C<low_water_mark> this will be called precisely when all data has been |
1601 | C<low_water_mark> this will be called precisely when all data has been |
1549 | written to the socket: |
1602 | written to the socket: |