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.192 by root, Fri Mar 12 23:22:14 2010 UTC vs.
Revision 1.222 by root, Thu Aug 25 03:08:48 2011 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 3AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent; 7 use AnyEvent;
8 use AnyEvent::Handle; 8 use AnyEvent::Handle;
… …
11 11
12 my $hdl; $hdl = new AnyEvent::Handle 12 my $hdl; $hdl = new AnyEvent::Handle
13 fh => \*STDIN, 13 fh => \*STDIN,
14 on_error => sub { 14 on_error => sub {
15 my ($hdl, $fatal, $msg) = @_; 15 my ($hdl, $fatal, $msg) = @_;
16 warn "got error $msg\n"; 16 AE::log warn => "got error $msg\n";
17 $hdl->destroy; 17 $hdl->destroy;
18 $cv->send; 18 $cv->send;
19 }; 19 };
20 20
21 # send some request line 21 # send some request line
22 $hdl->push_write ("getinfo\015\012"); 22 $hdl->push_write ("getinfo\015\012");
23 23
24 # read the response line 24 # read the response line
25 $hdl->push_read (line => sub { 25 $hdl->push_read (line => sub {
26 my ($hdl, $line) = @_; 26 my ($hdl, $line) = @_;
27 warn "got line <$line>\n"; 27 AE::log warn => "got line <$line>\n";
28 $cv->send; 28 $cv->send;
29 }); 29 });
30 30
31 $cv->recv; 31 $cv->recv;
32 32
33=head1 DESCRIPTION 33=head1 DESCRIPTION
34 34
35This module is a helper module to make it easier to do event-based I/O on 35This is a helper module to make it easier to do event-based I/O on
36filehandles. 36stream-based filehandles (sockets, pipes, and other stream things).
37 37
38The L<AnyEvent::Intro> tutorial contains some well-documented 38The L<AnyEvent::Intro> tutorial contains some well-documented
39AnyEvent::Handle examples. 39AnyEvent::Handle examples.
40 40
41In the following, when the documentation refers to of "bytes" then this 41In the following, where the documentation refers to "bytes", it means
42means characters. As sysread and syswrite are used for all I/O, their 42characters. As sysread and syswrite are used for all I/O, their
43treatment of characters applies to this module as well. 43treatment of characters applies to this module as well.
44 44
45At the very minimum, you should specify C<fh> or C<connect>, and the 45At the very minimum, you should specify C<fh> or C<connect>, and the
46C<on_error> callback. 46C<on_error> callback.
47 47
… …
75 } 75 }
76 76
77 \&$func 77 \&$func
78} 78}
79 79
80sub MAX_READ_SIZE() { 131072 }
81
80=head1 METHODS 82=head1 METHODS
81 83
82=over 4 84=over 4
83 85
84=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... 86=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
… …
112=over 4 114=over 4
113 115
114=item on_prepare => $cb->($handle) 116=item on_prepare => $cb->($handle)
115 117
116This (rarely used) callback is called before a new connection is 118This (rarely used) callback is called before a new connection is
117attempted, but after the file handle has been created. It could be used to 119attempted, but after the file handle has been created (you can access that
120file handle via C<< $handle->{fh} >>). It could be used to prepare the
118prepare the file handle with parameters required for the actual connect 121file handle with parameters required for the actual connect (as opposed to
119(as opposed to settings that can be changed when the connection is already 122settings that can be changed when the connection is already established).
120established).
121 123
122The return value of this callback should be the connect timeout value in 124The return value of this callback should be the connect timeout value in
123seconds (or C<0>, or C<undef>, or the empty list, to indicate the default 125seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
124timeout is to be used). 126default timeout is to be used).
125 127
126=item on_connect => $cb->($handle, $host, $port, $retry->()) 128=item on_connect => $cb->($handle, $host, $port, $retry->())
127 129
128This callback is called when a connection has been successfully established. 130This callback is called when a connection has been successfully established.
129 131
130The actual numeric host and port (the socket peername) are passed as 132The peer's numeric host and port (the socket peername) are passed as
131parameters, together with a retry callback. 133parameters, together with a retry callback.
132 134
133When, for some reason, the handle is not acceptable, then calling 135If, for some reason, the handle is not acceptable, calling C<$retry>
134C<$retry> will continue with the next connection target (in case of 136will continue with the next connection target (in case of multi-homed
135multi-homed hosts or SRV records there can be multiple connection 137hosts or SRV records there can be multiple connection endpoints). At the
136endpoints). At the time it is called the read and write queues, eof 138time it is called the read and write queues, eof status, tls status and
137status, tls status and similar properties of the handle will have been 139similar properties of the handle will have been reset.
138reset.
139 140
140In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
141 142
142=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
143 144
144This callback is called when the connection could not be 145This callback is called when the connection could not be
145established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
… …
152 153
153=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
154 155
155This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
156occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
157connect or a read error. 158connect, or a read error.
158 159
159Some errors are fatal (which is indicated by C<$fatal> being true). On 160Some errors are fatal (which is indicated by C<$fatal> being true). On
160fatal errors the handle object will be destroyed (by a call to C<< -> 161fatal errors the handle object will be destroyed (by a call to C<< ->
161destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
162examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
163with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 164with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
164cases where the other side can close the connection at their will it is 165cases where the other side can close the connection at will, it is
165often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
166 167
167AnyEvent::Handle tries to find an appropriate error code for you to check 168AnyEvent::Handle tries to find an appropriate error code for you to check
168against, but in some cases (TLS errors), this does not work well. It is 169against, but in some cases (TLS errors), this does not work well. It is
169recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
170error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
171 172
172Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
173to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
174when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
175C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
176 177
177On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
178error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
179C<EPROTO>). 180C<EPROTO>).
180 181
181While not mandatory, it is I<highly> recommended to set this callback, as 182While not mandatory, it is I<highly> recommended to set this callback, as
182you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
183C<croak>. 184C<croak>.
184 185
185=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
186 187
187This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
192To access (and remove data from) the read buffer, use the C<< ->rbuf >> 193To access (and remove data from) the read buffer, use the C<< ->rbuf >>
193method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method or access the C<< $handle->{rbuf} >> member directly. Note that you
194must not enlarge or modify the read buffer, you can only remove data at 195must not enlarge or modify the read buffer, you can only remove data at
195the beginning from it. 196the beginning from it.
196 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
197When an EOF condition is detected then AnyEvent::Handle will first try to 201When an EOF condition is detected, AnyEvent::Handle will first try to
198feed all the remaining data to the queued callbacks and C<on_read> before 202feed all the remaining data to the queued callbacks and C<on_read> before
199calling the C<on_eof> callback. If no progress can be made, then a fatal 203calling the C<on_eof> callback. If no progress can be made, then a fatal
200error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
201 205
202Note that, unlike requests in the read queue, an C<on_read> callback 206Note that, unlike requests in the read queue, an C<on_read> callback
… …
221set, then a fatal error will be raised with C<$!> set to <0>. 225set, then a fatal error will be raised with C<$!> set to <0>.
222 226
223=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
224 228
225This sets the callback that is called when the write buffer becomes empty 229This sets the callback that is called when the write buffer becomes empty
226(or when the callback is set and the buffer is empty already). 230(or immediately if the buffer is empty already).
227 231
228To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
229 233
230This callback is useful when you don't want to put all of your write data 234This callback is useful when you don't want to put all of your write data
231into the queue at once, for example, when you want to write the contents 235into the queue at once, for example, when you want to write the contents
… …
243many seconds pass without a successful read or write on the underlying 247many seconds pass without a successful read or write on the underlying
244file handle (or a call to C<timeout_reset>), the C<on_timeout> callback 248file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
245will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> 249will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
246error will be raised). 250error will be raised).
247 251
248There are three variants of the timeouts that work fully independent 252There are three variants of the timeouts that work independently of each
249of each other, for both read and write, just read, and just write: 253other, for both read and write (triggered when nothing was read I<OR>
254written), just read (triggered when nothing was read), and just write:
250C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 255C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
251C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions 256C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
252C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 257C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
253 258
254Note that timeout processing is also active when you currently do not have 259Note that timeout processing is active even when you do not have any
255any outstanding read or write requests: If you plan to keep the connection 260outstanding read or write requests: If you plan to keep the connection
256idle then you should disable the timout temporarily or ignore the timeout 261idle then you should disable the timeout temporarily or ignore the
257in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 262timeout in the corresponding C<on_timeout> callback, in which case
258restart the timeout. 263AnyEvent::Handle will simply restart the timeout.
259 264
260Zero (the default) disables this timeout. 265Zero (the default) disables the corresponding timeout.
261 266
262=item on_timeout => $cb->($handle) 267=item on_timeout => $cb->($handle)
268
269=item on_rtimeout => $cb->($handle)
270
271=item on_wtimeout => $cb->($handle)
263 272
264Called whenever the inactivity timeout passes. If you return from this 273Called whenever the inactivity timeout passes. If you return from this
265callback, then the timeout will be reset as if some activity had happened, 274callback, then the timeout will be reset as if some activity had happened,
266so this condition is not fatal in any way. 275so this condition is not fatal in any way.
267 276
… …
275be configured to accept only so-and-so much data that it cannot act on 284be configured to accept only so-and-so much data that it cannot act on
276(for example, when expecting a line, an attacker could send an unlimited 285(for example, when expecting a line, an attacker could send an unlimited
277amount of data without a callback ever being called as long as the line 286amount of data without a callback ever being called as long as the line
278isn't finished). 287isn't finished).
279 288
289=item wbuf_max => <bytes>
290
291If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
292when the write buffer ever (strictly) exceeds this size. This is useful to
293avoid some forms of denial-of-service attacks.
294
295Although the units of this parameter is bytes, this is the I<raw> number
296of bytes not yet accepted by the kernel. This can make a difference when
297you e.g. use TLS, as TLS typically makes your write data larger (but it
298can also make it smaller due to compression).
299
300As an example of when this limit is useful, take a chat server that sends
301chat messages to a client. If the client does not read those in a timely
302manner then the send buffer in the server would grow unbounded.
303
280=item autocork => <boolean> 304=item autocork => <boolean>
281 305
282When disabled (the default), then C<push_write> will try to immediately 306When disabled (the default), C<push_write> will try to immediately
283write the data to the handle, if possible. This avoids having to register 307write the data to the handle if possible. This avoids having to register
284a write watcher and wait for the next event loop iteration, but can 308a write watcher and wait for the next event loop iteration, but can
285be inefficient if you write multiple small chunks (on the wire, this 309be inefficient if you write multiple small chunks (on the wire, this
286disadvantage is usually avoided by your kernel's nagle algorithm, see 310disadvantage is usually avoided by your kernel's nagle algorithm, see
287C<no_delay>, but this option can save costly syscalls). 311C<no_delay>, but this option can save costly syscalls).
288 312
289When enabled, then writes will always be queued till the next event loop 313When enabled, writes will always be queued till the next event loop
290iteration. This is efficient when you do many small writes per iteration, 314iteration. This is efficient when you do many small writes per iteration,
291but less efficient when you do a single write only per iteration (or when 315but less efficient when you do a single write only per iteration (or when
292the write buffer often is full). It also increases write latency. 316the write buffer often is full). It also increases write latency.
293 317
294=item no_delay => <boolean> 318=item no_delay => <boolean>
… …
298the Nagle algorithm, and usually it is beneficial. 322the Nagle algorithm, and usually it is beneficial.
299 323
300In some situations you want as low a delay as possible, which can be 324In some situations you want as low a delay as possible, which can be
301accomplishd by setting this option to a true value. 325accomplishd by setting this option to a true value.
302 326
303The default is your opertaing system's default behaviour (most likely 327The default is your operating system's default behaviour (most likely
304enabled), this option explicitly enables or disables it, if possible. 328enabled). This option explicitly enables or disables it, if possible.
305 329
306=item keepalive => <boolean> 330=item keepalive => <boolean>
307 331
308Enables (default disable) the SO_KEEPALIVE option on the stream socket: 332Enables (default disable) the SO_KEEPALIVE option on the stream socket:
309normally, TCP connections have no time-out once established, so TCP 333normally, TCP connections have no time-out once established, so TCP
310connections, once established, can stay alive forever even when the other 334connections, once established, can stay alive forever even when the other
311side has long gone. TCP keepalives are a cheap way to take down long-lived 335side has long gone. TCP keepalives are a cheap way to take down long-lived
312TCP connections whent he other side becomes unreachable. While the default 336TCP connections when the other side becomes unreachable. While the default
313is OS-dependent, TCP keepalives usually kick in after around two hours, 337is OS-dependent, TCP keepalives usually kick in after around two hours,
314and, if the other side doesn't reply, take down the TCP connection some 10 338and, if the other side doesn't reply, take down the TCP connection some 10
315to 15 minutes later. 339to 15 minutes later.
316 340
317It is harmless to specify this option for file handles that do not support 341It is harmless to specify this option for file handles that do not support
… …
335already have occured on BSD systems), but at least it will protect you 359already have occured on BSD systems), but at least it will protect you
336from most attacks. 360from most attacks.
337 361
338=item read_size => <bytes> 362=item read_size => <bytes>
339 363
340The default read block size (the amount of bytes this module will 364The initial read block size, the number of bytes this module will try
341try to read during each loop iteration, which affects memory 365to read during each loop iteration. Each handle object will consume
342requirements). Default: C<8192>. 366at least this amount of memory for the read buffer as well, so when
367handling many connections watch out for memory requirements). See also
368C<max_read_size>. Default: C<2048>.
369
370=item max_read_size => <bytes>
371
372The maximum read buffer size used by the dynamic adjustment
373algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
374one go it will double C<read_size> up to the maximum given by this
375option. Default: C<131072> or C<read_size>, whichever is higher.
343 376
344=item low_water_mark => <bytes> 377=item low_water_mark => <bytes>
345 378
346Sets the amount of bytes (default: C<0>) that make up an "empty" write 379Sets the number of bytes (default: C<0>) that make up an "empty" write
347buffer: If the write reaches this size or gets even samller it is 380buffer: If the buffer reaches this size or gets even samller it is
348considered empty. 381considered empty.
349 382
350Sometimes it can be beneficial (for performance reasons) to add data to 383Sometimes it can be beneficial (for performance reasons) to add data to
351the write buffer before it is fully drained, but this is a rare case, as 384the write buffer before it is fully drained, but this is a rare case, as
352the operating system kernel usually buffers data as well, so the default 385the operating system kernel usually buffers data as well, so the default
353is good in almost all cases. 386is good in almost all cases.
354 387
355=item linger => <seconds> 388=item linger => <seconds>
356 389
357If non-zero (default: C<3600>), then the destructor of the 390If this is non-zero (default: C<3600>), the destructor of the
358AnyEvent::Handle object will check whether there is still outstanding 391AnyEvent::Handle object will check whether there is still outstanding
359write data and will install a watcher that will write this data to the 392write data and will install a watcher that will write this data to the
360socket. No errors will be reported (this mostly matches how the operating 393socket. No errors will be reported (this mostly matches how the operating
361system treats outstanding data at socket close time). 394system treats outstanding data at socket close time).
362 395
… …
369A string used to identify the remote site - usually the DNS hostname 402A string used to identify the remote site - usually the DNS hostname
370(I<not> IDN!) used to create the connection, rarely the IP address. 403(I<not> IDN!) used to create the connection, rarely the IP address.
371 404
372Apart from being useful in error messages, this string is also used in TLS 405Apart from being useful in error messages, this string is also used in TLS
373peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 406peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
374verification will be skipped when C<peername> is not specified or 407verification will be skipped when C<peername> is not specified or is
375C<undef>. 408C<undef>.
376 409
377=item tls => "accept" | "connect" | Net::SSLeay::SSL object 410=item tls => "accept" | "connect" | Net::SSLeay::SSL object
378 411
379When this parameter is given, it enables TLS (SSL) mode, that means 412When this parameter is given, it enables TLS (SSL) mode, that means
… …
405B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 438B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
406passing in the wrong integer will lead to certain crash. This most often 439passing in the wrong integer will lead to certain crash. This most often
407happens when one uses a stylish C<< tls => 1 >> and is surprised about the 440happens when one uses a stylish C<< tls => 1 >> and is surprised about the
408segmentation fault. 441segmentation fault.
409 442
410See the C<< ->starttls >> method for when need to start TLS negotiation later. 443Use the C<< ->starttls >> method if you need to start TLS negotiation later.
411 444
412=item tls_ctx => $anyevent_tls 445=item tls_ctx => $anyevent_tls
413 446
414Use the given C<AnyEvent::TLS> object to create the new TLS connection 447Use the given C<AnyEvent::TLS> object to create the new TLS connection
415(unless a connection object was specified directly). If this parameter is 448(unless a connection object was specified directly). If this
416missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 449parameter is missing (or C<undef>), then AnyEvent::Handle will use
450C<AnyEvent::Handle::TLS_CTX>.
417 451
418Instead of an object, you can also specify a hash reference with C<< key 452Instead of an object, you can also specify a hash reference with C<< key
419=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a 453=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
420new TLS context object. 454new TLS context object.
421 455
… …
430 464
431TLS handshake failures will not cause C<on_error> to be invoked when this 465TLS handshake failures will not cause C<on_error> to be invoked when this
432callback is in effect, instead, the error message will be passed to C<on_starttls>. 466callback is in effect, instead, the error message will be passed to C<on_starttls>.
433 467
434Without this callback, handshake failures lead to C<on_error> being 468Without this callback, handshake failures lead to C<on_error> being
435called, as normal. 469called as usual.
436 470
437Note that you cannot call C<starttls> right again in this callback. If you 471Note that you cannot just call C<starttls> again in this callback. If you
438need to do that, start an zero-second timer instead whose callback can 472need to do that, start an zero-second timer instead whose callback can
439then call C<< ->starttls >> again. 473then call C<< ->starttls >> again.
440 474
441=item on_stoptls => $cb->($handle) 475=item on_stoptls => $cb->($handle)
442 476
… …
490 $self->{connect}[0], 524 $self->{connect}[0],
491 $self->{connect}[1], 525 $self->{connect}[1],
492 sub { 526 sub {
493 my ($fh, $host, $port, $retry) = @_; 527 my ($fh, $host, $port, $retry) = @_;
494 528
529 delete $self->{_connect}; # no longer needed
530
495 if ($fh) { 531 if ($fh) {
496 $self->{fh} = $fh; 532 $self->{fh} = $fh;
497 533
498 delete $self->{_skip_drain_rbuf}; 534 delete $self->{_skip_drain_rbuf};
499 $self->_start; 535 $self->_start;
… …
506 }); 542 });
507 543
508 } else { 544 } else {
509 if ($self->{on_connect_error}) { 545 if ($self->{on_connect_error}) {
510 $self->{on_connect_error}($self, "$!"); 546 $self->{on_connect_error}($self, "$!");
511 $self->destroy; 547 $self->destroy if $self;
512 } else { 548 } else {
513 $self->_error ($!, 1); 549 $self->_error ($!, 1);
514 } 550 }
515 } 551 }
516 }, 552 },
517 sub { 553 sub {
518 local $self->{fh} = $_[0]; 554 local $self->{fh} = $_[0];
519 555
520 $self->{on_prepare} 556 $self->{on_prepare}
521 ? $self->{on_prepare}->($self) 557 ? $self->{on_prepare}->($self)
522 : () 558 : ()
523 } 559 }
524 ); 560 );
525 } 561 }
526 562
… …
532} 568}
533 569
534sub _start { 570sub _start {
535 my ($self) = @_; 571 my ($self) = @_;
536 572
573 # too many clueless people try to use udp and similar sockets
574 # with AnyEvent::Handle, do them a favour.
575 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
576 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
577 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
578
537 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 579 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
538 580
539 $self->{_activity} = 581 $self->{_activity} =
540 $self->{_ractivity} = 582 $self->{_ractivity} =
541 $self->{_wactivity} = AE::now; 583 $self->{_wactivity} = AE::now;
542 584
585 $self->{read_size} ||= 2048;
586 $self->{max_read_size} = $self->{read_size}
587 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
588
543 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 589 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
544 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; 590 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
545 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; 591 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
546 592
547 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; 593 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
… …
550 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); 596 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
551 597
552 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 598 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
553 if $self->{tls}; 599 if $self->{tls};
554 600
555 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 601 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
556 602
557 $self->start_read 603 $self->start_read
558 if $self->{on_read} || @{ $self->{_queue} }; 604 if $self->{on_read} || @{ $self->{_queue} };
559 605
560 $self->_drain_wbuf; 606 $self->_drain_wbuf;
… …
636=cut 682=cut
637 683
638sub no_delay { 684sub no_delay {
639 $_[0]{no_delay} = $_[1]; 685 $_[0]{no_delay} = $_[1];
640 686
641 eval {
642 local $SIG{__DIE__};
643 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] 687 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
644 if $_[0]{fh}; 688 if $_[0]{fh};
645 };
646} 689}
647 690
648=item $handle->keepalive ($boolean) 691=item $handle->keepalive ($boolean)
649 692
650Enables or disables the C<keepalive> setting (see constructor argument of 693Enables or disables the C<keepalive> setting (see constructor argument of
… …
718 761
719=item $handle->rbuf_max ($max_octets) 762=item $handle->rbuf_max ($max_octets)
720 763
721Configures the C<rbuf_max> setting (C<undef> disables it). 764Configures the C<rbuf_max> setting (C<undef> disables it).
722 765
766=item $handle->wbuf_max ($max_octets)
767
768Configures the C<wbuf_max> setting (C<undef> disables it).
769
723=cut 770=cut
724 771
725sub rbuf_max { 772sub rbuf_max {
726 $_[0]{rbuf_max} = $_[1]; 773 $_[0]{rbuf_max} = $_[1];
727} 774}
728 775
776sub wbuf_max {
777 $_[0]{wbuf_max} = $_[1];
778}
779
729############################################################################# 780#############################################################################
730 781
731=item $handle->timeout ($seconds) 782=item $handle->timeout ($seconds)
732 783
733=item $handle->rtimeout ($seconds) 784=item $handle->rtimeout ($seconds)
734 785
735=item $handle->wtimeout ($seconds) 786=item $handle->wtimeout ($seconds)
736 787
737Configures (or disables) the inactivity timeout. 788Configures (or disables) the inactivity timeout.
789
790The timeout will be checked instantly, so this method might destroy the
791handle before it returns.
738 792
739=item $handle->timeout_reset 793=item $handle->timeout_reset
740 794
741=item $handle->rtimeout_reset 795=item $handle->rtimeout_reset
742 796
… …
759 $_[0]{$on_timeout} = $_[1]; 813 $_[0]{$on_timeout} = $_[1];
760 }; 814 };
761 815
762 *$timeout = sub { 816 *$timeout = sub {
763 my ($self, $new_value) = @_; 817 my ($self, $new_value) = @_;
818
819 $new_value >= 0
820 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
764 821
765 $self->{$timeout} = $new_value; 822 $self->{$timeout} = $new_value;
766 delete $self->{$tw}; &$cb; 823 delete $self->{$tw}; &$cb;
767 }; 824 };
768 825
… …
832=item $handle->on_drain ($cb) 889=item $handle->on_drain ($cb)
833 890
834Sets the C<on_drain> callback or clears it (see the description of 891Sets the C<on_drain> callback or clears it (see the description of
835C<on_drain> in the constructor). 892C<on_drain> in the constructor).
836 893
894This method may invoke callbacks (and therefore the handle might be
895destroyed after it returns).
896
837=cut 897=cut
838 898
839sub on_drain { 899sub on_drain {
840 my ($self, $cb) = @_; 900 my ($self, $cb) = @_;
841 901
… …
845 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); 905 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
846} 906}
847 907
848=item $handle->push_write ($data) 908=item $handle->push_write ($data)
849 909
850Queues the given scalar to be written. You can push as much data as you 910Queues the given scalar to be written. You can push as much data as
851want (only limited by the available memory), as C<AnyEvent::Handle> 911you want (only limited by the available memory and C<wbuf_max>), as
852buffers it independently of the kernel. 912C<AnyEvent::Handle> buffers it independently of the kernel.
913
914This method may invoke callbacks (and therefore the handle might be
915destroyed after it returns).
853 916
854=cut 917=cut
855 918
856sub _drain_wbuf { 919sub _drain_wbuf {
857 my ($self) = @_; 920 my ($self) = @_;
… …
882 $cb->() unless $self->{autocork}; 945 $cb->() unless $self->{autocork};
883 946
884 # if still data left in wbuf, we need to poll 947 # if still data left in wbuf, we need to poll
885 $self->{_ww} = AE::io $self->{fh}, 1, $cb 948 $self->{_ww} = AE::io $self->{fh}, 1, $cb
886 if length $self->{wbuf}; 949 if length $self->{wbuf};
950
951 if (
952 defined $self->{wbuf_max}
953 && $self->{wbuf_max} < length $self->{wbuf}
954 ) {
955 $self->_error (Errno::ENOSPC, 1), return;
956 }
887 }; 957 };
888} 958}
889 959
890our %WH; 960our %WH;
891 961
… …
921 991
922Instead of formatting your data yourself, you can also let this module 992Instead of formatting your data yourself, you can also let this module
923do the job by specifying a type and type-specific arguments. You 993do the job by specifying a type and type-specific arguments. You
924can also specify the (fully qualified) name of a package, in which 994can also specify the (fully qualified) name of a package, in which
925case AnyEvent tries to load the package and then expects to find the 995case AnyEvent tries to load the package and then expects to find the
926C<anyevent_read_type> function inside (see "custom write types", below). 996C<anyevent_write_type> function inside (see "custom write types", below).
927 997
928Predefined types are (if you have ideas for additional types, feel free to 998Predefined types are (if you have ideas for additional types, feel free to
929drop by and tell us): 999drop by and tell us):
930 1000
931=over 4 1001=over 4
… …
1026before it was actually written. One way to do that is to replace your 1096before it was actually written. One way to do that is to replace your
1027C<on_drain> handler by a callback that shuts down the socket (and set 1097C<on_drain> handler by a callback that shuts down the socket (and set
1028C<low_water_mark> to C<0>). This method is a shorthand for just that, and 1098C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1029replaces the C<on_drain> callback with: 1099replaces the C<on_drain> callback with:
1030 1100
1031 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown 1101 sub { shutdown $_[0]{fh}, 1 }
1032 1102
1033This simply shuts down the write side and signals an EOF condition to the 1103This simply shuts down the write side and signals an EOF condition to the
1034the peer. 1104the peer.
1035 1105
1036You can rely on the normal read queue and C<on_eof> handling 1106You can rely on the normal read queue and C<on_eof> handling
1037afterwards. This is the cleanest way to close a connection. 1107afterwards. This is the cleanest way to close a connection.
1108
1109This method may invoke callbacks (and therefore the handle might be
1110destroyed after it returns).
1038 1111
1039=cut 1112=cut
1040 1113
1041sub push_shutdown { 1114sub push_shutdown {
1042 my ($self) = @_; 1115 my ($self) = @_;
… …
1092ways, the "simple" way, using only C<on_read> and the "complex" way, using 1165ways, the "simple" way, using only C<on_read> and the "complex" way, using
1093a queue. 1166a queue.
1094 1167
1095In the simple case, you just install an C<on_read> callback and whenever 1168In the simple case, you just install an C<on_read> callback and whenever
1096new data arrives, it will be called. You can then remove some data (if 1169new data arrives, it will be called. You can then remove some data (if
1097enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1170enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
1098leave the data there if you want to accumulate more (e.g. when only a 1171leave the data there if you want to accumulate more (e.g. when only a
1099partial message has been received so far). 1172partial message has been received so far), or change the read queue with
1173e.g. C<push_read>.
1100 1174
1101In the more complex case, you want to queue multiple callbacks. In this 1175In the more complex case, you want to queue multiple callbacks. In this
1102case, AnyEvent::Handle will call the first queued callback each time new 1176case, AnyEvent::Handle will call the first queued callback each time new
1103data arrives (also the first time it is queued) and removes it when it has 1177data arrives (also the first time it is queued) and remove it when it has
1104done its job (see C<push_read>, below). 1178done its job (see C<push_read>, below).
1105 1179
1106This way you can, for example, push three line-reads, followed by reading 1180This way you can, for example, push three line-reads, followed by reading
1107a chunk of data, and AnyEvent::Handle will execute them in order. 1181a chunk of data, and AnyEvent::Handle will execute them in order.
1108 1182
… …
1239 1313
1240This replaces the currently set C<on_read> callback, or clears it (when 1314This replaces the currently set C<on_read> callback, or clears it (when
1241the new callback is C<undef>). See the description of C<on_read> in the 1315the new callback is C<undef>). See the description of C<on_read> in the
1242constructor. 1316constructor.
1243 1317
1318This method may invoke callbacks (and therefore the handle might be
1319destroyed after it returns).
1320
1244=cut 1321=cut
1245 1322
1246sub on_read { 1323sub on_read {
1247 my ($self, $cb) = @_; 1324 my ($self, $cb) = @_;
1248 1325
… …
1250 $self->_drain_rbuf if $cb; 1327 $self->_drain_rbuf if $cb;
1251} 1328}
1252 1329
1253=item $handle->rbuf 1330=item $handle->rbuf
1254 1331
1255Returns the read buffer (as a modifiable lvalue). 1332Returns the read buffer (as a modifiable lvalue). You can also access the
1333read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1334much faster, and no less clean).
1256 1335
1257You can access the read buffer directly as the C<< ->{rbuf} >> 1336The only operation allowed on the read buffer (apart from looking at it)
1258member, if you want. However, the only operation allowed on the 1337is removing data from its beginning. Otherwise modifying or appending to
1259read buffer (apart from looking at it) is removing data from its 1338it is not allowed and will lead to hard-to-track-down bugs.
1260beginning. Otherwise modifying or appending to it is not allowed and will
1261lead to hard-to-track-down bugs.
1262 1339
1263NOTE: The read buffer should only be used or modified if the C<on_read>, 1340NOTE: The read buffer should only be used or modified in the C<on_read>
1264C<push_read> or C<unshift_read> methods are used. The other read methods 1341callback or when C<push_read> or C<unshift_read> are used with a single
1265automatically manage the read buffer. 1342callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1343will manage the read buffer on their own.
1266 1344
1267=cut 1345=cut
1268 1346
1269sub rbuf : lvalue { 1347sub rbuf : lvalue {
1270 $_[0]{rbuf} 1348 $_[0]{rbuf}
… …
1287 1365
1288If enough data was available, then the callback must remove all data it is 1366If enough data was available, then the callback must remove all data it is
1289interested in (which can be none at all) and return a true value. After returning 1367interested in (which can be none at all) and return a true value. After returning
1290true, it will be removed from the queue. 1368true, it will be removed from the queue.
1291 1369
1370These methods may invoke callbacks (and therefore the handle might be
1371destroyed after it returns).
1372
1292=cut 1373=cut
1293 1374
1294our %RH; 1375our %RH;
1295 1376
1296sub register_read_type($$) { 1377sub register_read_type($$) {
… …
1318 my $cb = pop; 1399 my $cb = pop;
1319 1400
1320 if (@_) { 1401 if (@_) {
1321 my $type = shift; 1402 my $type = shift;
1322 1403
1404 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1323 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1405 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1324 ->($self, $cb, @_); 1406 ->($self, $cb, @_);
1325 } 1407 }
1326 1408
1327 unshift @{ $self->{_queue} }, $cb; 1409 unshift @{ $self->{_queue} }, $cb;
1328 $self->_drain_rbuf; 1410 $self->_drain_rbuf;
… …
1350data. 1432data.
1351 1433
1352Example: read 2 bytes. 1434Example: read 2 bytes.
1353 1435
1354 $handle->push_read (chunk => 2, sub { 1436 $handle->push_read (chunk => 2, sub {
1355 warn "yay ", unpack "H*", $_[1]; 1437 AE::log debug => "yay " . unpack "H*", $_[1];
1356 }); 1438 });
1357 1439
1358=cut 1440=cut
1359 1441
1360register_read_type chunk => sub { 1442register_read_type chunk => sub {
… …
1436the receive buffer when neither C<$accept> nor C<$reject> match, 1518the receive buffer when neither C<$accept> nor C<$reject> match,
1437and everything preceding and including the match will be accepted 1519and everything preceding and including the match will be accepted
1438unconditionally. This is useful to skip large amounts of data that you 1520unconditionally. This is useful to skip large amounts of data that you
1439know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1521know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1440have to start matching from the beginning. This is purely an optimisation 1522have to start matching from the beginning. This is purely an optimisation
1441and is usually worth only when you expect more than a few kilobytes. 1523and is usually worth it only when you expect more than a few kilobytes.
1442 1524
1443Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1525Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1444expect the header to be very large (it isn't in practise, but...), we use 1526expect the header to be very large (it isn't in practice, but...), we use
1445a skip regex to skip initial portions. The skip regex is tricky in that 1527a skip regex to skip initial portions. The skip regex is tricky in that
1446it only accepts something not ending in either \015 or \012, as these are 1528it only accepts something not ending in either \015 or \012, as these are
1447required for the accept regex. 1529required for the accept regex.
1448 1530
1449 $handle->push_read (regex => 1531 $handle->push_read (regex =>
… …
1462 1544
1463 sub { 1545 sub {
1464 # accept 1546 # accept
1465 if ($$rbuf =~ $accept) { 1547 if ($$rbuf =~ $accept) {
1466 $data .= substr $$rbuf, 0, $+[0], ""; 1548 $data .= substr $$rbuf, 0, $+[0], "";
1467 $cb->($self, $data); 1549 $cb->($_[0], $data);
1468 return 1; 1550 return 1;
1469 } 1551 }
1470 1552
1471 # reject 1553 # reject
1472 if ($reject && $$rbuf =~ $reject) { 1554 if ($reject && $$rbuf =~ $reject) {
1473 $self->_error (Errno::EBADMSG); 1555 $_[0]->_error (Errno::EBADMSG);
1474 } 1556 }
1475 1557
1476 # skip 1558 # skip
1477 if ($skip && $$rbuf =~ $skip) { 1559 if ($skip && $$rbuf =~ $skip) {
1478 $data .= substr $$rbuf, 0, $+[0], ""; 1560 $data .= substr $$rbuf, 0, $+[0], "";
… …
1494 my ($self, $cb) = @_; 1576 my ($self, $cb) = @_;
1495 1577
1496 sub { 1578 sub {
1497 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1579 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1498 if ($_[0]{rbuf} =~ /[^0-9]/) { 1580 if ($_[0]{rbuf} =~ /[^0-9]/) {
1499 $self->_error (Errno::EBADMSG); 1581 $_[0]->_error (Errno::EBADMSG);
1500 } 1582 }
1501 return; 1583 return;
1502 } 1584 }
1503 1585
1504 my $len = $1; 1586 my $len = $1;
1505 1587
1506 $self->unshift_read (chunk => $len, sub { 1588 $_[0]->unshift_read (chunk => $len, sub {
1507 my $string = $_[1]; 1589 my $string = $_[1];
1508 $_[0]->unshift_read (chunk => 1, sub { 1590 $_[0]->unshift_read (chunk => 1, sub {
1509 if ($_[1] eq ",") { 1591 if ($_[1] eq ",") {
1510 $cb->($_[0], $string); 1592 $cb->($_[0], $string);
1511 } else { 1593 } else {
1512 $self->_error (Errno::EBADMSG); 1594 $_[0]->_error (Errno::EBADMSG);
1513 } 1595 }
1514 }); 1596 });
1515 }); 1597 });
1516 1598
1517 1 1599 1
… …
1590 1672
1591 my $data; 1673 my $data;
1592 my $rbuf = \$self->{rbuf}; 1674 my $rbuf = \$self->{rbuf};
1593 1675
1594 sub { 1676 sub {
1595 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1677 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1596 1678
1597 if ($ref) { 1679 if ($ref) {
1598 $self->{rbuf} = $json->incr_text; 1680 $_[0]{rbuf} = $json->incr_text;
1599 $json->incr_text = ""; 1681 $json->incr_text = "";
1600 $cb->($self, $ref); 1682 $cb->($_[0], $ref);
1601 1683
1602 1 1684 1
1603 } elsif ($@) { 1685 } elsif ($@) {
1604 # error case 1686 # error case
1605 $json->incr_skip; 1687 $json->incr_skip;
1606 1688
1607 $self->{rbuf} = $json->incr_text; 1689 $_[0]{rbuf} = $json->incr_text;
1608 $json->incr_text = ""; 1690 $json->incr_text = "";
1609 1691
1610 $self->_error (Errno::EBADMSG); 1692 $_[0]->_error (Errno::EBADMSG);
1611 1693
1612 () 1694 ()
1613 } else { 1695 } else {
1614 $self->{rbuf} = ""; 1696 $_[0]{rbuf} = "";
1615 1697
1616 () 1698 ()
1617 } 1699 }
1618 } 1700 }
1619}; 1701};
… …
1652 # read remaining chunk 1734 # read remaining chunk
1653 $_[0]->unshift_read (chunk => $len, sub { 1735 $_[0]->unshift_read (chunk => $len, sub {
1654 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1736 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1655 $cb->($_[0], $ref); 1737 $cb->($_[0], $ref);
1656 } else { 1738 } else {
1657 $self->_error (Errno::EBADMSG); 1739 $_[0]->_error (Errno::EBADMSG);
1658 } 1740 }
1659 }); 1741 });
1660 } 1742 }
1661 1743
1662 1 1744 1
… …
1700Note that AnyEvent::Handle will automatically C<start_read> for you when 1782Note that AnyEvent::Handle will automatically C<start_read> for you when
1701you change the C<on_read> callback or push/unshift a read callback, and it 1783you change the C<on_read> callback or push/unshift a read callback, and it
1702will automatically C<stop_read> for you when neither C<on_read> is set nor 1784will automatically C<stop_read> for you when neither C<on_read> is set nor
1703there are any read requests in the queue. 1785there are any read requests in the queue.
1704 1786
1705These methods will have no effect when in TLS mode (as TLS doesn't support 1787In older versions of this module (<= 5.3), these methods had no effect,
1706half-duplex connections). 1788as TLS does not support half-duplex connections. In current versions they
1789work as expected, as this behaviour is required to avoid certain resource
1790attacks, where the program would be forced to read (and buffer) arbitrary
1791amounts of data before being able to send some data. The drawback is that
1792some readings of the the SSL/TLS specifications basically require this
1793attack to be working, as SSL/TLS implementations might stall sending data
1794during a rehandshake.
1795
1796As a guideline, during the initial handshake, you should not stop reading,
1797and as a client, it might cause problems, depending on your applciation.
1707 1798
1708=cut 1799=cut
1709 1800
1710sub stop_read { 1801sub stop_read {
1711 my ($self) = @_; 1802 my ($self) = @_;
1712 1803
1713 delete $self->{_rw} unless $self->{tls}; 1804 delete $self->{_rw};
1714} 1805}
1715 1806
1716sub start_read { 1807sub start_read {
1717 my ($self) = @_; 1808 my ($self) = @_;
1718 1809
1719 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { 1810 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1720 Scalar::Util::weaken $self; 1811 Scalar::Util::weaken $self;
1721 1812
1722 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1813 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1723 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1814 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1724 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1815 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1725 1816
1726 if ($len > 0) { 1817 if ($len > 0) {
1727 $self->{_activity} = $self->{_ractivity} = AE::now; 1818 $self->{_activity} = $self->{_ractivity} = AE::now;
1728 1819
1729 if ($self->{tls}) { 1820 if ($self->{tls}) {
1730 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1821 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1731 1822
1732 &_dotls ($self); 1823 &_dotls ($self);
1733 } else { 1824 } else {
1734 $self->_drain_rbuf; 1825 $self->_drain_rbuf;
1826 }
1827
1828 if ($len == $self->{read_size}) {
1829 $self->{read_size} *= 2;
1830 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1831 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1735 } 1832 }
1736 1833
1737 } elsif (defined $len) { 1834 } elsif (defined $len) {
1738 delete $self->{_rw}; 1835 delete $self->{_rw};
1739 $self->{_eof} = 1; 1836 $self->{_eof} = 1;
… …
1849context in C<< $handle->{tls_ctx} >> after this call and can be used or 1946context in C<< $handle->{tls_ctx} >> after this call and can be used or
1850changed to your liking. Note that the handshake might have already started 1947changed to your liking. Note that the handshake might have already started
1851when this function returns. 1948when this function returns.
1852 1949
1853Due to bugs in OpenSSL, it might or might not be possible to do multiple 1950Due to bugs in OpenSSL, it might or might not be possible to do multiple
1854handshakes on the same stream. Best do not attempt to use the stream after 1951handshakes on the same stream. It is best to not attempt to use the
1855stopping TLS. 1952stream after stopping TLS.
1953
1954This method may invoke callbacks (and therefore the handle might be
1955destroyed after it returns).
1856 1956
1857=cut 1957=cut
1858 1958
1859our %TLS_CACHE; #TODO not yet documented, should we? 1959our %TLS_CACHE; #TODO not yet documented, should we?
1860 1960
… …
1911 Net::SSLeay::CTX_set_mode ($tls, 1|2); 2011 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1912 2012
1913 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2013 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1914 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2014 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1915 2015
1916 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); 2016 Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
2017 $self->{rbuf} = "";
1917 2018
1918 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 2019 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1919 2020
1920 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 2021 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1921 if $self->{on_starttls}; 2022 if $self->{on_starttls};
… …
1929Shuts down the SSL connection - this makes a proper EOF handshake by 2030Shuts down the SSL connection - this makes a proper EOF handshake by
1930sending a close notify to the other side, but since OpenSSL doesn't 2031sending a close notify to the other side, but since OpenSSL doesn't
1931support non-blocking shut downs, it is not guaranteed that you can re-use 2032support non-blocking shut downs, it is not guaranteed that you can re-use
1932the stream afterwards. 2033the stream afterwards.
1933 2034
2035This method may invoke callbacks (and therefore the handle might be
2036destroyed after it returns).
2037
1934=cut 2038=cut
1935 2039
1936sub stoptls { 2040sub stoptls {
1937 my ($self) = @_; 2041 my ($self) = @_;
1938 2042
… …
1956 if $self->{tls} > 0; 2060 if $self->{tls} > 0;
1957 2061
1958 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 2062 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1959} 2063}
1960 2064
2065=item $handle->resettls
2066
2067This rarely-used method simply resets and TLS state on the handle, usually
2068causing data loss.
2069
2070One case where it may be useful is when you want to skip over the data in
2071the stream but you are not interested in interpreting it, so data loss is
2072no concern.
2073
2074=cut
2075
2076*resettls = \&_freetls;
2077
1961sub DESTROY { 2078sub DESTROY {
1962 my ($self) = @_; 2079 my ($self) = @_;
1963 2080
1964 &_freetls; 2081 &_freetls;
1965 2082
… …
1974 push @linger, AE::io $fh, 1, sub { 2091 push @linger, AE::io $fh, 1, sub {
1975 my $len = syswrite $fh, $wbuf, length $wbuf; 2092 my $len = syswrite $fh, $wbuf, length $wbuf;
1976 2093
1977 if ($len > 0) { 2094 if ($len > 0) {
1978 substr $wbuf, 0, $len, ""; 2095 substr $wbuf, 0, $len, "";
1979 } else { 2096 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1980 @linger = (); # end 2097 @linger = (); # end
1981 } 2098 }
1982 }; 2099 };
1983 push @linger, AE::timer $linger, 0, sub { 2100 push @linger, AE::timer $linger, 0, sub {
1984 @linger = (); 2101 @linger = ();
… …
2080 2197
2081It is only safe to "forget" the reference inside EOF or error callbacks, 2198It is only safe to "forget" the reference inside EOF or error callbacks,
2082from within all other callbacks, you need to explicitly call the C<< 2199from within all other callbacks, you need to explicitly call the C<<
2083->destroy >> method. 2200->destroy >> method.
2084 2201
2202=item Why is my C<on_eof> callback never called?
2203
2204Probably because your C<on_error> callback is being called instead: When
2205you have outstanding requests in your read queue, then an EOF is
2206considered an error as you clearly expected some data.
2207
2208To avoid this, make sure you have an empty read queue whenever your handle
2209is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
2210an C<on_read> handler that simply pushes the first read requests in the
2211queue.
2212
2213See also the next question, which explains this in a bit more detail.
2214
2215=item How can I serve requests in a loop?
2216
2217Most protocols consist of some setup phase (authentication for example)
2218followed by a request handling phase, where the server waits for requests
2219and handles them, in a loop.
2220
2221There are two important variants: The first (traditional, better) variant
2222handles requests until the server gets some QUIT command, causing it to
2223close the connection first (highly desirable for a busy TCP server). A
2224client dropping the connection is an error, which means this variant can
2225detect an unexpected detection close.
2226
2227To handle this case, always make sure you have a on-empty read queue, by
2228pushing the "read request start" handler on it:
2229
2230 # we assume a request starts with a single line
2231 my @start_request; @start_request = (line => sub {
2232 my ($hdl, $line) = @_;
2233
2234 ... handle request
2235
2236 # push next request read, possibly from a nested callback
2237 $hdl->push_read (@start_request);
2238 });
2239
2240 # auth done, now go into request handling loop
2241 # now push the first @start_request
2242 $hdl->push_read (@start_request);
2243
2244By always having an outstanding C<push_read>, the handle always expects
2245some data and raises the C<EPIPE> error when the connction is dropped
2246unexpectedly.
2247
2248The second variant is a protocol where the client can drop the connection
2249at any time. For TCP, this means that the server machine may run out of
2250sockets easier, and in general, it means you cnanot distinguish a protocl
2251failure/client crash from a normal connection close. Nevertheless, these
2252kinds of protocols are common (and sometimes even the best solution to the
2253problem).
2254
2255Having an outstanding read request at all times is possible if you ignore
2256C<EPIPE> errors, but this doesn't help with when the client drops the
2257connection during a request, which would still be an error.
2258
2259A better solution is to push the initial request read in an C<on_read>
2260callback. This avoids an error, as when the server doesn't expect data
2261(i.e. is idly waiting for the next request, an EOF will not raise an
2262error, but simply result in an C<on_eof> callback. It is also a bit slower
2263and simpler:
2264
2265 # auth done, now go into request handling loop
2266 $hdl->on_read (sub {
2267 my ($hdl) = @_;
2268
2269 # called each time we receive data but the read queue is empty
2270 # simply start read the request
2271
2272 $hdl->push_read (line => sub {
2273 my ($hdl, $line) = @_;
2274
2275 ... handle request
2276
2277 # do nothing special when the request has been handled, just
2278 # let the request queue go empty.
2279 });
2280 });
2281
2085=item I get different callback invocations in TLS mode/Why can't I pause 2282=item I get different callback invocations in TLS mode/Why can't I pause
2086reading? 2283reading?
2087 2284
2088Unlike, say, TCP, TLS connections do not consist of two independent 2285Unlike, say, TCP, TLS connections do not consist of two independent
2089communication channels, one for each direction. Or put differently. The 2286communication channels, one for each direction. Or put differently, the
2090read and write directions are not independent of each other: you cannot 2287read and write directions are not independent of each other: you cannot
2091write data unless you are also prepared to read, and vice versa. 2288write data unless you are also prepared to read, and vice versa.
2092 2289
2093This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2290This means that, in TLS mode, you might get C<on_error> or C<on_eof>
2094callback invocations when you are not expecting any read data - the reason 2291callback invocations when you are not expecting any read data - the reason
2095is that AnyEvent::Handle always reads in TLS mode. 2292is that AnyEvent::Handle always reads in TLS mode.
2096 2293
2097During the connection, you have to make sure that you always have a 2294During the connection, you have to make sure that you always have a
2098non-empty read-queue, or an C<on_read> watcher. At the end of the 2295non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
2110 $handle->on_eof (undef); 2307 $handle->on_eof (undef);
2111 $handle->on_error (sub { 2308 $handle->on_error (sub {
2112 my $data = delete $_[0]{rbuf}; 2309 my $data = delete $_[0]{rbuf};
2113 }); 2310 });
2114 2311
2312Note that this example removes the C<rbuf> member from the handle object,
2313which is not normally allowed by the API. It is expressly permitted in
2314this case only, as the handle object needs to be destroyed afterwards.
2315
2115The reason to use C<on_error> is that TCP connections, due to latencies 2316The reason to use C<on_error> is that TCP connections, due to latencies
2116and packets loss, might get closed quite violently with an error, when in 2317and packets loss, might get closed quite violently with an error, when in
2117fact, all data has been received. 2318fact all data has been received.
2118 2319
2119It is usually better to use acknowledgements when transferring data, 2320It is usually better to use acknowledgements when transferring data,
2120to make sure the other side hasn't just died and you got the data 2321to make sure the other side hasn't just died and you got the data
2121intact. This is also one reason why so many internet protocols have an 2322intact. This is also one reason why so many internet protocols have an
2122explicit QUIT command. 2323explicit QUIT command.
… …
2129C<low_water_mark> this will be called precisely when all data has been 2330C<low_water_mark> this will be called precisely when all data has been
2130written to the socket: 2331written to the socket:
2131 2332
2132 $handle->push_write (...); 2333 $handle->push_write (...);
2133 $handle->on_drain (sub { 2334 $handle->on_drain (sub {
2134 warn "all data submitted to the kernel\n"; 2335 AE::log debug => "all data submitted to the kernel\n";
2135 undef $handle; 2336 undef $handle;
2136 }); 2337 });
2137 2338
2138If you just want to queue some data and then signal EOF to the other side, 2339If you just want to queue some data and then signal EOF to the other side,
2139consider using C<< ->push_shutdown >> instead. 2340consider using C<< ->push_shutdown >> instead.
2140 2341
2141=item I want to contact a TLS/SSL server, I don't care about security. 2342=item I want to contact a TLS/SSL server, I don't care about security.
2142 2343
2143If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2344If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
2144simply connect to it and then create the AnyEvent::Handle with the C<tls> 2345connect to it and then create the AnyEvent::Handle with the C<tls>
2145parameter: 2346parameter:
2146 2347
2147 tcp_connect $host, $port, sub { 2348 tcp_connect $host, $port, sub {
2148 my ($fh) = @_; 2349 my ($fh) = @_;
2149 2350
… …
2249 2450
2250=item * all members not documented here and not prefixed with an underscore 2451=item * all members not documented here and not prefixed with an underscore
2251are free to use in subclasses. 2452are free to use in subclasses.
2252 2453
2253Of course, new versions of AnyEvent::Handle may introduce more "public" 2454Of course, new versions of AnyEvent::Handle may introduce more "public"
2254member variables, but thats just life, at least it is documented. 2455member variables, but that's just life. At least it is documented.
2255 2456
2256=back 2457=back
2257 2458
2258=head1 AUTHOR 2459=head1 AUTHOR
2259 2460

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines