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

Diff Legend

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