| … | |
… | |
| 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.160; |
19 | our $VERSION = 4.22; |
| 20 | |
20 | |
| 21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
| 22 | |
22 | |
| 23 | use AnyEvent; |
23 | use AnyEvent; |
| 24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
| … | |
… | |
| 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->($handle) |
78 | =item on_eof => $cb->($handle) |
| 79 | |
79 | |
| 80 | Set the callback to be called when an end-of-file condition is detcted, |
80 | Set the callback to be called when an end-of-file condition is detected, |
| 81 | i.e. in the case of a socket, when the other side has closed the |
81 | i.e. in the case of a socket, when the other side has closed the |
| 82 | connection cleanly. |
82 | connection cleanly. |
| 83 | |
83 | |
| 84 | 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, |
| 85 | 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 |
| … | |
… | |
| 225 | You can also provide your own TLS connection object, but you have |
225 | You can also provide your own TLS connection object, but you have |
| 226 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
226 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
| 227 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
227 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
| 228 | AnyEvent::Handle. |
228 | AnyEvent::Handle. |
| 229 | |
229 | |
| 230 | See the C<starttls> method if you need to start TLs negotiation later. |
230 | See the C<starttls> method if you need to start TLS negotiation later. |
| 231 | |
231 | |
| 232 | =item tls_ctx => $ssl_ctx |
232 | =item tls_ctx => $ssl_ctx |
| 233 | |
233 | |
| 234 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
234 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
| 235 | (unless a connection object was specified directly). If this parameter is |
235 | (unless a connection object was specified directly). If this parameter is |
| … | |
… | |
| 1448 | =over 4 |
1448 | =over 4 |
| 1449 | |
1449 | |
| 1450 | =item * all constructor arguments become object members. |
1450 | =item * all constructor arguments become object members. |
| 1451 | |
1451 | |
| 1452 | At least initially, when you pass a C<tls>-argument to the constructor it |
1452 | At least initially, when you pass a C<tls>-argument to the constructor it |
| 1453 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1453 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
| 1454 | mutated later on (for example C<tls> will hold the TLS connection object). |
1454 | mutated later on (for example C<tls> will hold the TLS connection object). |
| 1455 | |
1455 | |
| 1456 | =item * other object member names are prefixed with an C<_>. |
1456 | =item * other object member names are prefixed with an C<_>. |
| 1457 | |
1457 | |
| 1458 | All object members not explicitly documented (internal use) are prefixed |
1458 | All object members not explicitly documented (internal use) are prefixed |
