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.87 by root, Thu Aug 21 20:52:39 2008 UTC vs.
Revision 1.109 by root, Wed Jan 14 02:03:43 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.232; 19our $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");
84Set 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,
85i.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
86connection cleanly. 86connection cleanly.
87 87
88For 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,
89you 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
90callback 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
91down. 91down.
92 92
93While 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,
94otherwise 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
95waiting for data. 95waiting for data.
96 96
97If 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
98set, 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>.
103occured, such as not being able to resolve the hostname, failure to 103occured, such as not being able to resolve the hostname, failure to
104connect or a read error. 104connect or a read error.
105 105
106Some errors are fatal (which is indicated by C<$fatal> being true). On 106Some errors are fatal (which is indicated by C<$fatal> being true). On
107fatal 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
108(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
109errors are an EOF condition with active (but unsatisifable) read watchers 109errors are an EOF condition with active (but unsatisifable) read watchers
110(C<EPIPE>) or I/O errors. 110(C<EPIPE>) or I/O errors.
111 111
112Non-fatal errors can be retried by simply returning, but it is recommended 112Non-fatal errors can be retried by simply returning, but it is recommended
113to simply ignore this parameter and instead abondon the handle object 113to simply ignore this parameter and instead abondon the handle object
152=item timeout => $fractional_seconds 152=item timeout => $fractional_seconds
153 153
154If non-zero, then this enables an "inactivity" timeout: whenever this many 154If non-zero, then this enables an "inactivity" timeout: whenever this many
155seconds pass without a successful read or write on the underlying file 155seconds pass without a successful read or write on the underlying file
156handle, the C<on_timeout> callback will be invoked (and if that one is 156handle, the C<on_timeout> callback will be invoked (and if that one is
157missing, an C<ETIMEDOUT> error will be raised). 157missing, a non-fatal C<ETIMEDOUT> error will be raised).
158 158
159Note that timeout processing is also active when you currently do not have 159Note that timeout processing is also active when you currently do not have
160any outstanding read or write requests: If you plan to keep the connection 160any outstanding read or write requests: If you plan to keep the connection
161idle then you should disable the timout temporarily or ignore the timeout 161idle then you should disable the timout temporarily or ignore the timeout
162in the C<on_timeout> callback. 162in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
163restart the timeout.
163 164
164Zero (the default) disables this timeout. 165Zero (the default) disables this timeout.
165 166
166=item on_timeout => $cb->($handle) 167=item on_timeout => $cb->($handle)
167 168
171 172
172=item rbuf_max => <bytes> 173=item rbuf_max => <bytes>
173 174
174If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) 175If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
175when the read buffer ever (strictly) exceeds this size. This is useful to 176when the read buffer ever (strictly) exceeds this size. This is useful to
176avoid denial-of-service attacks. 177avoid some forms of denial-of-service attacks.
177 178
178For example, a server accepting connections from untrusted sources should 179For example, a server accepting connections from untrusted sources should
179be configured to accept only so-and-so much data that it cannot act on 180be configured to accept only so-and-so much data that it cannot act on
180(for example, when expecting a line, an attacker could send an unlimited 181(for example, when expecting a line, an attacker could send an unlimited
181amount of data without a callback ever being called as long as the line 182amount of data without a callback ever being called as long as the line
182isn't finished). 183isn't finished).
183 184
184=item autocork => <boolean> 185=item autocork => <boolean>
185 186
186When disabled (the default), then C<push_write> will try to immediately 187When disabled (the default), then C<push_write> will try to immediately
187write the data to the handle if possible. This avoids having to register 188write the data to the handle, if possible. This avoids having to register
188a write watcher and wait for the next event loop iteration, but can be 189a write watcher and wait for the next event loop iteration, but can
189inefficient if you write multiple small chunks (this disadvantage is 190be inefficient if you write multiple small chunks (on the wire, this
190usually avoided by your kernel's nagle algorithm, see C<low_delay>). 191disadvantage is usually avoided by your kernel's nagle algorithm, see
192C<no_delay>, but this option can save costly syscalls).
191 193
192When enabled, then writes will always be queued till the next event loop 194When enabled, then writes will always be queued till the next event loop
193iteration. This is efficient when you do many small writes per iteration, 195iteration. This is efficient when you do many small writes per iteration,
194but less efficient when you do a single write only. 196but less efficient when you do a single write only per iteration (or when
197the write buffer often is full). It also increases write latency.
195 198
196=item no_delay => <boolean> 199=item no_delay => <boolean>
197 200
198When doing small writes on sockets, your operating system kernel might 201When doing small writes on sockets, your operating system kernel might
199wait a bit for more data before actually sending it out. This is called 202wait a bit for more data before actually sending it out. This is called
200the Nagle algorithm, and usually it is beneficial. 203the Nagle algorithm, and usually it is beneficial.
201 204
202In some situations you want as low a delay as possible, which cna be 205In some situations you want as low a delay as possible, which can be
203accomplishd by setting this option to true. 206accomplishd by setting this option to a true value.
204 207
205The default is your opertaing system's default behaviour, this option 208The default is your opertaing system's default behaviour (most likely
206explicitly enables or disables it, if possible. 209enabled), this option explicitly enables or disables it, if possible.
207 210
208=item read_size => <bytes> 211=item read_size => <bytes>
209 212
210The default read block size (the amount of bytes this module will try to read 213The default read block size (the amount of bytes this module will
211during each (loop iteration). Default: C<8192>. 214try to read during each loop iteration, which affects memory
215requirements). Default: C<8192>.
212 216
213=item low_water_mark => <bytes> 217=item low_water_mark => <bytes>
214 218
215Sets the amount of bytes (default: C<0>) that make up an "empty" write 219Sets the amount of bytes (default: C<0>) that make up an "empty" write
216buffer: If the write reaches this size or gets even samller it is 220buffer: If the write reaches this size or gets even samller it is
217considered empty. 221considered empty.
218 222
223Sometimes it can be beneficial (for performance reasons) to add data to
224the write buffer before it is fully drained, but this is a rare case, as
225the operating system kernel usually buffers data as well, so the default
226is good in almost all cases.
227
219=item linger => <seconds> 228=item linger => <seconds>
220 229
221If non-zero (default: C<3600>), then the destructor of the 230If non-zero (default: C<3600>), then the destructor of the
222AnyEvent::Handle object will check wether there is still outstanding write 231AnyEvent::Handle object will check whether there is still outstanding
223data and will install a watcher that will write out this data. No errors 232write data and will install a watcher that will write this data to the
224will be reported (this mostly matches how the operating system treats 233socket. No errors will be reported (this mostly matches how the operating
225outstanding data at socket close time). 234system treats outstanding data at socket close time).
226 235
227This will not work for partial TLS data that could not yet been 236This will not work for partial TLS data that could not be encoded
228encoded. This data will be lost. 237yet. This data will be lost. Calling the C<stoptls> method in time might
238help.
229 239
230=item tls => "accept" | "connect" | Net::SSLeay::SSL object 240=item tls => "accept" | "connect" | Net::SSLeay::SSL object
231 241
232When this parameter is given, it enables TLS (SSL) mode, that means 242When this parameter is given, it enables TLS (SSL) mode, that means
233AnyEvent will start a TLS handshake and will transparently encrypt/decrypt 243AnyEvent will start a TLS handshake as soon as the conenction has been
234data. 244established and will transparently encrypt/decrypt data afterwards.
235 245
236TLS mode requires Net::SSLeay to be installed (it will be loaded 246TLS mode requires Net::SSLeay to be installed (it will be loaded
237automatically when you try to create a TLS handle). 247automatically when you try to create a TLS handle): this module doesn't
248have a dependency on that module, so if your module requires it, you have
249to add the dependency yourself.
238 250
239Unlike TCP, TLS has a server and client side: for the TLS server side, use 251Unlike TCP, TLS has a server and client side: for the TLS server side, use
240C<accept>, and for the TLS client side of a connection, use C<connect> 252C<accept>, and for the TLS client side of a connection, use C<connect>
241mode. 253mode.
242 254
243You can also provide your own TLS connection object, but you have 255You can also provide your own TLS connection object, but you have
244to make sure that you call either C<Net::SSLeay::set_connect_state> 256to make sure that you call either C<Net::SSLeay::set_connect_state>
245or C<Net::SSLeay::set_accept_state> on it before you pass it to 257or C<Net::SSLeay::set_accept_state> on it before you pass it to
246AnyEvent::Handle. 258AnyEvent::Handle.
247 259
260B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
261passing in the wrong integer will lead to certain crash. This most often
262happens when one uses a stylish C<< tls => 1 >> and is surprised about the
263segmentation fault.
264
248See the C<starttls> method for when need to start TLS negotiation later. 265See the C<< ->starttls >> method for when need to start TLS negotiation later.
249 266
250=item tls_ctx => $ssl_ctx 267=item tls_ctx => $ssl_ctx
251 268
252Use the given Net::SSLeay::CTX object to create the new TLS connection 269Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
253(unless a connection object was specified directly). If this parameter is 270(unless a connection object was specified directly). If this parameter is
254missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 271missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
255 272
256=item json => JSON or JSON::XS object 273=item json => JSON or JSON::XS object
257 274
262texts. 279texts.
263 280
264Note that you are responsible to depend on the JSON module if you want to 281Note that you are responsible to depend on the JSON module if you want to
265use this functionality, as AnyEvent does not have a dependency itself. 282use this functionality, as AnyEvent does not have a dependency itself.
266 283
267=item filter_r => $cb
268
269=item filter_w => $cb
270
271These exist, but are undocumented at this time. (They are used internally
272by the TLS code).
273
274=back 284=back
275 285
276=cut 286=cut
277 287
278sub new { 288sub new {
282 292
283 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 293 $self->{fh} or Carp::croak "mandatory argument fh is missing";
284 294
285 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 295 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
286 296
287 if ($self->{tls}) {
288 require Net::SSLeay;
289 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); 297 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
290 } 298 if $self->{tls};
291 299
292 $self->{_activity} = AnyEvent->now; 300 $self->{_activity} = AnyEvent->now;
293 $self->_timeout; 301 $self->_timeout;
294 302
295 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; 303 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
307 delete $self->{_tw}; 315 delete $self->{_tw};
308 delete $self->{_rw}; 316 delete $self->{_rw};
309 delete $self->{_ww}; 317 delete $self->{_ww};
310 delete $self->{fh}; 318 delete $self->{fh};
311 319
312 $self->stoptls; 320 &_freetls;
313 321
314 delete $self->{on_read}; 322 delete $self->{on_read};
315 delete $self->{_queue}; 323 delete $self->{_queue};
316} 324}
317 325
323 331
324 $! = $errno; 332 $! = $errno;
325 333
326 if ($self->{on_error}) { 334 if ($self->{on_error}) {
327 $self->{on_error}($self, $fatal); 335 $self->{on_error}($self, $fatal);
328 } else { 336 } elsif ($self->{fh}) {
329 Carp::croak "AnyEvent::Handle uncaught error: $!"; 337 Carp::croak "AnyEvent::Handle uncaught error: $!";
330 } 338 }
331} 339}
332 340
333=item $fh = $handle->fh 341=item $fh = $handle->fh
334 342
335This method returns the file handle of the L<AnyEvent::Handle> object. 343This method returns the file handle used to create the L<AnyEvent::Handle> object.
336 344
337=cut 345=cut
338 346
339sub fh { $_[0]{fh} } 347sub fh { $_[0]{fh} }
340 348
358 $_[0]{on_eof} = $_[1]; 366 $_[0]{on_eof} = $_[1];
359} 367}
360 368
361=item $handle->on_timeout ($cb) 369=item $handle->on_timeout ($cb)
362 370
363Replace the current C<on_timeout> callback, or disables the callback 371Replace the current C<on_timeout> callback, or disables the callback (but
364(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor 372not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
365argument. 373argument and method.
366 374
367=cut 375=cut
368 376
369sub on_timeout { 377sub on_timeout {
370 $_[0]{on_timeout} = $_[1]; 378 $_[0]{on_timeout} = $_[1];
371} 379}
372 380
373=item $handle->autocork ($boolean) 381=item $handle->autocork ($boolean)
374 382
375Enables or disables the current autocork behaviour (see C<autocork> 383Enables or disables the current autocork behaviour (see C<autocork>
376constructor argument). 384constructor argument). Changes will only take effect on the next write.
377 385
378=cut 386=cut
387
388sub autocork {
389 $_[0]{autocork} = $_[1];
390}
379 391
380=item $handle->no_delay ($boolean) 392=item $handle->no_delay ($boolean)
381 393
382Enables or disables the C<no_delay> setting (see constructor argument of 394Enables or disables the C<no_delay> setting (see constructor argument of
383the same name for details). 395the same name for details).
476 my ($self, $cb) = @_; 488 my ($self, $cb) = @_;
477 489
478 $self->{on_drain} = $cb; 490 $self->{on_drain} = $cb;
479 491
480 $cb->($self) 492 $cb->($self)
481 if $cb && $self->{low_water_mark} >= length $self->{wbuf}; 493 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
482} 494}
483 495
484=item $handle->push_write ($data) 496=item $handle->push_write ($data)
485 497
486Queues the given scalar to be written. You can push as much data as you 498Queues the given scalar to be written. You can push as much data as you
503 substr $self->{wbuf}, 0, $len, ""; 515 substr $self->{wbuf}, 0, $len, "";
504 516
505 $self->{_activity} = AnyEvent->now; 517 $self->{_activity} = AnyEvent->now;
506 518
507 $self->{on_drain}($self) 519 $self->{on_drain}($self)
508 if $self->{low_water_mark} >= length $self->{wbuf} 520 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
509 && $self->{on_drain}; 521 && $self->{on_drain};
510 522
511 delete $self->{_ww} unless length $self->{wbuf}; 523 delete $self->{_ww} unless length $self->{wbuf};
512 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 524 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
513 $self->_error ($!, 1); 525 $self->_error ($!, 1);
537 549
538 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 550 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
539 ->($self, @_); 551 ->($self, @_);
540 } 552 }
541 553
542 if ($self->{filter_w}) { 554 if ($self->{tls}) {
543 $self->{filter_w}($self, \$_[0]); 555 $self->{_tls_wbuf} .= $_[0];
556
557 &_dotls ($self);
544 } else { 558 } else {
545 $self->{wbuf} .= $_[0]; 559 $self->{wbuf} .= $_[0];
546 $self->_drain_wbuf; 560 $self->_drain_wbuf;
547 } 561 }
548} 562}
565=cut 579=cut
566 580
567register_write_type netstring => sub { 581register_write_type netstring => sub {
568 my ($self, $string) = @_; 582 my ($self, $string) = @_;
569 583
570 sprintf "%d:%s,", (length $string), $string 584 (length $string) . ":$string,"
571}; 585};
572 586
573=item packstring => $format, $data 587=item packstring => $format, $data
574 588
575An octet string prefixed with an encoded length. The encoding C<$format> 589An octet string prefixed with an encoded length. The encoding C<$format>
784 798
785 last; # more data might arrive 799 last; # more data might arrive
786 } 800 }
787 } else { 801 } else {
788 # read side becomes idle 802 # read side becomes idle
789 delete $self->{_rw}; 803 delete $self->{_rw} unless $self->{tls};
790 last; 804 last;
791 } 805 }
792 } 806 }
793 807
794 if ($self->{_eof}) { 808 if ($self->{_eof}) {
1089An octet string prefixed with an encoded length. The encoding C<$format> 1103An octet string prefixed with an encoded length. The encoding C<$format>
1090uses the same format as a Perl C<pack> format, but must specify a single 1104uses the same format as a Perl C<pack> format, but must specify a single
1091integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an 1105integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1092optional C<!>, C<< < >> or C<< > >> modifier). 1106optional C<!>, C<< < >> or C<< > >> modifier).
1093 1107
1094DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. 1108For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
1109EPP uses a prefix of C<N> (4 octtes).
1095 1110
1096Example: read a block of data prefixed by its length in BER-encoded 1111Example: read a block of data prefixed by its length in BER-encoded
1097format (very efficient). 1112format (very efficient).
1098 1113
1099 $handle->push_read (packstring => "w", sub { 1114 $handle->push_read (packstring => "w", sub {
1252Note that AnyEvent::Handle will automatically C<start_read> for you when 1267Note that AnyEvent::Handle will automatically C<start_read> for you when
1253you change the C<on_read> callback or push/unshift a read callback, and it 1268you change the C<on_read> callback or push/unshift a read callback, and it
1254will automatically C<stop_read> for you when neither C<on_read> is set nor 1269will automatically C<stop_read> for you when neither C<on_read> is set nor
1255there are any read requests in the queue. 1270there are any read requests in the queue.
1256 1271
1272These methods will have no effect when in TLS mode (as TLS doesn't support
1273half-duplex connections).
1274
1257=cut 1275=cut
1258 1276
1259sub stop_read { 1277sub stop_read {
1260 my ($self) = @_; 1278 my ($self) = @_;
1261 1279
1262 delete $self->{_rw}; 1280 delete $self->{_rw} unless $self->{tls};
1263} 1281}
1264 1282
1265sub start_read { 1283sub start_read {
1266 my ($self) = @_; 1284 my ($self) = @_;
1267 1285
1268 unless ($self->{_rw} || $self->{_eof}) { 1286 unless ($self->{_rw} || $self->{_eof}) {
1269 Scalar::Util::weaken $self; 1287 Scalar::Util::weaken $self;
1270 1288
1271 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1289 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1272 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; 1290 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1273 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1291 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1274 1292
1275 if ($len > 0) { 1293 if ($len > 0) {
1276 $self->{_activity} = AnyEvent->now; 1294 $self->{_activity} = AnyEvent->now;
1277 1295
1278 $self->{filter_r} 1296 if ($self->{tls}) {
1279 ? $self->{filter_r}($self, $rbuf) 1297 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1280 : $self->{_in_drain} || $self->_drain_rbuf; 1298
1299 &_dotls ($self);
1300 } else {
1301 $self->_drain_rbuf unless $self->{_in_drain};
1302 }
1281 1303
1282 } elsif (defined $len) { 1304 } elsif (defined $len) {
1283 delete $self->{_rw}; 1305 delete $self->{_rw};
1284 $self->{_eof} = 1; 1306 $self->{_eof} = 1;
1285 $self->_drain_rbuf unless $self->{_in_drain}; 1307 $self->_drain_rbuf unless $self->{_in_drain};
1289 } 1311 }
1290 }); 1312 });
1291 } 1313 }
1292} 1314}
1293 1315
1316# poll the write BIO and send the data if applicable
1294sub _dotls { 1317sub _dotls {
1295 my ($self) = @_; 1318 my ($self) = @_;
1296 1319
1297 my $buf; 1320 my $tmp;
1298 1321
1299 if (length $self->{_tls_wbuf}) { 1322 if (length $self->{_tls_wbuf}) {
1300 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1323 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1301 substr $self->{_tls_wbuf}, 0, $len, ""; 1324 substr $self->{_tls_wbuf}, 0, $tmp, "";
1302 } 1325 }
1303 } 1326 }
1304 1327
1305 if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1306 $self->{wbuf} .= $buf;
1307 $self->_drain_wbuf;
1308 }
1309
1310 while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { 1328 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1311 if (length $buf) { 1329 unless (length $tmp) {
1312 $self->{rbuf} .= $buf;
1313 $self->_drain_rbuf unless $self->{_in_drain};
1314 } else {
1315 # let's treat SSL-eof as we treat normal EOF 1330 # let's treat SSL-eof as we treat normal EOF
1331 delete $self->{_rw};
1316 $self->{_eof} = 1; 1332 $self->{_eof} = 1;
1317 $self->_shutdown; 1333 &_freetls;
1318 return;
1319 } 1334 }
1320 }
1321 1335
1336 $self->{rbuf} .= $tmp;
1337 $self->_drain_rbuf unless $self->{_in_drain};
1338 $self->{tls} or return; # tls session might have gone away in callback
1339 }
1340
1322 my $err = Net::SSLeay::get_error ($self->{tls}, -1); 1341 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1323 1342
1324 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { 1343 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1325 if ($err == Net::SSLeay::ERROR_SYSCALL ()) { 1344 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1326 return $self->_error ($!, 1); 1345 return $self->_error ($!, 1);
1327 } elsif ($err == Net::SSLeay::ERROR_SSL ()) { 1346 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1328 return $self->_error (&Errno::EIO, 1); 1347 return $self->_error (&Errno::EIO, 1);
1329 } 1348 }
1330 1349
1331 # all others are fine for our purposes 1350 # all other errors are fine for our purposes
1351 }
1352
1353 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1354 $self->{wbuf} .= $tmp;
1355 $self->_drain_wbuf;
1332 } 1356 }
1333} 1357}
1334 1358
1335=item $handle->starttls ($tls[, $tls_ctx]) 1359=item $handle->starttls ($tls[, $tls_ctx])
1336 1360
1346 1370
1347The TLS connection object will end up in C<< $handle->{tls} >> after this 1371The TLS connection object will end up in C<< $handle->{tls} >> after this
1348call and can be used or changed to your liking. Note that the handshake 1372call and can be used or changed to your liking. Note that the handshake
1349might have already started when this function returns. 1373might have already started when this function returns.
1350 1374
1375If it an error to start a TLS handshake more than once per
1376AnyEvent::Handle object (this is due to bugs in OpenSSL).
1377
1351=cut 1378=cut
1352 1379
1353sub starttls { 1380sub starttls {
1354 my ($self, $ssl, $ctx) = @_; 1381 my ($self, $ssl, $ctx) = @_;
1355 1382
1356 $self->stoptls; 1383 require Net::SSLeay;
1357 1384
1385 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1386 if $self->{tls};
1387
1358 if ($ssl eq "accept") { 1388 if ($ssl eq "accept") {
1359 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1389 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1360 Net::SSLeay::set_accept_state ($ssl); 1390 Net::SSLeay::set_accept_state ($ssl);
1361 } elsif ($ssl eq "connect") { 1391 } elsif ($ssl eq "connect") {
1362 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1392 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1371 # and mismaintained ssleay-module doesn't even offer them). 1401 # and mismaintained ssleay-module doesn't even offer them).
1372 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html 1402 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1373 # 1403 #
1374 # in short: this is a mess. 1404 # in short: this is a mess.
1375 # 1405 #
1376 # note that we do not try to kepe the length constant between writes as we are required to do. 1406 # note that we do not try to keep the length constant between writes as we are required to do.
1377 # we assume that most (but not all) of this insanity only applies to non-blocking cases, 1407 # we assume that most (but not all) of this insanity only applies to non-blocking cases,
1378 # and we drive openssl fully in blocking mode here. 1408 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1409 # have identity issues in that area.
1379 Net::SSLeay::CTX_set_mode ($self->{tls}, 1410 Net::SSLeay::CTX_set_mode ($self->{tls},
1380 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1411 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1381 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1412 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1382 1413
1383 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1414 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1384 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1415 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1385 1416
1386 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1417 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1387 1418
1388 $self->{filter_w} = sub { 1419 &_dotls; # need to trigger the initial handshake
1389 $_[0]{_tls_wbuf} .= ${$_[1]}; 1420 $self->start_read; # make sure we actually do read
1390 &_dotls;
1391 };
1392 $self->{filter_r} = sub {
1393 Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1394 &_dotls;
1395 };
1396} 1421}
1397 1422
1398=item $handle->stoptls 1423=item $handle->stoptls
1399 1424
1400Destroys the SSL connection, if any. Partial read or write data will be 1425Shuts down the SSL connection - this makes a proper EOF handshake by
1401lost. 1426sending a close notify to the other side, but since OpenSSL doesn't
1427support non-blocking shut downs, it is not possible to re-use the stream
1428afterwards.
1402 1429
1403=cut 1430=cut
1404 1431
1405sub stoptls { 1432sub stoptls {
1406 my ($self) = @_; 1433 my ($self) = @_;
1407 1434
1435 if ($self->{tls}) {
1436 Net::SSLeay::shutdown ($self->{tls});
1437
1438 &_dotls;
1439
1440 # we don't give a shit. no, we do, but we can't. no...
1441 # we, we... have to use openssl :/
1442 &_freetls;
1443 }
1444}
1445
1446sub _freetls {
1447 my ($self) = @_;
1448
1449 return unless $self->{tls};
1450
1408 Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; 1451 Net::SSLeay::free (delete $self->{tls});
1409 1452
1410 delete $self->{_rbio}; 1453 delete @$self{qw(_rbio _wbio _tls_wbuf)};
1411 delete $self->{_wbio};
1412 delete $self->{_tls_wbuf};
1413 delete $self->{filter_r};
1414 delete $self->{filter_w};
1415} 1454}
1416 1455
1417sub DESTROY { 1456sub DESTROY {
1418 my $self = shift; 1457 my $self = shift;
1419 1458
1420 $self->stoptls; 1459 &_freetls;
1421 1460
1422 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1461 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1423 1462
1424 if ($linger && length $self->{wbuf}) { 1463 if ($linger && length $self->{wbuf}) {
1425 my $fh = delete $self->{fh}; 1464 my $fh = delete $self->{fh};
1440 @linger = (); 1479 @linger = ();
1441 }); 1480 });
1442 } 1481 }
1443} 1482}
1444 1483
1484=item $handle->destroy
1485
1486Shuts down the handle object as much as possible - this call ensures that
1487no further callbacks will be invoked and resources will be freed as much
1488as possible. You must not call any methods on the object afterwards.
1489
1490Normally, you can just "forget" any references to an AnyEvent::Handle
1491object and it will simply shut down. This works in fatal error and EOF
1492callbacks, as well as code outside. It does I<NOT> work in a read or write
1493callback, so when you want to destroy the AnyEvent::Handle object from
1494within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1495that case.
1496
1497The handle might still linger in the background and write out remaining
1498data, as specified by the C<linger> option, however.
1499
1500=cut
1501
1502sub destroy {
1503 my ($self) = @_;
1504
1505 $self->DESTROY;
1506 %$self = ();
1507}
1508
1445=item AnyEvent::Handle::TLS_CTX 1509=item AnyEvent::Handle::TLS_CTX
1446 1510
1447This function creates and returns the Net::SSLeay::CTX object used by 1511This function creates and returns the Net::SSLeay::CTX object used by
1448default for TLS mode. 1512default for TLS mode.
1449 1513
1477 } 1541 }
1478} 1542}
1479 1543
1480=back 1544=back
1481 1545
1546
1547=head1 NONFREQUENTLY ASKED QUESTIONS
1548
1549=over 4
1550
1551=item I C<undef> the AnyEvent::Handle reference inside my callback and
1552still get further invocations!
1553
1554That's because AnyEvent::Handle keeps a reference to itself when handling
1555read or write callbacks.
1556
1557It is only safe to "forget" the reference inside EOF or error callbacks,
1558from within all other callbacks, you need to explicitly call the C<<
1559->destroy >> method.
1560
1561=item I get different callback invocations in TLS mode/Why can't I pause
1562reading?
1563
1564Unlike, say, TCP, TLS connections do not consist of two independent
1565communication channels, one for each direction. Or put differently. The
1566read and write directions are not independent of each other: you cannot
1567write data unless you are also prepared to read, and vice versa.
1568
1569This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
1570callback invocations when you are not expecting any read data - the reason
1571is that AnyEvent::Handle always reads in TLS mode.
1572
1573During the connection, you have to make sure that you always have a
1574non-empty read-queue, or an C<on_read> watcher. At the end of the
1575connection (or when you no longer want to use it) you can call the
1576C<destroy> method.
1577
1578=item How do I read data until the other side closes the connection?
1579
1580If you just want to read your data into a perl scalar, the easiest way
1581to achieve this is by setting an C<on_read> callback that does nothing,
1582clearing the C<on_eof> callback and in the C<on_error> callback, the data
1583will be in C<$_[0]{rbuf}>:
1584
1585 $handle->on_read (sub { });
1586 $handle->on_eof (undef);
1587 $handle->on_error (sub {
1588 my $data = delete $_[0]{rbuf};
1589 undef $handle;
1590 });
1591
1592The reason to use C<on_error> is that TCP connections, due to latencies
1593and packets loss, might get closed quite violently with an error, when in
1594fact, all data has been received.
1595
1596It is usually better to use acknowledgements when transferring data,
1597to make sure the other side hasn't just died and you got the data
1598intact. This is also one reason why so many internet protocols have an
1599explicit QUIT command.
1600
1601=item I don't want to destroy the handle too early - how do I wait until
1602all data has been written?
1603
1604After writing your last bits of data, set the C<on_drain> callback
1605and destroy the handle in there - with the default setting of
1606C<low_water_mark> this will be called precisely when all data has been
1607written to the socket:
1608
1609 $handle->push_write (...);
1610 $handle->on_drain (sub {
1611 warn "all data submitted to the kernel\n";
1612 undef $handle;
1613 });
1614
1615=back
1616
1617
1482=head1 SUBCLASSING AnyEvent::Handle 1618=head1 SUBCLASSING AnyEvent::Handle
1483 1619
1484In many cases, you might want to subclass AnyEvent::Handle. 1620In many cases, you might want to subclass AnyEvent::Handle.
1485 1621
1486To make this easier, a given version of AnyEvent::Handle uses these 1622To make this easier, a given version of AnyEvent::Handle uses these

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines