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.204 by root, Mon Nov 15 03:29:17 2010 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
… …
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
… …
118prepare the file handle with parameters required for the actual connect 120prepare the file handle with parameters required for the actual connect
119(as opposed to settings that can be changed when the connection is already 121(as opposed to settings that can be changed when the connection is already
120established). 122established).
121 123
122The return value of this callback should be the connect timeout value in 124The return value of this callback should be the connect timeout value in
123seconds (or C<0>, or C<undef>, or the empty list, to indicate the default 125seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
124timeout is to be used). 126default timeout is to be used).
125 127
126=item on_connect => $cb->($handle, $host, $port, $retry->()) 128=item on_connect => $cb->($handle, $host, $port, $retry->())
127 129
128This callback is called when a connection has been successfully established. 130This callback is called when a connection has been successfully established.
129 131
130The actual numeric host and port (the socket peername) are passed as 132The peer's numeric host and port (the socket peername) are passed as
131parameters, together with a retry callback. 133parameters, together with a retry callback.
132 134
133When, for some reason, the handle is not acceptable, then calling 135If, for some reason, the handle is not acceptable, calling C<$retry>
134C<$retry> will continue with the next conenction target (in case of 136will continue with the next connection target (in case of multi-homed
135multi-homed hosts or SRV records there can be multiple connection 137hosts or SRV records there can be multiple connection endpoints). At the
136endpoints). When it is called then the read and write queues, eof status, 138time it is called the read and write queues, eof status, tls status and
137tls status and similar properties of the handle are being reset. 139similar properties of the handle will have been reset.
138 140
139In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
140 142
141=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
142 144
143This callback is called when the conenction could not be 145This callback is called when the connection could not be
144established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
145message describing it (usually the same as C<"$!">). 147message describing it (usually the same as C<"$!">).
146 148
147If this callback isn't specified, then C<on_error> will be called with a 149If this callback isn't specified, then C<on_error> will be called with a
148fatal error instead. 150fatal error instead.
… …
151 153
152=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
153 155
154This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
155occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
156connect or a read error. 158connect, or a read error.
157 159
158Some errors are fatal (which is indicated by C<$fatal> being true). On 160Some errors are fatal (which is indicated by C<$fatal> being true). On
159fatal errors the handle object will be destroyed (by a call to C<< -> 161fatal errors the handle object will be destroyed (by a call to C<< ->
160destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
161examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
162with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 164with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
163cases where the other side can close the connection at their will it is 165cases where the other side can close the connection at will, it is
164often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
165 167
166AnyEvent::Handle tries to find an appropriate error code for you to check 168AnyEvent::Handle tries to find an appropriate error code for you to check
167against, but in some cases (TLS errors), this does not work well. It is 169against, but in some cases (TLS errors), this does not work well. It is
168recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
169error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
170 172
171Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
172to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
173when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
174C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
175 177
176On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
177error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
178C<EPROTO>). 180C<EPROTO>).
179 181
180While not mandatory, it is I<highly> recommended to set this callback, as 182While not mandatory, it is I<highly> recommended to set this callback, as
181you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
182C<croak>. 184C<croak>.
183 185
184=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
185 187
186This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
191To access (and remove data from) the read buffer, use the C<< ->rbuf >> 193To access (and remove data from) the read buffer, use the C<< ->rbuf >>
192method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method or access the C<< $handle->{rbuf} >> member directly. Note that you
193must not enlarge or modify the read buffer, you can only remove data at 195must not enlarge or modify the read buffer, you can only remove data at
194the beginning from it. 196the beginning from it.
195 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
196When an EOF condition is detected then AnyEvent::Handle will first try to 201When an EOF condition is detected, AnyEvent::Handle will first try to
197feed all the remaining data to the queued callbacks and C<on_read> before 202feed all the remaining data to the queued callbacks and C<on_read> before
198calling the C<on_eof> callback. If no progress can be made, then a fatal 203calling the C<on_eof> callback. If no progress can be made, then a fatal
199error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
200 205
201Note that, unlike requests in the read queue, an C<on_read> callback 206Note that, unlike requests in the read queue, an C<on_read> callback
… …
220set, then a fatal error will be raised with C<$!> set to <0>. 225set, then a fatal error will be raised with C<$!> set to <0>.
221 226
222=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
223 228
224This sets the callback that is called when the write buffer becomes empty 229This sets the callback that is called when the write buffer becomes empty
225(or when the callback is set and the buffer is empty already). 230(or immediately if the buffer is empty already).
226 231
227To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
228 233
229This callback is useful when you don't want to put all of your write data 234This callback is useful when you don't want to put all of your write data
230into the queue at once, for example, when you want to write the contents 235into the queue at once, for example, when you want to write the contents
… …
242many seconds pass without a successful read or write on the underlying 247many seconds pass without a successful read or write on the underlying
243file handle (or a call to C<timeout_reset>), the C<on_timeout> callback 248file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
244will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> 249will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
245error will be raised). 250error will be raised).
246 251
247There are three variants of the timeouts that work fully independent 252There are three variants of the timeouts that work independently
248of each other, for both read and write, just read, and just write: 253of each other, for both read and write, just read, and just write:
249C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 254C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
250C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions 255C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
251C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 256C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
252 257
253Note that timeout processing is also active when you currently do not have 258Note that timeout processing is active even when you do not have
254any outstanding read or write requests: If you plan to keep the connection 259any outstanding read or write requests: If you plan to keep the connection
255idle then you should disable the timout temporarily or ignore the timeout 260idle then you should disable the timeout temporarily or ignore the timeout
256in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 261in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
257restart the timeout. 262restart the timeout.
258 263
259Zero (the default) disables this timeout. 264Zero (the default) disables this timeout.
260 265
… …
276amount of data without a callback ever being called as long as the line 281amount of data without a callback ever being called as long as the line
277isn't finished). 282isn't finished).
278 283
279=item autocork => <boolean> 284=item autocork => <boolean>
280 285
281When disabled (the default), then C<push_write> will try to immediately 286When disabled (the default), C<push_write> will try to immediately
282write the data to the handle, if possible. This avoids having to register 287write 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 288a write watcher and wait for the next event loop iteration, but can
284be inefficient if you write multiple small chunks (on the wire, this 289be inefficient if you write multiple small chunks (on the wire, this
285disadvantage is usually avoided by your kernel's nagle algorithm, see 290disadvantage is usually avoided by your kernel's nagle algorithm, see
286C<no_delay>, but this option can save costly syscalls). 291C<no_delay>, but this option can save costly syscalls).
287 292
288When enabled, then writes will always be queued till the next event loop 293When enabled, writes will always be queued till the next event loop
289iteration. This is efficient when you do many small writes per iteration, 294iteration. 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 295but less efficient when you do a single write only per iteration (or when
291the write buffer often is full). It also increases write latency. 296the write buffer often is full). It also increases write latency.
292 297
293=item no_delay => <boolean> 298=item no_delay => <boolean>
… …
297the Nagle algorithm, and usually it is beneficial. 302the Nagle algorithm, and usually it is beneficial.
298 303
299In some situations you want as low a delay as possible, which can be 304In some situations you want as low a delay as possible, which can be
300accomplishd by setting this option to a true value. 305accomplishd by setting this option to a true value.
301 306
302The default is your opertaing system's default behaviour (most likely 307The default is your operating system's default behaviour (most likely
303enabled), this option explicitly enables or disables it, if possible. 308enabled). This option explicitly enables or disables it, if possible.
304 309
305=item keepalive => <boolean> 310=item keepalive => <boolean>
306 311
307Enables (default disable) the SO_KEEPALIVE option on the stream socket: 312Enables (default disable) the SO_KEEPALIVE option on the stream socket:
308normally, TCP connections have no time-out once established, so TCP 313normally, TCP connections have no time-out once established, so TCP
309conenctions, once established, can stay alive forever even when the other 314connections, 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 315side 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 316TCP connections when the other side becomes unreachable. While the default
312is OS-dependent, TCP keepalives usually kick in after around two hours, 317is 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 318and, if the other side doesn't reply, take down the TCP connection some 10
314to 15 minutes later. 319to 15 minutes later.
315 320
316It is harmless to specify this option for file handles that do not support 321It 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 339already have occured on BSD systems), but at least it will protect you
335from most attacks. 340from most attacks.
336 341
337=item read_size => <bytes> 342=item read_size => <bytes>
338 343
339The default read block size (the amount of bytes this module will 344The initial read block size, the number of bytes this module will try to
340try to read during each loop iteration, which affects memory 345read during each loop iteration. Each handle object will consume at least
341requirements). Default: C<8192>. 346this amount of memory for the read buffer as well, so when handling many
347connections requirements). See also C<max_read_size>. Default: C<2048>.
348
349=item max_read_size => <bytes>
350
351The maximum read buffer size used by the dynamic adjustment
352algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
353one go it will double C<read_size> up to the maximum given by this
354option. Default: C<131072> or C<read_size>, whichever is higher.
342 355
343=item low_water_mark => <bytes> 356=item low_water_mark => <bytes>
344 357
345Sets the amount of bytes (default: C<0>) that make up an "empty" write 358Sets 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 359buffer: If the buffer reaches this size or gets even samller it is
347considered empty. 360considered empty.
348 361
349Sometimes it can be beneficial (for performance reasons) to add data to 362Sometimes 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 363the 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 364the operating system kernel usually buffers data as well, so the default
352is good in almost all cases. 365is good in almost all cases.
353 366
354=item linger => <seconds> 367=item linger => <seconds>
355 368
356If non-zero (default: C<3600>), then the destructor of the 369If this is non-zero (default: C<3600>), the destructor of the
357AnyEvent::Handle object will check whether there is still outstanding 370AnyEvent::Handle object will check whether there is still outstanding
358write data and will install a watcher that will write this data to the 371write 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 372socket. No errors will be reported (this mostly matches how the operating
360system treats outstanding data at socket close time). 373system treats outstanding data at socket close time).
361 374
… …
368A string used to identify the remote site - usually the DNS hostname 381A string used to identify the remote site - usually the DNS hostname
369(I<not> IDN!) used to create the connection, rarely the IP address. 382(I<not> IDN!) used to create the connection, rarely the IP address.
370 383
371Apart from being useful in error messages, this string is also used in TLS 384Apart from being useful in error messages, this string is also used in TLS
372peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 385peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
373verification will be skipped when C<peername> is not specified or 386verification will be skipped when C<peername> is not specified or is
374C<undef>. 387C<undef>.
375 388
376=item tls => "accept" | "connect" | Net::SSLeay::SSL object 389=item tls => "accept" | "connect" | Net::SSLeay::SSL object
377 390
378When this parameter is given, it enables TLS (SSL) mode, that means 391When this parameter is given, it enables TLS (SSL) mode, that means
379AnyEvent will start a TLS handshake as soon as the conenction has been 392AnyEvent will start a TLS handshake as soon as the connection has been
380established and will transparently encrypt/decrypt data afterwards. 393established and will transparently encrypt/decrypt data afterwards.
381 394
382All TLS protocol errors will be signalled as C<EPROTO>, with an 395All TLS protocol errors will be signalled as C<EPROTO>, with an
383appropriate error message. 396appropriate error message.
384 397
… …
404B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 417B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
405passing in the wrong integer will lead to certain crash. This most often 418passing 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 419happens when one uses a stylish C<< tls => 1 >> and is surprised about the
407segmentation fault. 420segmentation fault.
408 421
409See the C<< ->starttls >> method for when need to start TLS negotiation later. 422Use the C<< ->starttls >> method if you need to start TLS negotiation later.
410 423
411=item tls_ctx => $anyevent_tls 424=item tls_ctx => $anyevent_tls
412 425
413Use the given C<AnyEvent::TLS> object to create the new TLS connection 426Use the given C<AnyEvent::TLS> object to create the new TLS connection
414(unless a connection object was specified directly). If this parameter is 427(unless a connection object was specified directly). If this parameter is
… …
429 442
430TLS handshake failures will not cause C<on_error> to be invoked when this 443TLS 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>. 444callback is in effect, instead, the error message will be passed to C<on_starttls>.
432 445
433Without this callback, handshake failures lead to C<on_error> being 446Without this callback, handshake failures lead to C<on_error> being
434called, as normal. 447called as usual.
435 448
436Note that you cannot call C<starttls> right again in this callback. If you 449Note 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 450need to do that, start an zero-second timer instead whose callback can
438then call C<< ->starttls >> again. 451then call C<< ->starttls >> again.
439 452
440=item on_stoptls => $cb->($handle) 453=item on_stoptls => $cb->($handle)
441 454
… …
531} 544}
532 545
533sub _start { 546sub _start {
534 my ($self) = @_; 547 my ($self) = @_;
535 548
549 # too many clueless people try to use udp and similar sockets
550 # with AnyEvent::Handle, do them a favour.
551 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
552 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
553 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
554
536 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 555 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
537 556
538 $self->{_activity} = 557 $self->{_activity} =
539 $self->{_ractivity} = 558 $self->{_ractivity} =
540 $self->{_wactivity} = AE::now; 559 $self->{_wactivity} = AE::now;
541 560
561 $self->{read_size} ||= 2048;
562 $self->{max_read_size} = $self->{read_size}
563 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
564
542 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 565 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
543 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; 566 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
544 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; 567 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
545 568
546 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; 569 $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); 572 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
550 573
551 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 574 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
552 if $self->{tls}; 575 if $self->{tls};
553 576
554 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 577 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
555 578
556 $self->start_read 579 $self->start_read
557 if $self->{on_read} || @{ $self->{_queue} }; 580 if $self->{on_read} || @{ $self->{_queue} };
558 581
559 $self->_drain_wbuf; 582 $self->_drain_wbuf;
… …
566 $message ||= "$!"; 589 $message ||= "$!";
567 590
568 if ($self->{on_error}) { 591 if ($self->{on_error}) {
569 $self->{on_error}($self, $fatal, $message); 592 $self->{on_error}($self, $fatal, $message);
570 $self->destroy if $fatal; 593 $self->destroy if $fatal;
571 } elsif ($self->{fh}) { 594 } elsif ($self->{fh} || $self->{connect}) {
572 $self->destroy; 595 $self->destroy;
573 Carp::croak "AnyEvent::Handle uncaught error: $message"; 596 Carp::croak "AnyEvent::Handle uncaught error: $message";
574 } 597 }
575} 598}
576 599
… …
635=cut 658=cut
636 659
637sub no_delay { 660sub no_delay {
638 $_[0]{no_delay} = $_[1]; 661 $_[0]{no_delay} = $_[1];
639 662
640 eval {
641 local $SIG{__DIE__};
642 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] 663 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
643 if $_[0]{fh}; 664 if $_[0]{fh};
644 };
645} 665}
646 666
647=item $handle->keepalive ($boolean) 667=item $handle->keepalive ($boolean)
648 668
649Enables or disables the C<keepalive> setting (see constructor argument of 669Enables or disables the C<keepalive> setting (see constructor argument of
… …
709 729
710Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 730Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
711 731
712=cut 732=cut
713 733
714sub on_starttls { 734sub on_stoptls {
715 $_[0]{on_stoptls} = $_[1]; 735 $_[0]{on_stoptls} = $_[1];
716} 736}
717 737
718=item $handle->rbuf_max ($max_octets) 738=item $handle->rbuf_max ($max_octets)
719 739
… …
758 $_[0]{$on_timeout} = $_[1]; 778 $_[0]{$on_timeout} = $_[1];
759 }; 779 };
760 780
761 *$timeout = sub { 781 *$timeout = sub {
762 my ($self, $new_value) = @_; 782 my ($self, $new_value) = @_;
783
784 $new_value >= 0
785 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
763 786
764 $self->{$timeout} = $new_value; 787 $self->{$timeout} = $new_value;
765 delete $self->{$tw}; &$cb; 788 delete $self->{$tw}; &$cb;
766 }; 789 };
767 790
… …
831=item $handle->on_drain ($cb) 854=item $handle->on_drain ($cb)
832 855
833Sets the C<on_drain> callback or clears it (see the description of 856Sets the C<on_drain> callback or clears it (see the description of
834C<on_drain> in the constructor). 857C<on_drain> in the constructor).
835 858
859This method may invoke callbacks (and therefore the handle might be
860destroyed after it returns).
861
836=cut 862=cut
837 863
838sub on_drain { 864sub on_drain {
839 my ($self, $cb) = @_; 865 my ($self, $cb) = @_;
840 866
… …
847=item $handle->push_write ($data) 873=item $handle->push_write ($data)
848 874
849Queues the given scalar to be written. You can push as much data as you 875Queues the given scalar to be written. You can push as much data as you
850want (only limited by the available memory), as C<AnyEvent::Handle> 876want (only limited by the available memory), as C<AnyEvent::Handle>
851buffers it independently of the kernel. 877buffers it independently of the kernel.
878
879This method may invoke callbacks (and therefore the handle might be
880destroyed after it returns).
852 881
853=cut 882=cut
854 883
855sub _drain_wbuf { 884sub _drain_wbuf {
856 my ($self) = @_; 885 my ($self) = @_;
… …
902 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" 931 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
903 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") 932 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
904 ->($self, @_); 933 ->($self, @_);
905 } 934 }
906 935
936 # we downgrade here to avoid hard-to-track-down bugs,
937 # and diagnose the problem earlier and better.
938
907 if ($self->{tls}) { 939 if ($self->{tls}) {
908 $self->{_tls_wbuf} .= $_[0]; 940 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
909 &_dotls ($self) if $self->{fh}; 941 &_dotls ($self) if $self->{fh};
910 } else { 942 } else {
911 $self->{wbuf} .= $_[0]; 943 utf8::downgrade $self->{wbuf} .= $_[0];
912 $self->_drain_wbuf if $self->{fh}; 944 $self->_drain_wbuf if $self->{fh};
913 } 945 }
914} 946}
915 947
916=item $handle->push_write (type => @args) 948=item $handle->push_write (type => @args)
917 949
918Instead of formatting your data yourself, you can also let this module 950Instead of formatting your data yourself, you can also let this module
919do the job by specifying a type and type-specific arguments. You 951do the job by specifying a type and type-specific arguments. You
920can also specify the (fully qualified) name of a package, in which 952can also specify the (fully qualified) name of a package, in which
921case AnyEvent tries to load the package and then expects to find the 953case AnyEvent tries to load the package and then expects to find the
922C<anyevent_read_type> function inside (see "custom write types", below). 954C<anyevent_write_type> function inside (see "custom write types", below).
923 955
924Predefined types are (if you have ideas for additional types, feel free to 956Predefined types are (if you have ideas for additional types, feel free to
925drop by and tell us): 957drop by and tell us):
926 958
927=over 4 959=over 4
… …
1030the peer. 1062the peer.
1031 1063
1032You can rely on the normal read queue and C<on_eof> handling 1064You can rely on the normal read queue and C<on_eof> handling
1033afterwards. This is the cleanest way to close a connection. 1065afterwards. This is the cleanest way to close a connection.
1034 1066
1067This method may invoke callbacks (and therefore the handle might be
1068destroyed after it returns).
1069
1035=cut 1070=cut
1036 1071
1037sub push_shutdown { 1072sub push_shutdown {
1038 my ($self) = @_; 1073 my ($self) = @_;
1039 1074
… …
1088ways, the "simple" way, using only C<on_read> and the "complex" way, using 1123ways, the "simple" way, using only C<on_read> and the "complex" way, using
1089a queue. 1124a queue.
1090 1125
1091In the simple case, you just install an C<on_read> callback and whenever 1126In 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 1127new 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 1128enough 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 1129leave the data there if you want to accumulate more (e.g. when only a
1095partial message has been received so far). 1130partial message has been received so far), or change the read queue with
1131e.g. C<push_read>.
1096 1132
1097In the more complex case, you want to queue multiple callbacks. In this 1133In the more complex case, you want to queue multiple callbacks. In this
1098case, AnyEvent::Handle will call the first queued callback each time new 1134case, 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 1135data arrives (also the first time it is queued) and remove it when it has
1100done its job (see C<push_read>, below). 1136done its job (see C<push_read>, below).
1101 1137
1102This way you can, for example, push three line-reads, followed by reading 1138This way you can, for example, push three line-reads, followed by reading
1103a chunk of data, and AnyEvent::Handle will execute them in order. 1139a chunk of data, and AnyEvent::Handle will execute them in order.
1104 1140
… …
1235 1271
1236This replaces the currently set C<on_read> callback, or clears it (when 1272This 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 1273the new callback is C<undef>). See the description of C<on_read> in the
1238constructor. 1274constructor.
1239 1275
1276This method may invoke callbacks (and therefore the handle might be
1277destroyed after it returns).
1278
1240=cut 1279=cut
1241 1280
1242sub on_read { 1281sub on_read {
1243 my ($self, $cb) = @_; 1282 my ($self, $cb) = @_;
1244 1283
… …
1246 $self->_drain_rbuf if $cb; 1285 $self->_drain_rbuf if $cb;
1247} 1286}
1248 1287
1249=item $handle->rbuf 1288=item $handle->rbuf
1250 1289
1251Returns the read buffer (as a modifiable lvalue). 1290Returns the read buffer (as a modifiable lvalue). You can also access the
1291read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1292much faster, and no less clean).
1252 1293
1253You can access the read buffer directly as the C<< ->{rbuf} >> 1294The only operation allowed on the read buffer (apart from looking at it)
1254member, if you want. However, the only operation allowed on the 1295is removing data from its beginning. Otherwise modifying or appending to
1255read buffer (apart from looking at it) is removing data from its 1296it 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 1297
1259NOTE: The read buffer should only be used or modified if the C<on_read>, 1298NOTE: 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 1299callback or when C<push_read> or C<unshift_read> are used with a single
1261automatically manage the read buffer. 1300callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1301will manage the read buffer on their own.
1262 1302
1263=cut 1303=cut
1264 1304
1265sub rbuf : lvalue { 1305sub rbuf : lvalue {
1266 $_[0]{rbuf} 1306 $_[0]{rbuf}
… …
1283 1323
1284If enough data was available, then the callback must remove all data it is 1324If 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 1325interested in (which can be none at all) and return a true value. After returning
1286true, it will be removed from the queue. 1326true, it will be removed from the queue.
1287 1327
1328These methods may invoke callbacks (and therefore the handle might be
1329destroyed after it returns).
1330
1288=cut 1331=cut
1289 1332
1290our %RH; 1333our %RH;
1291 1334
1292sub register_read_type($$) { 1335sub register_read_type($$) {
… …
1314 my $cb = pop; 1357 my $cb = pop;
1315 1358
1316 if (@_) { 1359 if (@_) {
1317 my $type = shift; 1360 my $type = shift;
1318 1361
1362 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1319 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1363 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1320 ->($self, $cb, @_); 1364 ->($self, $cb, @_);
1321 } 1365 }
1322 1366
1323 unshift @{ $self->{_queue} }, $cb; 1367 unshift @{ $self->{_queue} }, $cb;
1324 $self->_drain_rbuf; 1368 $self->_drain_rbuf;
… …
1432the receive buffer when neither C<$accept> nor C<$reject> match, 1476the receive buffer when neither C<$accept> nor C<$reject> match,
1433and everything preceding and including the match will be accepted 1477and everything preceding and including the match will be accepted
1434unconditionally. This is useful to skip large amounts of data that you 1478unconditionally. 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 1479know 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 1480have to start matching from the beginning. This is purely an optimisation
1437and is usually worth only when you expect more than a few kilobytes. 1481and is usually worth it only when you expect more than a few kilobytes.
1438 1482
1439Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1483Example: 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 1484expect 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 1485a 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 1486it only accepts something not ending in either \015 or \012, as these are
1443required for the accept regex. 1487required for the accept regex.
1444 1488
1445 $handle->push_read (regex => 1489 $handle->push_read (regex =>
… …
1710} 1754}
1711 1755
1712sub start_read { 1756sub start_read {
1713 my ($self) = @_; 1757 my ($self) = @_;
1714 1758
1715 unless ($self->{_rw} || $self->{_eof}) { 1759 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1716 Scalar::Util::weaken $self; 1760 Scalar::Util::weaken $self;
1717 1761
1718 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1762 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1719 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1763 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1720 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1764 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1721 1765
1722 if ($len > 0) { 1766 if ($len > 0) {
1723 $self->{_activity} = $self->{_ractivity} = AE::now; 1767 $self->{_activity} = $self->{_ractivity} = AE::now;
1724 1768
1725 if ($self->{tls}) { 1769 if ($self->{tls}) {
1726 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1770 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1727 1771
1728 &_dotls ($self); 1772 &_dotls ($self);
1729 } else { 1773 } else {
1730 $self->_drain_rbuf; 1774 $self->_drain_rbuf;
1775 }
1776
1777 if ($len == $self->{read_size}) {
1778 $self->{read_size} *= 2;
1779 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1780 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1731 } 1781 }
1732 1782
1733 } elsif (defined $len) { 1783 } elsif (defined $len) {
1734 delete $self->{_rw}; 1784 delete $self->{_rw};
1735 $self->{_eof} = 1; 1785 $self->{_eof} = 1;
… …
1813 && ($tmp != $ERROR_SYSCALL || $!); 1863 && ($tmp != $ERROR_SYSCALL || $!);
1814 1864
1815 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1865 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1816 $self->{wbuf} .= $tmp; 1866 $self->{wbuf} .= $tmp;
1817 $self->_drain_wbuf; 1867 $self->_drain_wbuf;
1868 $self->{tls} or return; # tls session might have gone away in callback
1818 } 1869 }
1819 1870
1820 $self->{_on_starttls} 1871 $self->{_on_starttls}
1821 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1872 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1822 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1873 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 1895context 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 1896changed to your liking. Note that the handshake might have already started
1846when this function returns. 1897when this function returns.
1847 1898
1848Due to bugs in OpenSSL, it might or might not be possible to do multiple 1899Due 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 1900handshakes on the same stream. It is best to not attempt to use the
1850stopping TLS. 1901stream after stopping TLS.
1902
1903This method may invoke callbacks (and therefore the handle might be
1904destroyed after it returns).
1851 1905
1852=cut 1906=cut
1853 1907
1854our %TLS_CACHE; #TODO not yet documented, should we? 1908our %TLS_CACHE; #TODO not yet documented, should we?
1855 1909
… …
1921 1975
1922=item $handle->stoptls 1976=item $handle->stoptls
1923 1977
1924Shuts down the SSL connection - this makes a proper EOF handshake by 1978Shuts down the SSL connection - this makes a proper EOF handshake by
1925sending a close notify to the other side, but since OpenSSL doesn't 1979sending 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 1980support non-blocking shut downs, it is not guaranteed that you can re-use
1927the stream afterwards. 1981the stream afterwards.
1982
1983This method may invoke callbacks (and therefore the handle might be
1984destroyed after it returns).
1928 1985
1929=cut 1986=cut
1930 1987
1931sub stoptls { 1988sub stoptls {
1932 my ($self) = @_; 1989 my ($self) = @_;
1933 1990
1934 if ($self->{tls}) { 1991 if ($self->{tls} && $self->{fh}) {
1935 Net::SSLeay::shutdown ($self->{tls}); 1992 Net::SSLeay::shutdown ($self->{tls});
1936 1993
1937 &_dotls; 1994 &_dotls;
1938 1995
1939# # we don't give a shit. no, we do, but we can't. no...#d# 1996# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1969 push @linger, AE::io $fh, 1, sub { 2026 push @linger, AE::io $fh, 1, sub {
1970 my $len = syswrite $fh, $wbuf, length $wbuf; 2027 my $len = syswrite $fh, $wbuf, length $wbuf;
1971 2028
1972 if ($len > 0) { 2029 if ($len > 0) {
1973 substr $wbuf, 0, $len, ""; 2030 substr $wbuf, 0, $len, "";
1974 } else { 2031 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1975 @linger = (); # end 2032 @linger = (); # end
1976 } 2033 }
1977 }; 2034 };
1978 push @linger, AE::timer $linger, 0, sub { 2035 push @linger, AE::timer $linger, 0, sub {
1979 @linger = (); 2036 @linger = ();
… …
2016 2073
2017sub AnyEvent::Handle::destroyed::AUTOLOAD { 2074sub AnyEvent::Handle::destroyed::AUTOLOAD {
2018 #nop 2075 #nop
2019} 2076}
2020 2077
2078=item $handle->destroyed
2079
2080Returns false as long as the handle hasn't been destroyed by a call to C<<
2081->destroy >>, true otherwise.
2082
2083Can be useful to decide whether the handle is still valid after some
2084callback possibly destroyed the handle. For example, C<< ->push_write >>,
2085C<< ->starttls >> and other methods can call user callbacks, which in turn
2086can destroy the handle, so work can be avoided by checking sometimes:
2087
2088 $hdl->starttls ("accept");
2089 return if $hdl->destroyed;
2090 $hdl->push_write (...
2091
2092Note that the call to C<push_write> will silently be ignored if the handle
2093has been destroyed, so often you can just ignore the possibility of the
2094handle being destroyed.
2095
2096=cut
2097
2098sub destroyed { 0 }
2099sub AnyEvent::Handle::destroyed::destroyed { 1 }
2100
2021=item AnyEvent::Handle::TLS_CTX 2101=item AnyEvent::Handle::TLS_CTX
2022 2102
2023This function creates and returns the AnyEvent::TLS object used by default 2103This function creates and returns the AnyEvent::TLS object used by default
2024for TLS mode. 2104for TLS mode.
2025 2105
… …
2056 2136
2057=item I get different callback invocations in TLS mode/Why can't I pause 2137=item I get different callback invocations in TLS mode/Why can't I pause
2058reading? 2138reading?
2059 2139
2060Unlike, say, TCP, TLS connections do not consist of two independent 2140Unlike, say, TCP, TLS connections do not consist of two independent
2061communication channels, one for each direction. Or put differently. The 2141communication channels, one for each direction. Or put differently, the
2062read and write directions are not independent of each other: you cannot 2142read and write directions are not independent of each other: you cannot
2063write data unless you are also prepared to read, and vice versa. 2143write data unless you are also prepared to read, and vice versa.
2064 2144
2065This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2145This 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 2146callback invocations when you are not expecting any read data - the reason
2067is that AnyEvent::Handle always reads in TLS mode. 2147is that AnyEvent::Handle always reads in TLS mode.
2068 2148
2069During the connection, you have to make sure that you always have a 2149During 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 2150non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
2084 my $data = delete $_[0]{rbuf}; 2164 my $data = delete $_[0]{rbuf};
2085 }); 2165 });
2086 2166
2087The reason to use C<on_error> is that TCP connections, due to latencies 2167The 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 2168and packets loss, might get closed quite violently with an error, when in
2089fact, all data has been received. 2169fact all data has been received.
2090 2170
2091It is usually better to use acknowledgements when transferring data, 2171It is usually better to use acknowledgements when transferring data,
2092to make sure the other side hasn't just died and you got the data 2172to 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 2173intact. This is also one reason why so many internet protocols have an
2094explicit QUIT command. 2174explicit QUIT command.
… …
2111consider using C<< ->push_shutdown >> instead. 2191consider using C<< ->push_shutdown >> instead.
2112 2192
2113=item I want to contact a TLS/SSL server, I don't care about security. 2193=item I want to contact a TLS/SSL server, I don't care about security.
2114 2194
2115If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2195If 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> 2196connect to it and then create the AnyEvent::Handle with the C<tls>
2117parameter: 2197parameter:
2118 2198
2119 tcp_connect $host, $port, sub { 2199 tcp_connect $host, $port, sub {
2120 my ($fh) = @_; 2200 my ($fh) = @_;
2121 2201
… …
2221 2301
2222=item * all members not documented here and not prefixed with an underscore 2302=item * all members not documented here and not prefixed with an underscore
2223are free to use in subclasses. 2303are free to use in subclasses.
2224 2304
2225Of course, new versions of AnyEvent::Handle may introduce more "public" 2305Of course, new versions of AnyEvent::Handle may introduce more "public"
2226member variables, but thats just life, at least it is documented. 2306member variables, but that's just life. At least it is documented.
2227 2307
2228=back 2308=back
2229 2309
2230=head1 AUTHOR 2310=head1 AUTHOR
2231 2311

Diff Legend

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