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.184 by root, Thu Sep 3 13:14:38 2009 UTC vs.
Revision 1.220 by root, Sun Jul 24 13:10:43 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;
… …
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 warn "got error $msg\n";
17 $hdl->destroy; 17 $hdl->destroy;
18 $cv->send; 18 $cv->send;
19 ); 19 };
20 20
21 # send some request line 21 # send some request line
22 $hdl->push_write ("getinfo\015\012"); 22 $hdl->push_write ("getinfo\015\012");
23 23
24 # read the response line 24 # read the response line
… …
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
… …
60use AnyEvent (); BEGIN { AnyEvent::common_sense } 60use AnyEvent (); BEGIN { AnyEvent::common_sense }
61use AnyEvent::Util qw(WSAEWOULDBLOCK); 61use AnyEvent::Util qw(WSAEWOULDBLOCK);
62 62
63our $VERSION = $AnyEvent::VERSION; 63our $VERSION = $AnyEvent::VERSION;
64 64
65sub _load_func($) {
66 my $func = $_[0];
67
68 unless (defined &$func) {
69 my $pkg = $func;
70 do {
71 $pkg =~ s/::[^:]+$//
72 or return;
73 eval "require $pkg";
74 } until defined &$func;
75 }
76
77 \&$func
78}
79
80sub MAX_READ_SIZE() { 131072 }
81
65=head1 METHODS 82=head1 METHODS
66 83
67=over 4 84=over 4
68 85
69=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 86=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
70 87
71The constructor supports these arguments (all as C<< key => value >> pairs). 88The constructor supports these arguments (all as C<< key => value >> pairs).
72 89
73=over 4 90=over 4
74 91
… …
97=over 4 114=over 4
98 115
99=item on_prepare => $cb->($handle) 116=item on_prepare => $cb->($handle)
100 117
101This (rarely used) callback is called before a new connection is 118This (rarely used) callback is called before a new connection is
102attempted, 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
103prepare the file handle with parameters required for the actual connect 121file handle with parameters required for the actual connect (as opposed to
104(as opposed to settings that can be changed when the connection is already 122settings that can be changed when the connection is already established).
105established).
106 123
107The 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
108seconds (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
109timeout is to be used). 126default timeout is to be used).
110 127
111=item on_connect => $cb->($handle, $host, $port, $retry->()) 128=item on_connect => $cb->($handle, $host, $port, $retry->())
112 129
113This callback is called when a connection has been successfully established. 130This callback is called when a connection has been successfully established.
114 131
115The actual numeric host and port (the socket peername) are passed as 132The peer's numeric host and port (the socket peername) are passed as
116parameters, together with a retry callback. 133parameters, together with a retry callback.
117 134
118When, for some reason, the handle is not acceptable, then calling 135If, for some reason, the handle is not acceptable, calling C<$retry>
119C<$retry> will continue with the next conenction target (in case of 136will continue with the next connection target (in case of multi-homed
120multi-homed hosts or SRV records there can be multiple connection 137hosts or SRV records there can be multiple connection endpoints). At the
121endpoints). 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
122tls status and similar properties of the handle are being reset. 139similar properties of the handle will have been reset.
123 140
124In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
125 142
126=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
127 144
128This callback is called when the conenction could not be 145This callback is called when the connection could not be
129established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
130message describing it (usually the same as C<"$!">). 147message describing it (usually the same as C<"$!">).
131 148
132If 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
133fatal error instead. 150fatal error instead.
… …
136 153
137=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
138 155
139This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
140occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
141connect or a read error. 158connect, or a read error.
142 159
143Some 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
144fatal 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<< ->
145destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
146examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
147with 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
148cases 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
149often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
150 167
151AnyEvent::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
152against, 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
153recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
154error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
155 172
156Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
157to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
158when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
159C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
160 177
161On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
162error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
163C<EPROTO>). 180C<EPROTO>).
164 181
165While 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
166you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
167C<croak>. 184C<croak>.
168 185
169=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
170 187
171This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
176To 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 >>
177method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method or access the C<< $handle->{rbuf} >> member directly. Note that you
178must 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
179the beginning from it. 196the beginning from it.
180 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
181When an EOF condition is detected then AnyEvent::Handle will first try to 201When an EOF condition is detected, AnyEvent::Handle will first try to
182feed 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
183calling 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
184error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
185 205
186Note 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
… …
205set, 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>.
206 226
207=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
208 228
209This 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
210(or when the callback is set and the buffer is empty already). 230(or immediately if the buffer is empty already).
211 231
212To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
213 233
214This 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
215into 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
… …
227many seconds pass without a successful read or write on the underlying 247many seconds pass without a successful read or write on the underlying
228file 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
229will 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>
230error will be raised). 250error will be raised).
231 251
232There are three variants of the timeouts that work fully independent 252There are three variants of the timeouts that work independently of each
233of 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:
234C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 255C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
235C<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
236C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 257C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
237 258
238Note 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
239any outstanding read or write requests: If you plan to keep the connection 260outstanding read or write requests: If you plan to keep the connection
240idle then you should disable the timout temporarily or ignore the timeout 261idle then you should disable the timeout temporarily or ignore the
241in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 262timeout in the corresponding C<on_timeout> callback, in which case
242restart the timeout. 263AnyEvent::Handle will simply restart the timeout.
243 264
244Zero (the default) disables this timeout. 265Zero (the default) disables the corresponding timeout.
245 266
246=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)
247 272
248Called whenever the inactivity timeout passes. If you return from this 273Called whenever the inactivity timeout passes. If you return from this
249callback, 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,
250so this condition is not fatal in any way. 275so this condition is not fatal in any way.
251 276
… …
259be 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
260(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
261amount 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
262isn't finished). 287isn't finished).
263 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
264=item autocork => <boolean> 304=item autocork => <boolean>
265 305
266When disabled (the default), then C<push_write> will try to immediately 306When disabled (the default), C<push_write> will try to immediately
267write 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
268a 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
269be inefficient if you write multiple small chunks (on the wire, this 309be inefficient if you write multiple small chunks (on the wire, this
270disadvantage is usually avoided by your kernel's nagle algorithm, see 310disadvantage is usually avoided by your kernel's nagle algorithm, see
271C<no_delay>, but this option can save costly syscalls). 311C<no_delay>, but this option can save costly syscalls).
272 312
273When enabled, then writes will always be queued till the next event loop 313When enabled, writes will always be queued till the next event loop
274iteration. This is efficient when you do many small writes per iteration, 314iteration. This is efficient when you do many small writes per iteration,
275but 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
276the write buffer often is full). It also increases write latency. 316the write buffer often is full). It also increases write latency.
277 317
278=item no_delay => <boolean> 318=item no_delay => <boolean>
… …
282the Nagle algorithm, and usually it is beneficial. 322the Nagle algorithm, and usually it is beneficial.
283 323
284In 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
285accomplishd by setting this option to a true value. 325accomplishd by setting this option to a true value.
286 326
287The default is your opertaing system's default behaviour (most likely 327The default is your operating system's default behaviour (most likely
288enabled), this option explicitly enables or disables it, if possible. 328enabled). This option explicitly enables or disables it, if possible.
289 329
290=item keepalive => <boolean> 330=item keepalive => <boolean>
291 331
292Enables (default disable) the SO_KEEPALIVE option on the stream socket: 332Enables (default disable) the SO_KEEPALIVE option on the stream socket:
293normally, TCP connections have no time-out once established, so TCP 333normally, TCP connections have no time-out once established, so TCP
294conenctions, once established, can stay alive forever even when the other 334connections, once established, can stay alive forever even when the other
295side 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
296TCP connections whent he other side becomes unreachable. While the default 336TCP connections when the other side becomes unreachable. While the default
297is OS-dependent, TCP keepalives usually kick in after around two hours, 337is OS-dependent, TCP keepalives usually kick in after around two hours,
298and, 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
299to 15 minutes later. 339to 15 minutes later.
300 340
301It 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
… …
319already 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
320from most attacks. 360from most attacks.
321 361
322=item read_size => <bytes> 362=item read_size => <bytes>
323 363
324The default read block size (the amount of bytes this module will 364The initial read block size, the number of bytes this module will try to
325try to read during each loop iteration, which affects memory 365read during each loop iteration. Each handle object will consume at least
326requirements). Default: C<8192>. 366this amount of memory for the read buffer as well, so when handling many
367connections requirements). See also C<max_read_size>. Default: C<2048>.
368
369=item max_read_size => <bytes>
370
371The maximum read buffer size used by the dynamic adjustment
372algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
373one go it will double C<read_size> up to the maximum given by this
374option. Default: C<131072> or C<read_size>, whichever is higher.
327 375
328=item low_water_mark => <bytes> 376=item low_water_mark => <bytes>
329 377
330Sets the amount of bytes (default: C<0>) that make up an "empty" write 378Sets the number of bytes (default: C<0>) that make up an "empty" write
331buffer: If the write reaches this size or gets even samller it is 379buffer: If the buffer reaches this size or gets even samller it is
332considered empty. 380considered empty.
333 381
334Sometimes it can be beneficial (for performance reasons) to add data to 382Sometimes it can be beneficial (for performance reasons) to add data to
335the write buffer before it is fully drained, but this is a rare case, as 383the write buffer before it is fully drained, but this is a rare case, as
336the operating system kernel usually buffers data as well, so the default 384the operating system kernel usually buffers data as well, so the default
337is good in almost all cases. 385is good in almost all cases.
338 386
339=item linger => <seconds> 387=item linger => <seconds>
340 388
341If non-zero (default: C<3600>), then the destructor of the 389If this is non-zero (default: C<3600>), the destructor of the
342AnyEvent::Handle object will check whether there is still outstanding 390AnyEvent::Handle object will check whether there is still outstanding
343write data and will install a watcher that will write this data to the 391write data and will install a watcher that will write this data to the
344socket. No errors will be reported (this mostly matches how the operating 392socket. No errors will be reported (this mostly matches how the operating
345system treats outstanding data at socket close time). 393system treats outstanding data at socket close time).
346 394
… …
353A string used to identify the remote site - usually the DNS hostname 401A string used to identify the remote site - usually the DNS hostname
354(I<not> IDN!) used to create the connection, rarely the IP address. 402(I<not> IDN!) used to create the connection, rarely the IP address.
355 403
356Apart from being useful in error messages, this string is also used in TLS 404Apart from being useful in error messages, this string is also used in TLS
357peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 405peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
358verification will be skipped when C<peername> is not specified or 406verification will be skipped when C<peername> is not specified or is
359C<undef>. 407C<undef>.
360 408
361=item tls => "accept" | "connect" | Net::SSLeay::SSL object 409=item tls => "accept" | "connect" | Net::SSLeay::SSL object
362 410
363When this parameter is given, it enables TLS (SSL) mode, that means 411When this parameter is given, it enables TLS (SSL) mode, that means
364AnyEvent will start a TLS handshake as soon as the conenction has been 412AnyEvent will start a TLS handshake as soon as the connection has been
365established and will transparently encrypt/decrypt data afterwards. 413established and will transparently encrypt/decrypt data afterwards.
366 414
367All TLS protocol errors will be signalled as C<EPROTO>, with an 415All TLS protocol errors will be signalled as C<EPROTO>, with an
368appropriate error message. 416appropriate error message.
369 417
… …
389B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 437B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
390passing in the wrong integer will lead to certain crash. This most often 438passing in the wrong integer will lead to certain crash. This most often
391happens when one uses a stylish C<< tls => 1 >> and is surprised about the 439happens when one uses a stylish C<< tls => 1 >> and is surprised about the
392segmentation fault. 440segmentation fault.
393 441
394See the C<< ->starttls >> method for when need to start TLS negotiation later. 442Use the C<< ->starttls >> method if you need to start TLS negotiation later.
395 443
396=item tls_ctx => $anyevent_tls 444=item tls_ctx => $anyevent_tls
397 445
398Use the given C<AnyEvent::TLS> object to create the new TLS connection 446Use the given C<AnyEvent::TLS> object to create the new TLS connection
399(unless a connection object was specified directly). If this parameter is 447(unless a connection object was specified directly). If this
400missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 448parameter is missing (or C<undef>), then AnyEvent::Handle will use
449C<AnyEvent::Handle::TLS_CTX>.
401 450
402Instead of an object, you can also specify a hash reference with C<< key 451Instead of an object, you can also specify a hash reference with C<< key
403=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a 452=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
404new TLS context object. 453new TLS context object.
405 454
… …
414 463
415TLS handshake failures will not cause C<on_error> to be invoked when this 464TLS handshake failures will not cause C<on_error> to be invoked when this
416callback is in effect, instead, the error message will be passed to C<on_starttls>. 465callback is in effect, instead, the error message will be passed to C<on_starttls>.
417 466
418Without this callback, handshake failures lead to C<on_error> being 467Without this callback, handshake failures lead to C<on_error> being
419called, as normal. 468called as usual.
420 469
421Note that you cannot call C<starttls> right again in this callback. If you 470Note that you cannot just call C<starttls> again in this callback. If you
422need to do that, start an zero-second timer instead whose callback can 471need to do that, start an zero-second timer instead whose callback can
423then call C<< ->starttls >> again. 472then call C<< ->starttls >> again.
424 473
425=item on_stoptls => $cb->($handle) 474=item on_stoptls => $cb->($handle)
426 475
… …
474 $self->{connect}[0], 523 $self->{connect}[0],
475 $self->{connect}[1], 524 $self->{connect}[1],
476 sub { 525 sub {
477 my ($fh, $host, $port, $retry) = @_; 526 my ($fh, $host, $port, $retry) = @_;
478 527
528 delete $self->{_connect}; # no longer needed
529
479 if ($fh) { 530 if ($fh) {
480 $self->{fh} = $fh; 531 $self->{fh} = $fh;
481 532
482 delete $self->{_skip_drain_rbuf}; 533 delete $self->{_skip_drain_rbuf};
483 $self->_start; 534 $self->_start;
… …
490 }); 541 });
491 542
492 } else { 543 } else {
493 if ($self->{on_connect_error}) { 544 if ($self->{on_connect_error}) {
494 $self->{on_connect_error}($self, "$!"); 545 $self->{on_connect_error}($self, "$!");
495 $self->destroy; 546 $self->destroy if $self;
496 } else { 547 } else {
497 $self->_error ($!, 1); 548 $self->_error ($!, 1);
498 } 549 }
499 } 550 }
500 }, 551 },
501 sub { 552 sub {
502 local $self->{fh} = $_[0]; 553 local $self->{fh} = $_[0];
503 554
504 $self->{on_prepare} 555 $self->{on_prepare}
505 ? $self->{on_prepare}->($self) 556 ? $self->{on_prepare}->($self)
506 : () 557 : ()
507 } 558 }
508 ); 559 );
509 } 560 }
510 561
… …
516} 567}
517 568
518sub _start { 569sub _start {
519 my ($self) = @_; 570 my ($self) = @_;
520 571
572 # too many clueless people try to use udp and similar sockets
573 # with AnyEvent::Handle, do them a favour.
574 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
575 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
576 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
577
521 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 578 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
522 579
523 $self->{_activity} = 580 $self->{_activity} =
524 $self->{_ractivity} = 581 $self->{_ractivity} =
525 $self->{_wactivity} = AE::now; 582 $self->{_wactivity} = AE::now;
526 583
584 $self->{read_size} ||= 2048;
585 $self->{max_read_size} = $self->{read_size}
586 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
587
527 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 588 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
528 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; 589 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
529 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; 590 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
530 591
531 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; 592 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
… …
534 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); 595 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
535 596
536 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 597 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
537 if $self->{tls}; 598 if $self->{tls};
538 599
539 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 600 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
540 601
541 $self->start_read 602 $self->start_read
542 if $self->{on_read} || @{ $self->{_queue} }; 603 if $self->{on_read} || @{ $self->{_queue} };
543 604
544 $self->_drain_wbuf; 605 $self->_drain_wbuf;
… …
551 $message ||= "$!"; 612 $message ||= "$!";
552 613
553 if ($self->{on_error}) { 614 if ($self->{on_error}) {
554 $self->{on_error}($self, $fatal, $message); 615 $self->{on_error}($self, $fatal, $message);
555 $self->destroy if $fatal; 616 $self->destroy if $fatal;
556 } elsif ($self->{fh}) { 617 } elsif ($self->{fh} || $self->{connect}) {
557 $self->destroy; 618 $self->destroy;
558 Carp::croak "AnyEvent::Handle uncaught error: $message"; 619 Carp::croak "AnyEvent::Handle uncaught error: $message";
559 } 620 }
560} 621}
561 622
… …
620=cut 681=cut
621 682
622sub no_delay { 683sub no_delay {
623 $_[0]{no_delay} = $_[1]; 684 $_[0]{no_delay} = $_[1];
624 685
625 eval {
626 local $SIG{__DIE__};
627 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] 686 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
628 if $_[0]{fh}; 687 if $_[0]{fh};
629 };
630} 688}
631 689
632=item $handle->keepalive ($boolean) 690=item $handle->keepalive ($boolean)
633 691
634Enables or disables the C<keepalive> setting (see constructor argument of 692Enables or disables the C<keepalive> setting (see constructor argument of
… …
694 752
695Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 753Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
696 754
697=cut 755=cut
698 756
699sub on_starttls { 757sub on_stoptls {
700 $_[0]{on_stoptls} = $_[1]; 758 $_[0]{on_stoptls} = $_[1];
701} 759}
702 760
703=item $handle->rbuf_max ($max_octets) 761=item $handle->rbuf_max ($max_octets)
704 762
705Configures the C<rbuf_max> setting (C<undef> disables it). 763Configures the C<rbuf_max> setting (C<undef> disables it).
764
765=item $handle->wbuf_max ($max_octets)
766
767Configures the C<wbuf_max> setting (C<undef> disables it).
706 768
707=cut 769=cut
708 770
709sub rbuf_max { 771sub rbuf_max {
710 $_[0]{rbuf_max} = $_[1]; 772 $_[0]{rbuf_max} = $_[1];
711} 773}
712 774
775sub wbuf_max {
776 $_[0]{wbuf_max} = $_[1];
777}
778
713############################################################################# 779#############################################################################
714 780
715=item $handle->timeout ($seconds) 781=item $handle->timeout ($seconds)
716 782
717=item $handle->rtimeout ($seconds) 783=item $handle->rtimeout ($seconds)
718 784
719=item $handle->wtimeout ($seconds) 785=item $handle->wtimeout ($seconds)
720 786
721Configures (or disables) the inactivity timeout. 787Configures (or disables) the inactivity timeout.
788
789The timeout will be checked instantly, so this method might destroy the
790handle before it returns.
722 791
723=item $handle->timeout_reset 792=item $handle->timeout_reset
724 793
725=item $handle->rtimeout_reset 794=item $handle->rtimeout_reset
726 795
… …
743 $_[0]{$on_timeout} = $_[1]; 812 $_[0]{$on_timeout} = $_[1];
744 }; 813 };
745 814
746 *$timeout = sub { 815 *$timeout = sub {
747 my ($self, $new_value) = @_; 816 my ($self, $new_value) = @_;
817
818 $new_value >= 0
819 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
748 820
749 $self->{$timeout} = $new_value; 821 $self->{$timeout} = $new_value;
750 delete $self->{$tw}; &$cb; 822 delete $self->{$tw}; &$cb;
751 }; 823 };
752 824
… …
816=item $handle->on_drain ($cb) 888=item $handle->on_drain ($cb)
817 889
818Sets the C<on_drain> callback or clears it (see the description of 890Sets the C<on_drain> callback or clears it (see the description of
819C<on_drain> in the constructor). 891C<on_drain> in the constructor).
820 892
893This method may invoke callbacks (and therefore the handle might be
894destroyed after it returns).
895
821=cut 896=cut
822 897
823sub on_drain { 898sub on_drain {
824 my ($self, $cb) = @_; 899 my ($self, $cb) = @_;
825 900
… …
829 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); 904 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
830} 905}
831 906
832=item $handle->push_write ($data) 907=item $handle->push_write ($data)
833 908
834Queues the given scalar to be written. You can push as much data as you 909Queues the given scalar to be written. You can push as much data as
835want (only limited by the available memory), as C<AnyEvent::Handle> 910you want (only limited by the available memory and C<wbuf_max>), as
836buffers it independently of the kernel. 911C<AnyEvent::Handle> buffers it independently of the kernel.
912
913This method may invoke callbacks (and therefore the handle might be
914destroyed after it returns).
837 915
838=cut 916=cut
839 917
840sub _drain_wbuf { 918sub _drain_wbuf {
841 my ($self) = @_; 919 my ($self) = @_;
… …
866 $cb->() unless $self->{autocork}; 944 $cb->() unless $self->{autocork};
867 945
868 # if still data left in wbuf, we need to poll 946 # if still data left in wbuf, we need to poll
869 $self->{_ww} = AE::io $self->{fh}, 1, $cb 947 $self->{_ww} = AE::io $self->{fh}, 1, $cb
870 if length $self->{wbuf}; 948 if length $self->{wbuf};
949
950 if (
951 defined $self->{wbuf_max}
952 && $self->{wbuf_max} < length $self->{wbuf}
953 ) {
954 $self->_error (Errno::ENOSPC, 1), return;
955 }
871 }; 956 };
872} 957}
873 958
874our %WH; 959our %WH;
875 960
961# deprecated
876sub register_write_type($$) { 962sub register_write_type($$) {
877 $WH{$_[0]} = $_[1]; 963 $WH{$_[0]} = $_[1];
878} 964}
879 965
880sub push_write { 966sub push_write {
881 my $self = shift; 967 my $self = shift;
882 968
883 if (@_ > 1) { 969 if (@_ > 1) {
884 my $type = shift; 970 my $type = shift;
885 971
972 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
886 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 973 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
887 ->($self, @_); 974 ->($self, @_);
888 } 975 }
889 976
977 # we downgrade here to avoid hard-to-track-down bugs,
978 # and diagnose the problem earlier and better.
979
890 if ($self->{tls}) { 980 if ($self->{tls}) {
891 $self->{_tls_wbuf} .= $_[0]; 981 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
892 &_dotls ($self) if $self->{fh}; 982 &_dotls ($self) if $self->{fh};
893 } else { 983 } else {
894 $self->{wbuf} .= $_[0]; 984 utf8::downgrade $self->{wbuf} .= $_[0];
895 $self->_drain_wbuf if $self->{fh}; 985 $self->_drain_wbuf if $self->{fh};
896 } 986 }
897} 987}
898 988
899=item $handle->push_write (type => @args) 989=item $handle->push_write (type => @args)
900 990
901Instead of formatting your data yourself, you can also let this module do 991Instead of formatting your data yourself, you can also let this module
902the job by specifying a type and type-specific arguments. 992do the job by specifying a type and type-specific arguments. You
993can also specify the (fully qualified) name of a package, in which
994case AnyEvent tries to load the package and then expects to find the
995C<anyevent_write_type> function inside (see "custom write types", below).
903 996
904Predefined types are (if you have ideas for additional types, feel free to 997Predefined types are (if you have ideas for additional types, feel free to
905drop by and tell us): 998drop by and tell us):
906 999
907=over 4 1000=over 4
… …
1002before it was actually written. One way to do that is to replace your 1095before it was actually written. One way to do that is to replace your
1003C<on_drain> handler by a callback that shuts down the socket (and set 1096C<on_drain> handler by a callback that shuts down the socket (and set
1004C<low_water_mark> to C<0>). This method is a shorthand for just that, and 1097C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1005replaces the C<on_drain> callback with: 1098replaces the C<on_drain> callback with:
1006 1099
1007 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown 1100 sub { shutdown $_[0]{fh}, 1 }
1008 1101
1009This simply shuts down the write side and signals an EOF condition to the 1102This simply shuts down the write side and signals an EOF condition to the
1010the peer. 1103the peer.
1011 1104
1012You can rely on the normal read queue and C<on_eof> handling 1105You can rely on the normal read queue and C<on_eof> handling
1013afterwards. This is the cleanest way to close a connection. 1106afterwards. This is the cleanest way to close a connection.
1014 1107
1108This method may invoke callbacks (and therefore the handle might be
1109destroyed after it returns).
1110
1015=cut 1111=cut
1016 1112
1017sub push_shutdown { 1113sub push_shutdown {
1018 my ($self) = @_; 1114 my ($self) = @_;
1019 1115
1020 delete $self->{low_water_mark}; 1116 delete $self->{low_water_mark};
1021 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1117 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
1022} 1118}
1023 1119
1024=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1120=item custom write types - Package::anyevent_write_type $handle, @args
1025 1121
1026This function (not method) lets you add your own types to C<push_write>. 1122Instead of one of the predefined types, you can also specify the name of
1123a package. AnyEvent will try to load the package and then expects to find
1124a function named C<anyevent_write_type> inside. If it isn't found, it
1125progressively tries to load the parent package until it either finds the
1126function (good) or runs out of packages (bad).
1127
1027Whenever the given C<type> is used, C<push_write> will invoke the code 1128Whenever the given C<type> is used, C<push_write> will the function with
1028reference with the handle object and the remaining arguments. 1129the handle object and the remaining arguments.
1029 1130
1030The code reference is supposed to return a single octet string that will 1131The function is supposed to return a single octet string that will be
1031be appended to the write buffer. 1132appended to the write buffer, so you cna mentally treat this function as a
1133"arguments to on-the-wire-format" converter.
1032 1134
1033Note that this is a function, and all types registered this way will be 1135Example: implement a custom write type C<join> that joins the remaining
1034global, so try to use unique names. 1136arguments using the first one.
1137
1138 $handle->push_write (My::Type => " ", 1,2,3);
1139
1140 # uses the following package, which can be defined in the "My::Type" or in
1141 # the "My" modules to be auto-loaded, or just about anywhere when the
1142 # My::Type::anyevent_write_type is defined before invoking it.
1143
1144 package My::Type;
1145
1146 sub anyevent_write_type {
1147 my ($handle, $delim, @args) = @_;
1148
1149 join $delim, @args
1150 }
1035 1151
1036=cut 1152=cut
1037 1153
1038############################################################################# 1154#############################################################################
1039 1155
… …
1048ways, the "simple" way, using only C<on_read> and the "complex" way, using 1164ways, the "simple" way, using only C<on_read> and the "complex" way, using
1049a queue. 1165a queue.
1050 1166
1051In the simple case, you just install an C<on_read> callback and whenever 1167In the simple case, you just install an C<on_read> callback and whenever
1052new data arrives, it will be called. You can then remove some data (if 1168new data arrives, it will be called. You can then remove some data (if
1053enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1169enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
1054leave the data there if you want to accumulate more (e.g. when only a 1170leave the data there if you want to accumulate more (e.g. when only a
1055partial message has been received so far). 1171partial message has been received so far), or change the read queue with
1172e.g. C<push_read>.
1056 1173
1057In the more complex case, you want to queue multiple callbacks. In this 1174In the more complex case, you want to queue multiple callbacks. In this
1058case, AnyEvent::Handle will call the first queued callback each time new 1175case, AnyEvent::Handle will call the first queued callback each time new
1059data arrives (also the first time it is queued) and removes it when it has 1176data arrives (also the first time it is queued) and remove it when it has
1060done its job (see C<push_read>, below). 1177done its job (see C<push_read>, below).
1061 1178
1062This way you can, for example, push three line-reads, followed by reading 1179This way you can, for example, push three line-reads, followed by reading
1063a chunk of data, and AnyEvent::Handle will execute them in order. 1180a chunk of data, and AnyEvent::Handle will execute them in order.
1064 1181
… …
1195 1312
1196This replaces the currently set C<on_read> callback, or clears it (when 1313This replaces the currently set C<on_read> callback, or clears it (when
1197the new callback is C<undef>). See the description of C<on_read> in the 1314the new callback is C<undef>). See the description of C<on_read> in the
1198constructor. 1315constructor.
1199 1316
1317This method may invoke callbacks (and therefore the handle might be
1318destroyed after it returns).
1319
1200=cut 1320=cut
1201 1321
1202sub on_read { 1322sub on_read {
1203 my ($self, $cb) = @_; 1323 my ($self, $cb) = @_;
1204 1324
… …
1206 $self->_drain_rbuf if $cb; 1326 $self->_drain_rbuf if $cb;
1207} 1327}
1208 1328
1209=item $handle->rbuf 1329=item $handle->rbuf
1210 1330
1211Returns the read buffer (as a modifiable lvalue). 1331Returns the read buffer (as a modifiable lvalue). You can also access the
1332read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1333much faster, and no less clean).
1212 1334
1213You can access the read buffer directly as the C<< ->{rbuf} >> 1335The only operation allowed on the read buffer (apart from looking at it)
1214member, if you want. However, the only operation allowed on the 1336is removing data from its beginning. Otherwise modifying or appending to
1215read buffer (apart from looking at it) is removing data from its 1337it is not allowed and will lead to hard-to-track-down bugs.
1216beginning. Otherwise modifying or appending to it is not allowed and will
1217lead to hard-to-track-down bugs.
1218 1338
1219NOTE: The read buffer should only be used or modified if the C<on_read>, 1339NOTE: The read buffer should only be used or modified in the C<on_read>
1220C<push_read> or C<unshift_read> methods are used. The other read methods 1340callback or when C<push_read> or C<unshift_read> are used with a single
1221automatically manage the read buffer. 1341callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1342will manage the read buffer on their own.
1222 1343
1223=cut 1344=cut
1224 1345
1225sub rbuf : lvalue { 1346sub rbuf : lvalue {
1226 $_[0]{rbuf} 1347 $_[0]{rbuf}
… …
1243 1364
1244If enough data was available, then the callback must remove all data it is 1365If enough data was available, then the callback must remove all data it is
1245interested in (which can be none at all) and return a true value. After returning 1366interested in (which can be none at all) and return a true value. After returning
1246true, it will be removed from the queue. 1367true, it will be removed from the queue.
1247 1368
1369These methods may invoke callbacks (and therefore the handle might be
1370destroyed after it returns).
1371
1248=cut 1372=cut
1249 1373
1250our %RH; 1374our %RH;
1251 1375
1252sub register_read_type($$) { 1376sub register_read_type($$) {
… …
1258 my $cb = pop; 1382 my $cb = pop;
1259 1383
1260 if (@_) { 1384 if (@_) {
1261 my $type = shift; 1385 my $type = shift;
1262 1386
1387 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1263 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1388 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1264 ->($self, $cb, @_); 1389 ->($self, $cb, @_);
1265 } 1390 }
1266 1391
1267 push @{ $self->{_queue} }, $cb; 1392 push @{ $self->{_queue} }, $cb;
1268 $self->_drain_rbuf; 1393 $self->_drain_rbuf;
… …
1273 my $cb = pop; 1398 my $cb = pop;
1274 1399
1275 if (@_) { 1400 if (@_) {
1276 my $type = shift; 1401 my $type = shift;
1277 1402
1403 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1278 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1404 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1279 ->($self, $cb, @_); 1405 ->($self, $cb, @_);
1280 } 1406 }
1281 1407
1282 unshift @{ $self->{_queue} }, $cb; 1408 unshift @{ $self->{_queue} }, $cb;
1283 $self->_drain_rbuf; 1409 $self->_drain_rbuf;
… …
1287 1413
1288=item $handle->unshift_read (type => @args, $cb) 1414=item $handle->unshift_read (type => @args, $cb)
1289 1415
1290Instead of providing a callback that parses the data itself you can chose 1416Instead of providing a callback that parses the data itself you can chose
1291between a number of predefined parsing formats, for chunks of data, lines 1417between a number of predefined parsing formats, for chunks of data, lines
1292etc. 1418etc. You can also specify the (fully qualified) name of a package, in
1419which case AnyEvent tries to load the package and then expects to find the
1420C<anyevent_read_type> function inside (see "custom read types", below).
1293 1421
1294Predefined types are (if you have ideas for additional types, feel free to 1422Predefined types are (if you have ideas for additional types, feel free to
1295drop by and tell us): 1423drop by and tell us):
1296 1424
1297=over 4 1425=over 4
… …
1389the receive buffer when neither C<$accept> nor C<$reject> match, 1517the receive buffer when neither C<$accept> nor C<$reject> match,
1390and everything preceding and including the match will be accepted 1518and everything preceding and including the match will be accepted
1391unconditionally. This is useful to skip large amounts of data that you 1519unconditionally. This is useful to skip large amounts of data that you
1392know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1520know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1393have to start matching from the beginning. This is purely an optimisation 1521have to start matching from the beginning. This is purely an optimisation
1394and is usually worth only when you expect more than a few kilobytes. 1522and is usually worth it only when you expect more than a few kilobytes.
1395 1523
1396Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1524Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1397expect the header to be very large (it isn't in practise, but...), we use 1525expect the header to be very large (it isn't in practice, but...), we use
1398a skip regex to skip initial portions. The skip regex is tricky in that 1526a skip regex to skip initial portions. The skip regex is tricky in that
1399it only accepts something not ending in either \015 or \012, as these are 1527it only accepts something not ending in either \015 or \012, as these are
1400required for the accept regex. 1528required for the accept regex.
1401 1529
1402 $handle->push_read (regex => 1530 $handle->push_read (regex =>
… …
1415 1543
1416 sub { 1544 sub {
1417 # accept 1545 # accept
1418 if ($$rbuf =~ $accept) { 1546 if ($$rbuf =~ $accept) {
1419 $data .= substr $$rbuf, 0, $+[0], ""; 1547 $data .= substr $$rbuf, 0, $+[0], "";
1420 $cb->($self, $data); 1548 $cb->($_[0], $data);
1421 return 1; 1549 return 1;
1422 } 1550 }
1423 1551
1424 # reject 1552 # reject
1425 if ($reject && $$rbuf =~ $reject) { 1553 if ($reject && $$rbuf =~ $reject) {
1426 $self->_error (Errno::EBADMSG); 1554 $_[0]->_error (Errno::EBADMSG);
1427 } 1555 }
1428 1556
1429 # skip 1557 # skip
1430 if ($skip && $$rbuf =~ $skip) { 1558 if ($skip && $$rbuf =~ $skip) {
1431 $data .= substr $$rbuf, 0, $+[0], ""; 1559 $data .= substr $$rbuf, 0, $+[0], "";
… …
1447 my ($self, $cb) = @_; 1575 my ($self, $cb) = @_;
1448 1576
1449 sub { 1577 sub {
1450 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1578 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1451 if ($_[0]{rbuf} =~ /[^0-9]/) { 1579 if ($_[0]{rbuf} =~ /[^0-9]/) {
1452 $self->_error (Errno::EBADMSG); 1580 $_[0]->_error (Errno::EBADMSG);
1453 } 1581 }
1454 return; 1582 return;
1455 } 1583 }
1456 1584
1457 my $len = $1; 1585 my $len = $1;
1458 1586
1459 $self->unshift_read (chunk => $len, sub { 1587 $_[0]->unshift_read (chunk => $len, sub {
1460 my $string = $_[1]; 1588 my $string = $_[1];
1461 $_[0]->unshift_read (chunk => 1, sub { 1589 $_[0]->unshift_read (chunk => 1, sub {
1462 if ($_[1] eq ",") { 1590 if ($_[1] eq ",") {
1463 $cb->($_[0], $string); 1591 $cb->($_[0], $string);
1464 } else { 1592 } else {
1465 $self->_error (Errno::EBADMSG); 1593 $_[0]->_error (Errno::EBADMSG);
1466 } 1594 }
1467 }); 1595 });
1468 }); 1596 });
1469 1597
1470 1 1598 1
… …
1543 1671
1544 my $data; 1672 my $data;
1545 my $rbuf = \$self->{rbuf}; 1673 my $rbuf = \$self->{rbuf};
1546 1674
1547 sub { 1675 sub {
1548 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1676 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1549 1677
1550 if ($ref) { 1678 if ($ref) {
1551 $self->{rbuf} = $json->incr_text; 1679 $_[0]{rbuf} = $json->incr_text;
1552 $json->incr_text = ""; 1680 $json->incr_text = "";
1553 $cb->($self, $ref); 1681 $cb->($_[0], $ref);
1554 1682
1555 1 1683 1
1556 } elsif ($@) { 1684 } elsif ($@) {
1557 # error case 1685 # error case
1558 $json->incr_skip; 1686 $json->incr_skip;
1559 1687
1560 $self->{rbuf} = $json->incr_text; 1688 $_[0]{rbuf} = $json->incr_text;
1561 $json->incr_text = ""; 1689 $json->incr_text = "";
1562 1690
1563 $self->_error (Errno::EBADMSG); 1691 $_[0]->_error (Errno::EBADMSG);
1564 1692
1565 () 1693 ()
1566 } else { 1694 } else {
1567 $self->{rbuf} = ""; 1695 $_[0]{rbuf} = "";
1568 1696
1569 () 1697 ()
1570 } 1698 }
1571 } 1699 }
1572}; 1700};
… …
1605 # read remaining chunk 1733 # read remaining chunk
1606 $_[0]->unshift_read (chunk => $len, sub { 1734 $_[0]->unshift_read (chunk => $len, sub {
1607 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1735 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1608 $cb->($_[0], $ref); 1736 $cb->($_[0], $ref);
1609 } else { 1737 } else {
1610 $self->_error (Errno::EBADMSG); 1738 $_[0]->_error (Errno::EBADMSG);
1611 } 1739 }
1612 }); 1740 });
1613 } 1741 }
1614 1742
1615 1 1743 1
1616 } 1744 }
1617}; 1745};
1618 1746
1619=back 1747=back
1620 1748
1621=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1749=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1622 1750
1623This function (not method) lets you add your own types to C<push_read>. 1751Instead of one of the predefined types, you can also specify the name
1752of a package. AnyEvent will try to load the package and then expects to
1753find a function named C<anyevent_read_type> inside. If it isn't found, it
1754progressively tries to load the parent package until it either finds the
1755function (good) or runs out of packages (bad).
1624 1756
1625Whenever the given C<type> is used, C<push_read> will invoke the code 1757Whenever this type is used, C<push_read> will invoke the function with the
1626reference with the handle object, the callback and the remaining 1758handle object, the original callback and the remaining arguments.
1627arguments.
1628 1759
1629The code reference is supposed to return a callback (usually a closure) 1760The function is supposed to return a callback (usually a closure) that
1630that works as a plain read callback (see C<< ->push_read ($cb) >>). 1761works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1762mentally treat the function as a "configurable read type to read callback"
1763converter.
1631 1764
1632It should invoke the passed callback when it is done reading (remember to 1765It should invoke the original callback when it is done reading (remember
1633pass C<$handle> as first argument as all other callbacks do that). 1766to pass C<$handle> as first argument as all other callbacks do that,
1767although there is no strict requirement on this).
1634 1768
1635Note that this is a function, and all types registered this way will be
1636global, so try to use unique names.
1637
1638For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1769For examples, see the source of this module (F<perldoc -m
1639search for C<register_read_type>)). 1770AnyEvent::Handle>, search for C<register_read_type>)).
1640 1771
1641=item $handle->stop_read 1772=item $handle->stop_read
1642 1773
1643=item $handle->start_read 1774=item $handle->start_read
1644 1775
… …
1650Note that AnyEvent::Handle will automatically C<start_read> for you when 1781Note that AnyEvent::Handle will automatically C<start_read> for you when
1651you change the C<on_read> callback or push/unshift a read callback, and it 1782you change the C<on_read> callback or push/unshift a read callback, and it
1652will automatically C<stop_read> for you when neither C<on_read> is set nor 1783will automatically C<stop_read> for you when neither C<on_read> is set nor
1653there are any read requests in the queue. 1784there are any read requests in the queue.
1654 1785
1655These methods will have no effect when in TLS mode (as TLS doesn't support 1786In older versions of this module (<= 5.3), these methods had no effect,
1656half-duplex connections). 1787as TLS does not support half-duplex connections. In current versions they
1788work as expected, as this behaviour is required to avoid certain resource
1789attacks, where the program would be forced to read (and buffer) arbitrary
1790amounts of data before being able to send some data. The drawback is that
1791some readings of the the SSL/TLS specifications basically require this
1792attack to be working, as SSL/TLS implementations might stall sending data
1793during a rehandshake.
1794
1795As a guideline, during the initial handshake, you should not stop reading,
1796and as a client, it might cause problems, depending on your applciation.
1657 1797
1658=cut 1798=cut
1659 1799
1660sub stop_read { 1800sub stop_read {
1661 my ($self) = @_; 1801 my ($self) = @_;
1662 1802
1663 delete $self->{_rw} unless $self->{tls}; 1803 delete $self->{_rw};
1664} 1804}
1665 1805
1666sub start_read { 1806sub start_read {
1667 my ($self) = @_; 1807 my ($self) = @_;
1668 1808
1669 unless ($self->{_rw} || $self->{_eof}) { 1809 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1670 Scalar::Util::weaken $self; 1810 Scalar::Util::weaken $self;
1671 1811
1672 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1812 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1673 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1813 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1674 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1814 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1675 1815
1676 if ($len > 0) { 1816 if ($len > 0) {
1677 $self->{_activity} = $self->{_ractivity} = AE::now; 1817 $self->{_activity} = $self->{_ractivity} = AE::now;
1678 1818
1679 if ($self->{tls}) { 1819 if ($self->{tls}) {
1680 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1820 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1681 1821
1682 &_dotls ($self); 1822 &_dotls ($self);
1683 } else { 1823 } else {
1684 $self->_drain_rbuf; 1824 $self->_drain_rbuf;
1825 }
1826
1827 if ($len == $self->{read_size}) {
1828 $self->{read_size} *= 2;
1829 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1830 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1685 } 1831 }
1686 1832
1687 } elsif (defined $len) { 1833 } elsif (defined $len) {
1688 delete $self->{_rw}; 1834 delete $self->{_rw};
1689 $self->{_eof} = 1; 1835 $self->{_eof} = 1;
… …
1767 && ($tmp != $ERROR_SYSCALL || $!); 1913 && ($tmp != $ERROR_SYSCALL || $!);
1768 1914
1769 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1915 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1770 $self->{wbuf} .= $tmp; 1916 $self->{wbuf} .= $tmp;
1771 $self->_drain_wbuf; 1917 $self->_drain_wbuf;
1918 $self->{tls} or return; # tls session might have gone away in callback
1772 } 1919 }
1773 1920
1774 $self->{_on_starttls} 1921 $self->{_on_starttls}
1775 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1922 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1776 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1923 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1798context in C<< $handle->{tls_ctx} >> after this call and can be used or 1945context in C<< $handle->{tls_ctx} >> after this call and can be used or
1799changed to your liking. Note that the handshake might have already started 1946changed to your liking. Note that the handshake might have already started
1800when this function returns. 1947when this function returns.
1801 1948
1802Due to bugs in OpenSSL, it might or might not be possible to do multiple 1949Due to bugs in OpenSSL, it might or might not be possible to do multiple
1803handshakes on the same stream. Best do not attempt to use the stream after 1950handshakes on the same stream. It is best to not attempt to use the
1804stopping TLS. 1951stream after stopping TLS.
1952
1953This method may invoke callbacks (and therefore the handle might be
1954destroyed after it returns).
1805 1955
1806=cut 1956=cut
1807 1957
1808our %TLS_CACHE; #TODO not yet documented, should we? 1958our %TLS_CACHE; #TODO not yet documented, should we?
1809 1959
… …
1860 Net::SSLeay::CTX_set_mode ($tls, 1|2); 2010 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1861 2011
1862 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2012 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1863 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2013 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1864 2014
1865 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); 2015 Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
2016 $self->{rbuf} = "";
1866 2017
1867 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 2018 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1868 2019
1869 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 2020 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1870 if $self->{on_starttls}; 2021 if $self->{on_starttls};
… …
1875 2026
1876=item $handle->stoptls 2027=item $handle->stoptls
1877 2028
1878Shuts down the SSL connection - this makes a proper EOF handshake by 2029Shuts down the SSL connection - this makes a proper EOF handshake by
1879sending a close notify to the other side, but since OpenSSL doesn't 2030sending a close notify to the other side, but since OpenSSL doesn't
1880support non-blocking shut downs, it is not guarenteed that you can re-use 2031support non-blocking shut downs, it is not guaranteed that you can re-use
1881the stream afterwards. 2032the stream afterwards.
2033
2034This method may invoke callbacks (and therefore the handle might be
2035destroyed after it returns).
1882 2036
1883=cut 2037=cut
1884 2038
1885sub stoptls { 2039sub stoptls {
1886 my ($self) = @_; 2040 my ($self) = @_;
1887 2041
1888 if ($self->{tls}) { 2042 if ($self->{tls} && $self->{fh}) {
1889 Net::SSLeay::shutdown ($self->{tls}); 2043 Net::SSLeay::shutdown ($self->{tls});
1890 2044
1891 &_dotls; 2045 &_dotls;
1892 2046
1893# # we don't give a shit. no, we do, but we can't. no...#d# 2047# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1905 if $self->{tls} > 0; 2059 if $self->{tls} > 0;
1906 2060
1907 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 2061 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1908} 2062}
1909 2063
2064=item $handle->resettls
2065
2066This rarely-used method simply resets and TLS state on the handle, usually
2067causing data loss.
2068
2069One case where it may be useful is when you want to skip over the data in
2070the stream but you are not interested in interpreting it, so data loss is
2071no concern.
2072
2073=cut
2074
2075*resettls = \&_freetls;
2076
1910sub DESTROY { 2077sub DESTROY {
1911 my ($self) = @_; 2078 my ($self) = @_;
1912 2079
1913 &_freetls; 2080 &_freetls;
1914 2081
… …
1923 push @linger, AE::io $fh, 1, sub { 2090 push @linger, AE::io $fh, 1, sub {
1924 my $len = syswrite $fh, $wbuf, length $wbuf; 2091 my $len = syswrite $fh, $wbuf, length $wbuf;
1925 2092
1926 if ($len > 0) { 2093 if ($len > 0) {
1927 substr $wbuf, 0, $len, ""; 2094 substr $wbuf, 0, $len, "";
1928 } else { 2095 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1929 @linger = (); # end 2096 @linger = (); # end
1930 } 2097 }
1931 }; 2098 };
1932 push @linger, AE::timer $linger, 0, sub { 2099 push @linger, AE::timer $linger, 0, sub {
1933 @linger = (); 2100 @linger = ();
… …
1970 2137
1971sub AnyEvent::Handle::destroyed::AUTOLOAD { 2138sub AnyEvent::Handle::destroyed::AUTOLOAD {
1972 #nop 2139 #nop
1973} 2140}
1974 2141
2142=item $handle->destroyed
2143
2144Returns false as long as the handle hasn't been destroyed by a call to C<<
2145->destroy >>, true otherwise.
2146
2147Can be useful to decide whether the handle is still valid after some
2148callback possibly destroyed the handle. For example, C<< ->push_write >>,
2149C<< ->starttls >> and other methods can call user callbacks, which in turn
2150can destroy the handle, so work can be avoided by checking sometimes:
2151
2152 $hdl->starttls ("accept");
2153 return if $hdl->destroyed;
2154 $hdl->push_write (...
2155
2156Note that the call to C<push_write> will silently be ignored if the handle
2157has been destroyed, so often you can just ignore the possibility of the
2158handle being destroyed.
2159
2160=cut
2161
2162sub destroyed { 0 }
2163sub AnyEvent::Handle::destroyed::destroyed { 1 }
2164
1975=item AnyEvent::Handle::TLS_CTX 2165=item AnyEvent::Handle::TLS_CTX
1976 2166
1977This function creates and returns the AnyEvent::TLS object used by default 2167This function creates and returns the AnyEvent::TLS object used by default
1978for TLS mode. 2168for TLS mode.
1979 2169
… …
2006 2196
2007It is only safe to "forget" the reference inside EOF or error callbacks, 2197It is only safe to "forget" the reference inside EOF or error callbacks,
2008from within all other callbacks, you need to explicitly call the C<< 2198from within all other callbacks, you need to explicitly call the C<<
2009->destroy >> method. 2199->destroy >> method.
2010 2200
2201=item Why is my C<on_eof> callback never called?
2202
2203Probably because your C<on_error> callback is being called instead: When
2204you have outstanding requests in your read queue, then an EOF is
2205considered an error as you clearly expected some data.
2206
2207To avoid this, make sure you have an empty read queue whenever your handle
2208is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
2209an C<on_read> handler that simply pushes the first read requests in the
2210queue.
2211
2212See also the next question, which explains this in a bit more detail.
2213
2214=item How can I serve requests in a loop?
2215
2216Most protocols consist of some setup phase (authentication for example)
2217followed by a request handling phase, where the server waits for requests
2218and handles them, in a loop.
2219
2220There are two important variants: The first (traditional, better) variant
2221handles requests until the server gets some QUIT command, causing it to
2222close the connection first (highly desirable for a busy TCP server). A
2223client dropping the connection is an error, which means this variant can
2224detect an unexpected detection close.
2225
2226To handle this case, always make sure you have a on-empty read queue, by
2227pushing the "read request start" handler on it:
2228
2229 # we assume a request starts with a single line
2230 my @start_request; @start_request = (line => sub {
2231 my ($hdl, $line) = @_;
2232
2233 ... handle request
2234
2235 # push next request read, possibly from a nested callback
2236 $hdl->push_read (@start_request);
2237 });
2238
2239 # auth done, now go into request handling loop
2240 # now push the first @start_request
2241 $hdl->push_read (@start_request);
2242
2243By always having an outstanding C<push_read>, the handle always expects
2244some data and raises the C<EPIPE> error when the connction is dropped
2245unexpectedly.
2246
2247The second variant is a protocol where the client can drop the connection
2248at any time. For TCP, this means that the server machine may run out of
2249sockets easier, and in general, it means you cnanot distinguish a protocl
2250failure/client crash from a normal connection close. Nevertheless, these
2251kinds of protocols are common (and sometimes even the best solution to the
2252problem).
2253
2254Having an outstanding read request at all times is possible if you ignore
2255C<EPIPE> errors, but this doesn't help with when the client drops the
2256connection during a request, which would still be an error.
2257
2258A better solution is to push the initial request read in an C<on_read>
2259callback. This avoids an error, as when the server doesn't expect data
2260(i.e. is idly waiting for the next request, an EOF will not raise an
2261error, but simply result in an C<on_eof> callback. It is also a bit slower
2262and simpler:
2263
2264 # auth done, now go into request handling loop
2265 $hdl->on_read (sub {
2266 my ($hdl) = @_;
2267
2268 # called each time we receive data but the read queue is empty
2269 # simply start read the request
2270
2271 $hdl->push_read (line => sub {
2272 my ($hdl, $line) = @_;
2273
2274 ... handle request
2275
2276 # do nothing special when the request has been handled, just
2277 # let the request queue go empty.
2278 });
2279 });
2280
2011=item I get different callback invocations in TLS mode/Why can't I pause 2281=item I get different callback invocations in TLS mode/Why can't I pause
2012reading? 2282reading?
2013 2283
2014Unlike, say, TCP, TLS connections do not consist of two independent 2284Unlike, say, TCP, TLS connections do not consist of two independent
2015communication channels, one for each direction. Or put differently. The 2285communication channels, one for each direction. Or put differently, the
2016read and write directions are not independent of each other: you cannot 2286read and write directions are not independent of each other: you cannot
2017write data unless you are also prepared to read, and vice versa. 2287write data unless you are also prepared to read, and vice versa.
2018 2288
2019This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2289This means that, in TLS mode, you might get C<on_error> or C<on_eof>
2020callback invocations when you are not expecting any read data - the reason 2290callback invocations when you are not expecting any read data - the reason
2021is that AnyEvent::Handle always reads in TLS mode. 2291is that AnyEvent::Handle always reads in TLS mode.
2022 2292
2023During the connection, you have to make sure that you always have a 2293During the connection, you have to make sure that you always have a
2024non-empty read-queue, or an C<on_read> watcher. At the end of the 2294non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
2036 $handle->on_eof (undef); 2306 $handle->on_eof (undef);
2037 $handle->on_error (sub { 2307 $handle->on_error (sub {
2038 my $data = delete $_[0]{rbuf}; 2308 my $data = delete $_[0]{rbuf};
2039 }); 2309 });
2040 2310
2311Note that this example removes the C<rbuf> member from the handle object,
2312which is not normally allowed by the API. It is expressly permitted in
2313this case only, as the handle object needs to be destroyed afterwards.
2314
2041The reason to use C<on_error> is that TCP connections, due to latencies 2315The reason to use C<on_error> is that TCP connections, due to latencies
2042and packets loss, might get closed quite violently with an error, when in 2316and packets loss, might get closed quite violently with an error, when in
2043fact, all data has been received. 2317fact all data has been received.
2044 2318
2045It is usually better to use acknowledgements when transferring data, 2319It is usually better to use acknowledgements when transferring data,
2046to make sure the other side hasn't just died and you got the data 2320to make sure the other side hasn't just died and you got the data
2047intact. This is also one reason why so many internet protocols have an 2321intact. This is also one reason why so many internet protocols have an
2048explicit QUIT command. 2322explicit QUIT command.
… …
2065consider using C<< ->push_shutdown >> instead. 2339consider using C<< ->push_shutdown >> instead.
2066 2340
2067=item I want to contact a TLS/SSL server, I don't care about security. 2341=item I want to contact a TLS/SSL server, I don't care about security.
2068 2342
2069If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2343If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
2070simply connect to it and then create the AnyEvent::Handle with the C<tls> 2344connect to it and then create the AnyEvent::Handle with the C<tls>
2071parameter: 2345parameter:
2072 2346
2073 tcp_connect $host, $port, sub { 2347 tcp_connect $host, $port, sub {
2074 my ($fh) = @_; 2348 my ($fh) = @_;
2075 2349
… …
2175 2449
2176=item * all members not documented here and not prefixed with an underscore 2450=item * all members not documented here and not prefixed with an underscore
2177are free to use in subclasses. 2451are free to use in subclasses.
2178 2452
2179Of course, new versions of AnyEvent::Handle may introduce more "public" 2453Of course, new versions of AnyEvent::Handle may introduce more "public"
2180member variables, but thats just life, at least it is documented. 2454member variables, but that's just life. At least it is documented.
2181 2455
2182=back 2456=back
2183 2457
2184=head1 AUTHOR 2458=head1 AUTHOR
2185 2459

Diff Legend

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