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.228 by root, Mon Feb 6 00:17:26 2012 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. At the time it is called the
134read and write queues, EOF status, TLS status and similar properties of
135the handle will have been reset.
132 136
137It is not allowed to use the read or write queues while the handle object
138is connecting.
139
133When, for some reason, the handle is not acceptable, then calling 140If, for some reason, the handle is not acceptable, calling C<$retry> will
134C<$retry> will continue with the next conenction target (in case of 141continue with the next connection target (in case of multi-homed hosts or
135multi-homed hosts or SRV records there can be multiple connection 142SRV records there can be multiple connection endpoints). The C<$retry>
136endpoints). When it is called then the read and write queues, eof status, 143callback can be invoked after the connect callback returns, i.e. one can
137tls status and similar properties of the handle are being reset. 144start a handshake and then decide to retry with the next host if the
145handshake fails.
138 146
139In most cases, ignoring the C<$retry> parameter is the way to go. 147In most cases, you should ignore the C<$retry> parameter.
140 148
141=item on_connect_error => $cb->($handle, $message) 149=item on_connect_error => $cb->($handle, $message)
142 150
143This callback is called when the conenction could not be 151This callback is called when the connection could not be
144established. C<$!> will contain the relevant error code, and C<$message> a 152established. C<$!> will contain the relevant error code, and C<$message> a
145message describing it (usually the same as C<"$!">). 153message describing it (usually the same as C<"$!">).
146 154
147If this callback isn't specified, then C<on_error> will be called with a 155If this callback isn't specified, then C<on_error> will be called with a
148fatal error instead. 156fatal error instead.
… …
151 159
152=item on_error => $cb->($handle, $fatal, $message) 160=item on_error => $cb->($handle, $fatal, $message)
153 161
154This is the error callback, which is called when, well, some error 162This is the error callback, which is called when, well, some error
155occured, such as not being able to resolve the hostname, failure to 163occured, such as not being able to resolve the hostname, failure to
156connect or a read error. 164connect, or a read error.
157 165
158Some errors are fatal (which is indicated by C<$fatal> being true). On 166Some 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<< -> 167fatal errors the handle object will be destroyed (by a call to C<< ->
160destroy >>) after invoking the error callback (which means you are free to 168destroy >>) after invoking the error callback (which means you are free to
161examine the handle object). Examples of fatal errors are an EOF condition 169examine the handle object). Examples of fatal errors are an EOF condition
162with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 170with 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 171cases where the other side can close the connection at will, it is
164often easiest to not report C<EPIPE> errors in this callback. 172often easiest to not report C<EPIPE> errors in this callback.
165 173
166AnyEvent::Handle tries to find an appropriate error code for you to check 174AnyEvent::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 175against, but in some cases (TLS errors), this does not work well. It is
168recommended to always output the C<$message> argument in human-readable 176recommended to always output the C<$message> argument in human-readable
169error messages (it's usually the same as C<"$!">). 177error messages (it's usually the same as C<"$!">).
170 178
171Non-fatal errors can be retried by simply returning, but it is recommended 179Non-fatal errors can be retried by returning, but it is recommended
172to simply ignore this parameter and instead abondon the handle object 180to simply ignore this parameter and instead abondon the handle object
173when this callback is invoked. Examples of non-fatal errors are timeouts 181when this callback is invoked. Examples of non-fatal errors are timeouts
174C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 182C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
175 183
176On callback entrance, the value of C<$!> contains the operating system 184On entry to the callback, the value of C<$!> contains the operating
177error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 185system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
178C<EPROTO>). 186C<EPROTO>).
179 187
180While not mandatory, it is I<highly> recommended to set this callback, as 188While not mandatory, it is I<highly> recommended to set this callback, as
181you will not be notified of errors otherwise. The default simply calls 189you will not be notified of errors otherwise. The default just calls
182C<croak>. 190C<croak>.
183 191
184=item on_read => $cb->($handle) 192=item on_read => $cb->($handle)
185 193
186This sets the default read callback, which is called when data arrives 194This sets the default read callback, which is called when data arrives
… …
191To access (and remove data from) the read buffer, use the C<< ->rbuf >> 199To access (and remove data from) the read buffer, use the C<< ->rbuf >>
192method or access the C<< $handle->{rbuf} >> member directly. Note that you 200method 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 201must not enlarge or modify the read buffer, you can only remove data at
194the beginning from it. 202the beginning from it.
195 203
204You can also call C<< ->push_read (...) >> or any other function that
205modifies the read queue. Or do both. Or ...
206
196When an EOF condition is detected then AnyEvent::Handle will first try to 207When 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 208feed 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 209calling the C<on_eof> callback. If no progress can be made, then a fatal
199error will be raised (with C<$!> set to C<EPIPE>). 210error will be raised (with C<$!> set to C<EPIPE>).
200 211
201Note that, unlike requests in the read queue, an C<on_read> callback 212Note 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>. 231set, then a fatal error will be raised with C<$!> set to <0>.
221 232
222=item on_drain => $cb->($handle) 233=item on_drain => $cb->($handle)
223 234
224This sets the callback that is called when the write buffer becomes empty 235This 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). 236(or immediately if the buffer is empty already).
226 237
227To append to the write buffer, use the C<< ->push_write >> method. 238To append to the write buffer, use the C<< ->push_write >> method.
228 239
229This callback is useful when you don't want to put all of your write data 240This 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 241into 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 253many 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 254file 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> 255will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
245error will be raised). 256error will be raised).
246 257
247There are three variants of the timeouts that work fully independent 258There are three variants of the timeouts that work independently of each
248of each other, for both read and write, just read, and just write: 259other, for both read and write (triggered when nothing was read I<OR>
260written), just read (triggered when nothing was read), and just write:
249C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 261C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
250C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions 262C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
251C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 263C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
252 264
253Note that timeout processing is also active when you currently do not have 265Note 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 266outstanding read or write requests: If you plan to keep the connection
255idle then you should disable the timout temporarily or ignore the timeout 267idle then you should disable the timeout temporarily or ignore the
256in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 268timeout in the corresponding C<on_timeout> callback, in which case
257restart the timeout. 269AnyEvent::Handle will simply restart the timeout.
258 270
259Zero (the default) disables this timeout. 271Zero (the default) disables the corresponding timeout.
260 272
261=item on_timeout => $cb->($handle) 273=item on_timeout => $cb->($handle)
274
275=item on_rtimeout => $cb->($handle)
276
277=item on_wtimeout => $cb->($handle)
262 278
263Called whenever the inactivity timeout passes. If you return from this 279Called whenever the inactivity timeout passes. If you return from this
264callback, then the timeout will be reset as if some activity had happened, 280callback, then the timeout will be reset as if some activity had happened,
265so this condition is not fatal in any way. 281so this condition is not fatal in any way.
266 282
… …
274be configured to accept only so-and-so much data that it cannot act on 290be 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 291(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 292amount of data without a callback ever being called as long as the line
277isn't finished). 293isn't finished).
278 294
295=item wbuf_max => <bytes>
296
297If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
298when the write buffer ever (strictly) exceeds this size. This is useful to
299avoid some forms of denial-of-service attacks.
300
301Although the units of this parameter is bytes, this is the I<raw> number
302of bytes not yet accepted by the kernel. This can make a difference when
303you e.g. use TLS, as TLS typically makes your write data larger (but it
304can also make it smaller due to compression).
305
306As an example of when this limit is useful, take a chat server that sends
307chat messages to a client. If the client does not read those in a timely
308manner then the send buffer in the server would grow unbounded.
309
279=item autocork => <boolean> 310=item autocork => <boolean>
280 311
281When disabled (the default), then C<push_write> will try to immediately 312When disabled (the default), C<push_write> will try to immediately
282write the data to the handle, if possible. This avoids having to register 313write 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 314a write watcher and wait for the next event loop iteration, but can
284be inefficient if you write multiple small chunks (on the wire, this 315be inefficient if you write multiple small chunks (on the wire, this
285disadvantage is usually avoided by your kernel's nagle algorithm, see 316disadvantage is usually avoided by your kernel's nagle algorithm, see
286C<no_delay>, but this option can save costly syscalls). 317C<no_delay>, but this option can save costly syscalls).
287 318
288When enabled, then writes will always be queued till the next event loop 319When enabled, writes will always be queued till the next event loop
289iteration. This is efficient when you do many small writes per iteration, 320iteration. 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 321but less efficient when you do a single write only per iteration (or when
291the write buffer often is full). It also increases write latency. 322the write buffer often is full). It also increases write latency.
292 323
293=item no_delay => <boolean> 324=item no_delay => <boolean>
… …
297the Nagle algorithm, and usually it is beneficial. 328the Nagle algorithm, and usually it is beneficial.
298 329
299In some situations you want as low a delay as possible, which can be 330In some situations you want as low a delay as possible, which can be
300accomplishd by setting this option to a true value. 331accomplishd by setting this option to a true value.
301 332
302The default is your opertaing system's default behaviour (most likely 333The default is your operating system's default behaviour (most likely
303enabled), this option explicitly enables or disables it, if possible. 334enabled). This option explicitly enables or disables it, if possible.
304 335
305=item keepalive => <boolean> 336=item keepalive => <boolean>
306 337
307Enables (default disable) the SO_KEEPALIVE option on the stream socket: 338Enables (default disable) the SO_KEEPALIVE option on the stream socket:
308normally, TCP connections have no time-out once established, so TCP 339normally, TCP connections have no time-out once established, so TCP
309conenctions, once established, can stay alive forever even when the other 340connections, 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 341side 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 342TCP connections when the other side becomes unreachable. While the default
312is OS-dependent, TCP keepalives usually kick in after around two hours, 343is 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 344and, if the other side doesn't reply, take down the TCP connection some 10
314to 15 minutes later. 345to 15 minutes later.
315 346
316It is harmless to specify this option for file handles that do not support 347It 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 365already have occured on BSD systems), but at least it will protect you
335from most attacks. 366from most attacks.
336 367
337=item read_size => <bytes> 368=item read_size => <bytes>
338 369
339The default read block size (the amount of bytes this module will 370The initial read block size, the number of bytes this module will try
340try to read during each loop iteration, which affects memory 371to read during each loop iteration. Each handle object will consume
341requirements). Default: C<8192>. 372at least this amount of memory for the read buffer as well, so when
373handling many connections watch out for memory requirements). See also
374C<max_read_size>. Default: C<2048>.
375
376=item max_read_size => <bytes>
377
378The maximum read buffer size used by the dynamic adjustment
379algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
380one go it will double C<read_size> up to the maximum given by this
381option. Default: C<131072> or C<read_size>, whichever is higher.
342 382
343=item low_water_mark => <bytes> 383=item low_water_mark => <bytes>
344 384
345Sets the amount of bytes (default: C<0>) that make up an "empty" write 385Sets 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 386buffer: If the buffer reaches this size or gets even samller it is
347considered empty. 387considered empty.
348 388
349Sometimes it can be beneficial (for performance reasons) to add data to 389Sometimes 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 390the 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 391the operating system kernel usually buffers data as well, so the default
352is good in almost all cases. 392is good in almost all cases.
353 393
354=item linger => <seconds> 394=item linger => <seconds>
355 395
356If non-zero (default: C<3600>), then the destructor of the 396If this is non-zero (default: C<3600>), the destructor of the
357AnyEvent::Handle object will check whether there is still outstanding 397AnyEvent::Handle object will check whether there is still outstanding
358write data and will install a watcher that will write this data to the 398write 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 399socket. No errors will be reported (this mostly matches how the operating
360system treats outstanding data at socket close time). 400system treats outstanding data at socket close time).
361 401
… …
368A string used to identify the remote site - usually the DNS hostname 408A string used to identify the remote site - usually the DNS hostname
369(I<not> IDN!) used to create the connection, rarely the IP address. 409(I<not> IDN!) used to create the connection, rarely the IP address.
370 410
371Apart from being useful in error messages, this string is also used in TLS 411Apart from being useful in error messages, this string is also used in TLS
372peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 412peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
373verification will be skipped when C<peername> is not specified or 413verification will be skipped when C<peername> is not specified or is
374C<undef>. 414C<undef>.
375 415
376=item tls => "accept" | "connect" | Net::SSLeay::SSL object 416=item tls => "accept" | "connect" | Net::SSLeay::SSL object
377 417
378When this parameter is given, it enables TLS (SSL) mode, that means 418When this parameter is given, it enables TLS (SSL) mode, that means
379AnyEvent will start a TLS handshake as soon as the conenction has been 419AnyEvent will start a TLS handshake as soon as the connection has been
380established and will transparently encrypt/decrypt data afterwards. 420established and will transparently encrypt/decrypt data afterwards.
381 421
382All TLS protocol errors will be signalled as C<EPROTO>, with an 422All TLS protocol errors will be signalled as C<EPROTO>, with an
383appropriate error message. 423appropriate error message.
384 424
… …
404B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 444B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
405passing in the wrong integer will lead to certain crash. This most often 445passing 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 446happens when one uses a stylish C<< tls => 1 >> and is surprised about the
407segmentation fault. 447segmentation fault.
408 448
409See the C<< ->starttls >> method for when need to start TLS negotiation later. 449Use the C<< ->starttls >> method if you need to start TLS negotiation later.
410 450
411=item tls_ctx => $anyevent_tls 451=item tls_ctx => $anyevent_tls
412 452
413Use the given C<AnyEvent::TLS> object to create the new TLS connection 453Use the given C<AnyEvent::TLS> object to create the new TLS connection
414(unless a connection object was specified directly). If this parameter is 454(unless a connection object was specified directly). If this
415missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 455parameter is missing (or C<undef>), then AnyEvent::Handle will use
456C<AnyEvent::Handle::TLS_CTX>.
416 457
417Instead of an object, you can also specify a hash reference with C<< key 458Instead 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 459=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
419new TLS context object. 460new TLS context object.
420 461
… …
429 470
430TLS handshake failures will not cause C<on_error> to be invoked when this 471TLS 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>. 472callback is in effect, instead, the error message will be passed to C<on_starttls>.
432 473
433Without this callback, handshake failures lead to C<on_error> being 474Without this callback, handshake failures lead to C<on_error> being
434called, as normal. 475called as usual.
435 476
436Note that you cannot call C<starttls> right again in this callback. If you 477Note 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 478need to do that, start an zero-second timer instead whose callback can
438then call C<< ->starttls >> again. 479then call C<< ->starttls >> again.
439 480
440=item on_stoptls => $cb->($handle) 481=item on_stoptls => $cb->($handle)
441 482
… …
489 $self->{connect}[0], 530 $self->{connect}[0],
490 $self->{connect}[1], 531 $self->{connect}[1],
491 sub { 532 sub {
492 my ($fh, $host, $port, $retry) = @_; 533 my ($fh, $host, $port, $retry) = @_;
493 534
535 delete $self->{_connect}; # no longer needed
536
494 if ($fh) { 537 if ($fh) {
495 $self->{fh} = $fh; 538 $self->{fh} = $fh;
496 539
497 delete $self->{_skip_drain_rbuf}; 540 delete $self->{_skip_drain_rbuf};
498 $self->_start; 541 $self->_start;
… …
505 }); 548 });
506 549
507 } else { 550 } else {
508 if ($self->{on_connect_error}) { 551 if ($self->{on_connect_error}) {
509 $self->{on_connect_error}($self, "$!"); 552 $self->{on_connect_error}($self, "$!");
510 $self->destroy; 553 $self->destroy if $self;
511 } else { 554 } else {
512 $self->_error ($!, 1); 555 $self->_error ($!, 1);
513 } 556 }
514 } 557 }
515 }, 558 },
516 sub { 559 sub {
517 local $self->{fh} = $_[0]; 560 local $self->{fh} = $_[0];
518 561
519 $self->{on_prepare} 562 $self->{on_prepare}
520 ? $self->{on_prepare}->($self) 563 ? $self->{on_prepare}->($self)
521 : () 564 : ()
522 } 565 }
523 ); 566 );
524 } 567 }
525 568
… …
531} 574}
532 575
533sub _start { 576sub _start {
534 my ($self) = @_; 577 my ($self) = @_;
535 578
579 # too many clueless people try to use udp and similar sockets
580 # with AnyEvent::Handle, do them a favour.
581 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
582 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
583 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
584
536 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 585 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
537 586
538 $self->{_activity} = 587 $self->{_activity} =
539 $self->{_ractivity} = 588 $self->{_ractivity} =
540 $self->{_wactivity} = AE::now; 589 $self->{_wactivity} = AE::now;
541 590
591 $self->{read_size} ||= 2048;
592 $self->{max_read_size} = $self->{read_size}
593 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
594
542 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 595 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
543 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; 596 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
544 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; 597 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
545 598
546 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; 599 $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); 602 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
550 603
551 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 604 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
552 if $self->{tls}; 605 if $self->{tls};
553 606
554 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 607 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
555 608
556 $self->start_read 609 $self->start_read
557 if $self->{on_read} || @{ $self->{_queue} }; 610 if $self->{on_read} || @{ $self->{_queue} };
558 611
559 $self->_drain_wbuf; 612 $self->_drain_wbuf;
… …
566 $message ||= "$!"; 619 $message ||= "$!";
567 620
568 if ($self->{on_error}) { 621 if ($self->{on_error}) {
569 $self->{on_error}($self, $fatal, $message); 622 $self->{on_error}($self, $fatal, $message);
570 $self->destroy if $fatal; 623 $self->destroy if $fatal;
571 } elsif ($self->{fh}) { 624 } elsif ($self->{fh} || $self->{connect}) {
572 $self->destroy; 625 $self->destroy;
573 Carp::croak "AnyEvent::Handle uncaught error: $message"; 626 Carp::croak "AnyEvent::Handle uncaught error: $message";
574 } 627 }
575} 628}
576 629
… …
635=cut 688=cut
636 689
637sub no_delay { 690sub no_delay {
638 $_[0]{no_delay} = $_[1]; 691 $_[0]{no_delay} = $_[1];
639 692
640 eval {
641 local $SIG{__DIE__};
642 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] 693 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
643 if $_[0]{fh}; 694 if $_[0]{fh};
644 };
645} 695}
646 696
647=item $handle->keepalive ($boolean) 697=item $handle->keepalive ($boolean)
648 698
649Enables or disables the C<keepalive> setting (see constructor argument of 699Enables or disables the C<keepalive> setting (see constructor argument of
… …
709 759
710Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 760Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
711 761
712=cut 762=cut
713 763
714sub on_starttls { 764sub on_stoptls {
715 $_[0]{on_stoptls} = $_[1]; 765 $_[0]{on_stoptls} = $_[1];
716} 766}
717 767
718=item $handle->rbuf_max ($max_octets) 768=item $handle->rbuf_max ($max_octets)
719 769
720Configures the C<rbuf_max> setting (C<undef> disables it). 770Configures the C<rbuf_max> setting (C<undef> disables it).
771
772=item $handle->wbuf_max ($max_octets)
773
774Configures the C<wbuf_max> setting (C<undef> disables it).
721 775
722=cut 776=cut
723 777
724sub rbuf_max { 778sub rbuf_max {
725 $_[0]{rbuf_max} = $_[1]; 779 $_[0]{rbuf_max} = $_[1];
726} 780}
727 781
782sub wbuf_max {
783 $_[0]{wbuf_max} = $_[1];
784}
785
728############################################################################# 786#############################################################################
729 787
730=item $handle->timeout ($seconds) 788=item $handle->timeout ($seconds)
731 789
732=item $handle->rtimeout ($seconds) 790=item $handle->rtimeout ($seconds)
733 791
734=item $handle->wtimeout ($seconds) 792=item $handle->wtimeout ($seconds)
735 793
736Configures (or disables) the inactivity timeout. 794Configures (or disables) the inactivity timeout.
795
796The timeout will be checked instantly, so this method might destroy the
797handle before it returns.
737 798
738=item $handle->timeout_reset 799=item $handle->timeout_reset
739 800
740=item $handle->rtimeout_reset 801=item $handle->rtimeout_reset
741 802
… …
758 $_[0]{$on_timeout} = $_[1]; 819 $_[0]{$on_timeout} = $_[1];
759 }; 820 };
760 821
761 *$timeout = sub { 822 *$timeout = sub {
762 my ($self, $new_value) = @_; 823 my ($self, $new_value) = @_;
824
825 $new_value >= 0
826 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
763 827
764 $self->{$timeout} = $new_value; 828 $self->{$timeout} = $new_value;
765 delete $self->{$tw}; &$cb; 829 delete $self->{$tw}; &$cb;
766 }; 830 };
767 831
… …
831=item $handle->on_drain ($cb) 895=item $handle->on_drain ($cb)
832 896
833Sets the C<on_drain> callback or clears it (see the description of 897Sets the C<on_drain> callback or clears it (see the description of
834C<on_drain> in the constructor). 898C<on_drain> in the constructor).
835 899
900This method may invoke callbacks (and therefore the handle might be
901destroyed after it returns).
902
836=cut 903=cut
837 904
838sub on_drain { 905sub on_drain {
839 my ($self, $cb) = @_; 906 my ($self, $cb) = @_;
840 907
… …
844 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); 911 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
845} 912}
846 913
847=item $handle->push_write ($data) 914=item $handle->push_write ($data)
848 915
849Queues the given scalar to be written. You can push as much data as you 916Queues the given scalar to be written. You can push as much data as
850want (only limited by the available memory), as C<AnyEvent::Handle> 917you want (only limited by the available memory and C<wbuf_max>), as
851buffers it independently of the kernel. 918C<AnyEvent::Handle> buffers it independently of the kernel.
919
920This method may invoke callbacks (and therefore the handle might be
921destroyed after it returns).
852 922
853=cut 923=cut
854 924
855sub _drain_wbuf { 925sub _drain_wbuf {
856 my ($self) = @_; 926 my ($self) = @_;
… …
881 $cb->() unless $self->{autocork}; 951 $cb->() unless $self->{autocork};
882 952
883 # if still data left in wbuf, we need to poll 953 # if still data left in wbuf, we need to poll
884 $self->{_ww} = AE::io $self->{fh}, 1, $cb 954 $self->{_ww} = AE::io $self->{fh}, 1, $cb
885 if length $self->{wbuf}; 955 if length $self->{wbuf};
956
957 if (
958 defined $self->{wbuf_max}
959 && $self->{wbuf_max} < length $self->{wbuf}
960 ) {
961 $self->_error (Errno::ENOSPC, 1), return;
962 }
886 }; 963 };
887} 964}
888 965
889our %WH; 966our %WH;
890 967
… …
902 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" 979 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
903 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") 980 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
904 ->($self, @_); 981 ->($self, @_);
905 } 982 }
906 983
984 # we downgrade here to avoid hard-to-track-down bugs,
985 # and diagnose the problem earlier and better.
986
907 if ($self->{tls}) { 987 if ($self->{tls}) {
908 $self->{_tls_wbuf} .= $_[0]; 988 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
909 &_dotls ($self) if $self->{fh}; 989 &_dotls ($self) if $self->{fh};
910 } else { 990 } else {
911 $self->{wbuf} .= $_[0]; 991 utf8::downgrade $self->{wbuf} .= $_[0];
912 $self->_drain_wbuf if $self->{fh}; 992 $self->_drain_wbuf if $self->{fh};
913 } 993 }
914} 994}
915 995
916=item $handle->push_write (type => @args) 996=item $handle->push_write (type => @args)
917 997
918Instead of formatting your data yourself, you can also let this module 998Instead of formatting your data yourself, you can also let this module
919do the job by specifying a type and type-specific arguments. You 999do the job by specifying a type and type-specific arguments. You
920can also specify the (fully qualified) name of a package, in which 1000can also specify the (fully qualified) name of a package, in which
921case AnyEvent tries to load the package and then expects to find the 1001case AnyEvent tries to load the package and then expects to find the
922C<anyevent_read_type> function inside (see "custom write types", below). 1002C<anyevent_write_type> function inside (see "custom write types", below).
923 1003
924Predefined types are (if you have ideas for additional types, feel free to 1004Predefined types are (if you have ideas for additional types, feel free to
925drop by and tell us): 1005drop by and tell us):
926 1006
927=over 4 1007=over 4
… …
1007=cut 1087=cut
1008 1088
1009register_write_type storable => sub { 1089register_write_type storable => sub {
1010 my ($self, $ref) = @_; 1090 my ($self, $ref) = @_;
1011 1091
1012 require Storable; 1092 require Storable unless $Storable::VERSION;
1013 1093
1014 pack "w/a*", Storable::nfreeze ($ref) 1094 pack "w/a*", Storable::nfreeze ($ref)
1015}; 1095};
1016 1096
1017=back 1097=back
… …
1022before it was actually written. One way to do that is to replace your 1102before 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 1103C<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 1104C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1025replaces the C<on_drain> callback with: 1105replaces the C<on_drain> callback with:
1026 1106
1027 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown 1107 sub { shutdown $_[0]{fh}, 1 }
1028 1108
1029This simply shuts down the write side and signals an EOF condition to the 1109This simply shuts down the write side and signals an EOF condition to the
1030the peer. 1110the peer.
1031 1111
1032You can rely on the normal read queue and C<on_eof> handling 1112You can rely on the normal read queue and C<on_eof> handling
1033afterwards. This is the cleanest way to close a connection. 1113afterwards. This is the cleanest way to close a connection.
1114
1115This method may invoke callbacks (and therefore the handle might be
1116destroyed after it returns).
1034 1117
1035=cut 1118=cut
1036 1119
1037sub push_shutdown { 1120sub push_shutdown {
1038 my ($self) = @_; 1121 my ($self) = @_;
… …
1051 1134
1052Whenever the given C<type> is used, C<push_write> will the function with 1135Whenever the given C<type> is used, C<push_write> will the function with
1053the handle object and the remaining arguments. 1136the handle object and the remaining arguments.
1054 1137
1055The function is supposed to return a single octet string that will be 1138The 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 1139appended to the write buffer, so you can mentally treat this function as a
1057"arguments to on-the-wire-format" converter. 1140"arguments to on-the-wire-format" converter.
1058 1141
1059Example: implement a custom write type C<join> that joins the remaining 1142Example: implement a custom write type C<join> that joins the remaining
1060arguments using the first one. 1143arguments using the first one.
1061 1144
… …
1088ways, the "simple" way, using only C<on_read> and the "complex" way, using 1171ways, the "simple" way, using only C<on_read> and the "complex" way, using
1089a queue. 1172a queue.
1090 1173
1091In the simple case, you just install an C<on_read> callback and whenever 1174In 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 1175new 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 1176enough 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 1177leave the data there if you want to accumulate more (e.g. when only a
1095partial message has been received so far). 1178partial message has been received so far), or change the read queue with
1179e.g. C<push_read>.
1096 1180
1097In the more complex case, you want to queue multiple callbacks. In this 1181In the more complex case, you want to queue multiple callbacks. In this
1098case, AnyEvent::Handle will call the first queued callback each time new 1182case, 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 1183data arrives (also the first time it is queued) and remove it when it has
1100done its job (see C<push_read>, below). 1184done its job (see C<push_read>, below).
1101 1185
1102This way you can, for example, push three line-reads, followed by reading 1186This way you can, for example, push three line-reads, followed by reading
1103a chunk of data, and AnyEvent::Handle will execute them in order. 1187a chunk of data, and AnyEvent::Handle will execute them in order.
1104 1188
… …
1235 1319
1236This replaces the currently set C<on_read> callback, or clears it (when 1320This 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 1321the new callback is C<undef>). See the description of C<on_read> in the
1238constructor. 1322constructor.
1239 1323
1324This method may invoke callbacks (and therefore the handle might be
1325destroyed after it returns).
1326
1240=cut 1327=cut
1241 1328
1242sub on_read { 1329sub on_read {
1243 my ($self, $cb) = @_; 1330 my ($self, $cb) = @_;
1244 1331
… …
1246 $self->_drain_rbuf if $cb; 1333 $self->_drain_rbuf if $cb;
1247} 1334}
1248 1335
1249=item $handle->rbuf 1336=item $handle->rbuf
1250 1337
1251Returns the read buffer (as a modifiable lvalue). 1338Returns the read buffer (as a modifiable lvalue). You can also access the
1339read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1340much faster, and no less clean).
1252 1341
1253You can access the read buffer directly as the C<< ->{rbuf} >> 1342The only operation allowed on the read buffer (apart from looking at it)
1254member, if you want. However, the only operation allowed on the 1343is removing data from its beginning. Otherwise modifying or appending to
1255read buffer (apart from looking at it) is removing data from its 1344it 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 1345
1259NOTE: The read buffer should only be used or modified if the C<on_read>, 1346NOTE: 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 1347callback or when C<push_read> or C<unshift_read> are used with a single
1261automatically manage the read buffer. 1348callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1349will manage the read buffer on their own.
1262 1350
1263=cut 1351=cut
1264 1352
1265sub rbuf : lvalue { 1353sub rbuf : lvalue {
1266 $_[0]{rbuf} 1354 $_[0]{rbuf}
… …
1283 1371
1284If enough data was available, then the callback must remove all data it is 1372If 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 1373interested in (which can be none at all) and return a true value. After returning
1286true, it will be removed from the queue. 1374true, it will be removed from the queue.
1287 1375
1376These methods may invoke callbacks (and therefore the handle might be
1377destroyed after it returns).
1378
1288=cut 1379=cut
1289 1380
1290our %RH; 1381our %RH;
1291 1382
1292sub register_read_type($$) { 1383sub register_read_type($$) {
… …
1314 my $cb = pop; 1405 my $cb = pop;
1315 1406
1316 if (@_) { 1407 if (@_) {
1317 my $type = shift; 1408 my $type = shift;
1318 1409
1410 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1319 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1411 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1320 ->($self, $cb, @_); 1412 ->($self, $cb, @_);
1321 } 1413 }
1322 1414
1323 unshift @{ $self->{_queue} }, $cb; 1415 unshift @{ $self->{_queue} }, $cb;
1324 $self->_drain_rbuf; 1416 $self->_drain_rbuf;
… …
1346data. 1438data.
1347 1439
1348Example: read 2 bytes. 1440Example: read 2 bytes.
1349 1441
1350 $handle->push_read (chunk => 2, sub { 1442 $handle->push_read (chunk => 2, sub {
1351 warn "yay ", unpack "H*", $_[1]; 1443 say "yay " . unpack "H*", $_[1];
1352 }); 1444 });
1353 1445
1354=cut 1446=cut
1355 1447
1356register_read_type chunk => sub { 1448register_read_type chunk => sub {
… …
1390 if (@_ < 3) { 1482 if (@_ < 3) {
1391 # this is more than twice as fast as the generic code below 1483 # this is more than twice as fast as the generic code below
1392 sub { 1484 sub {
1393 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; 1485 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
1394 1486
1395 $cb->($_[0], $1, $2); 1487 $cb->($_[0], "$1", "$2");
1396 1 1488 1
1397 } 1489 }
1398 } else { 1490 } else {
1399 $eol = quotemeta $eol unless ref $eol; 1491 $eol = quotemeta $eol unless ref $eol;
1400 $eol = qr|^(.*?)($eol)|s; 1492 $eol = qr|^(.*?)($eol)|s;
1401 1493
1402 sub { 1494 sub {
1403 $_[0]{rbuf} =~ s/$eol// or return; 1495 $_[0]{rbuf} =~ s/$eol// or return;
1404 1496
1405 $cb->($_[0], $1, $2); 1497 $cb->($_[0], "$1", "$2");
1406 1 1498 1
1407 } 1499 }
1408 } 1500 }
1409}; 1501};
1410 1502
… …
1432the receive buffer when neither C<$accept> nor C<$reject> match, 1524the receive buffer when neither C<$accept> nor C<$reject> match,
1433and everything preceding and including the match will be accepted 1525and everything preceding and including the match will be accepted
1434unconditionally. This is useful to skip large amounts of data that you 1526unconditionally. 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 1527know 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 1528have to start matching from the beginning. This is purely an optimisation
1437and is usually worth only when you expect more than a few kilobytes. 1529and is usually worth it only when you expect more than a few kilobytes.
1438 1530
1439Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1531Example: 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 1532expect 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 1533a 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 1534it only accepts something not ending in either \015 or \012, as these are
1443required for the accept regex. 1535required for the accept regex.
1444 1536
1445 $handle->push_read (regex => 1537 $handle->push_read (regex =>
… …
1458 1550
1459 sub { 1551 sub {
1460 # accept 1552 # accept
1461 if ($$rbuf =~ $accept) { 1553 if ($$rbuf =~ $accept) {
1462 $data .= substr $$rbuf, 0, $+[0], ""; 1554 $data .= substr $$rbuf, 0, $+[0], "";
1463 $cb->($self, $data); 1555 $cb->($_[0], $data);
1464 return 1; 1556 return 1;
1465 } 1557 }
1466 1558
1467 # reject 1559 # reject
1468 if ($reject && $$rbuf =~ $reject) { 1560 if ($reject && $$rbuf =~ $reject) {
1469 $self->_error (Errno::EBADMSG); 1561 $_[0]->_error (Errno::EBADMSG);
1470 } 1562 }
1471 1563
1472 # skip 1564 # skip
1473 if ($skip && $$rbuf =~ $skip) { 1565 if ($skip && $$rbuf =~ $skip) {
1474 $data .= substr $$rbuf, 0, $+[0], ""; 1566 $data .= substr $$rbuf, 0, $+[0], "";
… …
1490 my ($self, $cb) = @_; 1582 my ($self, $cb) = @_;
1491 1583
1492 sub { 1584 sub {
1493 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1585 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1494 if ($_[0]{rbuf} =~ /[^0-9]/) { 1586 if ($_[0]{rbuf} =~ /[^0-9]/) {
1495 $self->_error (Errno::EBADMSG); 1587 $_[0]->_error (Errno::EBADMSG);
1496 } 1588 }
1497 return; 1589 return;
1498 } 1590 }
1499 1591
1500 my $len = $1; 1592 my $len = $1;
1501 1593
1502 $self->unshift_read (chunk => $len, sub { 1594 $_[0]->unshift_read (chunk => $len, sub {
1503 my $string = $_[1]; 1595 my $string = $_[1];
1504 $_[0]->unshift_read (chunk => 1, sub { 1596 $_[0]->unshift_read (chunk => 1, sub {
1505 if ($_[1] eq ",") { 1597 if ($_[1] eq ",") {
1506 $cb->($_[0], $string); 1598 $cb->($_[0], $string);
1507 } else { 1599 } else {
1508 $self->_error (Errno::EBADMSG); 1600 $_[0]->_error (Errno::EBADMSG);
1509 } 1601 }
1510 }); 1602 });
1511 }); 1603 });
1512 1604
1513 1 1605 1
… …
1586 1678
1587 my $data; 1679 my $data;
1588 my $rbuf = \$self->{rbuf}; 1680 my $rbuf = \$self->{rbuf};
1589 1681
1590 sub { 1682 sub {
1591 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1683 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1592 1684
1593 if ($ref) { 1685 if ($ref) {
1594 $self->{rbuf} = $json->incr_text; 1686 $_[0]{rbuf} = $json->incr_text;
1595 $json->incr_text = ""; 1687 $json->incr_text = "";
1596 $cb->($self, $ref); 1688 $cb->($_[0], $ref);
1597 1689
1598 1 1690 1
1599 } elsif ($@) { 1691 } elsif ($@) {
1600 # error case 1692 # error case
1601 $json->incr_skip; 1693 $json->incr_skip;
1602 1694
1603 $self->{rbuf} = $json->incr_text; 1695 $_[0]{rbuf} = $json->incr_text;
1604 $json->incr_text = ""; 1696 $json->incr_text = "";
1605 1697
1606 $self->_error (Errno::EBADMSG); 1698 $_[0]->_error (Errno::EBADMSG);
1607 1699
1608 () 1700 ()
1609 } else { 1701 } else {
1610 $self->{rbuf} = ""; 1702 $_[0]{rbuf} = "";
1611 1703
1612 () 1704 ()
1613 } 1705 }
1614 } 1706 }
1615}; 1707};
… …
1625=cut 1717=cut
1626 1718
1627register_read_type storable => sub { 1719register_read_type storable => sub {
1628 my ($self, $cb) = @_; 1720 my ($self, $cb) = @_;
1629 1721
1630 require Storable; 1722 require Storable unless $Storable::VERSION;
1631 1723
1632 sub { 1724 sub {
1633 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1725 # 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} }) 1726 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1635 or return; 1727 or return;
… …
1648 # read remaining chunk 1740 # read remaining chunk
1649 $_[0]->unshift_read (chunk => $len, sub { 1741 $_[0]->unshift_read (chunk => $len, sub {
1650 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1742 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1651 $cb->($_[0], $ref); 1743 $cb->($_[0], $ref);
1652 } else { 1744 } else {
1653 $self->_error (Errno::EBADMSG); 1745 $_[0]->_error (Errno::EBADMSG);
1654 } 1746 }
1655 }); 1747 });
1656 } 1748 }
1657 1749
1658 1 1750 1
… …
1696Note that AnyEvent::Handle will automatically C<start_read> for you when 1788Note 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 1789you 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 1790will automatically C<stop_read> for you when neither C<on_read> is set nor
1699there are any read requests in the queue. 1791there are any read requests in the queue.
1700 1792
1701These methods will have no effect when in TLS mode (as TLS doesn't support 1793In older versions of this module (<= 5.3), these methods had no effect,
1702half-duplex connections). 1794as TLS does not support half-duplex connections. In current versions they
1795work as expected, as this behaviour is required to avoid certain resource
1796attacks, where the program would be forced to read (and buffer) arbitrary
1797amounts of data before being able to send some data. The drawback is that
1798some readings of the the SSL/TLS specifications basically require this
1799attack to be working, as SSL/TLS implementations might stall sending data
1800during a rehandshake.
1801
1802As a guideline, during the initial handshake, you should not stop reading,
1803and as a client, it might cause problems, depending on your application.
1703 1804
1704=cut 1805=cut
1705 1806
1706sub stop_read { 1807sub stop_read {
1707 my ($self) = @_; 1808 my ($self) = @_;
1708 1809
1709 delete $self->{_rw} unless $self->{tls}; 1810 delete $self->{_rw};
1710} 1811}
1711 1812
1712sub start_read { 1813sub start_read {
1713 my ($self) = @_; 1814 my ($self) = @_;
1714 1815
1715 unless ($self->{_rw} || $self->{_eof}) { 1816 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1716 Scalar::Util::weaken $self; 1817 Scalar::Util::weaken $self;
1717 1818
1718 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1819 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1719 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1820 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1720 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1821 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1721 1822
1722 if ($len > 0) { 1823 if ($len > 0) {
1723 $self->{_activity} = $self->{_ractivity} = AE::now; 1824 $self->{_activity} = $self->{_ractivity} = AE::now;
1724 1825
1725 if ($self->{tls}) { 1826 if ($self->{tls}) {
1726 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1827 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1727 1828
1728 &_dotls ($self); 1829 &_dotls ($self);
1729 } else { 1830 } else {
1730 $self->_drain_rbuf; 1831 $self->_drain_rbuf;
1832 }
1833
1834 if ($len == $self->{read_size}) {
1835 $self->{read_size} *= 2;
1836 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1837 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1731 } 1838 }
1732 1839
1733 } elsif (defined $len) { 1840 } elsif (defined $len) {
1734 delete $self->{_rw}; 1841 delete $self->{_rw};
1735 $self->{_eof} = 1; 1842 $self->{_eof} = 1;
… …
1813 && ($tmp != $ERROR_SYSCALL || $!); 1920 && ($tmp != $ERROR_SYSCALL || $!);
1814 1921
1815 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1922 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1816 $self->{wbuf} .= $tmp; 1923 $self->{wbuf} .= $tmp;
1817 $self->_drain_wbuf; 1924 $self->_drain_wbuf;
1925 $self->{tls} or return; # tls session might have gone away in callback
1818 } 1926 }
1819 1927
1820 $self->{_on_starttls} 1928 $self->{_on_starttls}
1821 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1929 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1822 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1930 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 1952context 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 1953changed to your liking. Note that the handshake might have already started
1846when this function returns. 1954when this function returns.
1847 1955
1848Due to bugs in OpenSSL, it might or might not be possible to do multiple 1956Due 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 1957handshakes on the same stream. It is best to not attempt to use the
1850stopping TLS. 1958stream after stopping TLS.
1959
1960This method may invoke callbacks (and therefore the handle might be
1961destroyed after it returns).
1851 1962
1852=cut 1963=cut
1853 1964
1854our %TLS_CACHE; #TODO not yet documented, should we? 1965our %TLS_CACHE; #TODO not yet documented, should we?
1855 1966
… …
1906 Net::SSLeay::CTX_set_mode ($tls, 1|2); 2017 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1907 2018
1908 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2019 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1909 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2020 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1910 2021
1911 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); 2022 Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
2023 $self->{rbuf} = "";
1912 2024
1913 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 2025 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1914 2026
1915 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 2027 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1916 if $self->{on_starttls}; 2028 if $self->{on_starttls};
… …
1921 2033
1922=item $handle->stoptls 2034=item $handle->stoptls
1923 2035
1924Shuts down the SSL connection - this makes a proper EOF handshake by 2036Shuts down the SSL connection - this makes a proper EOF handshake by
1925sending a close notify to the other side, but since OpenSSL doesn't 2037sending 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 2038support non-blocking shut downs, it is not guaranteed that you can re-use
1927the stream afterwards. 2039the stream afterwards.
2040
2041This method may invoke callbacks (and therefore the handle might be
2042destroyed after it returns).
1928 2043
1929=cut 2044=cut
1930 2045
1931sub stoptls { 2046sub stoptls {
1932 my ($self) = @_; 2047 my ($self) = @_;
1933 2048
1934 if ($self->{tls}) { 2049 if ($self->{tls} && $self->{fh}) {
1935 Net::SSLeay::shutdown ($self->{tls}); 2050 Net::SSLeay::shutdown ($self->{tls});
1936 2051
1937 &_dotls; 2052 &_dotls;
1938 2053
1939# # we don't give a shit. no, we do, but we can't. no...#d# 2054# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1951 if $self->{tls} > 0; 2066 if $self->{tls} > 0;
1952 2067
1953 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 2068 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1954} 2069}
1955 2070
2071=item $handle->resettls
2072
2073This rarely-used method simply resets and TLS state on the handle, usually
2074causing data loss.
2075
2076One case where it may be useful is when you want to skip over the data in
2077the stream but you are not interested in interpreting it, so data loss is
2078no concern.
2079
2080=cut
2081
2082*resettls = \&_freetls;
2083
1956sub DESTROY { 2084sub DESTROY {
1957 my ($self) = @_; 2085 my ($self) = @_;
1958 2086
1959 &_freetls; 2087 &_freetls;
1960 2088
… …
1969 push @linger, AE::io $fh, 1, sub { 2097 push @linger, AE::io $fh, 1, sub {
1970 my $len = syswrite $fh, $wbuf, length $wbuf; 2098 my $len = syswrite $fh, $wbuf, length $wbuf;
1971 2099
1972 if ($len > 0) { 2100 if ($len > 0) {
1973 substr $wbuf, 0, $len, ""; 2101 substr $wbuf, 0, $len, "";
1974 } else { 2102 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1975 @linger = (); # end 2103 @linger = (); # end
1976 } 2104 }
1977 }; 2105 };
1978 push @linger, AE::timer $linger, 0, sub { 2106 push @linger, AE::timer $linger, 0, sub {
1979 @linger = (); 2107 @linger = ();
… …
2016 2144
2017sub AnyEvent::Handle::destroyed::AUTOLOAD { 2145sub AnyEvent::Handle::destroyed::AUTOLOAD {
2018 #nop 2146 #nop
2019} 2147}
2020 2148
2149=item $handle->destroyed
2150
2151Returns false as long as the handle hasn't been destroyed by a call to C<<
2152->destroy >>, true otherwise.
2153
2154Can be useful to decide whether the handle is still valid after some
2155callback possibly destroyed the handle. For example, C<< ->push_write >>,
2156C<< ->starttls >> and other methods can call user callbacks, which in turn
2157can destroy the handle, so work can be avoided by checking sometimes:
2158
2159 $hdl->starttls ("accept");
2160 return if $hdl->destroyed;
2161 $hdl->push_write (...
2162
2163Note that the call to C<push_write> will silently be ignored if the handle
2164has been destroyed, so often you can just ignore the possibility of the
2165handle being destroyed.
2166
2167=cut
2168
2169sub destroyed { 0 }
2170sub AnyEvent::Handle::destroyed::destroyed { 1 }
2171
2021=item AnyEvent::Handle::TLS_CTX 2172=item AnyEvent::Handle::TLS_CTX
2022 2173
2023This function creates and returns the AnyEvent::TLS object used by default 2174This function creates and returns the AnyEvent::TLS object used by default
2024for TLS mode. 2175for TLS mode.
2025 2176
… …
2052 2203
2053It is only safe to "forget" the reference inside EOF or error callbacks, 2204It is only safe to "forget" the reference inside EOF or error callbacks,
2054from within all other callbacks, you need to explicitly call the C<< 2205from within all other callbacks, you need to explicitly call the C<<
2055->destroy >> method. 2206->destroy >> method.
2056 2207
2208=item Why is my C<on_eof> callback never called?
2209
2210Probably because your C<on_error> callback is being called instead: When
2211you have outstanding requests in your read queue, then an EOF is
2212considered an error as you clearly expected some data.
2213
2214To avoid this, make sure you have an empty read queue whenever your handle
2215is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2216an C<on_read> handler that simply pushes the first read requests in the
2217queue.
2218
2219See also the next question, which explains this in a bit more detail.
2220
2221=item How can I serve requests in a loop?
2222
2223Most protocols consist of some setup phase (authentication for example)
2224followed by a request handling phase, where the server waits for requests
2225and handles them, in a loop.
2226
2227There are two important variants: The first (traditional, better) variant
2228handles requests until the server gets some QUIT command, causing it to
2229close the connection first (highly desirable for a busy TCP server). A
2230client dropping the connection is an error, which means this variant can
2231detect an unexpected detection close.
2232
2233To handle this case, always make sure you have a on-empty read queue, by
2234pushing the "read request start" handler on it:
2235
2236 # we assume a request starts with a single line
2237 my @start_request; @start_request = (line => sub {
2238 my ($hdl, $line) = @_;
2239
2240 ... handle request
2241
2242 # push next request read, possibly from a nested callback
2243 $hdl->push_read (@start_request);
2244 });
2245
2246 # auth done, now go into request handling loop
2247 # now push the first @start_request
2248 $hdl->push_read (@start_request);
2249
2250By always having an outstanding C<push_read>, the handle always expects
2251some data and raises the C<EPIPE> error when the connction is dropped
2252unexpectedly.
2253
2254The second variant is a protocol where the client can drop the connection
2255at any time. For TCP, this means that the server machine may run out of
2256sockets easier, and in general, it means you cannot distinguish a protocl
2257failure/client crash from a normal connection close. Nevertheless, these
2258kinds of protocols are common (and sometimes even the best solution to the
2259problem).
2260
2261Having an outstanding read request at all times is possible if you ignore
2262C<EPIPE> errors, but this doesn't help with when the client drops the
2263connection during a request, which would still be an error.
2264
2265A better solution is to push the initial request read in an C<on_read>
2266callback. This avoids an error, as when the server doesn't expect data
2267(i.e. is idly waiting for the next request, an EOF will not raise an
2268error, but simply result in an C<on_eof> callback. It is also a bit slower
2269and simpler:
2270
2271 # auth done, now go into request handling loop
2272 $hdl->on_read (sub {
2273 my ($hdl) = @_;
2274
2275 # called each time we receive data but the read queue is empty
2276 # simply start read the request
2277
2278 $hdl->push_read (line => sub {
2279 my ($hdl, $line) = @_;
2280
2281 ... handle request
2282
2283 # do nothing special when the request has been handled, just
2284 # let the request queue go empty.
2285 });
2286 });
2287
2057=item I get different callback invocations in TLS mode/Why can't I pause 2288=item I get different callback invocations in TLS mode/Why can't I pause
2058reading? 2289reading?
2059 2290
2060Unlike, say, TCP, TLS connections do not consist of two independent 2291Unlike, say, TCP, TLS connections do not consist of two independent
2061communication channels, one for each direction. Or put differently. The 2292communication channels, one for each direction. Or put differently, the
2062read and write directions are not independent of each other: you cannot 2293read and write directions are not independent of each other: you cannot
2063write data unless you are also prepared to read, and vice versa. 2294write data unless you are also prepared to read, and vice versa.
2064 2295
2065This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2296This 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 2297callback invocations when you are not expecting any read data - the reason
2067is that AnyEvent::Handle always reads in TLS mode. 2298is that AnyEvent::Handle always reads in TLS mode.
2068 2299
2069During the connection, you have to make sure that you always have a 2300During 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 2301non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
2082 $handle->on_eof (undef); 2313 $handle->on_eof (undef);
2083 $handle->on_error (sub { 2314 $handle->on_error (sub {
2084 my $data = delete $_[0]{rbuf}; 2315 my $data = delete $_[0]{rbuf};
2085 }); 2316 });
2086 2317
2318Note that this example removes the C<rbuf> member from the handle object,
2319which is not normally allowed by the API. It is expressly permitted in
2320this case only, as the handle object needs to be destroyed afterwards.
2321
2087The reason to use C<on_error> is that TCP connections, due to latencies 2322The 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 2323and packets loss, might get closed quite violently with an error, when in
2089fact, all data has been received. 2324fact all data has been received.
2090 2325
2091It is usually better to use acknowledgements when transferring data, 2326It is usually better to use acknowledgements when transferring data,
2092to make sure the other side hasn't just died and you got the data 2327to 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 2328intact. This is also one reason why so many internet protocols have an
2094explicit QUIT command. 2329explicit QUIT command.
… …
2101C<low_water_mark> this will be called precisely when all data has been 2336C<low_water_mark> this will be called precisely when all data has been
2102written to the socket: 2337written to the socket:
2103 2338
2104 $handle->push_write (...); 2339 $handle->push_write (...);
2105 $handle->on_drain (sub { 2340 $handle->on_drain (sub {
2106 warn "all data submitted to the kernel\n"; 2341 AE::log debug => "all data submitted to the kernel\n";
2107 undef $handle; 2342 undef $handle;
2108 }); 2343 });
2109 2344
2110If you just want to queue some data and then signal EOF to the other side, 2345If you just want to queue some data and then signal EOF to the other side,
2111consider using C<< ->push_shutdown >> instead. 2346consider using C<< ->push_shutdown >> instead.
2112 2347
2113=item I want to contact a TLS/SSL server, I don't care about security. 2348=item I want to contact a TLS/SSL server, I don't care about security.
2114 2349
2115If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2350If 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> 2351connect to it and then create the AnyEvent::Handle with the C<tls>
2117parameter: 2352parameter:
2118 2353
2119 tcp_connect $host, $port, sub { 2354 tcp_connect $host, $port, sub {
2120 my ($fh) = @_; 2355 my ($fh) = @_;
2121 2356
… …
2221 2456
2222=item * all members not documented here and not prefixed with an underscore 2457=item * all members not documented here and not prefixed with an underscore
2223are free to use in subclasses. 2458are free to use in subclasses.
2224 2459
2225Of course, new versions of AnyEvent::Handle may introduce more "public" 2460Of course, new versions of AnyEvent::Handle may introduce more "public"
2226member variables, but thats just life, at least it is documented. 2461member variables, but that's just life. At least it is documented.
2227 2462
2228=back 2463=back
2229 2464
2230=head1 AUTHOR 2465=head1 AUTHOR
2231 2466

Diff Legend

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