ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.96 by root, Thu Oct 2 08:10:27 2008 UTC vs.
Revision 1.137 by root, Sat Jul 4 23:58:52 2009 UTC

14 14
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 16
17=cut 17=cut
18 18
19our $VERSION = 4.3; 19our $VERSION = 4.452;
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");
59treatment of characters applies to this module as well. 59treatment of characters applies to this module as well.
60 60
61All callbacks will be invoked with the handle object as their first 61All callbacks will be invoked with the handle object as their first
62argument. 62argument.
63 63
64=head2 SIGPIPE is not handled by this module
65
66SIGPIPE is not handled by this module, so one of the practical
67requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
68'IGNORE'>). At least, this is highly recommend in a networked program: If
69you use AnyEvent::Handle in a filter program (like sort), exiting on
70SIGPIPE 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 $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
77 69
78The constructor supports these arguments (all as key => value pairs). 70The constructor supports these arguments (all as C<< key => value >> pairs).
79 71
80=over 4 72=over 4
81 73
82=item fh => $filehandle [MANDATORY] 74=item fh => $filehandle [MANDATORY]
83 75
92Set the callback to be called when an end-of-file condition is detected, 84Set the callback to be called when an end-of-file condition is detected,
93i.e. in the case of a socket, when the other side has closed the 85i.e. in the case of a socket, when the other side has closed the
94connection cleanly. 86connection cleanly.
95 87
96For sockets, this just means that the other side has stopped sending data, 88For sockets, this just means that the other side has stopped sending data,
97you can still try to write data, and, in fact, one can return from the eof 89you can still try to write data, and, in fact, one can return from the EOF
98callback and continue writing data, as only the read part has been shut 90callback and continue writing data, as only the read part has been shut
99down. 91down.
100 92
101While not mandatory, it is I<highly> recommended to set an eof callback, 93While not mandatory, it is I<highly> recommended to set an EOF callback,
102otherwise you might end up with a closed socket while you are still 94otherwise you might end up with a closed socket while you are still
103waiting for data. 95waiting for data.
104 96
105If an EOF condition has been detected but no C<on_eof> callback has been 97If an EOF condition has been detected but no C<on_eof> callback has been
106set, then a fatal error will be raised with C<$!> set to <0>. 98set, then a fatal error will be raised with C<$!> set to <0>.
107 99
108=item on_error => $cb->($handle, $fatal) 100=item on_error => $cb->($handle, $fatal, $message)
109 101
110This is the error callback, which is called when, well, some error 102This is the error callback, which is called when, well, some error
111occured, such as not being able to resolve the hostname, failure to 103occured, such as not being able to resolve the hostname, failure to
112connect or a read error. 104connect or a read error.
113 105
115fatal errors the handle object will be shut down and will not be usable 107fatal errors the handle object will be shut down and will not be usable
116(but you are free to look at the current C<< ->rbuf >>). Examples of fatal 108(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
117errors are an EOF condition with active (but unsatisifable) read watchers 109errors are an EOF condition with active (but unsatisifable) read watchers
118(C<EPIPE>) or I/O errors. 110(C<EPIPE>) or I/O errors.
119 111
112AnyEvent::Handle tries to find an appropriate error code for you to check
113against, but in some cases (TLS errors), this does not work well. It is
114recommended to always output the C<$message> argument in human-readable
115error messages (it's usually the same as C<"$!">).
116
120Non-fatal errors can be retried by simply returning, but it is recommended 117Non-fatal errors can be retried by simply returning, but it is recommended
121to simply ignore this parameter and instead abondon the handle object 118to simply ignore this parameter and instead abondon the handle object
122when this callback is invoked. Examples of non-fatal errors are timeouts 119when this callback is invoked. Examples of non-fatal errors are timeouts
123C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 120C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
124 121
125On callback entrance, the value of C<$!> contains the operating system 122On callback entrance, the value of C<$!> contains the operating system
126error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 123error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124C<EPROTO>).
127 125
128While not mandatory, it is I<highly> recommended to set this callback, as 126While not mandatory, it is I<highly> recommended to set this callback, as
129you will not be notified of errors otherwise. The default simply calls 127you will not be notified of errors otherwise. The default simply calls
130C<croak>. 128C<croak>.
131 129
135and no read request is in the queue (unlike read queue callbacks, this 133and no read request is in the queue (unlike read queue callbacks, this
136callback will only be called when at least one octet of data is in the 134callback will only be called when at least one octet of data is in the
137read buffer). 135read buffer).
138 136
139To access (and remove data from) the read buffer, use the C<< ->rbuf >> 137To access (and remove data from) the read buffer, use the C<< ->rbuf >>
140method or access the C<$handle->{rbuf}> member directly. 138method or access the C<$handle->{rbuf}> member directly. Note that you
139must not enlarge or modify the read buffer, you can only remove data at
140the beginning from it.
141 141
142When an EOF condition is detected then AnyEvent::Handle will first try to 142When an EOF condition is detected then AnyEvent::Handle will first try to
143feed all the remaining data to the queued callbacks and C<on_read> before 143feed all the remaining data to the queued callbacks and C<on_read> before
144calling the C<on_eof> callback. If no progress can be made, then a fatal 144calling the C<on_eof> callback. If no progress can be made, then a fatal
145error will be raised (with C<$!> set to C<EPIPE>). 145error will be raised (with C<$!> set to C<EPIPE>).
243 243
244This will not work for partial TLS data that could not be encoded 244This will not work for partial TLS data that could not be encoded
245yet. This data will be lost. Calling the C<stoptls> method in time might 245yet. This data will be lost. Calling the C<stoptls> method in time might
246help. 246help.
247 247
248=item peername => $string
249
250A string used to identify the remote site - usually the DNS hostname
251(I<not> IDN!) used to create the connection, rarely the IP address.
252
253Apart from being useful in error messages, this string is also used in TLS
254common name verification (see C<verify_cn> in L<AnyEvent::TLS>).
255
248=item tls => "accept" | "connect" | Net::SSLeay::SSL object 256=item tls => "accept" | "connect" | Net::SSLeay::SSL object
249 257
250When this parameter is given, it enables TLS (SSL) mode, that means 258When this parameter is given, it enables TLS (SSL) mode, that means
251AnyEvent will start a TLS handshake as soon as the conenction has been 259AnyEvent will start a TLS handshake as soon as the conenction has been
252established and will transparently encrypt/decrypt data afterwards. 260established and will transparently encrypt/decrypt data afterwards.
261
262All TLS protocol errors will be signalled as C<EPROTO>, with an
263appropriate error message.
253 264
254TLS mode requires Net::SSLeay to be installed (it will be loaded 265TLS mode requires Net::SSLeay to be installed (it will be loaded
255automatically when you try to create a TLS handle): this module doesn't 266automatically when you try to create a TLS handle): this module doesn't
256have a dependency on that module, so if your module requires it, you have 267have a dependency on that module, so if your module requires it, you have
257to add the dependency yourself. 268to add the dependency yourself.
261mode. 272mode.
262 273
263You can also provide your own TLS connection object, but you have 274You can also provide your own TLS connection object, but you have
264to make sure that you call either C<Net::SSLeay::set_connect_state> 275to make sure that you call either C<Net::SSLeay::set_connect_state>
265or C<Net::SSLeay::set_accept_state> on it before you pass it to 276or C<Net::SSLeay::set_accept_state> on it before you pass it to
266AnyEvent::Handle. 277AnyEvent::Handle. Also, this module will take ownership of this connection
278object.
279
280At some future point, AnyEvent::Handle might switch to another TLS
281implementation, then the option to use your own session object will go
282away.
283
284B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
285passing in the wrong integer will lead to certain crash. This most often
286happens when one uses a stylish C<< tls => 1 >> and is surprised about the
287segmentation fault.
267 288
268See the C<< ->starttls >> method for when need to start TLS negotiation later. 289See the C<< ->starttls >> method for when need to start TLS negotiation later.
269 290
270=item tls_ctx => $ssl_ctx 291=item tls_ctx => $anyevent_tls
271 292
272Use the given C<Net::SSLeay::CTX> object to create the new TLS connection 293Use the given C<AnyEvent::TLS> object to create the new TLS connection
273(unless a connection object was specified directly). If this parameter is 294(unless a connection object was specified directly). If this parameter is
274missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 295missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
296
297Instead of an object, you can also specify a hash reference with C<< key
298=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299new TLS context object.
275 300
276=item json => JSON or JSON::XS object 301=item json => JSON or JSON::XS object
277 302
278This is the json coder object used by the C<json> read and write types. 303This is the json coder object used by the C<json> read and write types.
279 304
288 313
289=cut 314=cut
290 315
291sub new { 316sub new {
292 my $class = shift; 317 my $class = shift;
293
294 my $self = bless { @_ }, $class; 318 my $self = bless { @_ }, $class;
295 319
296 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 320 $self->{fh} or Carp::croak "mandatory argument fh is missing";
297 321
298 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 322 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323
324 $self->{_activity} = AnyEvent->now;
325 $self->_timeout;
326
327 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
299 328
300 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 329 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
301 if $self->{tls}; 330 if $self->{tls};
302 331
303 $self->{_activity} = AnyEvent->now;
304 $self->_timeout;
305
306 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; 332 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
307 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
308 333
309 $self->start_read 334 $self->start_read
310 if $self->{on_read}; 335 if $self->{on_read};
311 336
312 $self 337 $self->{fh} && $self
313} 338}
314 339
315sub _shutdown { 340sub _shutdown {
316 my ($self) = @_; 341 my ($self) = @_;
317 342
318 delete $self->{_tw}; 343 delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
319 delete $self->{_rw}; 344 $self->{_eof} = 1; # tell starttls et. al to stop trying
320 delete $self->{_ww};
321 delete $self->{fh};
322 345
323 &_freetls; 346 &_freetls;
324
325 delete $self->{on_read};
326 delete $self->{_queue};
327} 347}
328 348
329sub _error { 349sub _error {
330 my ($self, $errno, $fatal) = @_; 350 my ($self, $errno, $fatal, $message) = @_;
331 351
332 $self->_shutdown 352 $self->_shutdown
333 if $fatal; 353 if $fatal;
334 354
335 $! = $errno; 355 $! = $errno;
356 $message ||= "$!";
336 357
337 if ($self->{on_error}) { 358 if ($self->{on_error}) {
338 $self->{on_error}($self, $fatal); 359 $self->{on_error}($self, $fatal, $message);
339 } else { 360 } elsif ($self->{fh}) {
340 Carp::croak "AnyEvent::Handle uncaught error: $!"; 361 Carp::croak "AnyEvent::Handle uncaught error: $message";
341 } 362 }
342} 363}
343 364
344=item $fh = $handle->fh 365=item $fh = $handle->fh
345 366
382} 403}
383 404
384=item $handle->autocork ($boolean) 405=item $handle->autocork ($boolean)
385 406
386Enables or disables the current autocork behaviour (see C<autocork> 407Enables or disables the current autocork behaviour (see C<autocork>
387constructor argument). 408constructor argument). Changes will only take effect on the next write.
388 409
389=cut 410=cut
411
412sub autocork {
413 $_[0]{autocork} = $_[1];
414}
390 415
391=item $handle->no_delay ($boolean) 416=item $handle->no_delay ($boolean)
392 417
393Enables or disables the C<no_delay> setting (see constructor argument of 418Enables or disables the C<no_delay> setting (see constructor argument of
394the same name for details). 419the same name for details).
550 ->($self, @_); 575 ->($self, @_);
551 } 576 }
552 577
553 if ($self->{tls}) { 578 if ($self->{tls}) {
554 $self->{_tls_wbuf} .= $_[0]; 579 $self->{_tls_wbuf} .= $_[0];
580
555 &_dotls ($self); 581 &_dotls ($self);
556 } else { 582 } else {
557 $self->{wbuf} .= $_[0]; 583 $self->{wbuf} .= $_[0];
558 $self->_drain_wbuf; 584 $self->_drain_wbuf;
559 } 585 }
652 678
653 pack "w/a*", Storable::nfreeze ($ref) 679 pack "w/a*", Storable::nfreeze ($ref)
654}; 680};
655 681
656=back 682=back
683
684=item $handle->push_shutdown
685
686Sometimes you know you want to close the socket after writing your data
687before it was actually written. One way to do that is to replace your
688C<on_drain> handler by a callback that shuts down the socket. This method
689is a shorthand for just that, and replaces the C<on_drain> callback with:
690
691 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692
693This simply shuts down the write side and signals an EOF condition to the
694the peer.
695
696You can rely on the normal read queue and C<on_eof> handling
697afterwards. This is the cleanest way to close a connection.
698
699=cut
700
701sub push_shutdown {
702 $_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };
703}
657 704
658=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 705=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
659 706
660This function (not method) lets you add your own types to C<push_write>. 707This function (not method) lets you add your own types to C<push_write>.
661Whenever the given C<type> is used, C<push_write> will invoke the code 708Whenever the given C<type> is used, C<push_write> will invoke the code
765 ) { 812 ) {
766 $self->_error (&Errno::ENOSPC, 1), return; 813 $self->_error (&Errno::ENOSPC, 1), return;
767 } 814 }
768 815
769 while () { 816 while () {
817 # we need to use a separate tls read buffer, as we must not receive data while
818 # we are draining the buffer, and this can only happen with TLS.
819 $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
820
770 my $len = length $self->{rbuf}; 821 my $len = length $self->{rbuf};
771 822
772 if (my $cb = shift @{ $self->{_queue} }) { 823 if (my $cb = shift @{ $self->{_queue} }) {
773 unless ($cb->($self)) { 824 unless ($cb->($self)) {
774 if ($self->{_eof}) { 825 if ($self->{_eof}) {
835 886
836=item $handle->rbuf 887=item $handle->rbuf
837 888
838Returns the read buffer (as a modifiable lvalue). 889Returns the read buffer (as a modifiable lvalue).
839 890
840You can access the read buffer directly as the C<< ->{rbuf} >> member, if 891You can access the read buffer directly as the C<< ->{rbuf} >>
841you want. 892member, if you want. However, the only operation allowed on the
893read buffer (apart from looking at it) is removing data from its
894beginning. Otherwise modifying or appending to it is not allowed and will
895lead to hard-to-track-down bugs.
842 896
843NOTE: The read buffer should only be used or modified if the C<on_read>, 897NOTE: The read buffer should only be used or modified if the C<on_read>,
844C<push_read> or C<unshift_read> methods are used. The other read methods 898C<push_read> or C<unshift_read> methods are used. The other read methods
845automatically manage the read buffer. 899automatically manage the read buffer.
846 900
1142 } 1196 }
1143}; 1197};
1144 1198
1145=item json => $cb->($handle, $hash_or_arrayref) 1199=item json => $cb->($handle, $hash_or_arrayref)
1146 1200
1147Reads a JSON object or array, decodes it and passes it to the callback. 1201Reads a JSON object or array, decodes it and passes it to the
1202callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1148 1203
1149If a C<json> object was passed to the constructor, then that will be used 1204If a C<json> object was passed to the constructor, then that will be used
1150for the final decode, otherwise it will create a JSON coder expecting UTF-8. 1205for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1151 1206
1152This read type uses the incremental parser available with JSON version 1207This read type uses the incremental parser available with JSON version
1161=cut 1216=cut
1162 1217
1163register_read_type json => sub { 1218register_read_type json => sub {
1164 my ($self, $cb) = @_; 1219 my ($self, $cb) = @_;
1165 1220
1166 require JSON; 1221 my $json = $self->{json} ||=
1222 eval { require JSON::XS; JSON::XS->new->utf8 }
1223 || do { require JSON; JSON->new->utf8 };
1167 1224
1168 my $data; 1225 my $data;
1169 my $rbuf = \$self->{rbuf}; 1226 my $rbuf = \$self->{rbuf};
1170 1227
1171 my $json = $self->{json} ||= JSON->new->utf8;
1172
1173 sub { 1228 sub {
1174 my $ref = $json->incr_parse ($self->{rbuf}); 1229 my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1175 1230
1176 if ($ref) { 1231 if ($ref) {
1177 $self->{rbuf} = $json->incr_text; 1232 $self->{rbuf} = $json->incr_text;
1178 $json->incr_text = ""; 1233 $json->incr_text = "";
1179 $cb->($self, $ref); 1234 $cb->($self, $ref);
1180 1235
1181 1 1236 1
1237 } elsif ($@) {
1238 # error case
1239 $json->incr_skip;
1240
1241 $self->{rbuf} = $json->incr_text;
1242 $json->incr_text = "";
1243
1244 $self->_error (&Errno::EBADMSG);
1245
1246 ()
1182 } else { 1247 } else {
1183 $self->{rbuf} = ""; 1248 $self->{rbuf} = "";
1249
1184 () 1250 ()
1185 } 1251 }
1186 } 1252 }
1187}; 1253};
1188 1254
1291 if ($len > 0) { 1357 if ($len > 0) {
1292 $self->{_activity} = AnyEvent->now; 1358 $self->{_activity} = AnyEvent->now;
1293 1359
1294 if ($self->{tls}) { 1360 if ($self->{tls}) {
1295 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1361 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362
1296 &_dotls ($self); 1363 &_dotls ($self);
1297 } else { 1364 } else {
1298 $self->_drain_rbuf unless $self->{_in_drain}; 1365 $self->_drain_rbuf unless $self->{_in_drain};
1299 } 1366 }
1300 1367
1308 } 1375 }
1309 }); 1376 });
1310 } 1377 }
1311} 1378}
1312 1379
1380our $ERROR_SYSCALL;
1381our $ERROR_WANT_READ;
1382our $ERROR_ZERO_RETURN;
1383
1384sub _tls_error {
1385 my ($self, $err) = @_;
1386
1387 return $self->_error ($!, 1)
1388 if $err == Net::SSLeay::ERROR_SYSCALL ();
1389
1390 my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1391
1392 # reduce error string to look less scary
1393 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1394
1395 $self->_error (&Errno::EPROTO, 1, $err);
1396}
1397
1398# poll the write BIO and send the data if applicable
1399# also decode read data if possible
1400# this is basiclaly our TLS state machine
1401# more efficient implementations are possible with openssl,
1402# but not with the buggy and incomplete Net::SSLeay.
1313sub _dotls { 1403sub _dotls {
1314 my ($self) = @_; 1404 my ($self) = @_;
1315 1405
1316 my $buf; 1406 my $tmp;
1317 1407
1318 if (length $self->{_tls_wbuf}) { 1408 if (length $self->{_tls_wbuf}) {
1319 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1409 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320 substr $self->{_tls_wbuf}, 0, $len, ""; 1410 substr $self->{_tls_wbuf}, 0, $tmp, "";
1321 } 1411 }
1322 }
1323 1412
1413 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1414 return $self->_tls_error ($tmp)
1415 if $tmp != $ERROR_WANT_READ
1416 && ($tmp != $ERROR_SYSCALL || $!)
1417 && $tmp != $ERROR_ZERO_RETURN;
1418 }
1419
1324 while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { 1420 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325 unless (length $buf) { 1421 unless (length $tmp) {
1326 # let's treat SSL-eof as we treat normal EOF 1422 # let's treat SSL-eof as we treat normal EOF
1327 delete $self->{_rw}; 1423 delete $self->{_rw};
1328 $self->{_eof} = 1; 1424 $self->{_eof} = 1;
1329 &_freetls; 1425 &_freetls;
1330 } 1426 }
1331 1427
1332 $self->{rbuf} .= $buf; 1428 $self->{_tls_rbuf} .= $tmp;
1333 $self->_drain_rbuf unless $self->{_in_drain}; 1429 $self->_drain_rbuf unless $self->{_in_drain};
1334 $self->{tls} or return; # tls session might have gone away in callback 1430 $self->{tls} or return; # tls session might have gone away in callback
1335 } 1431 }
1336 1432
1337 my $err = Net::SSLeay::get_error ($self->{tls}, -1); 1433 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338
1339 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1340 if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1341 return $self->_error ($!, 1); 1434 return $self->_tls_error ($tmp)
1342 } elsif ($err == Net::SSLeay::ERROR_SSL ()) { 1435 if $tmp != $ERROR_WANT_READ
1343 return $self->_error (&Errno::EIO, 1); 1436 && ($tmp != $ERROR_SYSCALL || $!)
1344 } 1437 && $tmp != $ERROR_ZERO_RETURN;
1345 1438
1346 # all others are fine for our purposes
1347 }
1348
1349 while (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1439 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350 $self->{wbuf} .= $buf; 1440 $self->{wbuf} .= $tmp;
1351 $self->_drain_wbuf; 1441 $self->_drain_wbuf;
1352 } 1442 }
1353} 1443}
1354 1444
1355=item $handle->starttls ($tls[, $tls_ctx]) 1445=item $handle->starttls ($tls[, $tls_ctx])
1359C<starttls>. 1449C<starttls>.
1360 1450
1361The first argument is the same as the C<tls> constructor argument (either 1451The first argument is the same as the C<tls> constructor argument (either
1362C<"connect">, C<"accept"> or an existing Net::SSLeay object). 1452C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1363 1453
1364The second argument is the optional C<Net::SSLeay::CTX> object that is 1454The second argument is the optional C<AnyEvent::TLS> object that is used
1365used when AnyEvent::Handle has to create its own TLS connection object. 1455when AnyEvent::Handle has to create its own TLS connection object, or
1456a hash reference with C<< key => value >> pairs that will be used to
1457construct a new context.
1366 1458
1367The TLS connection object will end up in C<< $handle->{tls} >> after this 1459The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1368call and can be used or changed to your liking. Note that the handshake 1460context in C<< $handle->{tls_ctx} >> after this call and can be used or
1369might have already started when this function returns. 1461changed to your liking. Note that the handshake might have already started
1462when this function returns.
1370 1463
1371If it an error to start a TLS handshake more than once per 1464If it an error to start a TLS handshake more than once per
1372AnyEvent::Handle object (this is due to bugs in OpenSSL). 1465AnyEvent::Handle object (this is due to bugs in OpenSSL).
1373 1466
1374=cut 1467=cut
1375 1468
1469our %TLS_CACHE; #TODO not yet documented, should we?
1470
1376sub starttls { 1471sub starttls {
1377 my ($self, $ssl, $ctx) = @_; 1472 my ($self, $ssl, $ctx) = @_;
1378 1473
1379 require Net::SSLeay; 1474 require Net::SSLeay;
1380 1475
1381 Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" 1476 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1382 if $self->{tls}; 1477 if $self->{tls};
1478
1479 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1480 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1481 $ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1482
1483 $ctx ||= $self->{tls_ctx};
1484
1485 if ("HASH" eq ref $ctx) {
1486 require AnyEvent::TLS;
1487
1488 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1489
1490 if ($ctx->{cache}) {
1491 my $key = $ctx+0;
1492 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1493 } else {
1494 $ctx = new AnyEvent::TLS %$ctx;
1495 }
1496 }
1383 1497
1384 if ($ssl eq "accept") { 1498 $self->{tls_ctx} = $ctx || TLS_CTX ();
1385 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1499 $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1386 Net::SSLeay::set_accept_state ($ssl);
1387 } elsif ($ssl eq "connect") {
1388 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1389 Net::SSLeay::set_connect_state ($ssl);
1390 }
1391
1392 $self->{tls} = $ssl;
1393 1500
1394 # basically, this is deep magic (because SSL_read should have the same issues) 1501 # basically, this is deep magic (because SSL_read should have the same issues)
1395 # but the openssl maintainers basically said: "trust us, it just works". 1502 # but the openssl maintainers basically said: "trust us, it just works".
1396 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1503 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1397 # and mismaintained ssleay-module doesn't even offer them). 1504 # and mismaintained ssleay-module doesn't even offer them).
1401 # 1508 #
1402 # note that we do not try to keep the length constant between writes as we are required to do. 1509 # note that we do not try to keep the length constant between writes as we are required to do.
1403 # we assume that most (but not all) of this insanity only applies to non-blocking cases, 1510 # we assume that most (but not all) of this insanity only applies to non-blocking cases,
1404 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to 1511 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1405 # have identity issues in that area. 1512 # have identity issues in that area.
1406 Net::SSLeay::CTX_set_mode ($self->{tls}, 1513# Net::SSLeay::CTX_set_mode ($ssl,
1407 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1514# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1408 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1515# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1516 Net::SSLeay::CTX_set_mode ($ssl, 1|2);
1409 1517
1410 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1518 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1411 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1519 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1412 1520
1413 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1521 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1442sub _freetls { 1550sub _freetls {
1443 my ($self) = @_; 1551 my ($self) = @_;
1444 1552
1445 return unless $self->{tls}; 1553 return unless $self->{tls};
1446 1554
1447 Net::SSLeay::free (delete $self->{tls}); 1555 $self->{tls_ctx}->_put_session (delete $self->{tls});
1448 1556
1449 delete @$self{qw(_rbio _wbio _tls_wbuf)}; 1557 delete @$self{qw(_rbio _wbio _tls_wbuf)};
1450} 1558}
1451 1559
1452sub DESTROY { 1560sub DESTROY {
1453 my $self = shift; 1561 my ($self) = @_;
1454 1562
1455 &_freetls; 1563 &_freetls;
1456 1564
1457 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1565 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1458 1566
1475 @linger = (); 1583 @linger = ();
1476 }); 1584 });
1477 } 1585 }
1478} 1586}
1479 1587
1588=item $handle->destroy
1589
1590Shuts down the handle object as much as possible - this call ensures that
1591no further callbacks will be invoked and resources will be freed as much
1592as possible. You must not call any methods on the object afterwards.
1593
1594Normally, you can just "forget" any references to an AnyEvent::Handle
1595object and it will simply shut down. This works in fatal error and EOF
1596callbacks, as well as code outside. It does I<NOT> work in a read or write
1597callback, so when you want to destroy the AnyEvent::Handle object from
1598within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1599that case.
1600
1601The handle might still linger in the background and write out remaining
1602data, as specified by the C<linger> option, however.
1603
1604=cut
1605
1606sub destroy {
1607 my ($self) = @_;
1608
1609 $self->DESTROY;
1610 %$self = ();
1611}
1612
1480=item AnyEvent::Handle::TLS_CTX 1613=item AnyEvent::Handle::TLS_CTX
1481 1614
1482This function creates and returns the Net::SSLeay::CTX object used by 1615This function creates and returns the AnyEvent::TLS object used by default
1483default for TLS mode. 1616for TLS mode.
1484 1617
1485The context is created like this: 1618The context is created by calling L<AnyEvent::TLS> without any arguments.
1486
1487 Net::SSLeay::load_error_strings;
1488 Net::SSLeay::SSLeay_add_ssl_algorithms;
1489 Net::SSLeay::randomize;
1490
1491 my $CTX = Net::SSLeay::CTX_new;
1492
1493 Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1494 1619
1495=cut 1620=cut
1496 1621
1497our $TLS_CTX; 1622our $TLS_CTX;
1498 1623
1499sub TLS_CTX() { 1624sub TLS_CTX() {
1500 $TLS_CTX || do { 1625 $TLS_CTX ||= do {
1501 require Net::SSLeay; 1626 require AnyEvent::TLS;
1502 1627
1503 Net::SSLeay::load_error_strings (); 1628 new AnyEvent::TLS
1504 Net::SSLeay::SSLeay_add_ssl_algorithms ();
1505 Net::SSLeay::randomize ();
1506
1507 $TLS_CTX = Net::SSLeay::CTX_new ();
1508
1509 Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1510
1511 $TLS_CTX
1512 } 1629 }
1513} 1630}
1514 1631
1515=back 1632=back
1516 1633
1517 1634
1518=head1 NONFREQUENTLY ASKED QUESTIONS 1635=head1 NONFREQUENTLY ASKED QUESTIONS
1519 1636
1520=over 4 1637=over 4
1638
1639=item I C<undef> the AnyEvent::Handle reference inside my callback and
1640still get further invocations!
1641
1642That's because AnyEvent::Handle keeps a reference to itself when handling
1643read or write callbacks.
1644
1645It is only safe to "forget" the reference inside EOF or error callbacks,
1646from within all other callbacks, you need to explicitly call the C<<
1647->destroy >> method.
1648
1649=item I get different callback invocations in TLS mode/Why can't I pause
1650reading?
1651
1652Unlike, say, TCP, TLS connections do not consist of two independent
1653communication channels, one for each direction. Or put differently. The
1654read and write directions are not independent of each other: you cannot
1655write data unless you are also prepared to read, and vice versa.
1656
1657This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
1658callback invocations when you are not expecting any read data - the reason
1659is that AnyEvent::Handle always reads in TLS mode.
1660
1661During the connection, you have to make sure that you always have a
1662non-empty read-queue, or an C<on_read> watcher. At the end of the
1663connection (or when you no longer want to use it) you can call the
1664C<destroy> method.
1521 1665
1522=item How do I read data until the other side closes the connection? 1666=item How do I read data until the other side closes the connection?
1523 1667
1524If you just want to read your data into a perl scalar, the easiest way 1668If you just want to read your data into a perl scalar, the easiest way
1525to achieve this is by setting an C<on_read> callback that does nothing, 1669to achieve this is by setting an C<on_read> callback that does nothing,
1535 1679
1536The reason to use C<on_error> is that TCP connections, due to latencies 1680The reason to use C<on_error> is that TCP connections, due to latencies
1537and packets loss, might get closed quite violently with an error, when in 1681and packets loss, might get closed quite violently with an error, when in
1538fact, all data has been received. 1682fact, all data has been received.
1539 1683
1540It is usually better to use acknowledgements when transfering data, 1684It is usually better to use acknowledgements when transferring data,
1541to make sure the other side hasn't just died and you got the data 1685to make sure the other side hasn't just died and you got the data
1542intact. This is also one reason why so many internet protocols have an 1686intact. This is also one reason why so many internet protocols have an
1543explicit QUIT command. 1687explicit QUIT command.
1544
1545 1688
1546=item I don't want to destroy the handle too early - how do I wait until 1689=item I don't want to destroy the handle too early - how do I wait until
1547all data has been written? 1690all data has been written?
1548 1691
1549After writing your last bits of data, set the C<on_drain> callback 1692After writing your last bits of data, set the C<on_drain> callback

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines