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.185 by root, Thu Sep 3 19:48:27 2009 UTC vs.
Revision 1.226 by root, Mon Dec 12 12:56:04 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 error => "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 say "got line <$line>";
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::TLS fh => $filehandle, key => value... 86=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
85 87
86The constructor supports these arguments (all as C<< key => value >> pairs). 88The constructor supports these arguments (all as C<< key => value >> pairs).
87 89
88=over 4 90=over 4
89 91
… …
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 conenction 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). When it is called then the read and write queues, eof status, 138time it is called the read and write queues, eof status, tls status and
137tls status and similar properties of the handle are being reset. 139similar properties of the handle will have been reset.
138 140
139In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
140 142
141=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
142 144
143This callback is called when the conenction could not be 145This callback is called when the connection could not be
144established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
145message describing it (usually the same as C<"$!">). 147message describing it (usually the same as C<"$!">).
146 148
147If this callback isn't specified, then C<on_error> will be called with a 149If this callback isn't specified, then C<on_error> will be called with a
148fatal error instead. 150fatal error instead.
… …
151 153
152=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
153 155
154This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
155occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
156connect or a read error. 158connect, or a read error.
157 159
158Some 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
159fatal 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<< ->
160destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
161examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
162with 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
163cases 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
164often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
165 167
166AnyEvent::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
167against, 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
168recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
169error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
170 172
171Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
172to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
173when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
174C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
175 177
176On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
177error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
178C<EPROTO>). 180C<EPROTO>).
179 181
180While 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
181you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
182C<croak>. 184C<croak>.
183 185
184=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
185 187
186This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
191To 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 >>
192method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method or access the C<< $handle->{rbuf} >> member directly. Note that you
193must 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
194the beginning from it. 196the beginning from it.
195 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
196When an EOF condition is detected then AnyEvent::Handle will first try to 201When an EOF condition is detected, AnyEvent::Handle will first try to
197feed 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
198calling 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
199error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
200 205
201Note 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
… …
220set, 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>.
221 226
222=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
223 228
224This 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
225(or when the callback is set and the buffer is empty already). 230(or immediately if the buffer is empty already).
226 231
227To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
228 233
229This 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
230into 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
… …
242many seconds pass without a successful read or write on the underlying 247many seconds pass without a successful read or write on the underlying
243file 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
244will 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>
245error will be raised). 250error will be raised).
246 251
247There are three variants of the timeouts that work fully independent 252There are three variants of the timeouts that work independently of each
248of 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:
249C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 255C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
250C<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
251C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 257C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
252 258
253Note 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
254any outstanding read or write requests: If you plan to keep the connection 260outstanding read or write requests: If you plan to keep the connection
255idle then you should disable the timout temporarily or ignore the timeout 261idle then you should disable the timeout temporarily or ignore the
256in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 262timeout in the corresponding C<on_timeout> callback, in which case
257restart the timeout. 263AnyEvent::Handle will simply restart the timeout.
258 264
259Zero (the default) disables this timeout. 265Zero (the default) disables the corresponding timeout.
260 266
261=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)
262 272
263Called whenever the inactivity timeout passes. If you return from this 273Called whenever the inactivity timeout passes. If you return from this
264callback, 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,
265so this condition is not fatal in any way. 275so this condition is not fatal in any way.
266 276
… …
274be 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
275(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
276amount 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
277isn't finished). 287isn't finished).
278 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
279=item autocork => <boolean> 304=item autocork => <boolean>
280 305
281When disabled (the default), then C<push_write> will try to immediately 306When disabled (the default), C<push_write> will try to immediately
282write 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
283a 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
284be inefficient if you write multiple small chunks (on the wire, this 309be inefficient if you write multiple small chunks (on the wire, this
285disadvantage is usually avoided by your kernel's nagle algorithm, see 310disadvantage is usually avoided by your kernel's nagle algorithm, see
286C<no_delay>, but this option can save costly syscalls). 311C<no_delay>, but this option can save costly syscalls).
287 312
288When enabled, then writes will always be queued till the next event loop 313When enabled, writes will always be queued till the next event loop
289iteration. This is efficient when you do many small writes per iteration, 314iteration. This is efficient when you do many small writes per iteration,
290but 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
291the write buffer often is full). It also increases write latency. 316the write buffer often is full). It also increases write latency.
292 317
293=item no_delay => <boolean> 318=item no_delay => <boolean>
… …
297the Nagle algorithm, and usually it is beneficial. 322the Nagle algorithm, and usually it is beneficial.
298 323
299In 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
300accomplishd by setting this option to a true value. 325accomplishd by setting this option to a true value.
301 326
302The default is your opertaing system's default behaviour (most likely 327The default is your operating system's default behaviour (most likely
303enabled), this option explicitly enables or disables it, if possible. 328enabled). This option explicitly enables or disables it, if possible.
304 329
305=item keepalive => <boolean> 330=item keepalive => <boolean>
306 331
307Enables (default disable) the SO_KEEPALIVE option on the stream socket: 332Enables (default disable) the SO_KEEPALIVE option on the stream socket:
308normally, TCP connections have no time-out once established, so TCP 333normally, TCP connections have no time-out once established, so TCP
309conenctions, once established, can stay alive forever even when the other 334connections, once established, can stay alive forever even when the other
310side 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
311TCP connections whent he other side becomes unreachable. While the default 336TCP connections when the other side becomes unreachable. While the default
312is OS-dependent, TCP keepalives usually kick in after around two hours, 337is OS-dependent, TCP keepalives usually kick in after around two hours,
313and, 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
314to 15 minutes later. 339to 15 minutes later.
315 340
316It 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
… …
334already 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
335from most attacks. 360from most attacks.
336 361
337=item read_size => <bytes> 362=item read_size => <bytes>
338 363
339The default read block size (the amount of bytes this module will 364The initial read block size, the number of bytes this module will try
340try to read during each loop iteration, which affects memory 365to read during each loop iteration. Each handle object will consume
341requirements). 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.
342 376
343=item low_water_mark => <bytes> 377=item low_water_mark => <bytes>
344 378
345Sets 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
346buffer: 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
347considered empty. 381considered empty.
348 382
349Sometimes it can be beneficial (for performance reasons) to add data to 383Sometimes it can be beneficial (for performance reasons) to add data to
350the 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
351the operating system kernel usually buffers data as well, so the default 385the operating system kernel usually buffers data as well, so the default
352is good in almost all cases. 386is good in almost all cases.
353 387
354=item linger => <seconds> 388=item linger => <seconds>
355 389
356If non-zero (default: C<3600>), then the destructor of the 390If this is non-zero (default: C<3600>), the destructor of the
357AnyEvent::Handle object will check whether there is still outstanding 391AnyEvent::Handle object will check whether there is still outstanding
358write 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
359socket. No errors will be reported (this mostly matches how the operating 393socket. No errors will be reported (this mostly matches how the operating
360system treats outstanding data at socket close time). 394system treats outstanding data at socket close time).
361 395
… …
368A string used to identify the remote site - usually the DNS hostname 402A string used to identify the remote site - usually the DNS hostname
369(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.
370 404
371Apart 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
372peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 406peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
373verification will be skipped when C<peername> is not specified or 407verification will be skipped when C<peername> is not specified or is
374C<undef>. 408C<undef>.
375 409
376=item tls => "accept" | "connect" | Net::SSLeay::SSL object 410=item tls => "accept" | "connect" | Net::SSLeay::SSL object
377 411
378When this parameter is given, it enables TLS (SSL) mode, that means 412When this parameter is given, it enables TLS (SSL) mode, that means
379AnyEvent will start a TLS handshake as soon as the conenction has been 413AnyEvent will start a TLS handshake as soon as the connection has been
380established and will transparently encrypt/decrypt data afterwards. 414established and will transparently encrypt/decrypt data afterwards.
381 415
382All TLS protocol errors will be signalled as C<EPROTO>, with an 416All TLS protocol errors will be signalled as C<EPROTO>, with an
383appropriate error message. 417appropriate error message.
384 418
… …
404B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 438B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
405passing 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
406happens 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
407segmentation fault. 441segmentation fault.
408 442
409See 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.
410 444
411=item tls_ctx => $anyevent_tls 445=item tls_ctx => $anyevent_tls
412 446
413Use 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
414(unless a connection object was specified directly). If this parameter is 448(unless a connection object was specified directly). If this
415missing, 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>.
416 451
417Instead 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
418=> 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
419new TLS context object. 454new TLS context object.
420 455
… …
429 464
430TLS 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
431callback 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>.
432 467
433Without this callback, handshake failures lead to C<on_error> being 468Without this callback, handshake failures lead to C<on_error> being
434called, as normal. 469called as usual.
435 470
436Note 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
437need 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
438then call C<< ->starttls >> again. 473then call C<< ->starttls >> again.
439 474
440=item on_stoptls => $cb->($handle) 475=item on_stoptls => $cb->($handle)
441 476
… …
489 $self->{connect}[0], 524 $self->{connect}[0],
490 $self->{connect}[1], 525 $self->{connect}[1],
491 sub { 526 sub {
492 my ($fh, $host, $port, $retry) = @_; 527 my ($fh, $host, $port, $retry) = @_;
493 528
529 delete $self->{_connect}; # no longer needed
530
494 if ($fh) { 531 if ($fh) {
495 $self->{fh} = $fh; 532 $self->{fh} = $fh;
496 533
497 delete $self->{_skip_drain_rbuf}; 534 delete $self->{_skip_drain_rbuf};
498 $self->_start; 535 $self->_start;
… …
505 }); 542 });
506 543
507 } else { 544 } else {
508 if ($self->{on_connect_error}) { 545 if ($self->{on_connect_error}) {
509 $self->{on_connect_error}($self, "$!"); 546 $self->{on_connect_error}($self, "$!");
510 $self->destroy; 547 $self->destroy if $self;
511 } else { 548 } else {
512 $self->_error ($!, 1); 549 $self->_error ($!, 1);
513 } 550 }
514 } 551 }
515 }, 552 },
516 sub { 553 sub {
517 local $self->{fh} = $_[0]; 554 local $self->{fh} = $_[0];
518 555
519 $self->{on_prepare} 556 $self->{on_prepare}
520 ? $self->{on_prepare}->($self) 557 ? $self->{on_prepare}->($self)
521 : () 558 : ()
522 } 559 }
523 ); 560 );
524 } 561 }
525 562
… …
531} 568}
532 569
533sub _start { 570sub _start {
534 my ($self) = @_; 571 my ($self) = @_;
535 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
536 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 579 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
537 580
538 $self->{_activity} = 581 $self->{_activity} =
539 $self->{_ractivity} = 582 $self->{_ractivity} =
540 $self->{_wactivity} = AE::now; 583 $self->{_wactivity} = AE::now;
541 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
542 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 589 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
543 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; 590 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
544 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; 591 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
545 592
546 $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};
… …
549 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); 596 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
550 597
551 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 598 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
552 if $self->{tls}; 599 if $self->{tls};
553 600
554 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 601 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
555 602
556 $self->start_read 603 $self->start_read
557 if $self->{on_read} || @{ $self->{_queue} }; 604 if $self->{on_read} || @{ $self->{_queue} };
558 605
559 $self->_drain_wbuf; 606 $self->_drain_wbuf;
… …
566 $message ||= "$!"; 613 $message ||= "$!";
567 614
568 if ($self->{on_error}) { 615 if ($self->{on_error}) {
569 $self->{on_error}($self, $fatal, $message); 616 $self->{on_error}($self, $fatal, $message);
570 $self->destroy if $fatal; 617 $self->destroy if $fatal;
571 } elsif ($self->{fh}) { 618 } elsif ($self->{fh} || $self->{connect}) {
572 $self->destroy; 619 $self->destroy;
573 Carp::croak "AnyEvent::Handle uncaught error: $message"; 620 Carp::croak "AnyEvent::Handle uncaught error: $message";
574 } 621 }
575} 622}
576 623
… …
635=cut 682=cut
636 683
637sub no_delay { 684sub no_delay {
638 $_[0]{no_delay} = $_[1]; 685 $_[0]{no_delay} = $_[1];
639 686
640 eval {
641 local $SIG{__DIE__};
642 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] 687 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
643 if $_[0]{fh}; 688 if $_[0]{fh};
644 };
645} 689}
646 690
647=item $handle->keepalive ($boolean) 691=item $handle->keepalive ($boolean)
648 692
649Enables or disables the C<keepalive> setting (see constructor argument of 693Enables or disables the C<keepalive> setting (see constructor argument of
… …
709 753
710Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 754Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
711 755
712=cut 756=cut
713 757
714sub on_starttls { 758sub on_stoptls {
715 $_[0]{on_stoptls} = $_[1]; 759 $_[0]{on_stoptls} = $_[1];
716} 760}
717 761
718=item $handle->rbuf_max ($max_octets) 762=item $handle->rbuf_max ($max_octets)
719 763
720Configures the C<rbuf_max> setting (C<undef> disables it). 764Configures the C<rbuf_max> setting (C<undef> disables it).
765
766=item $handle->wbuf_max ($max_octets)
767
768Configures the C<wbuf_max> setting (C<undef> disables it).
721 769
722=cut 770=cut
723 771
724sub rbuf_max { 772sub rbuf_max {
725 $_[0]{rbuf_max} = $_[1]; 773 $_[0]{rbuf_max} = $_[1];
726} 774}
727 775
776sub wbuf_max {
777 $_[0]{wbuf_max} = $_[1];
778}
779
728############################################################################# 780#############################################################################
729 781
730=item $handle->timeout ($seconds) 782=item $handle->timeout ($seconds)
731 783
732=item $handle->rtimeout ($seconds) 784=item $handle->rtimeout ($seconds)
733 785
734=item $handle->wtimeout ($seconds) 786=item $handle->wtimeout ($seconds)
735 787
736Configures (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.
737 792
738=item $handle->timeout_reset 793=item $handle->timeout_reset
739 794
740=item $handle->rtimeout_reset 795=item $handle->rtimeout_reset
741 796
… …
758 $_[0]{$on_timeout} = $_[1]; 813 $_[0]{$on_timeout} = $_[1];
759 }; 814 };
760 815
761 *$timeout = sub { 816 *$timeout = sub {
762 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";
763 821
764 $self->{$timeout} = $new_value; 822 $self->{$timeout} = $new_value;
765 delete $self->{$tw}; &$cb; 823 delete $self->{$tw}; &$cb;
766 }; 824 };
767 825
… …
831=item $handle->on_drain ($cb) 889=item $handle->on_drain ($cb)
832 890
833Sets 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
834C<on_drain> in the constructor). 892C<on_drain> in the constructor).
835 893
894This method may invoke callbacks (and therefore the handle might be
895destroyed after it returns).
896
836=cut 897=cut
837 898
838sub on_drain { 899sub on_drain {
839 my ($self, $cb) = @_; 900 my ($self, $cb) = @_;
840 901
… …
844 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});
845} 906}
846 907
847=item $handle->push_write ($data) 908=item $handle->push_write ($data)
848 909
849Queues 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
850want (only limited by the available memory), as C<AnyEvent::Handle> 911you want (only limited by the available memory and C<wbuf_max>), as
851buffers 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).
852 916
853=cut 917=cut
854 918
855sub _drain_wbuf { 919sub _drain_wbuf {
856 my ($self) = @_; 920 my ($self) = @_;
… …
881 $cb->() unless $self->{autocork}; 945 $cb->() unless $self->{autocork};
882 946
883 # if still data left in wbuf, we need to poll 947 # if still data left in wbuf, we need to poll
884 $self->{_ww} = AE::io $self->{fh}, 1, $cb 948 $self->{_ww} = AE::io $self->{fh}, 1, $cb
885 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 }
886 }; 957 };
887} 958}
888 959
889our %WH; 960our %WH;
890 961
… …
902 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" 973 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
903 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") 974 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
904 ->($self, @_); 975 ->($self, @_);
905 } 976 }
906 977
978 # we downgrade here to avoid hard-to-track-down bugs,
979 # and diagnose the problem earlier and better.
980
907 if ($self->{tls}) { 981 if ($self->{tls}) {
908 $self->{_tls_wbuf} .= $_[0]; 982 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
909 &_dotls ($self) if $self->{fh}; 983 &_dotls ($self) if $self->{fh};
910 } else { 984 } else {
911 $self->{wbuf} .= $_[0]; 985 utf8::downgrade $self->{wbuf} .= $_[0];
912 $self->_drain_wbuf if $self->{fh}; 986 $self->_drain_wbuf if $self->{fh};
913 } 987 }
914} 988}
915 989
916=item $handle->push_write (type => @args) 990=item $handle->push_write (type => @args)
917 991
918Instead of formatting your data yourself, you can also let this module 992Instead of formatting your data yourself, you can also let this module
919do the job by specifying a type and type-specific arguments. You 993do the job by specifying a type and type-specific arguments. You
920can also specify the (fully qualified) name of a package, in which 994can also specify the (fully qualified) name of a package, in which
921case 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
922C<anyevent_read_type> function inside (see "custom write types", below). 996C<anyevent_write_type> function inside (see "custom write types", below).
923 997
924Predefined 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
925drop by and tell us): 999drop by and tell us):
926 1000
927=over 4 1001=over 4
… …
1007=cut 1081=cut
1008 1082
1009register_write_type storable => sub { 1083register_write_type storable => sub {
1010 my ($self, $ref) = @_; 1084 my ($self, $ref) = @_;
1011 1085
1012 require Storable; 1086 require Storable unless $Storable::VERSION;
1013 1087
1014 pack "w/a*", Storable::nfreeze ($ref) 1088 pack "w/a*", Storable::nfreeze ($ref)
1015}; 1089};
1016 1090
1017=back 1091=back
… …
1022before 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
1023C<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
1024C<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
1025replaces the C<on_drain> callback with: 1099replaces the C<on_drain> callback with:
1026 1100
1027 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown 1101 sub { shutdown $_[0]{fh}, 1 }
1028 1102
1029This 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
1030the peer. 1104the peer.
1031 1105
1032You 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
1033afterwards. 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).
1034 1111
1035=cut 1112=cut
1036 1113
1037sub push_shutdown { 1114sub push_shutdown {
1038 my ($self) = @_; 1115 my ($self) = @_;
… …
1051 1128
1052Whenever the given C<type> is used, C<push_write> will the function with 1129Whenever the given C<type> is used, C<push_write> will the function with
1053the handle object and the remaining arguments. 1130the handle object and the remaining arguments.
1054 1131
1055The function is supposed to return a single octet string that will be 1132The function is supposed to return a single octet string that will be
1056appended to the write buffer, so you cna mentally treat this function as a 1133appended to the write buffer, so you can mentally treat this function as a
1057"arguments to on-the-wire-format" converter. 1134"arguments to on-the-wire-format" converter.
1058 1135
1059Example: implement a custom write type C<join> that joins the remaining 1136Example: implement a custom write type C<join> that joins the remaining
1060arguments using the first one. 1137arguments using the first one.
1061 1138
… …
1088ways, 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
1089a queue. 1166a queue.
1090 1167
1091In 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
1092new 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
1093enough 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
1094leave 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
1095partial message has been received so far). 1172partial message has been received so far), or change the read queue with
1173e.g. C<push_read>.
1096 1174
1097In 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
1098case, AnyEvent::Handle will call the first queued callback each time new 1176case, AnyEvent::Handle will call the first queued callback each time new
1099data 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
1100done its job (see C<push_read>, below). 1178done its job (see C<push_read>, below).
1101 1179
1102This 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
1103a chunk of data, and AnyEvent::Handle will execute them in order. 1181a chunk of data, and AnyEvent::Handle will execute them in order.
1104 1182
… …
1235 1313
1236This 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
1237the 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
1238constructor. 1316constructor.
1239 1317
1318This method may invoke callbacks (and therefore the handle might be
1319destroyed after it returns).
1320
1240=cut 1321=cut
1241 1322
1242sub on_read { 1323sub on_read {
1243 my ($self, $cb) = @_; 1324 my ($self, $cb) = @_;
1244 1325
… …
1246 $self->_drain_rbuf if $cb; 1327 $self->_drain_rbuf if $cb;
1247} 1328}
1248 1329
1249=item $handle->rbuf 1330=item $handle->rbuf
1250 1331
1251Returns 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).
1252 1335
1253You can access the read buffer directly as the C<< ->{rbuf} >> 1336The only operation allowed on the read buffer (apart from looking at it)
1254member, if you want. However, the only operation allowed on the 1337is removing data from its beginning. Otherwise modifying or appending to
1255read buffer (apart from looking at it) is removing data from its 1338it is not allowed and will lead to hard-to-track-down bugs.
1256beginning. Otherwise modifying or appending to it is not allowed and will
1257lead to hard-to-track-down bugs.
1258 1339
1259NOTE: 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>
1260C<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
1261automatically 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.
1262 1344
1263=cut 1345=cut
1264 1346
1265sub rbuf : lvalue { 1347sub rbuf : lvalue {
1266 $_[0]{rbuf} 1348 $_[0]{rbuf}
… …
1283 1365
1284If 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
1285interested 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
1286true, it will be removed from the queue. 1368true, it will be removed from the queue.
1287 1369
1370These methods may invoke callbacks (and therefore the handle might be
1371destroyed after it returns).
1372
1288=cut 1373=cut
1289 1374
1290our %RH; 1375our %RH;
1291 1376
1292sub register_read_type($$) { 1377sub register_read_type($$) {
… …
1314 my $cb = pop; 1399 my $cb = pop;
1315 1400
1316 if (@_) { 1401 if (@_) {
1317 my $type = shift; 1402 my $type = shift;
1318 1403
1404 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1319 $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")
1320 ->($self, $cb, @_); 1406 ->($self, $cb, @_);
1321 } 1407 }
1322 1408
1323 unshift @{ $self->{_queue} }, $cb; 1409 unshift @{ $self->{_queue} }, $cb;
1324 $self->_drain_rbuf; 1410 $self->_drain_rbuf;
… …
1346data. 1432data.
1347 1433
1348Example: read 2 bytes. 1434Example: read 2 bytes.
1349 1435
1350 $handle->push_read (chunk => 2, sub { 1436 $handle->push_read (chunk => 2, sub {
1351 warn "yay ", unpack "H*", $_[1]; 1437 say "yay " . unpack "H*", $_[1];
1352 }); 1438 });
1353 1439
1354=cut 1440=cut
1355 1441
1356register_read_type chunk => sub { 1442register_read_type chunk => sub {
… …
1432the receive buffer when neither C<$accept> nor C<$reject> match, 1518the receive buffer when neither C<$accept> nor C<$reject> match,
1433and everything preceding and including the match will be accepted 1519and everything preceding and including the match will be accepted
1434unconditionally. This is useful to skip large amounts of data that you 1520unconditionally. This is useful to skip large amounts of data that you
1435know 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
1436have to start matching from the beginning. This is purely an optimisation 1522have to start matching from the beginning. This is purely an optimisation
1437and 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.
1438 1524
1439Example: 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
1440expect 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
1441a 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
1442it 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
1443required for the accept regex. 1529required for the accept regex.
1444 1530
1445 $handle->push_read (regex => 1531 $handle->push_read (regex =>
… …
1458 1544
1459 sub { 1545 sub {
1460 # accept 1546 # accept
1461 if ($$rbuf =~ $accept) { 1547 if ($$rbuf =~ $accept) {
1462 $data .= substr $$rbuf, 0, $+[0], ""; 1548 $data .= substr $$rbuf, 0, $+[0], "";
1463 $cb->($self, $data); 1549 $cb->($_[0], $data);
1464 return 1; 1550 return 1;
1465 } 1551 }
1466 1552
1467 # reject 1553 # reject
1468 if ($reject && $$rbuf =~ $reject) { 1554 if ($reject && $$rbuf =~ $reject) {
1469 $self->_error (Errno::EBADMSG); 1555 $_[0]->_error (Errno::EBADMSG);
1470 } 1556 }
1471 1557
1472 # skip 1558 # skip
1473 if ($skip && $$rbuf =~ $skip) { 1559 if ($skip && $$rbuf =~ $skip) {
1474 $data .= substr $$rbuf, 0, $+[0], ""; 1560 $data .= substr $$rbuf, 0, $+[0], "";
… …
1490 my ($self, $cb) = @_; 1576 my ($self, $cb) = @_;
1491 1577
1492 sub { 1578 sub {
1493 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1579 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1494 if ($_[0]{rbuf} =~ /[^0-9]/) { 1580 if ($_[0]{rbuf} =~ /[^0-9]/) {
1495 $self->_error (Errno::EBADMSG); 1581 $_[0]->_error (Errno::EBADMSG);
1496 } 1582 }
1497 return; 1583 return;
1498 } 1584 }
1499 1585
1500 my $len = $1; 1586 my $len = $1;
1501 1587
1502 $self->unshift_read (chunk => $len, sub { 1588 $_[0]->unshift_read (chunk => $len, sub {
1503 my $string = $_[1]; 1589 my $string = $_[1];
1504 $_[0]->unshift_read (chunk => 1, sub { 1590 $_[0]->unshift_read (chunk => 1, sub {
1505 if ($_[1] eq ",") { 1591 if ($_[1] eq ",") {
1506 $cb->($_[0], $string); 1592 $cb->($_[0], $string);
1507 } else { 1593 } else {
1508 $self->_error (Errno::EBADMSG); 1594 $_[0]->_error (Errno::EBADMSG);
1509 } 1595 }
1510 }); 1596 });
1511 }); 1597 });
1512 1598
1513 1 1599 1
… …
1586 1672
1587 my $data; 1673 my $data;
1588 my $rbuf = \$self->{rbuf}; 1674 my $rbuf = \$self->{rbuf};
1589 1675
1590 sub { 1676 sub {
1591 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1677 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1592 1678
1593 if ($ref) { 1679 if ($ref) {
1594 $self->{rbuf} = $json->incr_text; 1680 $_[0]{rbuf} = $json->incr_text;
1595 $json->incr_text = ""; 1681 $json->incr_text = "";
1596 $cb->($self, $ref); 1682 $cb->($_[0], $ref);
1597 1683
1598 1 1684 1
1599 } elsif ($@) { 1685 } elsif ($@) {
1600 # error case 1686 # error case
1601 $json->incr_skip; 1687 $json->incr_skip;
1602 1688
1603 $self->{rbuf} = $json->incr_text; 1689 $_[0]{rbuf} = $json->incr_text;
1604 $json->incr_text = ""; 1690 $json->incr_text = "";
1605 1691
1606 $self->_error (Errno::EBADMSG); 1692 $_[0]->_error (Errno::EBADMSG);
1607 1693
1608 () 1694 ()
1609 } else { 1695 } else {
1610 $self->{rbuf} = ""; 1696 $_[0]{rbuf} = "";
1611 1697
1612 () 1698 ()
1613 } 1699 }
1614 } 1700 }
1615}; 1701};
… …
1625=cut 1711=cut
1626 1712
1627register_read_type storable => sub { 1713register_read_type storable => sub {
1628 my ($self, $cb) = @_; 1714 my ($self, $cb) = @_;
1629 1715
1630 require Storable; 1716 require Storable unless $Storable::VERSION;
1631 1717
1632 sub { 1718 sub {
1633 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1719 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1634 defined (my $len = eval { unpack "w", $_[0]{rbuf} }) 1720 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1635 or return; 1721 or return;
… …
1648 # read remaining chunk 1734 # read remaining chunk
1649 $_[0]->unshift_read (chunk => $len, sub { 1735 $_[0]->unshift_read (chunk => $len, sub {
1650 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1736 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1651 $cb->($_[0], $ref); 1737 $cb->($_[0], $ref);
1652 } else { 1738 } else {
1653 $self->_error (Errno::EBADMSG); 1739 $_[0]->_error (Errno::EBADMSG);
1654 } 1740 }
1655 }); 1741 });
1656 } 1742 }
1657 1743
1658 1 1744 1
… …
1696Note that AnyEvent::Handle will automatically C<start_read> for you when 1782Note that AnyEvent::Handle will automatically C<start_read> for you when
1697you 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
1698will 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
1699there are any read requests in the queue. 1785there are any read requests in the queue.
1700 1786
1701These 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,
1702half-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 application.
1703 1798
1704=cut 1799=cut
1705 1800
1706sub stop_read { 1801sub stop_read {
1707 my ($self) = @_; 1802 my ($self) = @_;
1708 1803
1709 delete $self->{_rw} unless $self->{tls}; 1804 delete $self->{_rw};
1710} 1805}
1711 1806
1712sub start_read { 1807sub start_read {
1713 my ($self) = @_; 1808 my ($self) = @_;
1714 1809
1715 unless ($self->{_rw} || $self->{_eof}) { 1810 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1716 Scalar::Util::weaken $self; 1811 Scalar::Util::weaken $self;
1717 1812
1718 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1813 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1719 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1814 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1720 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1815 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1721 1816
1722 if ($len > 0) { 1817 if ($len > 0) {
1723 $self->{_activity} = $self->{_ractivity} = AE::now; 1818 $self->{_activity} = $self->{_ractivity} = AE::now;
1724 1819
1725 if ($self->{tls}) { 1820 if ($self->{tls}) {
1726 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1821 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1727 1822
1728 &_dotls ($self); 1823 &_dotls ($self);
1729 } else { 1824 } else {
1730 $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);
1731 } 1832 }
1732 1833
1733 } elsif (defined $len) { 1834 } elsif (defined $len) {
1734 delete $self->{_rw}; 1835 delete $self->{_rw};
1735 $self->{_eof} = 1; 1836 $self->{_eof} = 1;
… …
1813 && ($tmp != $ERROR_SYSCALL || $!); 1914 && ($tmp != $ERROR_SYSCALL || $!);
1814 1915
1815 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1916 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1816 $self->{wbuf} .= $tmp; 1917 $self->{wbuf} .= $tmp;
1817 $self->_drain_wbuf; 1918 $self->_drain_wbuf;
1919 $self->{tls} or return; # tls session might have gone away in callback
1818 } 1920 }
1819 1921
1820 $self->{_on_starttls} 1922 $self->{_on_starttls}
1821 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1923 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1822 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1924 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1844context 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
1845changed to your liking. Note that the handshake might have already started 1947changed to your liking. Note that the handshake might have already started
1846when this function returns. 1948when this function returns.
1847 1949
1848Due 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
1849handshakes 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
1850stopping TLS. 1952stream after stopping TLS.
1953
1954This method may invoke callbacks (and therefore the handle might be
1955destroyed after it returns).
1851 1956
1852=cut 1957=cut
1853 1958
1854our %TLS_CACHE; #TODO not yet documented, should we? 1959our %TLS_CACHE; #TODO not yet documented, should we?
1855 1960
… …
1906 Net::SSLeay::CTX_set_mode ($tls, 1|2); 2011 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1907 2012
1908 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2013 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1909 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2014 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1910 2015
1911 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); 2016 Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
2017 $self->{rbuf} = "";
1912 2018
1913 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 2019 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1914 2020
1915 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 2021 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1916 if $self->{on_starttls}; 2022 if $self->{on_starttls};
… …
1921 2027
1922=item $handle->stoptls 2028=item $handle->stoptls
1923 2029
1924Shuts down the SSL connection - this makes a proper EOF handshake by 2030Shuts down the SSL connection - this makes a proper EOF handshake by
1925sending 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
1926support non-blocking shut downs, it is not guarenteed that you can re-use 2032support non-blocking shut downs, it is not guaranteed that you can re-use
1927the stream afterwards. 2033the stream afterwards.
2034
2035This method may invoke callbacks (and therefore the handle might be
2036destroyed after it returns).
1928 2037
1929=cut 2038=cut
1930 2039
1931sub stoptls { 2040sub stoptls {
1932 my ($self) = @_; 2041 my ($self) = @_;
1933 2042
1934 if ($self->{tls}) { 2043 if ($self->{tls} && $self->{fh}) {
1935 Net::SSLeay::shutdown ($self->{tls}); 2044 Net::SSLeay::shutdown ($self->{tls});
1936 2045
1937 &_dotls; 2046 &_dotls;
1938 2047
1939# # we don't give a shit. no, we do, but we can't. no...#d# 2048# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1951 if $self->{tls} > 0; 2060 if $self->{tls} > 0;
1952 2061
1953 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 2062 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1954} 2063}
1955 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
1956sub DESTROY { 2078sub DESTROY {
1957 my ($self) = @_; 2079 my ($self) = @_;
1958 2080
1959 &_freetls; 2081 &_freetls;
1960 2082
… …
1969 push @linger, AE::io $fh, 1, sub { 2091 push @linger, AE::io $fh, 1, sub {
1970 my $len = syswrite $fh, $wbuf, length $wbuf; 2092 my $len = syswrite $fh, $wbuf, length $wbuf;
1971 2093
1972 if ($len > 0) { 2094 if ($len > 0) {
1973 substr $wbuf, 0, $len, ""; 2095 substr $wbuf, 0, $len, "";
1974 } else { 2096 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1975 @linger = (); # end 2097 @linger = (); # end
1976 } 2098 }
1977 }; 2099 };
1978 push @linger, AE::timer $linger, 0, sub { 2100 push @linger, AE::timer $linger, 0, sub {
1979 @linger = (); 2101 @linger = ();
… …
2016 2138
2017sub AnyEvent::Handle::destroyed::AUTOLOAD { 2139sub AnyEvent::Handle::destroyed::AUTOLOAD {
2018 #nop 2140 #nop
2019} 2141}
2020 2142
2143=item $handle->destroyed
2144
2145Returns false as long as the handle hasn't been destroyed by a call to C<<
2146->destroy >>, true otherwise.
2147
2148Can be useful to decide whether the handle is still valid after some
2149callback possibly destroyed the handle. For example, C<< ->push_write >>,
2150C<< ->starttls >> and other methods can call user callbacks, which in turn
2151can destroy the handle, so work can be avoided by checking sometimes:
2152
2153 $hdl->starttls ("accept");
2154 return if $hdl->destroyed;
2155 $hdl->push_write (...
2156
2157Note that the call to C<push_write> will silently be ignored if the handle
2158has been destroyed, so often you can just ignore the possibility of the
2159handle being destroyed.
2160
2161=cut
2162
2163sub destroyed { 0 }
2164sub AnyEvent::Handle::destroyed::destroyed { 1 }
2165
2021=item AnyEvent::Handle::TLS_CTX 2166=item AnyEvent::Handle::TLS_CTX
2022 2167
2023This function creates and returns the AnyEvent::TLS object used by default 2168This function creates and returns the AnyEvent::TLS object used by default
2024for TLS mode. 2169for TLS mode.
2025 2170
… …
2052 2197
2053It 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,
2054from within all other callbacks, you need to explicitly call the C<< 2199from within all other callbacks, you need to explicitly call the C<<
2055->destroy >> method. 2200->destroy >> method.
2056 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 can 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 cannot 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
2057=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
2058reading? 2283reading?
2059 2284
2060Unlike, say, TCP, TLS connections do not consist of two independent 2285Unlike, say, TCP, TLS connections do not consist of two independent
2061communication channels, one for each direction. Or put differently. The 2286communication channels, one for each direction. Or put differently, the
2062read and write directions are not independent of each other: you cannot 2287read and write directions are not independent of each other: you cannot
2063write data unless you are also prepared to read, and vice versa. 2288write data unless you are also prepared to read, and vice versa.
2064 2289
2065This 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>
2066callback invocations when you are not expecting any read data - the reason 2291callback invocations when you are not expecting any read data - the reason
2067is that AnyEvent::Handle always reads in TLS mode. 2292is that AnyEvent::Handle always reads in TLS mode.
2068 2293
2069During 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
2070non-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
… …
2082 $handle->on_eof (undef); 2307 $handle->on_eof (undef);
2083 $handle->on_error (sub { 2308 $handle->on_error (sub {
2084 my $data = delete $_[0]{rbuf}; 2309 my $data = delete $_[0]{rbuf};
2085 }); 2310 });
2086 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
2087The 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
2088and 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
2089fact, all data has been received. 2318fact all data has been received.
2090 2319
2091It is usually better to use acknowledgements when transferring data, 2320It is usually better to use acknowledgements when transferring data,
2092to 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
2093intact. 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
2094explicit QUIT command. 2323explicit QUIT command.
… …
2101C<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
2102written to the socket: 2331written to the socket:
2103 2332
2104 $handle->push_write (...); 2333 $handle->push_write (...);
2105 $handle->on_drain (sub { 2334 $handle->on_drain (sub {
2106 warn "all data submitted to the kernel\n"; 2335 AE::log debug => "all data submitted to the kernel\n";
2107 undef $handle; 2336 undef $handle;
2108 }); 2337 });
2109 2338
2110If 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,
2111consider using C<< ->push_shutdown >> instead. 2340consider using C<< ->push_shutdown >> instead.
2112 2341
2113=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.
2114 2343
2115If 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,
2116simply 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>
2117parameter: 2346parameter:
2118 2347
2119 tcp_connect $host, $port, sub { 2348 tcp_connect $host, $port, sub {
2120 my ($fh) = @_; 2349 my ($fh) = @_;
2121 2350
… …
2221 2450
2222=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
2223are free to use in subclasses. 2452are free to use in subclasses.
2224 2453
2225Of course, new versions of AnyEvent::Handle may introduce more "public" 2454Of course, new versions of AnyEvent::Handle may introduce more "public"
2226member variables, but thats just life, at least it is documented. 2455member variables, but that's just life. At least it is documented.
2227 2456
2228=back 2457=back
2229 2458
2230=head1 AUTHOR 2459=head1 AUTHOR
2231 2460

Diff Legend

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