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.191 by root, Sun Jan 31 22:33:45 2010 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;
… …
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::Handle fh => $filehandle, key => value... 86=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
… …
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 connection 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). At the time it is called the read and write queues, eof 138time it is called the read and write queues, eof status, tls status and
137status, tls status and similar properties of the handle will have been 139similar properties of the handle will have been reset.
138reset.
139 140
140In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
141 142
142=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
143 144
144This callback is called when the connection could not be 145This callback is called when the connection could not be
145established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
… …
152 153
153=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
154 155
155This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
156occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
157connect or a read error. 158connect, or a read error.
158 159
159Some 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
160fatal 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<< ->
161destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
162examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
163with 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
164cases 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
165often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
166 167
167AnyEvent::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
168against, 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
169recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
170error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
171 172
172Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
173to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
174when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
175C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
176 177
177On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
178error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
179C<EPROTO>). 180C<EPROTO>).
180 181
181While 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
182you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
183C<croak>. 184C<croak>.
184 185
185=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
186 187
187This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
192To 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 >>
193method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method or access the C<< $handle->{rbuf} >> member directly. Note that you
194must 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
195the beginning from it. 196the beginning from it.
196 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
197When an EOF condition is detected then AnyEvent::Handle will first try to 201When an EOF condition is detected, AnyEvent::Handle will first try to
198feed 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
199calling 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
200error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
201 205
202Note 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
… …
221set, 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>.
222 226
223=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
224 228
225This 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
226(or when the callback is set and the buffer is empty already). 230(or immediately if the buffer is empty already).
227 231
228To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
229 233
230This 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
231into 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
… …
243many seconds pass without a successful read or write on the underlying 247many seconds pass without a successful read or write on the underlying
244file 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
245will 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>
246error will be raised). 250error will be raised).
247 251
248There are three variants of the timeouts that work fully independent 252There are three variants of the timeouts that work independently
249of 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:
250C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 254C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
251C<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
252C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 256C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
253 257
254Note that timeout processing is also active when you currently do not have 258Note that timeout processing is active even when you do not have
255any 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
256idle then you should disable the timout temporarily or ignore the timeout 260idle then you should disable the timeout temporarily or ignore the timeout
257in 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
258restart the timeout. 262restart the timeout.
259 263
260Zero (the default) disables this timeout. 264Zero (the default) disables this timeout.
261 265
… …
277amount 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
278isn't finished). 282isn't finished).
279 283
280=item autocork => <boolean> 284=item autocork => <boolean>
281 285
282When disabled (the default), then C<push_write> will try to immediately 286When disabled (the default), C<push_write> will try to immediately
283write 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
284a 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
285be inefficient if you write multiple small chunks (on the wire, this 289be inefficient if you write multiple small chunks (on the wire, this
286disadvantage is usually avoided by your kernel's nagle algorithm, see 290disadvantage is usually avoided by your kernel's nagle algorithm, see
287C<no_delay>, but this option can save costly syscalls). 291C<no_delay>, but this option can save costly syscalls).
288 292
289When enabled, then writes will always be queued till the next event loop 293When enabled, writes will always be queued till the next event loop
290iteration. This is efficient when you do many small writes per iteration, 294iteration. This is efficient when you do many small writes per iteration,
291but 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
292the write buffer often is full). It also increases write latency. 296the write buffer often is full). It also increases write latency.
293 297
294=item no_delay => <boolean> 298=item no_delay => <boolean>
… …
298the Nagle algorithm, and usually it is beneficial. 302the Nagle algorithm, and usually it is beneficial.
299 303
300In 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
301accomplishd by setting this option to a true value. 305accomplishd by setting this option to a true value.
302 306
303The default is your opertaing system's default behaviour (most likely 307The default is your operating system's default behaviour (most likely
304enabled), this option explicitly enables or disables it, if possible. 308enabled). This option explicitly enables or disables it, if possible.
305 309
306=item keepalive => <boolean> 310=item keepalive => <boolean>
307 311
308Enables (default disable) the SO_KEEPALIVE option on the stream socket: 312Enables (default disable) the SO_KEEPALIVE option on the stream socket:
309normally, TCP connections have no time-out once established, so TCP 313normally, TCP connections have no time-out once established, so TCP
310connections, once established, can stay alive forever even when the other 314connections, once established, can stay alive forever even when the other
311side 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
312TCP connections whent he other side becomes unreachable. While the default 316TCP connections when the other side becomes unreachable. While the default
313is OS-dependent, TCP keepalives usually kick in after around two hours, 317is OS-dependent, TCP keepalives usually kick in after around two hours,
314and, 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
315to 15 minutes later. 319to 15 minutes later.
316 320
317It 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
… …
335already 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
336from most attacks. 340from most attacks.
337 341
338=item read_size => <bytes> 342=item read_size => <bytes>
339 343
340The 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
341try to read during each loop iteration, which affects memory 345read during each loop iteration. Each handle object will consume at least
342requirements). 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.
343 355
344=item low_water_mark => <bytes> 356=item low_water_mark => <bytes>
345 357
346Sets 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
347buffer: 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
348considered empty. 360considered empty.
349 361
350Sometimes it can be beneficial (for performance reasons) to add data to 362Sometimes it can be beneficial (for performance reasons) to add data to
351the 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
352the operating system kernel usually buffers data as well, so the default 364the operating system kernel usually buffers data as well, so the default
353is good in almost all cases. 365is good in almost all cases.
354 366
355=item linger => <seconds> 367=item linger => <seconds>
356 368
357If non-zero (default: C<3600>), then the destructor of the 369If this is non-zero (default: C<3600>), the destructor of the
358AnyEvent::Handle object will check whether there is still outstanding 370AnyEvent::Handle object will check whether there is still outstanding
359write 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
360socket. No errors will be reported (this mostly matches how the operating 372socket. No errors will be reported (this mostly matches how the operating
361system treats outstanding data at socket close time). 373system treats outstanding data at socket close time).
362 374
… …
369A string used to identify the remote site - usually the DNS hostname 381A string used to identify the remote site - usually the DNS hostname
370(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.
371 383
372Apart 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
373peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 385peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
374verification will be skipped when C<peername> is not specified or 386verification will be skipped when C<peername> is not specified or is
375C<undef>. 387C<undef>.
376 388
377=item tls => "accept" | "connect" | Net::SSLeay::SSL object 389=item tls => "accept" | "connect" | Net::SSLeay::SSL object
378 390
379When this parameter is given, it enables TLS (SSL) mode, that means 391When this parameter is given, it enables TLS (SSL) mode, that means
… …
405B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 417B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
406passing 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
407happens 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
408segmentation fault. 420segmentation fault.
409 421
410See 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.
411 423
412=item tls_ctx => $anyevent_tls 424=item tls_ctx => $anyevent_tls
413 425
414Use 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
415(unless a connection object was specified directly). If this parameter is 427(unless a connection object was specified directly). If this parameter is
… …
430 442
431TLS 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
432callback 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>.
433 445
434Without this callback, handshake failures lead to C<on_error> being 446Without this callback, handshake failures lead to C<on_error> being
435called, as normal. 447called as usual.
436 448
437Note 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
438need 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
439then call C<< ->starttls >> again. 451then call C<< ->starttls >> again.
440 452
441=item on_stoptls => $cb->($handle) 453=item on_stoptls => $cb->($handle)
442 454
… …
532} 544}
533 545
534sub _start { 546sub _start {
535 my ($self) = @_; 547 my ($self) = @_;
536 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
537 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 555 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
538 556
539 $self->{_activity} = 557 $self->{_activity} =
540 $self->{_ractivity} = 558 $self->{_ractivity} =
541 $self->{_wactivity} = AE::now; 559 $self->{_wactivity} = AE::now;
542 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
543 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 565 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
544 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; 566 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
545 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; 567 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
546 568
547 $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};
… …
550 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); 572 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
551 573
552 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 574 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
553 if $self->{tls}; 575 if $self->{tls};
554 576
555 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 577 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
556 578
557 $self->start_read 579 $self->start_read
558 if $self->{on_read} || @{ $self->{_queue} }; 580 if $self->{on_read} || @{ $self->{_queue} };
559 581
560 $self->_drain_wbuf; 582 $self->_drain_wbuf;
… …
636=cut 658=cut
637 659
638sub no_delay { 660sub no_delay {
639 $_[0]{no_delay} = $_[1]; 661 $_[0]{no_delay} = $_[1];
640 662
641 eval {
642 local $SIG{__DIE__};
643 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] 663 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
644 if $_[0]{fh}; 664 if $_[0]{fh};
645 };
646} 665}
647 666
648=item $handle->keepalive ($boolean) 667=item $handle->keepalive ($boolean)
649 668
650Enables or disables the C<keepalive> setting (see constructor argument of 669Enables or disables the C<keepalive> setting (see constructor argument of
… …
759 $_[0]{$on_timeout} = $_[1]; 778 $_[0]{$on_timeout} = $_[1];
760 }; 779 };
761 780
762 *$timeout = sub { 781 *$timeout = sub {
763 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";
764 786
765 $self->{$timeout} = $new_value; 787 $self->{$timeout} = $new_value;
766 delete $self->{$tw}; &$cb; 788 delete $self->{$tw}; &$cb;
767 }; 789 };
768 790
… …
832=item $handle->on_drain ($cb) 854=item $handle->on_drain ($cb)
833 855
834Sets 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
835C<on_drain> in the constructor). 857C<on_drain> in the constructor).
836 858
859This method may invoke callbacks (and therefore the handle might be
860destroyed after it returns).
861
837=cut 862=cut
838 863
839sub on_drain { 864sub on_drain {
840 my ($self, $cb) = @_; 865 my ($self, $cb) = @_;
841 866
… …
848=item $handle->push_write ($data) 873=item $handle->push_write ($data)
849 874
850Queues 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
851want (only limited by the available memory), as C<AnyEvent::Handle> 876want (only limited by the available memory), as C<AnyEvent::Handle>
852buffers 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).
853 881
854=cut 882=cut
855 883
856sub _drain_wbuf { 884sub _drain_wbuf {
857 my ($self) = @_; 885 my ($self) = @_;
… …
921 949
922Instead of formatting your data yourself, you can also let this module 950Instead of formatting your data yourself, you can also let this module
923do the job by specifying a type and type-specific arguments. You 951do the job by specifying a type and type-specific arguments. You
924can also specify the (fully qualified) name of a package, in which 952can also specify the (fully qualified) name of a package, in which
925case 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
926C<anyevent_read_type> function inside (see "custom write types", below). 954C<anyevent_write_type> function inside (see "custom write types", below).
927 955
928Predefined 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
929drop by and tell us): 957drop by and tell us):
930 958
931=over 4 959=over 4
… …
1034the peer. 1062the peer.
1035 1063
1036You 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
1037afterwards. This is the cleanest way to close a connection. 1065afterwards. This is the cleanest way to close a connection.
1038 1066
1067This method may invoke callbacks (and therefore the handle might be
1068destroyed after it returns).
1069
1039=cut 1070=cut
1040 1071
1041sub push_shutdown { 1072sub push_shutdown {
1042 my ($self) = @_; 1073 my ($self) = @_;
1043 1074
… …
1092ways, 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
1093a queue. 1124a queue.
1094 1125
1095In 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
1096new 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
1097enough 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
1098leave 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
1099partial message has been received so far). 1130partial message has been received so far), or change the read queue with
1131e.g. C<push_read>.
1100 1132
1101In 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
1102case, AnyEvent::Handle will call the first queued callback each time new 1134case, AnyEvent::Handle will call the first queued callback each time new
1103data 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
1104done its job (see C<push_read>, below). 1136done its job (see C<push_read>, below).
1105 1137
1106This 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
1107a chunk of data, and AnyEvent::Handle will execute them in order. 1139a chunk of data, and AnyEvent::Handle will execute them in order.
1108 1140
… …
1239 1271
1240This 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
1241the 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
1242constructor. 1274constructor.
1243 1275
1276This method may invoke callbacks (and therefore the handle might be
1277destroyed after it returns).
1278
1244=cut 1279=cut
1245 1280
1246sub on_read { 1281sub on_read {
1247 my ($self, $cb) = @_; 1282 my ($self, $cb) = @_;
1248 1283
… …
1250 $self->_drain_rbuf if $cb; 1285 $self->_drain_rbuf if $cb;
1251} 1286}
1252 1287
1253=item $handle->rbuf 1288=item $handle->rbuf
1254 1289
1255Returns 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).
1256 1293
1257You can access the read buffer directly as the C<< ->{rbuf} >> 1294The only operation allowed on the read buffer (apart from looking at it)
1258member, if you want. However, the only operation allowed on the 1295is removing data from its beginning. Otherwise modifying or appending to
1259read buffer (apart from looking at it) is removing data from its 1296it is not allowed and will lead to hard-to-track-down bugs.
1260beginning. Otherwise modifying or appending to it is not allowed and will
1261lead to hard-to-track-down bugs.
1262 1297
1263NOTE: 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>
1264C<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
1265automatically 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.
1266 1302
1267=cut 1303=cut
1268 1304
1269sub rbuf : lvalue { 1305sub rbuf : lvalue {
1270 $_[0]{rbuf} 1306 $_[0]{rbuf}
… …
1287 1323
1288If 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
1289interested 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
1290true, it will be removed from the queue. 1326true, it will be removed from the queue.
1291 1327
1328These methods may invoke callbacks (and therefore the handle might be
1329destroyed after it returns).
1330
1292=cut 1331=cut
1293 1332
1294our %RH; 1333our %RH;
1295 1334
1296sub register_read_type($$) { 1335sub register_read_type($$) {
… …
1318 my $cb = pop; 1357 my $cb = pop;
1319 1358
1320 if (@_) { 1359 if (@_) {
1321 my $type = shift; 1360 my $type = shift;
1322 1361
1362 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1323 $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")
1324 ->($self, $cb, @_); 1364 ->($self, $cb, @_);
1325 } 1365 }
1326 1366
1327 unshift @{ $self->{_queue} }, $cb; 1367 unshift @{ $self->{_queue} }, $cb;
1328 $self->_drain_rbuf; 1368 $self->_drain_rbuf;
… …
1436the receive buffer when neither C<$accept> nor C<$reject> match, 1476the receive buffer when neither C<$accept> nor C<$reject> match,
1437and everything preceding and including the match will be accepted 1477and everything preceding and including the match will be accepted
1438unconditionally. This is useful to skip large amounts of data that you 1478unconditionally. This is useful to skip large amounts of data that you
1439know 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
1440have to start matching from the beginning. This is purely an optimisation 1480have to start matching from the beginning. This is purely an optimisation
1441and 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.
1442 1482
1443Example: 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
1444expect 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
1445a 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
1446it 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
1447required for the accept regex. 1487required for the accept regex.
1448 1488
1449 $handle->push_read (regex => 1489 $handle->push_read (regex =>
… …
1714} 1754}
1715 1755
1716sub start_read { 1756sub start_read {
1717 my ($self) = @_; 1757 my ($self) = @_;
1718 1758
1719 unless ($self->{_rw} || $self->{_eof}) { 1759 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1720 Scalar::Util::weaken $self; 1760 Scalar::Util::weaken $self;
1721 1761
1722 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1762 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1723 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1763 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1724 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1764 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1725 1765
1726 if ($len > 0) { 1766 if ($len > 0) {
1727 $self->{_activity} = $self->{_ractivity} = AE::now; 1767 $self->{_activity} = $self->{_ractivity} = AE::now;
1728 1768
1729 if ($self->{tls}) { 1769 if ($self->{tls}) {
1730 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1770 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1731 1771
1732 &_dotls ($self); 1772 &_dotls ($self);
1733 } else { 1773 } else {
1734 $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);
1735 } 1781 }
1736 1782
1737 } elsif (defined $len) { 1783 } elsif (defined $len) {
1738 delete $self->{_rw}; 1784 delete $self->{_rw};
1739 $self->{_eof} = 1; 1785 $self->{_eof} = 1;
… …
1817 && ($tmp != $ERROR_SYSCALL || $!); 1863 && ($tmp != $ERROR_SYSCALL || $!);
1818 1864
1819 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1865 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1820 $self->{wbuf} .= $tmp; 1866 $self->{wbuf} .= $tmp;
1821 $self->_drain_wbuf; 1867 $self->_drain_wbuf;
1868 $self->{tls} or return; # tls session might have gone away in callback
1822 } 1869 }
1823 1870
1824 $self->{_on_starttls} 1871 $self->{_on_starttls}
1825 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1872 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1826 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1873 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1848context 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
1849changed to your liking. Note that the handshake might have already started 1896changed to your liking. Note that the handshake might have already started
1850when this function returns. 1897when this function returns.
1851 1898
1852Due 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
1853handshakes 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
1854stopping TLS. 1901stream after stopping TLS.
1902
1903This method may invoke callbacks (and therefore the handle might be
1904destroyed after it returns).
1855 1905
1856=cut 1906=cut
1857 1907
1858our %TLS_CACHE; #TODO not yet documented, should we? 1908our %TLS_CACHE; #TODO not yet documented, should we?
1859 1909
… …
1925 1975
1926=item $handle->stoptls 1976=item $handle->stoptls
1927 1977
1928Shuts down the SSL connection - this makes a proper EOF handshake by 1978Shuts down the SSL connection - this makes a proper EOF handshake by
1929sending 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
1930support 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
1931the stream afterwards. 1981the stream afterwards.
1982
1983This method may invoke callbacks (and therefore the handle might be
1984destroyed after it returns).
1932 1985
1933=cut 1986=cut
1934 1987
1935sub stoptls { 1988sub stoptls {
1936 my ($self) = @_; 1989 my ($self) = @_;
1937 1990
1938 if ($self->{tls}) { 1991 if ($self->{tls} && $self->{fh}) {
1939 Net::SSLeay::shutdown ($self->{tls}); 1992 Net::SSLeay::shutdown ($self->{tls});
1940 1993
1941 &_dotls; 1994 &_dotls;
1942 1995
1943# # 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#
… …
1973 push @linger, AE::io $fh, 1, sub { 2026 push @linger, AE::io $fh, 1, sub {
1974 my $len = syswrite $fh, $wbuf, length $wbuf; 2027 my $len = syswrite $fh, $wbuf, length $wbuf;
1975 2028
1976 if ($len > 0) { 2029 if ($len > 0) {
1977 substr $wbuf, 0, $len, ""; 2030 substr $wbuf, 0, $len, "";
1978 } else { 2031 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1979 @linger = (); # end 2032 @linger = (); # end
1980 } 2033 }
1981 }; 2034 };
1982 push @linger, AE::timer $linger, 0, sub { 2035 push @linger, AE::timer $linger, 0, sub {
1983 @linger = (); 2036 @linger = ();
… …
2020 2073
2021sub AnyEvent::Handle::destroyed::AUTOLOAD { 2074sub AnyEvent::Handle::destroyed::AUTOLOAD {
2022 #nop 2075 #nop
2023} 2076}
2024 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
2025=item AnyEvent::Handle::TLS_CTX 2101=item AnyEvent::Handle::TLS_CTX
2026 2102
2027This function creates and returns the AnyEvent::TLS object used by default 2103This function creates and returns the AnyEvent::TLS object used by default
2028for TLS mode. 2104for TLS mode.
2029 2105
… …
2060 2136
2061=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
2062reading? 2138reading?
2063 2139
2064Unlike, say, TCP, TLS connections do not consist of two independent 2140Unlike, say, TCP, TLS connections do not consist of two independent
2065communication channels, one for each direction. Or put differently. The 2141communication channels, one for each direction. Or put differently, the
2066read and write directions are not independent of each other: you cannot 2142read and write directions are not independent of each other: you cannot
2067write data unless you are also prepared to read, and vice versa. 2143write data unless you are also prepared to read, and vice versa.
2068 2144
2069This 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>
2070callback invocations when you are not expecting any read data - the reason 2146callback invocations when you are not expecting any read data - the reason
2071is that AnyEvent::Handle always reads in TLS mode. 2147is that AnyEvent::Handle always reads in TLS mode.
2072 2148
2073During 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
2074non-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
… …
2088 my $data = delete $_[0]{rbuf}; 2164 my $data = delete $_[0]{rbuf};
2089 }); 2165 });
2090 2166
2091The 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
2092and 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
2093fact, all data has been received. 2169fact all data has been received.
2094 2170
2095It is usually better to use acknowledgements when transferring data, 2171It is usually better to use acknowledgements when transferring data,
2096to 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
2097intact. 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
2098explicit QUIT command. 2174explicit QUIT command.
… …
2115consider using C<< ->push_shutdown >> instead. 2191consider using C<< ->push_shutdown >> instead.
2116 2192
2117=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.
2118 2194
2119If 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,
2120simply 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>
2121parameter: 2197parameter:
2122 2198
2123 tcp_connect $host, $port, sub { 2199 tcp_connect $host, $port, sub {
2124 my ($fh) = @_; 2200 my ($fh) = @_;
2125 2201
… …
2225 2301
2226=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
2227are free to use in subclasses. 2303are free to use in subclasses.
2228 2304
2229Of course, new versions of AnyEvent::Handle may introduce more "public" 2305Of course, new versions of AnyEvent::Handle may introduce more "public"
2230member variables, but thats just life, at least it is documented. 2306member variables, but that's just life. At least it is documented.
2231 2307
2232=back 2308=back
2233 2309
2234=head1 AUTHOR 2310=head1 AUTHOR
2235 2311

Diff Legend

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