… | |
… | |
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.42; |
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"); |
… | |
… | |
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>. |
… | |
… | |
135 | and no read request is in the queue (unlike read queue callbacks, this |
127 | and no read request is in the queue (unlike read queue callbacks, this |
136 | callback will only be called when at least one octet of data is in the |
128 | callback will only be called when at least one octet of data is in the |
137 | read buffer). |
129 | read buffer). |
138 | |
130 | |
139 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
131 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
140 | method or access the C<$handle->{rbuf}> member directly. |
132 | method or access the C<$handle->{rbuf}> member directly. Note that you |
|
|
133 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
134 | the beginning from it. |
141 | |
135 | |
142 | When an EOF condition is detected then AnyEvent::Handle will first try to |
136 | When an EOF condition is detected then AnyEvent::Handle will first try to |
143 | feed all the remaining data to the queued callbacks and C<on_read> before |
137 | feed all the remaining data to the queued callbacks and C<on_read> before |
144 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
138 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
145 | error will be raised (with C<$!> set to C<EPIPE>). |
139 | error will be raised (with C<$!> set to C<EPIPE>). |
… | |
… | |
263 | You can also provide your own TLS connection object, but you have |
257 | You can also provide your own TLS connection object, but you have |
264 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
258 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
265 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
259 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
266 | AnyEvent::Handle. |
260 | AnyEvent::Handle. |
267 | |
261 | |
|
|
262 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
|
|
263 | passing in the wrong integer will lead to certain crash. This most often |
|
|
264 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
|
|
265 | segmentation fault. |
|
|
266 | |
268 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
267 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
269 | |
268 | |
270 | =item tls_ctx => $ssl_ctx |
269 | =item tls_ctx => $ssl_ctx |
271 | |
270 | |
272 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
271 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
… | |
… | |
295 | |
294 | |
296 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
295 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
297 | |
296 | |
298 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
297 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
299 | |
298 | |
300 | if ($self->{tls}) { |
|
|
301 | require Net::SSLeay; |
|
|
302 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
299 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
303 | } |
300 | if $self->{tls}; |
304 | |
301 | |
305 | $self->{_activity} = AnyEvent->now; |
302 | $self->{_activity} = AnyEvent->now; |
306 | $self->_timeout; |
303 | $self->_timeout; |
307 | |
304 | |
308 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
305 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
… | |
… | |
315 | } |
312 | } |
316 | |
313 | |
317 | sub _shutdown { |
314 | sub _shutdown { |
318 | my ($self) = @_; |
315 | my ($self) = @_; |
319 | |
316 | |
320 | delete $self->{_tw}; |
317 | delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)}; |
321 | delete $self->{_rw}; |
|
|
322 | delete $self->{_ww}; |
|
|
323 | delete $self->{fh}; |
|
|
324 | |
318 | |
325 | &_freetls; |
319 | &_freetls; |
326 | |
|
|
327 | delete $self->{on_read}; |
|
|
328 | delete $self->{_queue}; |
|
|
329 | } |
320 | } |
330 | |
321 | |
331 | sub _error { |
322 | sub _error { |
332 | my ($self, $errno, $fatal) = @_; |
323 | my ($self, $errno, $fatal) = @_; |
333 | |
324 | |
… | |
… | |
336 | |
327 | |
337 | $! = $errno; |
328 | $! = $errno; |
338 | |
329 | |
339 | if ($self->{on_error}) { |
330 | if ($self->{on_error}) { |
340 | $self->{on_error}($self, $fatal); |
331 | $self->{on_error}($self, $fatal); |
341 | } else { |
332 | } elsif ($self->{fh}) { |
342 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
333 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
343 | } |
334 | } |
344 | } |
335 | } |
345 | |
336 | |
346 | =item $fh = $handle->fh |
337 | =item $fh = $handle->fh |
… | |
… | |
384 | } |
375 | } |
385 | |
376 | |
386 | =item $handle->autocork ($boolean) |
377 | =item $handle->autocork ($boolean) |
387 | |
378 | |
388 | Enables or disables the current autocork behaviour (see C<autocork> |
379 | Enables or disables the current autocork behaviour (see C<autocork> |
389 | constructor argument). |
380 | constructor argument). Changes will only take effect on the next write. |
390 | |
381 | |
391 | =cut |
382 | =cut |
|
|
383 | |
|
|
384 | sub autocork { |
|
|
385 | $_[0]{autocork} = $_[1]; |
|
|
386 | } |
392 | |
387 | |
393 | =item $handle->no_delay ($boolean) |
388 | =item $handle->no_delay ($boolean) |
394 | |
389 | |
395 | Enables or disables the C<no_delay> setting (see constructor argument of |
390 | Enables or disables the C<no_delay> setting (see constructor argument of |
396 | the same name for details). |
391 | the same name for details). |
… | |
… | |
552 | ->($self, @_); |
547 | ->($self, @_); |
553 | } |
548 | } |
554 | |
549 | |
555 | if ($self->{tls}) { |
550 | if ($self->{tls}) { |
556 | $self->{_tls_wbuf} .= $_[0]; |
551 | $self->{_tls_wbuf} .= $_[0]; |
|
|
552 | |
557 | &_dotls ($self); |
553 | &_dotls ($self); |
558 | } else { |
554 | } else { |
559 | $self->{wbuf} .= $_[0]; |
555 | $self->{wbuf} .= $_[0]; |
560 | $self->_drain_wbuf; |
556 | $self->_drain_wbuf; |
561 | } |
557 | } |
… | |
… | |
579 | =cut |
575 | =cut |
580 | |
576 | |
581 | register_write_type netstring => sub { |
577 | register_write_type netstring => sub { |
582 | my ($self, $string) = @_; |
578 | my ($self, $string) = @_; |
583 | |
579 | |
584 | sprintf "%d:%s,", (length $string), $string |
580 | (length $string) . ":$string," |
585 | }; |
581 | }; |
586 | |
582 | |
587 | =item packstring => $format, $data |
583 | =item packstring => $format, $data |
588 | |
584 | |
589 | An octet string prefixed with an encoded length. The encoding C<$format> |
585 | An octet string prefixed with an encoded length. The encoding C<$format> |
… | |
… | |
767 | ) { |
763 | ) { |
768 | $self->_error (&Errno::ENOSPC, 1), return; |
764 | $self->_error (&Errno::ENOSPC, 1), return; |
769 | } |
765 | } |
770 | |
766 | |
771 | while () { |
767 | while () { |
|
|
768 | # we need to use a separate tls read buffer, as we must not receive data while |
|
|
769 | # we are draining the buffer, and this can only happen with TLS. |
|
|
770 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
|
|
771 | |
772 | my $len = length $self->{rbuf}; |
772 | my $len = length $self->{rbuf}; |
773 | |
773 | |
774 | if (my $cb = shift @{ $self->{_queue} }) { |
774 | if (my $cb = shift @{ $self->{_queue} }) { |
775 | unless ($cb->($self)) { |
775 | unless ($cb->($self)) { |
776 | if ($self->{_eof}) { |
776 | if ($self->{_eof}) { |
… | |
… | |
837 | |
837 | |
838 | =item $handle->rbuf |
838 | =item $handle->rbuf |
839 | |
839 | |
840 | Returns the read buffer (as a modifiable lvalue). |
840 | Returns the read buffer (as a modifiable lvalue). |
841 | |
841 | |
842 | You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
842 | You can access the read buffer directly as the C<< ->{rbuf} >> |
843 | you want. |
843 | member, if you want. However, the only operation allowed on the |
|
|
844 | read buffer (apart from looking at it) is removing data from its |
|
|
845 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
846 | lead to hard-to-track-down bugs. |
844 | |
847 | |
845 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
848 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
846 | C<push_read> or C<unshift_read> methods are used. The other read methods |
849 | C<push_read> or C<unshift_read> methods are used. The other read methods |
847 | automatically manage the read buffer. |
850 | automatically manage the read buffer. |
848 | |
851 | |
… | |
… | |
1103 | An octet string prefixed with an encoded length. The encoding C<$format> |
1106 | An octet string prefixed with an encoded length. The encoding C<$format> |
1104 | uses the same format as a Perl C<pack> format, but must specify a single |
1107 | uses the same format as a Perl C<pack> format, but must specify a single |
1105 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1108 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1106 | optional C<!>, C<< < >> or C<< > >> modifier). |
1109 | optional C<!>, C<< < >> or C<< > >> modifier). |
1107 | |
1110 | |
1108 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
1111 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1112 | EPP uses a prefix of C<N> (4 octtes). |
1109 | |
1113 | |
1110 | Example: read a block of data prefixed by its length in BER-encoded |
1114 | Example: read a block of data prefixed by its length in BER-encoded |
1111 | format (very efficient). |
1115 | format (very efficient). |
1112 | |
1116 | |
1113 | $handle->push_read (packstring => "w", sub { |
1117 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1143 | } |
1147 | } |
1144 | }; |
1148 | }; |
1145 | |
1149 | |
1146 | =item json => $cb->($handle, $hash_or_arrayref) |
1150 | =item json => $cb->($handle, $hash_or_arrayref) |
1147 | |
1151 | |
1148 | Reads a JSON object or array, decodes it and passes it to the callback. |
1152 | Reads a JSON object or array, decodes it and passes it to the |
|
|
1153 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1149 | |
1154 | |
1150 | If a C<json> object was passed to the constructor, then that will be used |
1155 | If a C<json> object was passed to the constructor, then that will be used |
1151 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1156 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1152 | |
1157 | |
1153 | This read type uses the incremental parser available with JSON version |
1158 | This read type uses the incremental parser available with JSON version |
… | |
… | |
1170 | my $rbuf = \$self->{rbuf}; |
1175 | my $rbuf = \$self->{rbuf}; |
1171 | |
1176 | |
1172 | my $json = $self->{json} ||= JSON->new->utf8; |
1177 | my $json = $self->{json} ||= JSON->new->utf8; |
1173 | |
1178 | |
1174 | sub { |
1179 | sub { |
1175 | my $ref = $json->incr_parse ($self->{rbuf}); |
1180 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1176 | |
1181 | |
1177 | if ($ref) { |
1182 | if ($ref) { |
1178 | $self->{rbuf} = $json->incr_text; |
1183 | $self->{rbuf} = $json->incr_text; |
1179 | $json->incr_text = ""; |
1184 | $json->incr_text = ""; |
1180 | $cb->($self, $ref); |
1185 | $cb->($self, $ref); |
1181 | |
1186 | |
1182 | 1 |
1187 | 1 |
|
|
1188 | } elsif ($@) { |
|
|
1189 | # error case |
|
|
1190 | $json->incr_skip; |
|
|
1191 | |
|
|
1192 | $self->{rbuf} = $json->incr_text; |
|
|
1193 | $json->incr_text = ""; |
|
|
1194 | |
|
|
1195 | $self->_error (&Errno::EBADMSG); |
|
|
1196 | |
|
|
1197 | () |
1183 | } else { |
1198 | } else { |
1184 | $self->{rbuf} = ""; |
1199 | $self->{rbuf} = ""; |
|
|
1200 | |
1185 | () |
1201 | () |
1186 | } |
1202 | } |
1187 | } |
1203 | } |
1188 | }; |
1204 | }; |
1189 | |
1205 | |
… | |
… | |
1292 | if ($len > 0) { |
1308 | if ($len > 0) { |
1293 | $self->{_activity} = AnyEvent->now; |
1309 | $self->{_activity} = AnyEvent->now; |
1294 | |
1310 | |
1295 | if ($self->{tls}) { |
1311 | if ($self->{tls}) { |
1296 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1312 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
|
|
1313 | |
1297 | &_dotls ($self); |
1314 | &_dotls ($self); |
1298 | } else { |
1315 | } else { |
1299 | $self->_drain_rbuf unless $self->{_in_drain}; |
1316 | $self->_drain_rbuf unless $self->{_in_drain}; |
1300 | } |
1317 | } |
1301 | |
1318 | |
… | |
… | |
1309 | } |
1326 | } |
1310 | }); |
1327 | }); |
1311 | } |
1328 | } |
1312 | } |
1329 | } |
1313 | |
1330 | |
|
|
1331 | # poll the write BIO and send the data if applicable |
1314 | sub _dotls { |
1332 | sub _dotls { |
1315 | my ($self) = @_; |
1333 | my ($self) = @_; |
1316 | |
1334 | |
1317 | my $buf; |
1335 | my $tmp; |
1318 | |
1336 | |
1319 | if (length $self->{_tls_wbuf}) { |
1337 | if (length $self->{_tls_wbuf}) { |
1320 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1338 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1321 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1339 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1322 | } |
1340 | } |
1323 | } |
1341 | } |
1324 | |
1342 | |
1325 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1343 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1326 | unless (length $buf) { |
1344 | unless (length $tmp) { |
1327 | # let's treat SSL-eof as we treat normal EOF |
1345 | # let's treat SSL-eof as we treat normal EOF |
1328 | delete $self->{_rw}; |
1346 | delete $self->{_rw}; |
1329 | $self->{_eof} = 1; |
1347 | $self->{_eof} = 1; |
1330 | &_freetls; |
1348 | &_freetls; |
1331 | } |
1349 | } |
1332 | |
1350 | |
1333 | $self->{rbuf} .= $buf; |
1351 | $self->{_tls_rbuf} .= $tmp; |
1334 | $self->_drain_rbuf unless $self->{_in_drain}; |
1352 | $self->_drain_rbuf unless $self->{_in_drain}; |
1335 | $self->{tls} or return; # tls session might have gone away in callback |
1353 | $self->{tls} or return; # tls session might have gone away in callback |
1336 | } |
1354 | } |
1337 | |
1355 | |
1338 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1356 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1339 | |
1357 | |
1340 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1358 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
1341 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1359 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
1342 | return $self->_error ($!, 1); |
1360 | return $self->_error ($!, 1); |
1343 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1361 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1344 | return $self->_error (&Errno::EIO, 1); |
1362 | return $self->_error (&Errno::EIO, 1); |
1345 | } |
1363 | } |
1346 | |
1364 | |
1347 | # all others are fine for our purposes |
1365 | # all other errors are fine for our purposes |
1348 | } |
1366 | } |
1349 | |
1367 | |
1350 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1368 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1351 | $self->{wbuf} .= $buf; |
1369 | $self->{wbuf} .= $tmp; |
1352 | $self->_drain_wbuf; |
1370 | $self->_drain_wbuf; |
1353 | } |
1371 | } |
1354 | } |
1372 | } |
1355 | |
1373 | |
1356 | =item $handle->starttls ($tls[, $tls_ctx]) |
1374 | =item $handle->starttls ($tls[, $tls_ctx]) |
… | |
… | |
1375 | =cut |
1393 | =cut |
1376 | |
1394 | |
1377 | sub starttls { |
1395 | sub starttls { |
1378 | my ($self, $ssl, $ctx) = @_; |
1396 | my ($self, $ssl, $ctx) = @_; |
1379 | |
1397 | |
|
|
1398 | require Net::SSLeay; |
|
|
1399 | |
1380 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
1400 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1381 | if $self->{tls}; |
1401 | if $self->{tls}; |
1382 | |
1402 | |
1383 | if ($ssl eq "accept") { |
1403 | if ($ssl eq "accept") { |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1404 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
1405 | Net::SSLeay::set_accept_state ($ssl); |
… | |
… | |
1426 | |
1446 | |
1427 | sub stoptls { |
1447 | sub stoptls { |
1428 | my ($self) = @_; |
1448 | my ($self) = @_; |
1429 | |
1449 | |
1430 | if ($self->{tls}) { |
1450 | if ($self->{tls}) { |
1431 | Net::SSLeay::shutdown $self->{tls}; |
1451 | Net::SSLeay::shutdown ($self->{tls}); |
1432 | |
1452 | |
1433 | &_dotls; |
1453 | &_dotls; |
1434 | |
1454 | |
1435 | # we don't give a shit. no, we do, but we can't. no... |
1455 | # we don't give a shit. no, we do, but we can't. no... |
1436 | # we, we... have to use openssl :/ |
1456 | # we, we... have to use openssl :/ |
… | |
… | |
1447 | |
1467 | |
1448 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1468 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1449 | } |
1469 | } |
1450 | |
1470 | |
1451 | sub DESTROY { |
1471 | sub DESTROY { |
1452 | my $self = shift; |
1472 | my ($self) = @_; |
1453 | |
1473 | |
1454 | &_freetls; |
1474 | &_freetls; |
1455 | |
1475 | |
1456 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1476 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1457 | |
1477 | |
… | |
… | |
1474 | @linger = (); |
1494 | @linger = (); |
1475 | }); |
1495 | }); |
1476 | } |
1496 | } |
1477 | } |
1497 | } |
1478 | |
1498 | |
|
|
1499 | =item $handle->destroy |
|
|
1500 | |
|
|
1501 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1502 | no further callbacks will be invoked and resources will be freed as much |
|
|
1503 | as possible. You must not call any methods on the object afterwards. |
|
|
1504 | |
|
|
1505 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1506 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1507 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1508 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1509 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1510 | that case. |
|
|
1511 | |
|
|
1512 | The handle might still linger in the background and write out remaining |
|
|
1513 | data, as specified by the C<linger> option, however. |
|
|
1514 | |
|
|
1515 | =cut |
|
|
1516 | |
|
|
1517 | sub destroy { |
|
|
1518 | my ($self) = @_; |
|
|
1519 | |
|
|
1520 | $self->DESTROY; |
|
|
1521 | %$self = (); |
|
|
1522 | } |
|
|
1523 | |
1479 | =item AnyEvent::Handle::TLS_CTX |
1524 | =item AnyEvent::Handle::TLS_CTX |
1480 | |
1525 | |
1481 | This function creates and returns the Net::SSLeay::CTX object used by |
1526 | This function creates and returns the Net::SSLeay::CTX object used by |
1482 | default for TLS mode. |
1527 | default for TLS mode. |
1483 | |
1528 | |
… | |
… | |
1511 | } |
1556 | } |
1512 | } |
1557 | } |
1513 | |
1558 | |
1514 | =back |
1559 | =back |
1515 | |
1560 | |
|
|
1561 | |
|
|
1562 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1563 | |
|
|
1564 | =over 4 |
|
|
1565 | |
|
|
1566 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1567 | still get further invocations! |
|
|
1568 | |
|
|
1569 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1570 | read or write callbacks. |
|
|
1571 | |
|
|
1572 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1573 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1574 | ->destroy >> method. |
|
|
1575 | |
|
|
1576 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1577 | reading? |
|
|
1578 | |
|
|
1579 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1580 | communication channels, one for each direction. Or put differently. The |
|
|
1581 | read and write directions are not independent of each other: you cannot |
|
|
1582 | write data unless you are also prepared to read, and vice versa. |
|
|
1583 | |
|
|
1584 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1585 | callback invocations when you are not expecting any read data - the reason |
|
|
1586 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1587 | |
|
|
1588 | During the connection, you have to make sure that you always have a |
|
|
1589 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1590 | connection (or when you no longer want to use it) you can call the |
|
|
1591 | C<destroy> method. |
|
|
1592 | |
|
|
1593 | =item How do I read data until the other side closes the connection? |
|
|
1594 | |
|
|
1595 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1596 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1597 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1598 | will be in C<$_[0]{rbuf}>: |
|
|
1599 | |
|
|
1600 | $handle->on_read (sub { }); |
|
|
1601 | $handle->on_eof (undef); |
|
|
1602 | $handle->on_error (sub { |
|
|
1603 | my $data = delete $_[0]{rbuf}; |
|
|
1604 | undef $handle; |
|
|
1605 | }); |
|
|
1606 | |
|
|
1607 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1608 | and packets loss, might get closed quite violently with an error, when in |
|
|
1609 | fact, all data has been received. |
|
|
1610 | |
|
|
1611 | It is usually better to use acknowledgements when transferring data, |
|
|
1612 | to make sure the other side hasn't just died and you got the data |
|
|
1613 | intact. This is also one reason why so many internet protocols have an |
|
|
1614 | explicit QUIT command. |
|
|
1615 | |
|
|
1616 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1617 | all data has been written? |
|
|
1618 | |
|
|
1619 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1620 | and destroy the handle in there - with the default setting of |
|
|
1621 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1622 | written to the socket: |
|
|
1623 | |
|
|
1624 | $handle->push_write (...); |
|
|
1625 | $handle->on_drain (sub { |
|
|
1626 | warn "all data submitted to the kernel\n"; |
|
|
1627 | undef $handle; |
|
|
1628 | }); |
|
|
1629 | |
|
|
1630 | =back |
|
|
1631 | |
|
|
1632 | |
1516 | =head1 SUBCLASSING AnyEvent::Handle |
1633 | =head1 SUBCLASSING AnyEvent::Handle |
1517 | |
1634 | |
1518 | In many cases, you might want to subclass AnyEvent::Handle. |
1635 | In many cases, you might want to subclass AnyEvent::Handle. |
1519 | |
1636 | |
1520 | To make this easier, a given version of AnyEvent::Handle uses these |
1637 | To make this easier, a given version of AnyEvent::Handle uses these |